From 0505284554ce824daae1b219040d29522c65544a Mon Sep 17 00:00:00 2001 From: modos189 Date: Mon, 18 Mar 2024 12:11:10 +0000 Subject: [PATCH] deploy: 0976b274c8e5aeb6ce9132a4867736b9336dbf3b --- DataCache.html | 2966 +-- IITC.filters.FilterLayer.html | 272 +- IITC.filters.html | 5772 +---- IITC.toolbox.html | 3284 +-- L.FileListLoader.html | 780 +- L.FileReader.html | 1306 +- L.LayerChooser.html | 150 +- L.html | 1507 +- MapDataRequest.html | 7984 +------ Render.html | 9313 +------- RenderDebugTiles.html | 2755 +-- code__deprecated.js.html | 2 +- code_app.js.html | 2 +- code_artifact.js.html | 2 +- code_boot.js.html | 2 +- code_chat.js.html | 2 +- code_data_cache.js.html | 2 +- code_dialog.js.html | 2 +- code_dialog_about.js.html | 2 +- code_entity_decode.js.html | 2 +- code_entity_info.js.html | 2 +- code_extract_niantic_parameters.js.html | 2 +- code_filters.js.html | 66 +- code_game_status.js.html | 2 +- code_hooks.js.html | 2 +- code_idle.js.html | 2 +- code_layerchooser.js.html | 2 +- code_map.js.html | 2 +- code_map_data_calc_tools.js.html | 2 +- code_map_data_debug.js.html | 2 +- code_map_data_render.js.html | 2 +- code_map_data_request.js.html | 2 +- code_ornaments.js.html | 2 +- code_panes.js.html | 2 +- code_player_names.js.html | 2 +- code_portal_data.js.html | 2 +- code_portal_detail.js.html | 2 +- code_portal_detail_display.js.html | 2 +- code_portal_detail_display_tools.js.html | 2 +- code_portal_highlighter.js.html | 2 +- code_portal_info.js.html | 2 +- code_portal_marker.js.html | 2 +- code_redeeming.js.html | 2 +- code_region_scoreboard.js.html | 2 +- code_request_handling.js.html | 2 +- code_search.js.html | 2 +- code_send_request.js.html | 2 +- code_sidebar.js.html | 2 +- code_smartphone.js.html | 2 +- code_status_bar.js.html | 2 +- code_toolbox.js.html | 2 +- code_utils_file.js.html | 2 +- code_utils_misc.js.html | 2 +- config_options.html | 5576 +---- global.html | 373 +- index.html | 2 +- ingress_constants.html | 3999 +--- module-_deprecated.html | 2448 +- module-app.html | 1403 +- module-boot.html | 2799 +-- module-dialog.html | 3019 +-- module-dialog_about.html | 4789 +--- module-entity_decode.html | 4732 +--- module-entity_info.html | 1240 +- module-extract_niantic_parameters.html | 547 +- module-game_status.html | 742 +- module-hooks.html | 1907 +- module-idle.html | 2101 +- module-map.html | 2400 +- module-map_data_calc_tools.html | 1518 +- module-panes.html | 1201 +- module-player_names.html | 759 +- module-portal_data.html | 3373 +-- module-portal_detail_display.html | 3230 +-- module-portal_detail_display_tools.html | 5159 +--- module-portal_highlighter.html | 2168 +- module-portal_info.html | 8689 +------ module-portal_marker.html | 2149 +- module-redeeming.html | 2556 +- module-region_scoreboard-RegionScore.html | 187 +- module-region_scoreboard.html | 1193 +- module-request_handling.html | 736 +- module-send_request.html | 1236 +- module-sidebar.html | 2473 +- module-smartphone.html | 1870 +- module-status_bar.html | 549 +- module-utils_file.html | 1630 +- module-utils_misc.html | 14330 +----------- other_constants.html | 3782 +-- player.html | 1123 +- storage_variables.html | 2358 +- total-conversion-build.js.html | 2 +- window.artifact.html | 6393 +---- window.chat.html | 24613 +------------------- window.decodeArray.html | 740 +- window.ornaments.html | 6154 +---- window.portalDetail.html | 2414 +- window.requests.html | 1891 +- window.search.Query.html | 4080 +--- window.search.html | 1463 +- 100 files changed, 4728 insertions(+), 179605 deletions(-) diff --git a/DataCache.html b/DataCache.html index 4bac83a02..59da15e4b 100644 --- a/DataCache.html +++ b/DataCache.html @@ -34,7 +34,7 @@

IITC-CE

- +
@@ -314,169 +314,6 @@
Returns:
- - - - - - - - - - - - - - - - - - - - -
- -

- - static window.DataCache#get(qk) → {object|undefined} - - - - -

- - - -
-
- - -
-

Retrieves the data for a given key from the cache.

-
- - - - - - - - - -
-
Parameters:
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
qk - - -string - - - -

The key of the data to retrieve.

- -
- - - - - - - - - - - - - -
-
Returns:
- - - - - -object -| - -undefined - - - - - --

The cached data if it exists, otherwise undefined.

- - - - - -
- - - - - -
- - - - - - - - - - - - - - - - - - - - @@ -659,14 +496,14 @@
Returns:
-

+

- static window.DataCache#getTime(qk) → {number} + static window.DataCache#isFresh(qk) → {boolean|undefined}

@@ -678,7 +515,7 @@

-

Retrieves the timestamp for the given key from the cache.

+

Checks if the data for the given key is fresh.

@@ -758,13 +595,16 @@

Returns:
-number +boolean +| +undefined --

The timestamp of the data if it exists, otherwise 0.

+ +-

True if the data is fresh, false if it's stale, undefined if data doesn't exist.

@@ -819,14 +659,14 @@
Returns:
-

+

- static window.DataCache#isFresh(qk) → {boolean|undefined} + static window.DataCache#remove(qk)

@@ -838,7 +678,7 @@

-

Checks if the data for the given key is fresh.

+

Removes a specific entry from the cache based on its key.

@@ -890,7 +730,7 @@

Parameters:
-

The key of the data to check.

+

The key of the data to remove from the cache.

@@ -911,30 +751,6 @@
Parameters:
-
-
Returns:
- - - - - -boolean -| - -undefined - - - - - --

True if the data is fresh, false if it's stale, undefined if data doesn't exist.

- - - - - -
- @@ -982,14 +798,14 @@
Returns:
-

+

- static window.DataCache#isFresh(qk) → {boolean|undefined} + static window.DataCache#startExpireInterval(period)

@@ -1001,7 +817,7 @@

-

Checks if the data for the given key is fresh.

+

Starts the interval to periodically run the cache expiration.

@@ -1037,2589 +853,13 @@

Parameters:
- qk + period -string - - - - - - - - - -

The key of the data to check.

- - - - - - - - - - - - - - - - - - - - -
-
Returns:
- - - - - -boolean -| - -undefined - - - - - --

True if the data is fresh, false if it's stale, undefined if data doesn't exist.

- - - - - -
- - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - -
- - - - -
- -

- - static window.DataCache#remove(qk) - - - - -

- - - -
-
- - -
-

Removes a specific entry from the cache based on its key.

-
- - - - - - - - - -
-
Parameters:
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
qk - - -string - - - -

The key of the data to remove from the cache.

- -
- - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - -
- - - - -
- -

- - static window.DataCache#remove(qk) - - - - -

- - - -
-
- - -
-

Removes a specific entry from the cache based on its key.

-
- - - - - - - - - -
-
Parameters:
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
qk - - -string - - - -

The key of the data to remove from the cache.

- -
- - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - -
- - - - -
- -

- - static window.DataCache#startExpireInterval(period) - - - - -

- - - -
-
- - -
-

Starts the interval to periodically run the cache expiration.

-
- - - - - - - - - -
-
Parameters:
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
period - - -number - - - -

The period in seconds between each expiration run.

- -
- - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - -
- - - - -
- -

- - static window.DataCache#startExpireInterval(period) - - - - -

- - - -
-
- - -
-

Starts the interval to periodically run the cache expiration.

-
- - - - - - - - - -
-
Parameters:
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
period - - -number - - - -

The period in seconds between each expiration run.

- -
- - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - -
- - - - -
- -

- - static window.DataCache#store(qk, data) - - - - -

- - - -
-
- - -
-

Stores data in the cache. -If an entry for the given key already exists, it's removed before the new data is stored. -The data is stored along with its timestamp and expiration time.

-
- - - - - - - - - -
-
Parameters:
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
qk - - -string - - - -

The key under which to store the data.

data - - -object - - - -

The data to be stored in the cache.

- -
- - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - -
- - - - -
- -

- - static window.DataCache#store(qk, data) - - - - -

- - - -
-
- - -
-

Stores data in the cache. -If an entry for the given key already exists, it's removed before the new data is stored. -The data is stored along with its timestamp and expiration time.

-
- - - - - - - - - -
-
Parameters:
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
qk - - -string - - - -

The key under which to store the data.

data - - -object - - - -

The data to be stored in the cache.

- -
- - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - -
- - - - - - - - - - - - - - - - - -
- -
- -

DataCache()

- - -
- -
- -
- - - -
- -

- - new DataCache() - - - - -

- - - -
-
- - -
-

DataCache constructor. -Manages a cache for map data tiles. The cache has a maximum age and size limit, -and these limits can vary for mobile and desktop environments.

-
- - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - -
- - -
- - - - - - - - - - - - - - - - - -

Methods

- -
- - -
- -

- - static window.DataCache#get(qk) → {object|undefined} - - - - -

- - - -
-
- - -
-

Retrieves the data for a given key from the cache.

-
- - - - - - - - - -
-
Parameters:
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
qk - - -string - - - -

The key of the data to retrieve.

- -
- - - - - - - - - - - - - -
-
Returns:
- - - - - -object -| - -undefined - - - - - --

The cached data if it exists, otherwise undefined.

- - - - - -
- - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - -
- - - - -
- -

- - static window.DataCache#get(qk) → {object|undefined} - - - - -

- - - -
-
- - -
-

Retrieves the data for a given key from the cache.

-
- - - - - - - - - -
-
Parameters:
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
qk - - -string - - - -

The key of the data to retrieve.

- -
- - - - - - - - - - - - - -
-
Returns:
- - - - - -object -| - -undefined - - - - - --

The cached data if it exists, otherwise undefined.

- - - - - -
- - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - -
- - - - -
- -

- - static window.DataCache#getTime(qk) → {number} - - - - -

- - - -
-
- - -
-

Retrieves the timestamp for the given key from the cache.

-
- - - - - - - - - -
-
Parameters:
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
qk - - -string - - - -

The key of the data to check.

- -
- - - - - - - - - - - - - -
-
Returns:
- - - - - -number - - - - - --

The timestamp of the data if it exists, otherwise 0.

- - - - - -
- - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - -
- - - - -
- -

- - static window.DataCache#getTime(qk) → {number} - - - - -

- - - -
-
- - -
-

Retrieves the timestamp for the given key from the cache.

-
- - - - - - - - - -
-
Parameters:
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
qk - - -string - - - -

The key of the data to check.

- -
- - - - - - - - - - - - - -
-
Returns:
- - - - - -number - - - - - --

The timestamp of the data if it exists, otherwise 0.

- - - - - -
- - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - -
- - - - -
- -

- - static window.DataCache#isFresh(qk) → {boolean|undefined} - - - - -

- - - -
-
- - -
-

Checks if the data for the given key is fresh.

-
- - - - - - - - - -
-
Parameters:
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
qk - - -string - - - -

The key of the data to check.

- -
- - - - - - - - - - - - - -
-
Returns:
- - - - - -boolean -| - -undefined - - - - - --

True if the data is fresh, false if it's stale, undefined if data doesn't exist.

- - - - - -
- - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - -
- - - - -
- -

- - static window.DataCache#isFresh(qk) → {boolean|undefined} - - - - -

- - - -
-
- - -
-

Checks if the data for the given key is fresh.

-
- - - - - - - - - -
-
Parameters:
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
qk - - -string - - - -

The key of the data to check.

- -
- - - - - - - - - - - - - -
-
Returns:
- - - - - -boolean -| - -undefined - - - - - --

True if the data is fresh, false if it's stale, undefined if data doesn't exist.

- - - - - -
- - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - -
- - - - -
- -

- - static window.DataCache#remove(qk) - - - - -

- - - -
-
- - -
-

Removes a specific entry from the cache based on its key.

-
- - - - - - - - - -
-
Parameters:
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
qk - - -string - - - -

The key of the data to remove from the cache.

- -
- - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - -
- - - - -
- -

- - static window.DataCache#remove(qk) - - - - -

- - - -
-
- - -
-

Removes a specific entry from the cache based on its key.

-
- - - - - - - - - -
-
Parameters:
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
qk - - -string - - - -

The key of the data to remove from the cache.

- -
- - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - -
- - - - -
- -

- - static window.DataCache#startExpireInterval(period) - - - - -

- - - -
-
- - -
-

Starts the interval to periodically run the cache expiration.

-
- - - - - - - - - -
-
Parameters:
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
period - - -number - - - -

The period in seconds between each expiration run.

- -
- - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - -
- - - - -
- -

- - static window.DataCache#startExpireInterval(period) - - - - -

- - - -
-
- - -
-

Starts the interval to periodically run the cache expiration.

-
- - - - - - - - - -
-
Parameters:
- - - - - - - - - - - - - - - - - - - - - - - - - - - - + + @@ -752,7 +621,7 @@
Returns:
--

true if the the field matches one of the filters

+-

true if the the link matches one of the filters

@@ -807,14 +676,14 @@
Returns:
-

- static filterLink(link) → {boolean} + static filterPortal(portal) → {boolean}

@@ -826,7 +695,7 @@
Parameters:
- + + @@ -912,7 +781,7 @@
Returns:
--

true if the the link matches one of the filters

+-

true if the the portal matches one of the filters

@@ -967,14 +836,14 @@
Returns:
-

- static filterLink(link) → {boolean} + static has(name) → {boolean}

@@ -986,7 +855,7 @@
Parameters:
- + + @@ -1072,7 +941,7 @@
Returns:
--

true if the the link matches one of the filters

+-

True if the filter exists, false otherwise.

@@ -1127,14 +996,14 @@
Returns:
-

+

- static filterPortal(portal) → {boolean} + static remove(name) → {boolean}

@@ -1146,7 +1015,7 @@

-

Tests whether a given portal matches any of the currently active filters.

+

Removes a filter with the specified name.

@@ -1182,13 +1051,13 @@

Parameters:
- + + @@ -1232,7 +1101,7 @@
Returns:
--

true if the the portal matches one of the filters

+-

True if the filter was successfully deleted, false otherwise.

@@ -1287,14 +1156,14 @@
Returns:
-

+

- static filterPortal(portal) → {boolean} + static set(name, filterDesc)

@@ -1306,7 +1175,7 @@

-

Tests whether a given portal matches any of the currently active filters.

+

Sets or updates a filter with a given name. If a filter with the same name already exists, it is overwritten.

@@ -1342,13 +1211,13 @@

Parameters:
- + + - -
NameTypeDescription
period - - -number +number @@ -3839,170 +1079,6 @@
Parameters:
- - - - - - - - - - - - - - - - - - - - -
- -

- - static window.DataCache#store(qk, data) - - - - -

- - - -
-
- - -
-

Stores data in the cache. -If an entry for the given key already exists, it's removed before the new data is stored. -The data is stored along with its timestamp and expiration time.

-
- - - - - - - - - -
-
Parameters:
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
qk - - -string - - - -

The key under which to store the data.

data - - -object - - - -

The data to be stored in the cache.

- -
- - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - diff --git a/IITC.filters.FilterLayer.html b/IITC.filters.FilterLayer.html index cfbf4ce06..894a5a1c9 100644 --- a/IITC.filters.FilterLayer.html +++ b/IITC.filters.FilterLayer.html @@ -34,7 +34,7 @@

IITC-CE

    - +
    @@ -69,275 +69,7 @@

    - -

    - - - - -
    - - -
    -

    Layer abstraction to control with the layer chooser a filter. -The filter is disabled on layer add, and enabled on layer remove.

    -
    - - - - - - - - - -
    -
    Parameters:
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    NameTypeDescription
    options - - -Object - - - -

    Configuration options for the filter layer

    -
    Properties
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    NameTypeDescription
    name - - -string - - - -

    The name of the filter

    filter - - -IITC.filters.FilterDesc - - - -

    The filter description

    - -
    - -
    - - - - - - - - - - - - - - - - - -
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    - - - - -
    - - - - - - -

    Extends

    - - - - -
      -
    • L.Layer
    • -
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    - -
    - -

    - .filters.FilterLayer(options)

    - - -
    - -
    - -
    - - - -
    - -

    - - new FilterLayer(options) - - -

    diff --git a/IITC.filters.html b/IITC.filters.html index a42205b4d..3ff283d13 100644 --- a/IITC.filters.html +++ b/IITC.filters.html @@ -34,7 +34,7 @@

    IITC-CE

      - +
      @@ -58,7 +58,51 @@

      filters

      -

      Filters API

      +

      Filters API

      +

      Filters API is a mechanism to hide intel entities using their properties (faction, +health, timestamp...). It provides two level APIs: a set of named filters that +apply globally (any entity matching one of the filters will be hidden), and low +level API to test an entity against a filter for generic purpose. +This comes with a Leaflet layer system following the old layer system, the filter +is disabled when the layer is added to the map and is enabled when removed.

      +

      A filter applies to a combinaison of portal/link/field and is described by

      +
        +
      • data properties that must (all) match
      • +
      • or a predicate for complex filter
      • +
      +

      { portal: true, link: true, data: { team: 'E' }} +filters any ENL portal/link

      +

      [{ link: true, data: { oGuid: "some guid" }}, { link: true, data: { dGuid: "some guid" }}] +filters any links on portal with guid "some guid"

      +

      { field: true, pred: function (f) { return f.options.timestamp < Date.parse('2021-10-31'); } } +filters any fields made before Halloween 2021

      +

      Data properties can be specified as value, or as a complex expression (required +for array data properties). A complex expression is a 2-array, first element is +an operator, second is the argument of the operator for the property. +The operators are:

      +
        +
      • ['eq', value] : this is equivalent to type directly value
      • +
      • ['not', ]
      • +
      • ['or', [exp1, exp2,...]]: the expression matches if one of the exp1.. matches
      • +
      • ['and', [exp1, exp2...]]: matches if all exp1 matches (useful for array +properties)
      • +
      • ['some', exp]: when the property is an array, matches if one of the element +matches exp
      • +
      • ['every', exp]: all elements must match exp
      • +
      • ['<', number]: for number comparison (and <= > >=)
      • +
      +

      Examples:

      +

      { portal: true, data: ['not', { history: { scoutControlled: false }, ornaments: ['some', 'sc5_p'] }] } +filters all portals but the one never scout controlled that have a scout +volatile ornament

      +

      { portal: true, data: ['not', { resonators: ['every', { owner: 'some agent' } ] } ] } +filters all portals that have resonators not owned from 'some agent' +(note: that would need to load portal details)

      +

      { portal: true, data: { level: ['or', [1,4,5]], health: ['>', 85] } } +filters all portals with level 1,4 or 5 and health over 85

      +

      { portal: true, link: true, field: true, options: { timestamp: ['<', Date.now() - 3600000] } } +filters all entities with no change since 1 hour (from the creation of +the filter)

      @@ -123,16 +167,6 @@

      -
      -

      - FilterLayer - -

      -
      - -

      @@ -155,82 +189,7 @@

      - -

      - - - -
      - - - - - - - -
      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      - - - - - -
      - - - - -
      -

      - static _filters :Object.<string, IITC.filters.FilterDesc> - -

      @@ -314,97 +273,7 @@

      - -

      - - - -
      -
      - - -
      -

      Applies all existing filters to the entities (portals, links, and fields) on the map. -Entities that match any of the active filters are removed from the map; others are added or remain on the map.

      -
      - - - - - - - - - - - - - - - - - - - - - - - - - -
      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      - - - - -
      - - - - -
      - -

      - - static filterEntities() - - -

      @@ -494,7 +363,7 @@

      @@ -647,14 +516,14 @@
      Returns:
      -

      +

      @@ -666,7 +535,7 @@

      -

      Tests whether a given field matches any of the currently active filters.

      +

      Tests whether a given link matches any of the currently active filters.

      @@ -702,7 +571,7 @@

      Parameters:
      fieldlink @@ -718,7 +587,7 @@
      Parameters:
      -

      Field to test

      Link to test

      linkportal @@ -878,7 +747,7 @@
      Parameters:
      -

      Link to test

      Portal to test

      linkname -object +string @@ -1038,7 +907,7 @@
      Parameters:
      -

      Link to test

      The name of the filter to check.

      portalname -object +string @@ -1198,7 +1067,7 @@
      Parameters:
      -

      Portal to test

      The name of the filter to be removed.

      portalname -object +string @@ -1358,157 +1227,23 @@
      Parameters:
      -

      Portal to test

      filter name

      - -
      - - + + + filterDesc + - + + + +IITC.filters.FilterDesc +| - - - - - - - -
      -
      Returns:
      - - - - - -boolean - - - - - --

      true if the the portal matches one of the filters

      - - - - - -
      - - - - - -
      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      - - - - -
      - - - - -
      - -

      - - static has(name) → {boolean} - - - - -

      - - - -
      -
      - - -
      -

      Checks if a filter with the specified name exists.

      -
      - - - - - - - - - -
      -
      Parameters:
      - - - - - - - - - - - - - - - - - - - - - - - - - - - + @@ -1539,27 +1274,6 @@
      Parameters:
      -
      -
      Returns:
      - - - - - -boolean - - - - - --

      True if the filter exists, false otherwise.

      - - - - - -
      - @@ -1607,14 +1321,14 @@
      Returns:
      -

      +

      - static has(name) → {boolean} + static testFilter(type, entity, filter) → {boolean}

      @@ -1626,7 +1340,7 @@

      -

      Checks if a filter with the specified name exists.

      +

      Tests whether a given entity matches a specified filter.

      @@ -1649,5074 +1363,49 @@

      Parameters:
      - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      NameTypeDescription
      name - - -string +Array.<IITC.filters.FilterDesc> @@ -1518,7 +1253,7 @@
      Parameters:
      -

      The name of the filter to check.

      filter description (OR)

      TypeDescription
      name - - -string - - - -

      The name of the filter to check.

      - -
      - - - - - - - - - - - - - -
      -
      Returns:
      - - - - - -boolean - - - - - --

      True if the filter exists, false otherwise.

      - - - - - -
      - - - - - -
      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      - - - - -
      - - - - -
      - -

      - - static remove(name) → {boolean} - - - - -

      - - - -
      -
      - - -
      -

      Removes a filter with the specified name.

      -
      - - - - - - - - - -
      -
      Parameters:
      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      NameTypeDescription
      name - - -string - - - -

      The name of the filter to be removed.

      - -
      - - - - - - - - - - - - - -
      -
      Returns:
      - - - - - -boolean - - - - - --

      True if the filter was successfully deleted, false otherwise.

      - - - - - -
      - - - - - -
      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      - - - - -
      - - - - -
      - -

      - - static remove(name) → {boolean} - - - - -

      - - - -
      -
      - - -
      -

      Removes a filter with the specified name.

      -
      - - - - - - - - - -
      -
      Parameters:
      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      NameTypeDescription
      name - - -string - - - -

      The name of the filter to be removed.

      - -
      - - - - - - - - - - - - - -
      -
      Returns:
      - - - - - -boolean - - - - - --

      True if the filter was successfully deleted, false otherwise.

      - - - - - -
      - - - - - -
      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      - - - - -
      - - - - -
      - -

      - - static set(name, filterDesc) - - - - -

      - - - -
      -
      - - -
      -

      Sets or updates a filter with a given name. If a filter with the same name already exists, it is overwritten.

      -
      - - - - - - - - - -
      -
      Parameters:
      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      NameTypeDescription
      name - - -string - - - -

      filter name

      filterDesc - - -IITC.filters.FilterDesc -| - -Array.<IITC.filters.FilterDesc> - - - -

      filter description (OR)

      - -
      - - - - - - - - - - - - - - - - - -
      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      - - - - -
      - - - - -
      - -

      - - static set(name, filterDesc) - - - - -

      - - - -
      -
      - - -
      -

      Sets or updates a filter with a given name. If a filter with the same name already exists, it is overwritten.

      -
      - - - - - - - - - -
      -
      Parameters:
      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      NameTypeDescription
      name - - -string - - - -

      filter name

      filterDesc - - -IITC.filters.FilterDesc -| - -Array.<IITC.filters.FilterDesc> - - - -

      filter description (OR)

      - -
      - - - - - - - - - - - - - - - - - -
      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      - - - - -
      - - - - -
      - -

      - - static testFilter(type, entity, filter) → {boolean} - - - - -

      - - - -
      -
      - - -
      -

      Tests whether a given entity matches a specified filter.

      -
      - - - - - - - - - -
      -
      Parameters:
      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      NameTypeDescription
      type - - -"portal" -| - -"link" -| - -"field" - - - -

      Type of the entity

      entity - - -object - - - -

      Portal/link/field to test

      filter - - -IITC.filters.FilterDesc - - - -

      Filter

      - -
      - - - - - - - - - - - - - -
      -
      Returns:
      - - - - - -boolean - - - - - --

      true if the the entity of type type matches the filter

      - - - - - -
      - - - - - -
      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      - - - - -
      - - - - -
      - -

      - - static testFilter(type, entity, filter) → {boolean} - - - - -

      - - - -
      -
      - - -
      -

      Tests whether a given entity matches a specified filter.

      -
      - - - - - - - - - -
      -
      Parameters:
      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      NameTypeDescription
      type - - -"portal" -| - -"link" -| - -"field" - - - -

      Type of the entity

      entity - - -object - - - -

      Portal/link/field to test

      filter - - -IITC.filters.FilterDesc - - - -

      Filter

      - -
      - - - - - - - - - - - - - -
      -
      Returns:
      - - - - - -boolean - - - - - --

      true if the the entity of type type matches the filter

      - - - - - -
      - - - - - -
      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      - - - - -
      - -
      - - - -

      Type Definitions

      - -
      - - -
      -

      - FilterDesc - - - -

      - - -
      -
      - - - - - - - -
      Properties:
      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      NameTypeAttributesDescription
      filterDesc.portal - - -boolean - - - - - - - -

      apply to portal

      filterDesc.link - - -boolean - - - - - - - -

      apply to link

      filterDesc.field - - -boolean - - - - - - - -

      apply to field

      filterDesc.data - - -object - - - - - - <optional>
      - - - -

      entity data properties that must match

      filterDesc.options - - -object - - - - - - <optional>
      - - - -

      entity options that must match

      filterDesc.pred - - -IITC.filters.FilterPredicate - - - - - - <optional>
      - - - -

      predicate on the entity

      - - - - -
      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      - - - - - -
      - - - - -
      -

      - FilterDesc - - - -

      - - -
      -
      - - - - - - - -
      Properties:
      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      NameTypeAttributesDescription
      filterDesc.portal - - -boolean - - - - - - - -

      apply to portal

      filterDesc.link - - -boolean - - - - - - - -

      apply to link

      filterDesc.field - - -boolean - - - - - - - -

      apply to field

      filterDesc.data - - -object - - - - - - <optional>
      - - - -

      entity data properties that must match

      filterDesc.options - - -object - - - - - - <optional>
      - - - -

      entity options that must match

      filterDesc.pred - - -IITC.filters.FilterPredicate - - - - - - <optional>
      - - - -

      predicate on the entity

      - - - - -
      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      - - - - - -
      - - - - -
      - -

      - - FilterPredicate(ent) → {boolean} - - - - -

      - - - -
      -
      - - - - - - - - - - -
      -
      Parameters:
      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      NameTypeDescription
      ent - - -Object - - - -

      IITC entity

      - -
      - - - - - - - - - - - - - -
      -
      Returns:
      - - - - - -boolean - - - - - - - - - -
      - - - - - -
      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      - - - - -
      - - - - -
      - -

      - - FilterPredicate(ent) → {boolean} - - - - -

      - - - -
      -
      - - - - - - - - - - -
      -
      Parameters:
      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      NameTypeDescription
      ent - - -Object - - - -

      IITC entity

      - -
      - - - - - - - - - - - - - -
      -
      Returns:
      - - - - - -boolean - - - - - - - - - -
      - - - - - -
      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      - - - - -
      - -
      - - - -
      - -
      - - - - - - - -
      - -
      - -

      filters

      - - -
      - -
      - -
      - - -

      Filters API

      - - - - - -
      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      - - - - -
      - - - - - - - -

      Classes

      - - -
      - -
      -

      - FilterLayer - -

      -
      - - -
      -

      - FilterLayer - -

      -
      - - -
      - - - - - - - - - - -

      Members

      - -
      - - -
      -

      - static _filters :Object.<string, IITC.filters.FilterDesc> - - - -

      - - -
      -
      - - - - - - - -
      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      - - - - - -
      - - - - -
      -

      - static _filters :Object.<string, IITC.filters.FilterDesc> - - - -

      - - -
      -
      - - - - - - - -
      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      - - - - - -
      - -
      - - - -

      Methods

      - -
      - - -
      - -

      - - static filterEntities() - - - - -

      - - - -
      -
      - - -
      -

      Applies all existing filters to the entities (portals, links, and fields) on the map. -Entities that match any of the active filters are removed from the map; others are added or remain on the map.

      -
      - - - - - - - - - - - - - - - - - - - - - - - - - -
      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      - - - - -
      - - - - -
      - -

      - - static filterEntities() - - - - -

      - - - -
      -
      - - -
      -

      Applies all existing filters to the entities (portals, links, and fields) on the map. -Entities that match any of the active filters are removed from the map; others are added or remain on the map.

      -
      - - - - - - - - - - - - - - - - - - - - - - - - - -
      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      - - - - -
      - - - - -
      - -

      - - static filterField(field) → {boolean} - - - - -

      - - - -
      -
      - - -
      -

      Tests whether a given field matches any of the currently active filters.

      -
      - - - - - - - - - -
      -
      Parameters:
      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      NameTypeDescription
      field - - -object - - - -

      Field to test

      - -
      - - - - - - - - - - - - - -
      -
      Returns:
      - - - - - -boolean - - - - - --

      true if the the field matches one of the filters

      - - - - - -
      - - - - - -
      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      - - - - -
      - - - - -
      - -

      - - static filterField(field) → {boolean} - - - - -

      - - - -
      -
      - - -
      -

      Tests whether a given field matches any of the currently active filters.

      -
      - - - - - - - - - -
      -
      Parameters:
      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      NameTypeDescription
      field - - -object - - - -

      Field to test

      - -
      - - - - - - - - - - - - - -
      -
      Returns:
      - - - - - -boolean - - - - - --

      true if the the field matches one of the filters

      - - - - - -
      - - - - - -
      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      - - - - -
      - - - - -
      - - - - - -
      -
      - - -
      -

      Tests whether a given link matches any of the currently active filters.

      -
      - - - - - - - - - -
      -
      Parameters:
      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      NameTypeDescription
      link - - -object - - - -

      Link to test

      - -
      - - - - - - - - - - - - - -
      -
      Returns:
      - - - - - -boolean - - - - - --

      true if the the link matches one of the filters

      - - - - - -
      - - - - - -
      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      - - - - -
      - - - - -
      - - - - - -
      -
      - - -
      -

      Tests whether a given link matches any of the currently active filters.

      -
      - - - - - - - - - -
      -
      Parameters:
      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      NameTypeDescription
      link - - -object - - - -

      Link to test

      - -
      - - - - - - - - - - - - - -
      -
      Returns:
      - - - - - -boolean - - - - - --

      true if the the link matches one of the filters

      - - - - - -
      - - - - - -
      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      - - - - -
      - - - - -
      - -

      - - static filterPortal(portal) → {boolean} - - - - -

      - - - -
      -
      - - -
      -

      Tests whether a given portal matches any of the currently active filters.

      -
      - - - - - - - - - -
      -
      Parameters:
      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      NameTypeDescription
      portal - - -object - - - -

      Portal to test

      - -
      - - - - - - - - - - - - - -
      -
      Returns:
      - - - - - -boolean - - - - - --

      true if the the portal matches one of the filters

      - - - - - -
      - - - - - -
      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      - - - - -
      - - - - -
      - -

      - - static filterPortal(portal) → {boolean} - - - - -

      - - - -
      -
      - - -
      -

      Tests whether a given portal matches any of the currently active filters.

      -
      - - - - - - - - - -
      -
      Parameters:
      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      NameTypeDescription
      portal - - -object - - - -

      Portal to test

      - -
      - - - - - - - - - - - - - -
      -
      Returns:
      - - - - - -boolean - - - - - --

      true if the the portal matches one of the filters

      - - - - - -
      - - - - - -
      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      - - - - -
      - - - - -
      - -

      - - static has(name) → {boolean} - - - - -

      - - - -
      -
      - - -
      -

      Checks if a filter with the specified name exists.

      -
      - - - - - - - - - -
      -
      Parameters:
      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      NameTypeDescription
      name - - -string - - - -

      The name of the filter to check.

      - -
      - - - - - - - - - - - - - -
      -
      Returns:
      - - - - - -boolean - - - - - --

      True if the filter exists, false otherwise.

      - - - - - -
      - - - - - -
      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      - - - - -
      - - - - -
      - -

      - - static has(name) → {boolean} - - - - -

      - - - -
      -
      - - -
      -

      Checks if a filter with the specified name exists.

      -
      - - - - - - - - - -
      -
      Parameters:
      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      NameTypeDescription
      name - - -string - - - -

      The name of the filter to check.

      - -
      - - - - - - - - - - - - - -
      -
      Returns:
      - - - - - -boolean - - - - - --

      True if the filter exists, false otherwise.

      - - - - - -
      - - - - - -
      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      - - - - -
      - - - - -
      - -

      - - static remove(name) → {boolean} - - - - -

      - - - -
      -
      - - -
      -

      Removes a filter with the specified name.

      -
      - - - - - - - - - -
      -
      Parameters:
      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      NameTypeDescription
      name - - -string - - - -

      The name of the filter to be removed.

      - -
      - - - - - - - - - - - - - -
      -
      Returns:
      - - - - - -boolean - - - - - --

      True if the filter was successfully deleted, false otherwise.

      - - - - - -
      - - - - - -
      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      - - - - -
      - - - - -
      - -

      - - static remove(name) → {boolean} - - - - -

      - - - -
      -
      - - -
      -

      Removes a filter with the specified name.

      -
      - - - - - - - - - -
      -
      Parameters:
      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      NameTypeDescription
      name - - -string - - - -

      The name of the filter to be removed.

      - -
      - - - - - - - - - - - - - -
      -
      Returns:
      - - - - - -boolean - - - - - --

      True if the filter was successfully deleted, false otherwise.

      - - - - - -
      - - - - - -
      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      - - - - -
      - - - - -
      - -

      - - static set(name, filterDesc) - - - - -

      - - - -
      -
      - - -
      -

      Sets or updates a filter with a given name. If a filter with the same name already exists, it is overwritten.

      -
      - - - - - - - - - -
      -
      Parameters:
      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      NameTypeDescription
      name - - -string - - - -

      filter name

      filterDesc - - -IITC.filters.FilterDesc -| - -Array.<IITC.filters.FilterDesc> - - - -

      filter description (OR)

      - -
      - - - - - - - - - - - - - - - - - -
      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      - - - - -
      - - - - -
      - -

      - - static set(name, filterDesc) - - - - -

      - - - -
      -
      - - -
      -

      Sets or updates a filter with a given name. If a filter with the same name already exists, it is overwritten.

      -
      - - - - - - - - - -
      -
      Parameters:
      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      NameTypeDescription
      name - - -string - - - -

      filter name

      filterDesc - - -IITC.filters.FilterDesc -| - -Array.<IITC.filters.FilterDesc> - - - -

      filter description (OR)

      - -
      - - - - - - - - - - - - - - - - - -
      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      - - - - -
      - - - - -
      - -

      - - static testFilter(type, entity, filter) → {boolean} - - - - -

      - - - -
      -
      - - -
      -

      Tests whether a given entity matches a specified filter.

      -
      - - - - - - - - - -
      -
      Parameters:
      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      NameTypeDescription
      type - - -"portal" -| - -"link" -| - -"field" - - - -

      Type of the entity

      entity - - -object - - - -

      Portal/link/field to test

      filter - - -IITC.filters.FilterDesc - - - -

      Filter

      - -
      - - - - - - - - - - - - - -
      -
      Returns:
      - - - - - -boolean - - - - - --

      true if the the entity of type type matches the filter

      - - - - - -
      - - - - - -
      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      - - - - -
      - - - - -
      - -

      - - static testFilter(type, entity, filter) → {boolean} - - - - -

      - - - -
      -
      - - -
      -

      Tests whether a given entity matches a specified filter.

      -
      - - - - - - - - - -
      -
      Parameters:
      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      NameTypeDescription
      type - - -"portal" -| - -"link" -| - -"field" - - - -

      Type of the entity

      entity - - -object - - - -

      Portal/link/field to test

      filter - - -IITC.filters.FilterDesc - - - -

      Filter

      - -
      - - - - - - - - - - - - - -
      -
      Returns:
      - - - - - -boolean - - - - - --

      true if the the entity of type type matches the filter

      - - - - - -
      - - - - - -
      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      - - - - -
      - -
      - - - -

      Type Definitions

      - -
      - - -
      -

      - FilterDesc - - - -

      - - -
      -
      - - - - - - - -
      Properties:
      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + - + - - + + + + - + - - - - + - + - - - + - + - - - +
      NameTypeAttributesDescription
      filterDesc.portal - - -boolean - - - - - - - -

      apply to portal

      filterDesc.link - - -boolean - - - - - - - -

      apply to link

      filterDesc.field - - -boolean - - - - - - - -

      apply to field

      Description
      filterDesc.datatype -object +"portal" +| +"link" +| + +"field" - - - - <optional>
      - +

      entity data properties that must match

      Type of the entity

      filterDesc.optionsentity @@ -6729,57 +1418,77 @@
      Properties:
      - - <optional>
      - - - -

      entity options that must match

      Portal/link/field to test

      filterDesc.predfilter -IITC.filters.FilterPredicate +IITC.filters.FilterDesc - - <optional>
      - - - -

      predicate on the entity

      Filter

      + + + + + + + + + + + + + + +
      +
      Returns:
      + + + + + +boolean + + + + + +-

      true if the the entity of type type matches the filter

      + + + +
      + + + +
      @@ -6817,10 +1526,15 @@
      Properties:
      -
      - +
      + + + +

      Type Definitions

      + +
      @@ -6829,7 +1543,7 @@

      @@ -7118,161 +1832,7 @@

      - -

      - - - -
      -
      - - - - - - - - - - -
      -
      Parameters:
      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      NameTypeDescription
      ent - - -Object - - - -

      IITC entity

      - -
      - - - - - - - - - - - - - -
      -
      Returns:
      - - - - - -boolean - - - - - - - - - -
      - - - - - -
      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      - - - - -
      - - - - -
      - -

      - - FilterPredicate(ent) → {boolean} - - -

      diff --git a/IITC.toolbox.html b/IITC.toolbox.html index 9e75d1685..0e9a81f90 100644 --- a/IITC.toolbox.html +++ b/IITC.toolbox.html @@ -34,7 +34,7 @@

      IITC-CE

        - +
        @@ -214,3097 +214,14 @@

        -

        - - private, static _applySort() - - - - -

        - - - -
        -
        - - -
        -

        Internal method to apply sorting to the buttons.

        -
        - - - - - - - - - - - - - - - - - - - - - - - - - -
        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
        - - - - -
        - - - - -
        - -

        - - private, static _renderButton(buttonId) - - - - -

        - - - -
        -
        - - -
        -

        Internal method to render a button.

        -
        - - - - - - - - - -
        -
        Parameters:
        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
        NameTypeDescription
        buttonId - - -string - - - -

        The ID of the button to render.

        - -
        - - - - - - - - - - - - - - - - - -
        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
        - - - - -
        - - - - -
        - -

        - - private, static _renderButton(buttonId) - - - - -

        - - - -
        -
        - - -
        -

        Internal method to render a button.

        -
        - - - - - - - - - -
        -
        Parameters:
        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
        NameTypeDescription
        buttonId - - -string - - - -

        The ID of the button to render.

        - -
        - - - - - - - - - - - - - - - - - -
        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
        - - - - -
        - - - - -
        - -

        - - private, static _syncWithLegacyToolbox() → {void} - - - - -

        - - - -
        -
        - - -
        -

        Internal method to synchronize the toolbox with the legacy toolbox.

        -
        - - - - - - - - - - - - - - - - - - - - - -
        -
        Returns:
        - - - - - -void - - - - - - - - - -
        - - - - - -
        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
        - - - - -
        - - - - -
        - -

        - - private, static _syncWithLegacyToolbox() → {void} - - - - -

        - - - -
        -
        - - -
        -

        Internal method to synchronize the toolbox with the legacy toolbox.

        -
        - - - - - - - - - - - - - - - - - - - - - -
        -
        Returns:
        - - - - - -void - - - - - - - - - -
        - - - - - -
        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
        - - - - -
        - - - - -
        - -

        - - static addButton(buttonArgs) → {string|null} - - - - -

        - - - -
        -
        - - -
        -

        Adds a button to the toolbox.

        -
        - - - - - - - - - -
        -
        Parameters:
        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
        NameTypeDescription
        buttonArgs - - -ButtonArgs - - - -

        The arguments for the button.

        - -
        - - - - - - - - - - - - - -
        -
        Returns:
        - - - - - -string -| - -null - - - - - --

        The ID of the added button or null if required parameters are missing.

        - - - - - -
        - - - - - -
        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
        - - - -
        Examples
        - -
        const buttonId = IITC.toolbox.addButton({
        -  label: 'AboutIITC',
        -  action: window.AboutIITC
        -});
        - -
        const buttonId = IITC.toolbox.addButton({
        -  label: 'Test Button',
        -  action: () => alert('Clicked!')
        -});
        - - - -
        - - - - -
        - -

        - - static addButton(buttonArgs) → {string|null} - - - - -

        - - - -
        -
        - - -
        -

        Adds a button to the toolbox.

        -
        - - - - - - - - - -
        -
        Parameters:
        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
        NameTypeDescription
        buttonArgs - - -ButtonArgs - - - -

        The arguments for the button.

        - -
        - - - - - - - - - - - - - -
        -
        Returns:
        - - - - - -string -| - -null - - - - - --

        The ID of the added button or null if required parameters are missing.

        - - - - - -
        - - - - - -
        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
        - - - -
        Examples
        - -
        const buttonId = IITC.toolbox.addButton({
        -  label: 'AboutIITC',
        -  action: window.AboutIITC
        -});
        - -
        const buttonId = IITC.toolbox.addButton({
        -  label: 'Test Button',
        -  action: () => alert('Clicked!')
        -});
        - - - -
        - - - - -
        - -

        - - static removeButton(buttonId) → {boolean} - - - - -

        - - - -
        -
        - - -
        -

        Removes a button from the toolbox.

        -
        - - - - - - - - - -
        -
        Parameters:
        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
        NameTypeDescription
        buttonId - - -string - - - -

        The ID of the button to remove.

        - -
        - - - - - - - - - - - - - -
        -
        Returns:
        - - - - - -boolean - - - - - --

        True if the button is successfully removed, false otherwise.

        - - - - - -
        - - - - - -
        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
        - - - -
        Example
        - -
        const isRemoved = IITC.toolbox.removeButton(buttonId);
        - - - -
        - - - - -
        - -

        - - static removeButton(buttonId) → {boolean} - - - - -

        - - - -
        -
        - - -
        -

        Removes a button from the toolbox.

        -
        - - - - - - - - - -
        -
        Parameters:
        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
        NameTypeDescription
        buttonId - - -string - - - -

        The ID of the button to remove.

        - -
        - - - - - - - - - - - - - -
        -
        Returns:
        - - - - - -boolean - - - - - --

        True if the button is successfully removed, false otherwise.

        - - - - - -
        - - - - - -
        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
        - - - -
        Example
        - -
        const isRemoved = IITC.toolbox.removeButton(buttonId);
        - - - -
        - - - - -
        - -

        - - static setSortMethod(sortMethod) → {void} - - - - -

        - - - -
        -
        - - -
        -

        Sets the sorting method for the toolbox buttons.

        -
        - - - - - - - - - -
        -
        Parameters:
        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
        NameTypeDescription
        sortMethod - - -function - - - -

        The sorting method to be used.

        - -
        - - - - - - - - - - - - - -
        -
        Returns:
        - - - - - -void - - - - - - - - - -
        - - - - - -
        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
        - - - -
        Example
        - -
        IITC.toolbox.setSortMethod((a, b) => a.label.localeCompare(b.label));
        - - - -
        - - - - -
        - -

        - - static setSortMethod(sortMethod) → {void} - - - - -

        - - - -
        -
        - - -
        -

        Sets the sorting method for the toolbox buttons.

        -
        - - - - - - - - - -
        -
        Parameters:
        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
        NameTypeDescription
        sortMethod - - -function - - - -

        The sorting method to be used.

        - -
        - - - - - - - - - - - - - -
        -
        Returns:
        - - - - - -void - - - - - - - - - -
        - - - - - -
        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
        - - - -
        Example
        - -
        IITC.toolbox.setSortMethod((a, b) => a.label.localeCompare(b.label));
        - - - -
        - - - - -
        - -

        - - static updateButton(buttonId, newButtonArgs) → {boolean} - - - - -

        - - - -
        -
        - - -
        -

        Updates an existing button in the toolbox.

        -
        - - - - - - - - - -
        -
        Parameters:
        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
        NameTypeDescription
        buttonId - - -string - - - -

        The ID of the button to update.

        newButtonArgs - - -ButtonArgs - - - -

        The new arguments for the button.

        - -
        - - - - - - - - - - - - - -
        -
        Returns:
        - - - - - -boolean - - - - - --

        True if the button is successfully updated, false otherwise.

        - - - - - -
        - - - - - -
        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
        - - - -
        Example
        - -
        const isUpdated = IITC.toolbox.updateButton(buttonId, { label: 'Updated Button', action: () => console.log('New Action') });
        - - - -
        - - - - -
        - -

        - - static updateButton(buttonId, newButtonArgs) → {boolean} - - - - -

        - - - -
        -
        - - -
        -

        Updates an existing button in the toolbox.

        -
        - - - - - - - - - -
        -
        Parameters:
        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
        NameTypeDescription
        buttonId - - -string - - - -

        The ID of the button to update.

        newButtonArgs - - -ButtonArgs - - - -

        The new arguments for the button.

        - -
        - - - - - - - - - - - - - -
        -
        Returns:
        - - - - - -boolean - - - - - --

        True if the button is successfully updated, false otherwise.

        - - - - - -
        - - - - - -
        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
        - - - -
        Example
        - -
        const isUpdated = IITC.toolbox.updateButton(buttonId, { label: 'Updated Button', action: () => console.log('New Action') });
        - - - -
        - -

        - - - - - -
        - -
        - - - - - - - -
        - -
        - -

        toolbox

        - - -
        - -
        - -
        - - -

        Toolbox API

        - - - - - -
        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
        - - - - -
        - - - - - - - - - - - - - - - - - -

        Methods

        - -
        - - -
        - -

        - - private, static _applySort() - - - - -

        - - - -
        -
        - - -
        -

        Internal method to apply sorting to the buttons.

        -
        - - - - - - - - - - - - - - - - - - - - - - - - - -
        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
        - - - - -
        - - - - -
        - -

        - - private, static _applySort() - - - - -

        - - - -
        -
        - - -
        -

        Internal method to apply sorting to the buttons.

        -
        - - - - - - - - - - - - - - - - - - - - - - - - - -
        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
        - - - - -
        - - - - -
        - -

        - - private, static _renderButton(buttonId) - - - - -

        - - - -
        -
        - - -
        -

        Internal method to render a button.

        -
        - - - - - - - - - -
        -
        Parameters:
        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
        NameTypeDescription
        buttonId - - -string - - - -

        The ID of the button to render.

        - -
        - - - - - - - - - - - - - - - - - -
        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
        - - - - -
        - - - - -
        - -

        - - private, static _renderButton(buttonId) - - - - -

        - - - -
        -
        - - -
        -

        Internal method to render a button.

        -
        - - - - - - - - - -
        -
        Parameters:
        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
        NameTypeDescription
        buttonId - - -string - - - -

        The ID of the button to render.

        - -
        - - - - - - - - - - - - - - - - - -
        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
        - - - - -
        - - - - -
        - -

        - - private, static _syncWithLegacyToolbox() → {void} - - - - -

        - - - -
        -
        - - -
        -

        Internal method to synchronize the toolbox with the legacy toolbox.

        -
        - - - - - - - - - - - - - - - - - - - - - -
        -
        Returns:
        - - - - - -void - - - - - - - - - -
        - - - - - -
        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
        - - - - -
        - - - - -
        - -

        - - private, static _syncWithLegacyToolbox() → {void} - - - - -

        - - - -
        -
        - - -
        -

        Internal method to synchronize the toolbox with the legacy toolbox.

        -
        - - - - - - - - - - - - - - - - - - - - - -
        -
        Returns:
        - - - - - -void - - - - - - - - - -
        - - - - - -
        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
        - - - - -
        - - - - -
        - -

        - - static addButton(buttonArgs) → {string|null} - - - - -

        - - - -
        -
        - - -
        -

        Adds a button to the toolbox.

        -
        - - - - - - - - - -
        -
        Parameters:
        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
        NameTypeDescription
        buttonArgs - - -ButtonArgs - - - -

        The arguments for the button.

        - -
        - - - - - - - - - - - - - -
        -
        Returns:
        - - - - - -string -| - -null - - - - - --

        The ID of the added button or null if required parameters are missing.

        - - - - - -
        - - - - - -
        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
        - - - -
        Examples
        - -
        const buttonId = IITC.toolbox.addButton({
        -  label: 'AboutIITC',
        -  action: window.AboutIITC
        -});
        - -
        const buttonId = IITC.toolbox.addButton({
        -  label: 'Test Button',
        -  action: () => alert('Clicked!')
        -});
        - - - -
        - - - - -
        - -

        - - static addButton(buttonArgs) → {string|null} - - - - -

        - - - -
        -
        - - -
        -

        Adds a button to the toolbox.

        -
        - - - - - - - - - -
        -
        Parameters:
        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
        NameTypeDescription
        buttonArgs - - -ButtonArgs - - - -

        The arguments for the button.

        - -
        - - - - - - - - - - - - - -
        -
        Returns:
        - - - - - -string -| - -null - - - - - --

        The ID of the added button or null if required parameters are missing.

        - - - - - -
        - - - - - -
        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
        - - - -
        Examples
        - -
        const buttonId = IITC.toolbox.addButton({
        -  label: 'AboutIITC',
        -  action: window.AboutIITC
        -});
        - -
        const buttonId = IITC.toolbox.addButton({
        -  label: 'Test Button',
        -  action: () => alert('Clicked!')
        -});
        - - - -
        - - - - -
        - -

        +

        - static removeButton(buttonId) → {boolean} + private, static _renderButton(buttonId)

        @@ -3316,7 +233,7 @@

        -

        Removes a button from the toolbox.

        +

        Internal method to render a button.

        @@ -3368,7 +285,7 @@

        Parameters:
        -

        The ID of the button to remove.

        +

        The ID of the button to render.

        @@ -3389,27 +306,6 @@
        Parameters:
        -
        -
        Returns:
        - - - - - -boolean - - - - - --

        True if the button is successfully removed, false otherwise.

        - - - - - -
        - @@ -3449,11 +345,6 @@
        Returns:
        -
        Example
        - -
        const isRemoved = IITC.toolbox.removeButton(buttonId);
        - - @@ -3462,14 +353,14 @@
        Example
        -

        +

        - static removeButton(buttonId) → {boolean} + private, static _syncWithLegacyToolbox() → {void}

        @@ -3481,7 +372,7 @@

        -

        Removes a button from the toolbox.

        +

        Internal method to synchronize the toolbox with the legacy toolbox.

        @@ -3492,56 +383,6 @@

        -
        -
        Parameters:
        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
        NameTypeDescription
        buttonId - - -string - - - -

        The ID of the button to remove.

        - -
        - @@ -3561,13 +402,11 @@

        Returns:
        -boolean - +void --

        True if the button is successfully removed, false otherwise.

        @@ -3614,11 +453,6 @@
        Returns:
        -
        Example
        - -
        const isRemoved = IITC.toolbox.removeButton(buttonId);
        - - @@ -3627,14 +461,14 @@
        Example
        -

        +

        - static setSortMethod(sortMethod) → {void} + static addButton(buttonArgs) → {string|null}

        @@ -3646,7 +480,7 @@

        -

        Sets the sorting method for the toolbox buttons.

        +

        Adds a button to the toolbox.

        @@ -3682,13 +516,13 @@

        Parameters:
        - sortMethod + buttonArgs -function +ButtonArgs @@ -3698,7 +532,7 @@
        Parameters:
        -

        The sorting method to be used.

        +

        The arguments for the button.

        @@ -3726,11 +560,16 @@
        Returns:
        -void +string +| + +null + +-

        The ID of the added button or null if required parameters are missing.

        @@ -3777,9 +616,17 @@
        Returns:
        -
        Example
        +
        Examples
        -
        IITC.toolbox.setSortMethod((a, b) => a.label.localeCompare(b.label));
        +
        const buttonId = IITC.toolbox.addButton({
        +  label: 'AboutIITC',
        +  action: window.AboutIITC
        +});
        + +
        const buttonId = IITC.toolbox.addButton({
        +  label: 'Test Button',
        +  action: () => alert('Clicked!')
        +});
        @@ -3790,14 +637,14 @@
        Example
        -

        +

        - static setSortMethod(sortMethod) → {void} + static removeButton(buttonId) → {boolean}

        @@ -3809,7 +656,7 @@

        -

        Sets the sorting method for the toolbox buttons.

        +

        Removes a button from the toolbox.

        @@ -3845,13 +692,13 @@

        Parameters:
        - sortMethod + buttonId -function +string @@ -3861,7 +708,7 @@
        Parameters:
        -

        The sorting method to be used.

        +

        The ID of the button to remove.

        @@ -3889,11 +736,13 @@
        Returns:
        -void +boolean + +-

        True if the button is successfully removed, false otherwise.

        @@ -3942,7 +791,7 @@
        Returns:
        Example
        -
        IITC.toolbox.setSortMethod((a, b) => a.label.localeCompare(b.label));
        +
        const isRemoved = IITC.toolbox.removeButton(buttonId);
        @@ -3953,14 +802,14 @@
        Example
        -

        +

        - static updateButton(buttonId, newButtonArgs) → {boolean} + static setSortMethod(sortMethod) → {void}

        @@ -3972,7 +821,7 @@

        -

        Updates an existing button in the toolbox.

        +

        Sets the sorting method for the toolbox buttons.

        @@ -4008,36 +857,13 @@

        Parameters:
        - buttonId - - - - - -string - - - - - - - - - -

        The ID of the button to update.

        - - - - - - - newButtonArgs + sortMethod -ButtonArgs +function @@ -4047,7 +873,7 @@
        Parameters:
        -

        The new arguments for the button.

        +

        The sorting method to be used.

        @@ -4075,13 +901,11 @@
        Returns:
        -boolean - +void --

        True if the button is successfully updated, false otherwise.

        @@ -4130,7 +954,7 @@
        Returns:
        Example
        -
        const isUpdated = IITC.toolbox.updateButton(buttonId, { label: 'Updated Button', action: () => console.log('New Action') });
        +
        IITC.toolbox.setSortMethod((a, b) => a.label.localeCompare(b.label));
        diff --git a/L.FileListLoader.html b/L.FileListLoader.html index cf7bcbb45..b8bdc9287 100644 --- a/L.FileListLoader.html +++ b/L.FileListLoader.html @@ -34,7 +34,7 @@

        IITC-CE

          - +
          @@ -441,784 +441,6 @@
          Returns:
          - - - - - - - - - - -
          - - - - - - - - - -
          - -

          - - static loadFiles(optionsopt) → {L.FileListLoader} - - - - -

          - - - -
          -
          - - -
          -

          Instantiates a L.FileListLoader object and initiates a file chooser dialog. -This simulates a click on a hidden input HTML element created using the specified options. -It then calls the load method with the list of files chosen by the user.

          -
          - - - - - - - - - -
          -
          Parameters:
          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
          NameTypeAttributesDescription
          options - - -Object - - - - - - <optional>
          - - - - - -

          Options for the file input, like accept, multiple, capture.

          - -
          - - - - - - - - - - - - - -
          -
          Returns:
          - - - - - -L.FileListLoader - - - - - --

          A new instance of L.FileListLoader.

          - - - - - -
          - - - - - -
          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
          - - - - -
          - - - - - - - -
          - -
          - - - - - - - -
          - -
          - -

          - L.FileListLoader(fileList, optionsopt)

          - - -
          - -
          - -
          - - - -
          - -

          - - new FileListLoader(fileList, optionsopt) - - - - -

          - - - -
          -
          - - -
          -

          A class for handling a list of files (FileList), processing each file with L.FileReader. -It extends L.Evented to use event handling.

          -
          - - - - - - - - - -
          -
          Parameters:
          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
          NameTypeAttributesDescription
          fileList - - -FileList - - - - - - - - - -

          The list of files to be processed.

          options - - -Object - - - - - - <optional>
          - - - - - -

          Options for file reading.

          - -
          - - - - - - - - - - - - - - - - - -
          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
          - - - -
          Example
          - -
          L.FileListLoader(fileList)
          -  .on('load', function(e) {
          -    console.log(e.file.name, e.reader.result);
          -  })
          -  .on('loaded', function() {
          -    console.log('All files processed');
          -  })
          -  .load();
          - - - -
          - - -
          - - - -

          Extends

          - - - - -
            -
          • L.Evented
          • -
          - - - - - - - - - - - - - - - - - -

          Methods

          - -
          - - -
          - -

          - - static loadFiles(optionsopt) → {L.FileListLoader} - - - - -

          - - - -
          -
          - - -
          -

          Instantiates a L.FileListLoader object and initiates a file chooser dialog. -This simulates a click on a hidden input HTML element created using the specified options. -It then calls the load method with the list of files chosen by the user.

          -
          - - - - - - - - - -
          -
          Parameters:
          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
          NameTypeAttributesDescription
          options - - -Object - - - - - - <optional>
          - - - - - -

          Options for the file input, like accept, multiple, capture.

          - -
          - - - - - - - - - - - - - -
          -
          Returns:
          - - - - - -L.FileListLoader - - - - - --

          A new instance of L.FileListLoader.

          - - - - - -
          - - - - - -
          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
          - - - - -
          - - - - -
          - -

          - - static loadFiles(optionsopt) → {L.FileListLoader} - - - - -

          - - - -
          -
          - - -
          -

          Instantiates a L.FileListLoader object and initiates a file chooser dialog. -This simulates a click on a hidden input HTML element created using the specified options. -It then calls the load method with the list of files chosen by the user.

          -
          - - - - - - - - - -
          -
          Parameters:
          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
          NameTypeAttributesDescription
          options - - -Object - - - - - - <optional>
          - - - - - -

          Options for the file input, like accept, multiple, capture.

          - -
          - - - - - - - - - - - - - -
          -
          Returns:
          - - - - - -L.FileListLoader - - - - - --

          A new instance of L.FileListLoader.

          - - - - - -
          - - - - - -
          - - - - - - - - - - - - - - - - - - - - diff --git a/L.FileReader.html b/L.FileReader.html index e4df83705..5e6937c9f 100644 --- a/L.FileReader.html +++ b/L.FileReader.html @@ -34,7 +34,7 @@

          IITC-CE

            - +
            @@ -337,1310 +337,6 @@
            Returns:
            - - - - - - - - - - -
            - - - - -
            - - - - -
            - -

            - - static loadFile(optionsopt) → {L.FileReader} - - - - -

            - - - -
            -
            - - -
            -

            Instantiates a L.FileReader object and initiates a file chooser dialog. -This function simulates a click on a hidden file input element created with the given options. -The read method is called with the file chosen by the user.

            -
            - - - - - - - - - -
            -
            Parameters:
            - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
            NameTypeAttributesDescription
            options - - -Object - - - - - - <optional>
            - - - - - -

            Options for the file input element.

            - -
            - - - - - - - - - - - - - -
            -
            Returns:
            - - - - - -L.FileReader - - - - - --

            A new instance of L.FileReader with the file to be read.

            - - - - - -
            - - - - - -
            - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
            - - - - -
            - - - - -
            - -

            - - static read(fileopt, optionsopt) → {L.FileReader} - - - - -

            - - - -
            -
            - - -
            -

            Starts reading the contents of the specified file -using reader method specified in options. -Note: all 'init*' event handlers expected to be already attached before this method call.

            -
            - - - - - - - - - -
            -
            Parameters:
            - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
            NameTypeAttributesDescription
            file - - -Blob - - - - - - <optional>
            - - - - - -

            The file or blob to be read. Optional if already set.

            options - - -Object -| - -string - - - - - - <optional>
            - - - - - -

            Options for file reading. Same as in constructor.

            - -
            - - - - - - - - - - - - - -
            -
            Returns:
            - - - - - -L.FileReader - - - - - --

            Returns the L.FileReader instance for chaining.

            - - - - - -
            - - - - - -
            - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
            - - - - -
            - - - - -
            - -

            - - static read(fileopt, optionsopt) → {L.FileReader} - - - - -

            - - - -
            -
            - - -
            -

            Starts reading the contents of the specified file -using reader method specified in options. -Note: all 'init*' event handlers expected to be already attached before this method call.

            -
            - - - - - - - - - -
            -
            Parameters:
            - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
            NameTypeAttributesDescription
            file - - -Blob - - - - - - <optional>
            - - - - - -

            The file or blob to be read. Optional if already set.

            options - - -Object -| - -string - - - - - - <optional>
            - - - - - -

            Options for file reading. Same as in constructor.

            - -
            - - - - - - - - - - - - - -
            -
            Returns:
            - - - - - -L.FileReader - - - - - --

            Returns the L.FileReader instance for chaining.

            - - - - - -
            - - - - - -
            - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
            - - - - -
            - -
            - - - - - -
            - -
            - - - - - - - -
            - -
            - -

            - L.FileReader()

            - - -
            - -
            - -
            - - - -
            - -

            - - new FileReader() - - - - -

            - - - -
            -
            - - -
            -

            Leaflet wrapper over FileReader Web API, -making it compatible with the Leaflet event system. -This class extends L.Evented.

            -
            - - - - - - - - - - - - - - - - - - - - - - - - - -
            - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
            - - - - -
            - - -
            - - - -

            Extends

            - - - - -
              -
            • L.Evented
            • -
            - - - - - - - - - - - - - - - - - -

            Methods

            - -
            - - -
            - -

            - - static loadFile(optionsopt) → {L.FileReader} - - - - -

            - - - -
            -
            - - -
            -

            Instantiates a L.FileReader object and initiates a file chooser dialog. -This function simulates a click on a hidden file input element created with the given options. -The read method is called with the file chosen by the user.

            -
            - - - - - - - - - -
            -
            Parameters:
            - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
            NameTypeAttributesDescription
            options - - -Object - - - - - - <optional>
            - - - - - -

            Options for the file input element.

            - -
            - - - - - - - - - - - - - -
            -
            Returns:
            - - - - - -L.FileReader - - - - - --

            A new instance of L.FileReader with the file to be read.

            - - - - - -
            - - - - - -
            - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
            - - - - -
            - - - - -
            - -

            - - static loadFile(optionsopt) → {L.FileReader} - - - - -

            - - - -
            -
            - - -
            -

            Instantiates a L.FileReader object and initiates a file chooser dialog. -This function simulates a click on a hidden file input element created with the given options. -The read method is called with the file chosen by the user.

            -
            - - - - - - - - - -
            -
            Parameters:
            - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
            NameTypeAttributesDescription
            options - - -Object - - - - - - <optional>
            - - - - - -

            Options for the file input element.

            - -
            - - - - - - - - - - - - - -
            -
            Returns:
            - - - - - -L.FileReader - - - - - --

            A new instance of L.FileReader with the file to be read.

            - - - - - -
            - - - - - -
            - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
            - - - - -
            - - - - -
            - -

            - - static read(fileopt, optionsopt) → {L.FileReader} - - - - -

            - - - -
            -
            - - -
            -

            Starts reading the contents of the specified file -using reader method specified in options. -Note: all 'init*' event handlers expected to be already attached before this method call.

            -
            - - - - - - - - - -
            -
            Parameters:
            - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
            NameTypeAttributesDescription
            file - - -Blob - - - - - - <optional>
            - - - - - -

            The file or blob to be read. Optional if already set.

            options - - -Object -| - -string - - - - - - <optional>
            - - - - - -

            Options for file reading. Same as in constructor.

            - -
            - - - - - - - - - - - - - -
            -
            Returns:
            - - - - - -L.FileReader - - - - - --

            Returns the L.FileReader instance for chaining.

            - - - - - -
            - - - - - -
            - - - - - - - - - - - - - - - - - - - - diff --git a/L.LayerChooser.html b/L.LayerChooser.html index c96b55fd8..2a1665ae3 100644 --- a/L.LayerChooser.html +++ b/L.LayerChooser.html @@ -34,7 +34,7 @@

            IITC-CE

              - +
              @@ -131,154 +131,6 @@

              - - - - - - - - - - -

              - - - - -
              - - - - - - -

              Extends

              - - - - -
                -
              • L.Control.Layers
              • -
              - - - - - - - - - - - - - - - - - - - - - -
              - -
              - - - - - - - -
              - -
              - -

              - L.LayerChooser()

              - - -
              - -
              - -
              - - - -
              - -

              - - new LayerChooser() - - - - -

              - - - -
              -
              - - -
              -

              Represents a control for selecting layers on the map. It extends the Leaflet's L.Control.Layers class. -This control not only manages layer visibility but also provides persistence of layer display states between sessions. -The class has been enhanced with additional options and methods for more flexible layer management.

              -
              - - - - - - - - - - - - - - - - - - - - - - - - - -
              - - - - - - - - - - - - - - - - - - - - diff --git a/L.html b/L.html index 7906377ff..9dd6869c5 100644 --- a/L.html +++ b/L.html @@ -34,7 +34,7 @@

              IITC-CE

                - +
                @@ -169,26 +169,6 @@

                -
                -

                - FileListLoader - -

                -
                - - -
                -

                - FileReader - -

                -
                - -

                FileReader @@ -209,16 +189,6 @@

                -
                -

                - LayerChooser - -

                -
                - - @@ -444,1481 +414,6 @@

                Returns:
                -
                - -

                - - static fileListLoader(fileListopt, optionsopt) → {L.FileListLoader} - - - - -

                - - - -
                -
                - - -
                -

                A factory function that instantiates a FileListLoader object given the FileList and options.

                -
                - - - - - - - - - -
                -
                Parameters:
                - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                NameTypeAttributesDescription
                fileList - - -FileList - - - - - - <optional>
                - - - - - -

                The list of files to load. -See FileList. -If fileList argument is specified, then load method is called immediately.

                options - - -Object - - - - - - <optional>
                - - - - - -

                Options for file reading.

                - -
                - - - - - - - - - - - - - -
                -
                Returns:
                - - - - - -L.FileListLoader - - - - - --

                A new FileListLoader instance.

                - - - - - -
                - - - - - -
                - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                - - - - -
                - - - - -
                - -

                - - static fileReader(fileopt, optionsopt) → {L.FileReader} - - - - -

                - - - -
                -
                - - -
                -

                Factory function to instantiate a L.FileReader object. -Instantiates a L.FileReader object given the File/Blob -and optionally an object literal with options. -Note: it's possible to specify readAs directly instead of full options object.

                -
                - - - - - - - - - -
                -
                Parameters:
                - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                NameTypeAttributesDescription
                file - - -Blob - - - - - - <optional>
                - - - - - -

                The file or blob to be read. Optional.

                options - - -Object -| - -string - - - - - - <optional>
                - - - - - -

                Options for file reading or a string representing the read method.

                - -
                - - - - - - - - - - - - - -
                -
                Returns:
                - - - - - -L.FileReader - - - - - --

                A new instance of L.FileReader.

                - - - - - -
                - - - - - -
                - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                - - - -
                Example
                - -
                var reader = L.fileReader(file, { readAs: 'readAsText' });
                - - - -
                - - - - -
                - -

                - - static fileReader(fileopt, optionsopt) → {L.FileReader} - - - - -

                - - - -
                -
                - - -
                -

                Factory function to instantiate a L.FileReader object. -Instantiates a L.FileReader object given the File/Blob -and optionally an object literal with options. -Note: it's possible to specify readAs directly instead of full options object.

                -
                - - - - - - - - - -
                -
                Parameters:
                - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                NameTypeAttributesDescription
                file - - -Blob - - - - - - <optional>
                - - - - - -

                The file or blob to be read. Optional.

                options - - -Object -| - -string - - - - - - <optional>
                - - - - - -

                Options for file reading or a string representing the read method.

                - -
                - - - - - - - - - - - - - -
                -
                Returns:
                - - - - - -L.FileReader - - - - - --

                A new instance of L.FileReader.

                - - - - - -
                - - - - - -
                - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                - - - -
                Example
                - -
                var reader = L.fileReader(file, { readAs: 'readAsText' });
                - - - -
                - - - - - - - -
                - -
                - - - - - - - -
                - -
                - -

                L()

                - - -
                - -
                - -
                - - - -
                - -

                - - new L() - - - - -

                - - - -
                -
                - - -
                -

                Root class for all Leaflet-related functionalities, extended with custom methods and properties.

                -
                - - - - - - - - - - - - - - - - - - - - - - - - - -
                - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                - - - - -
                - - -
                - - - - - - - -

                Classes

                - - -
                - -
                -

                - FileListLoader - -

                -
                - - -
                -

                - FileListLoader - -

                -
                - - -
                -

                - FileReader - -

                -
                - - -
                -

                - FileReader - -

                -
                - - -
                -

                - LayerChooser - -

                -
                - - -
                -

                - LayerChooser - -

                -
                - - -
                - - - - - - - - - - - - -

                Methods

                - -
                - - -
                - -

                - - static fileListLoader(fileListopt, optionsopt) → {L.FileListLoader} - - - - -

                - - - -
                -
                - - -
                -

                A factory function that instantiates a FileListLoader object given the FileList and options.

                -
                - - - - - - - - - -
                -
                Parameters:
                - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                NameTypeAttributesDescription
                fileList - - -FileList - - - - - - <optional>
                - - - - - -

                The list of files to load. -See FileList. -If fileList argument is specified, then load method is called immediately.

                options - - -Object - - - - - - <optional>
                - - - - - -

                Options for file reading.

                - -
                - - - - - - - - - - - - - -
                -
                Returns:
                - - - - - -L.FileListLoader - - - - - --

                A new FileListLoader instance.

                - - - - - -
                - - - - - -
                - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                - - - - -
                - - - - -
                - -

                - - static fileListLoader(fileListopt, optionsopt) → {L.FileListLoader} - - - - -

                - - - -
                -
                - - -
                -

                A factory function that instantiates a FileListLoader object given the FileList and options.

                -
                - - - - - - - - - -
                -
                Parameters:
                - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                NameTypeAttributesDescription
                fileList - - -FileList - - - - - - <optional>
                - - - - - -

                The list of files to load. -See FileList. -If fileList argument is specified, then load method is called immediately.

                options - - -Object - - - - - - <optional>
                - - - - - -

                Options for file reading.

                - -
                - - - - - - - - - - - - - -
                -
                Returns:
                - - - - - -L.FileListLoader - - - - - --

                A new FileListLoader instance.

                - - - - - -
                - - - - - -
                - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                - - - - -
                - - - - -
                - -

                - - static fileReader(fileopt, optionsopt) → {L.FileReader} - - - - -

                - - - -
                -
                - - -
                -

                Factory function to instantiate a L.FileReader object. -Instantiates a L.FileReader object given the File/Blob -and optionally an object literal with options. -Note: it's possible to specify readAs directly instead of full options object.

                -
                - - - - - - - - - -
                -
                Parameters:
                - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                NameTypeAttributesDescription
                file - - -Blob - - - - - - <optional>
                - - - - - -

                The file or blob to be read. Optional.

                options - - -Object -| - -string - - - - - - <optional>
                - - - - - -

                Options for file reading or a string representing the read method.

                - -
                - - - - - - - - - - - - - -
                -
                Returns:
                - - - - - -L.FileReader - - - - - --

                A new instance of L.FileReader.

                - - - - - -
                - - - - - -
                - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                - - - -
                Example
                - -
                var reader = L.fileReader(file, { readAs: 'readAsText' });
                - - - -
                - - - -

                diff --git a/MapDataRequest.html b/MapDataRequest.html index d87270c21..b4e745be9 100644 --- a/MapDataRequest.html +++ b/MapDataRequest.html @@ -34,7 +34,7 @@

                IITC-CE

                  - +
                  @@ -260,14 +260,14 @@

                  -

                  +

                  - static window.MapDataRequest#clearTimeout() + static window.MapDataRequest#delayProcessRequestQueue(seconds)

                  @@ -279,7 +279,7 @@

                  -

                  Clears the current data refresh timeout.

                  +

                  Delays the processing of the request queue for fetching map data tiles. The delay is specified in seconds.

                  @@ -290,6 +290,56 @@

                  +
                  +
                  Parameters:
                  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
                  NameTypeDescription
                  seconds + + +number + + + +

                  The delay in seconds before starting to process the request queue.

                  + +
                  + @@ -349,14 +399,14 @@

                  -

                  +

                  - static window.MapDataRequest#delayProcessRequestQueue(seconds) + static window.MapDataRequest#getStatus() → {Object}

                  @@ -368,7 +418,7 @@

                  -

                  Delays the processing of the request queue for fetching map data tiles. The delay is specified in seconds.

                  +

                  Gets the current status of the map data request, including short description, long description, and progress.

                  @@ -379,67 +429,38 @@

                  -
                  -
                  Parameters:
                  - - - - - - - - - - + - + - - - + - - - - - + - - - - +Object - - - - -
                  NameTypeDescription
                  seconds - + +
                  +
                  Returns:
                  + -number - -

                  The delay in seconds before starting to process the request queue.

                  -
                  - - - +-

                  An object containing the current status of the map data request.

                  - - - + + @@ -488,14 +509,14 @@

                  Parameters:
                  -

                  +

                  - static window.MapDataRequest#delayProcessRequestQueue(seconds) + static window.MapDataRequest#handleResponse(data, tiles, success)

                  @@ -507,7 +528,8 @@

                  -

                  Delays the processing of the request queue for fetching map data tiles. The delay is specified in seconds.

                  +

                  Handles the response from the server for tile data requests. +Processes success and error cases, manages retries for failed tiles, and updates the render queue with new data.

                  @@ -543,13 +565,13 @@

                  Parameters:
                  - seconds + data -number +Object @@ -559,7 +581,53 @@
                  Parameters:
                  -

                  The delay in seconds before starting to process the request queue.

                  +

                  The response data from the server.

                  + + + + + + + tiles + + + + + +Array + + + + + + + + + +

                  The array of requested tile identifiers.

                  + + + + + + + success + + + + + +boolean + + + + + + + + + +

                  Flag indicating if the request was successful.

                  @@ -627,14 +695,14 @@
                  Parameters:
                  -

                  +

                  - static window.MapDataRequest#getStatus() → {Object} + static window.MapDataRequest#idleResume()

                  @@ -646,7 +714,7 @@

                  -

                  Gets the current status of the map data request, including short description, long description, and progress.

                  +

                  Resumes data fetching and rendering after being idle.

                  @@ -668,27 +736,6 @@

                  - -
                  -
                  Returns:
                  - - - - - -Object - - - - - --

                  An object containing the current status of the map data request.

                  - - - - - -
                  @@ -737,14 +784,14 @@

                  Returns:
                  -

                  +

                  - static window.MapDataRequest#getStatus() → {Object} + static window.MapDataRequest#mapMoveEnd()

                  @@ -756,7 +803,7 @@

                  -

                  Gets the current status of the map data request, including short description, long description, and progress.

                  +

                  Handles map movement end. Determines whether new data needs to be fetched based on map bounds and zoom level.

                  @@ -778,27 +825,6 @@

                  - -
                  -
                  Returns:
                  - - - - - -Object - - - - - --

                  An object containing the current status of the map data request.

                  - - - - - -
                  @@ -847,14 +873,14 @@

                  Returns:
                  -

                  +

                  - static window.MapDataRequest#handleResponse(data, tiles, success) + static window.MapDataRequest#mapMoveStart()

                  @@ -866,8 +892,7 @@

                  -

                  Handles the response from the server for tile data requests. -Processes success and error cases, manages retries for failed tiles, and updates the render queue with new data.

                  +

                  Callback for map movement start. Pauses the rendering and data requests.

                  @@ -878,7251 +903,6 @@

                  -
                  -
                  Parameters:
                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                  NameTypeDescription
                  data - - -Object - - - -

                  The response data from the server.

                  tiles - - -Array - - - -

                  The array of requested tile identifiers.

                  success - - -boolean - - - -

                  Flag indicating if the request was successful.

                  - -
                  - - - - - - - - - - - - - - - - - -
                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                  - - - - - - - - - -
                  - -

                  - - static window.MapDataRequest#handleResponse(data, tiles, success) - - - - -

                  - - - -
                  -
                  - - -
                  -

                  Handles the response from the server for tile data requests. -Processes success and error cases, manages retries for failed tiles, and updates the render queue with new data.

                  -
                  - - - - - - - - - -
                  -
                  Parameters:
                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                  NameTypeDescription
                  data - - -Object - - - -

                  The response data from the server.

                  tiles - - -Array - - - -

                  The array of requested tile identifiers.

                  success - - -boolean - - - -

                  Flag indicating if the request was successful.

                  - -
                  - - - - - - - - - - - - - - - - - -
                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                  - - - - -
                  - - - - -
                  - -

                  - - static window.MapDataRequest#idleResume() - - - - -

                  - - - -
                  -
                  - - -
                  -

                  Resumes data fetching and rendering after being idle.

                  -
                  - - - - - - - - - - - - - - - - - - - - - - - - - -
                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                  - - - - -
                  - - - - -
                  - -

                  - - static window.MapDataRequest#idleResume() - - - - -

                  - - - -
                  -
                  - - -
                  -

                  Resumes data fetching and rendering after being idle.

                  -
                  - - - - - - - - - - - - - - - - - - - - - - - - - -
                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                  - - - - -
                  - - - - -
                  - -

                  - - static window.MapDataRequest#mapMoveEnd() - - - - -

                  - - - -
                  -
                  - - -
                  -

                  Handles map movement end. Determines whether new data needs to be fetched based on map bounds and zoom level.

                  -
                  - - - - - - - - - - - - - - - - - - - - - - - - - -
                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                  - - - - -
                  - - - - -
                  - -

                  - - static window.MapDataRequest#mapMoveEnd() - - - - -

                  - - - -
                  -
                  - - -
                  -

                  Handles map movement end. Determines whether new data needs to be fetched based on map bounds and zoom level.

                  -
                  - - - - - - - - - - - - - - - - - - - - - - - - - -
                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                  - - - - -
                  - - - - -
                  - -

                  - - static window.MapDataRequest#mapMoveStart() - - - - -

                  - - - -
                  -
                  - - -
                  -

                  Callback for map movement start. Pauses the rendering and data requests.

                  -
                  - - - - - - - - - - - - - - - - - - - - - - - - - -
                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                  - - - - -
                  - - - - -
                  - -

                  - - static window.MapDataRequest#mapMoveStart() - - - - -

                  - - - -
                  -
                  - - -
                  -

                  Callback for map movement start. Pauses the rendering and data requests.

                  -
                  - - - - - - - - - - - - - - - - - - - - - - - - - -
                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                  - - - - -
                  - - - - -
                  - -

                  - - static window.MapDataRequest#pauseRenderQueue(pause) - - - - -

                  - - - -
                  -
                  - - -
                  -

                  Pauses or resumes the render queue processing. When paused, the queue timer is cleared.

                  -
                  - - - - - - - - - -
                  -
                  Parameters:
                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                  NameTypeDescription
                  pause - - -boolean - - - -

                  Flag indicating whether to pause (true) or resume (false) the render queue processing.

                  - -
                  - - - - - - - - - - - - - - - - - -
                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                  - - - - -
                  - - - - -
                  - -

                  - - static window.MapDataRequest#pauseRenderQueue(pause) - - - - -

                  - - - -
                  -
                  - - -
                  -

                  Pauses or resumes the render queue processing. When paused, the queue timer is cleared.

                  -
                  - - - - - - - - - -
                  -
                  Parameters:
                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                  NameTypeDescription
                  pause - - -boolean - - - -

                  Flag indicating whether to pause (true) or resume (false) the render queue processing.

                  - -
                  - - - - - - - - - - - - - - - - - -
                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                  - - - - -
                  - - - - -
                  - -

                  - - static window.MapDataRequest#processRenderQueue() - - - - -

                  - - - -
                  -
                  - - -
                  -

                  Processes the render queue, rendering entities on the map. -This function handles both the rendering of new entities and the deletion of old ones. -It ensures that the quantity of entities processed per cycle does not exceed a set limit.

                  -
                  - - - - - - - - - - - - - - - - - - - - - - - - - -
                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                  - - - - -
                  - - - - -
                  - -

                  - - static window.MapDataRequest#processRenderQueue() - - - - -

                  - - - -
                  -
                  - - -
                  -

                  Processes the render queue, rendering entities on the map. -This function handles both the rendering of new entities and the deletion of old ones. -It ensures that the quantity of entities processed per cycle does not exceed a set limit.

                  -
                  - - - - - - - - - - - - - - - - - - - - - - - - - -
                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                  - - - - -
                  - - - - -
                  - -

                  - - static window.MapDataRequest#processRequestQueue() - - - - -

                  - - - -
                  -
                  - - -
                  -

                  Processes the request queue for fetching map data tiles. Manages the number of simultaneous tile requests, -tile error handling, and updates the request status.

                  -
                  - - - - - - - - - - - - - - - - - - - - - - - - - -
                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                  - - - - -
                  - - - - -
                  - -

                  - - static window.MapDataRequest#processRequestQueue() - - - - -

                  - - - -
                  -
                  - - -
                  -

                  Processes the request queue for fetching map data tiles. Manages the number of simultaneous tile requests, -tile error handling, and updates the request status.

                  -
                  - - - - - - - - - - - - - - - - - - - - - - - - - -
                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                  - - - - -
                  - - - - -
                  - -

                  - - static window.MapDataRequest#pushRenderQueue(id, data, status) - - - - -

                  - - - -
                  -
                  - - -
                  -

                  Pushes a tile to the render queue for processing. The queue is processed to render entities on the map.

                  -
                  - - - - - - - - - -
                  -
                  Parameters:
                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                  NameTypeDescription
                  id - - -string - - - -

                  The identifier of the tile.

                  data - - -Object - - - -

                  Data associated with the tile, including game entity GUIDs and entities.

                  status - - -string - - - -

                  The status of the tile, such as 'render-queue'.

                  - -
                  - - - - - - - - - - - - - - - - - -
                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                  - - - - -
                  - - - - -
                  - -

                  - - static window.MapDataRequest#pushRenderQueue(id, data, status) - - - - -

                  - - - -
                  -
                  - - -
                  -

                  Pushes a tile to the render queue for processing. The queue is processed to render entities on the map.

                  -
                  - - - - - - - - - -
                  -
                  Parameters:
                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                  NameTypeDescription
                  id - - -string - - - -

                  The identifier of the tile.

                  data - - -Object - - - -

                  Data associated with the tile, including game entity GUIDs and entities.

                  status - - -string - - - -

                  The status of the tile, such as 'render-queue'.

                  - -
                  - - - - - - - - - - - - - - - - - -
                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                  - - - - -
                  - - - - -
                  - -

                  - - static window.MapDataRequest#refresh() - - - - -

                  - - - -
                  -
                  - - -
                  -

                  Initiates the map data refresh process. This includes resetting necessary properties, -preparing requests for map data, and handling cached data.

                  -
                  - - - - - - - - - - - - - - - - - - - - - - - - - -
                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                  - - - - -
                  - - - - -
                  - -

                  - - static window.MapDataRequest#refresh() - - - - -

                  - - - -
                  -
                  - - -
                  -

                  Initiates the map data refresh process. This includes resetting necessary properties, -preparing requests for map data, and handling cached data.

                  -
                  - - - - - - - - - - - - - - - - - - - - - - - - - -
                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                  - - - - -
                  - - - - -
                  - -

                  - - static window.MapDataRequest#refreshOnTimeout(seconds) - - - - -

                  - - - -
                  -
                  - - -
                  -

                  Sets a timeout to refresh the map data.

                  -
                  - - - - - - - - - -
                  -
                  Parameters:
                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                  NameTypeDescription
                  seconds - - -number - - - -

                  Time in seconds to wait before refreshing the map data.

                  - -
                  - - - - - - - - - - - - - - - - - -
                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                  - - - - -
                  - - - - -
                  - -

                  - - static window.MapDataRequest#refreshOnTimeout(seconds) - - - - -

                  - - - -
                  -
                  - - -
                  -

                  Sets a timeout to refresh the map data.

                  -
                  - - - - - - - - - -
                  -
                  Parameters:
                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                  NameTypeDescription
                  seconds - - -number - - - -

                  Time in seconds to wait before refreshing the map data.

                  - -
                  - - - - - - - - - - - - - - - - - -
                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                  - - - - -
                  - - - - -
                  - -

                  - - static window.MapDataRequest#requeueTile(id, error) - - - - -

                  - - - -
                  -
                  - - -
                  -

                  Re-queues a tile for data fetching in case of an error or timeouts. -Handles retry limits and uses stale data if available.

                  -
                  - - - - - - - - - -
                  -
                  Parameters:
                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                  NameTypeDescription
                  id - - -string - - - -

                  The tile identifier.

                  error - - -boolean - - - -

                  Flag indicating whether the tile fetch encountered an error.

                  - -
                  - - - - - - - - - - - - - - - - - -
                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                  - - - - -
                  - - - - -
                  - -

                  - - static window.MapDataRequest#requeueTile(id, error) - - - - -

                  - - - -
                  -
                  - - -
                  -

                  Re-queues a tile for data fetching in case of an error or timeouts. -Handles retry limits and uses stale data if available.

                  -
                  - - - - - - - - - -
                  -
                  Parameters:
                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                  NameTypeDescription
                  id - - -string - - - -

                  The tile identifier.

                  error - - -boolean - - - -

                  Flag indicating whether the tile fetch encountered an error.

                  - -
                  - - - - - - - - - - - - - - - - - -
                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                  - - - - -
                  - - - - -
                  - -

                  - - static window.MapDataRequest#resetRenderQueue() - - - - -

                  - - - -
                  -
                  - - -
                  -

                  Resets the render queue, clearing existing queued render tasks and stopping any active timer.

                  -
                  - - - - - - - - - - - - - - - - - - - - - - - - - -
                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                  - - - - -
                  - - - - -
                  - -

                  - - static window.MapDataRequest#resetRenderQueue() - - - - -

                  - - - -
                  -
                  - - -
                  -

                  Resets the render queue, clearing existing queued render tasks and stopping any active timer.

                  -
                  - - - - - - - - - - - - - - - - - - - - - - - - - -
                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                  - - - - -
                  - - - - -
                  - -

                  - - static window.MapDataRequest#sendTileRequest(tiles) - - - - -

                  - - - -
                  -
                  - - -
                  -

                  Sends requests for a group of tiles to the server. -Updates the debugTiles state and manages the count of active requests.

                  -
                  - - - - - - - - - -
                  -
                  Parameters:
                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                  NameTypeDescription
                  tiles - - -Array - - - -

                  An array of tile identifiers to request.

                  - -
                  - - - - - - - - - - - - - - - - - -
                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                  - - - - -
                  - - - - -
                  - -

                  - - static window.MapDataRequest#sendTileRequest(tiles) - - - - -

                  - - - -
                  -
                  - - -
                  -

                  Sends requests for a group of tiles to the server. -Updates the debugTiles state and manages the count of active requests.

                  -
                  - - - - - - - - - -
                  -
                  Parameters:
                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                  NameTypeDescription
                  tiles - - -Array - - - -

                  An array of tile identifiers to request.

                  - -
                  - - - - - - - - - - - - - - - - - -
                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                  - - - - -
                  - - - - -
                  - -

                  - - static window.MapDataRequest#setStatus(short, long, progress) - - - - -

                  - - - -
                  -
                  - - -
                  -

                  Sets the current status of the map data request, including a short description, long description, and progress.

                  -
                  - - - - - - - - - -
                  -
                  Parameters:
                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                  NameTypeDescription
                  short - - -string - - - -

                  Short description of the current status.

                  long - - -string - - - -

                  Long description of the current status.

                  progress - - -number - - - -

                  Progress indicator, typically represented as a percentage.

                  - -
                  - - - - - - - - - - - - - - - - - -
                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                  - - - - -
                  - - - - -
                  - -

                  - - static window.MapDataRequest#setStatus(short, long, progress) - - - - -

                  - - - -
                  -
                  - - -
                  -

                  Sets the current status of the map data request, including a short description, long description, and progress.

                  -
                  - - - - - - - - - -
                  -
                  Parameters:
                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                  NameTypeDescription
                  short - - -string - - - -

                  Short description of the current status.

                  long - - -string - - - -

                  Long description of the current status.

                  progress - - -number - - - -

                  Progress indicator, typically represented as a percentage.

                  - -
                  - - - - - - - - - - - - - - - - - -
                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                  - - - - -
                  - - - - -
                  - -

                  - - static window.MapDataRequest#start() - - - - -

                  - - - -
                  -
                  - - -
                  -

                  Starts the data request process, setting up hooks and callbacks.

                  -
                  - - - - - - - - - - - - - - - - - - - - - - - - - -
                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                  - - - - -
                  - - - - -
                  - -

                  - - static window.MapDataRequest#start() - - - - -

                  - - - -
                  -
                  - - -
                  -

                  Starts the data request process, setting up hooks and callbacks.

                  -
                  - - - - - - - - - - - - - - - - - - - - - - - - - -
                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                  - - - - -
                  - - - - -
                  - -

                  - - static window.MapDataRequest#startQueueTimer(delay) - - - - -

                  - - - -
                  -
                  - - -
                  -

                  Starts a timer to process the render queue after a specified delay.

                  -
                  - - - - - - - - - -
                  -
                  Parameters:
                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                  NameTypeDescription
                  delay - - -number - - - -

                  The delay in seconds before processing the render queue.

                  - -
                  - - - - - - - - - - - - - - - - - -
                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                  - - - - -
                  - - - - -
                  - -

                  - - static window.MapDataRequest#startQueueTimer(delay) - - - - -

                  - - - -
                  -
                  - - -
                  -

                  Starts a timer to process the render queue after a specified delay.

                  -
                  - - - - - - - - - -
                  -
                  Parameters:
                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                  NameTypeDescription
                  delay - - -number - - - -

                  The delay in seconds before processing the render queue.

                  - -
                  - - - - - - - - - - - - - - - - - -
                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                  - - - - -
                  - -

                  - - - - - -
                  - -
                  - - - - - - - -
                  - -
                  - -

                  MapDataRequest()

                  - - -
                  - -
                  - -
                  - - - -
                  - -

                  - - new MapDataRequest() - - - - -

                  - - - -
                  -
                  - - -
                  -

                  Class for managing map data requests from the Ingress servers, caching the data, and passing it to the renderer.

                  -
                  - - - - - - - - - - - - - - - - - - - - - - - - - -
                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                  - - - - -
                  - - -
                  - - - - - - - - - - - - - - - - - -

                  Methods

                  - -
                  - - -
                  - -

                  - - static window.MapDataRequest#clearTimeout() - - - - -

                  - - - -
                  -
                  - - -
                  -

                  Clears the current data refresh timeout.

                  -
                  - - - - - - - - - - - - - - - - - - - - - - - - - -
                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                  - - - - -
                  - - - - -
                  - -

                  - - static window.MapDataRequest#clearTimeout() - - - - -

                  - - - -
                  -
                  - - -
                  -

                  Clears the current data refresh timeout.

                  -
                  - - - - - - - - - - - - - - - - - - - - - - - - - -
                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                  - - - - -
                  - - - - -
                  - -

                  - - static window.MapDataRequest#delayProcessRequestQueue(seconds) - - - - -

                  - - - -
                  -
                  - - -
                  -

                  Delays the processing of the request queue for fetching map data tiles. The delay is specified in seconds.

                  -
                  - - - - - - - - - -
                  -
                  Parameters:
                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                  NameTypeDescription
                  seconds - - -number - - - -

                  The delay in seconds before starting to process the request queue.

                  - -
                  - - - - - - - - - - - - - - - - - -
                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                  - - - - -
                  - - - - -
                  - -

                  - - static window.MapDataRequest#delayProcessRequestQueue(seconds) - - - - -

                  - - - -
                  -
                  - - -
                  -

                  Delays the processing of the request queue for fetching map data tiles. The delay is specified in seconds.

                  -
                  - - - - - - - - - -
                  -
                  Parameters:
                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                  NameTypeDescription
                  seconds - - -number - - - -

                  The delay in seconds before starting to process the request queue.

                  - -
                  - - - - - - - - - - - - - - - - - -
                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                  - - - - -
                  - - - - -
                  - -

                  - - static window.MapDataRequest#getStatus() → {Object} - - - - -

                  - - - -
                  -
                  - - -
                  -

                  Gets the current status of the map data request, including short description, long description, and progress.

                  -
                  - - - - - - - - - - - - - - - - - - - - - -
                  -
                  Returns:
                  - - - - - -Object - - - - - --

                  An object containing the current status of the map data request.

                  - - - - - -
                  - - - - - -
                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                  - - - - -
                  - - - - -
                  - -

                  - - static window.MapDataRequest#getStatus() → {Object} - - - - -

                  - - - -
                  -
                  - - -
                  -

                  Gets the current status of the map data request, including short description, long description, and progress.

                  -
                  - - - - - - - - - - - - - - - - - - - - - -
                  -
                  Returns:
                  - - - - - -Object - - - - - --

                  An object containing the current status of the map data request.

                  - - - - - -
                  - - - - - -
                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                  - - - - -
                  - - - - -
                  - -

                  - - static window.MapDataRequest#handleResponse(data, tiles, success) - - - - -

                  - - - -
                  -
                  - - -
                  -

                  Handles the response from the server for tile data requests. -Processes success and error cases, manages retries for failed tiles, and updates the render queue with new data.

                  -
                  - - - - - - - - - -
                  -
                  Parameters:
                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                  NameTypeDescription
                  data - - -Object - - - -

                  The response data from the server.

                  tiles - - -Array - - - -

                  The array of requested tile identifiers.

                  success - - -boolean - - - -

                  Flag indicating if the request was successful.

                  - -
                  - - - - - - - - - - - - - - - - - -
                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                  - - - - -
                  - - - - -
                  - -

                  - - static window.MapDataRequest#handleResponse(data, tiles, success) - - - - -

                  - - - -
                  -
                  - - -
                  -

                  Handles the response from the server for tile data requests. -Processes success and error cases, manages retries for failed tiles, and updates the render queue with new data.

                  -
                  - - - - - - - - - -
                  -
                  Parameters:
                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                  NameTypeDescription
                  data - - -Object - - - -

                  The response data from the server.

                  tiles - - -Array - - - -

                  The array of requested tile identifiers.

                  success - - -boolean - - - -

                  Flag indicating if the request was successful.

                  - -
                  - - - - - - - - - - - - - - - - - -
                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                  - - - - -
                  - - - - -
                  - -

                  - - static window.MapDataRequest#idleResume() - - - - -

                  - - - -
                  -
                  - - -
                  -

                  Resumes data fetching and rendering after being idle.

                  -
                  - - - - - - - - - - - - - - - - - - - - - - - - - -
                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                  - - - - -
                  - - - - -
                  - -

                  - - static window.MapDataRequest#idleResume() - - - - -

                  - - - -
                  -
                  - - -
                  -

                  Resumes data fetching and rendering after being idle.

                  -
                  - - - - - - - - - - - - - - - - - - - - - - - - - -
                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                  - - - - -
                  - - - - -
                  - -

                  - - static window.MapDataRequest#mapMoveEnd() - - - - -

                  - - - -
                  -
                  - - -
                  -

                  Handles map movement end. Determines whether new data needs to be fetched based on map bounds and zoom level.

                  -
                  - - - - - - - - - - - - - - - - - - - - - - - - - -
                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                  - - - - -
                  - - - - -
                  - -

                  - - static window.MapDataRequest#mapMoveEnd() - - - - -

                  - - - -
                  -
                  - - -
                  -

                  Handles map movement end. Determines whether new data needs to be fetched based on map bounds and zoom level.

                  -
                  - - - - - - - - - - - - - - - - - - - - - - - - - -
                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                  - - - - -
                  - - - - -
                  - -

                  - - static window.MapDataRequest#mapMoveStart() - - - - -

                  - - - -
                  -
                  - - -
                  -

                  Callback for map movement start. Pauses the rendering and data requests.

                  -
                  - - - - - - - - - - - - - - - - - - - - - - - - - -
                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                  - - - - -
                  - - - - -
                  - -

                  - - static window.MapDataRequest#mapMoveStart() - - - - -

                  - - - -
                  -
                  - - -
                  -

                  Callback for map movement start. Pauses the rendering and data requests.

                  -
                  - - - - - - - - - - - - - - - - - - - - - - - - - -
                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                  - - - - -
                  - - - - -
                  - -

                  - - static window.MapDataRequest#pauseRenderQueue(pause) - - - - -

                  - - - -
                  -
                  - - -
                  -

                  Pauses or resumes the render queue processing. When paused, the queue timer is cleared.

                  -
                  - - - - - - - - - -
                  -
                  Parameters:
                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                  NameTypeDescription
                  pause - - -boolean - - - -

                  Flag indicating whether to pause (true) or resume (false) the render queue processing.

                  - -
                  - - - - - - - - - - - - - - - - - -
                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                  - - - - -
                  - - - - -
                  - -

                  - - static window.MapDataRequest#pauseRenderQueue(pause) - - - - -

                  - - - -
                  -
                  - - -
                  -

                  Pauses or resumes the render queue processing. When paused, the queue timer is cleared.

                  -
                  - - - - - - - - - -
                  -
                  Parameters:
                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                  NameTypeDescription
                  pause - - -boolean - - - -

                  Flag indicating whether to pause (true) or resume (false) the render queue processing.

                  - -
                  - - - - - - - - - - - - - - - - - -
                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                  - - - - -
                  - - - - -
                  - -

                  - - static window.MapDataRequest#processRenderQueue() - - - - -

                  - - - -
                  -
                  - - -
                  -

                  Processes the render queue, rendering entities on the map. -This function handles both the rendering of new entities and the deletion of old ones. -It ensures that the quantity of entities processed per cycle does not exceed a set limit.

                  -
                  - - - - - - - - - - - - - - - - - - - - - - - - - -
                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                  - - - - -
                  - - - - -
                  - -

                  - - static window.MapDataRequest#processRenderQueue() - - - - -

                  - - - -
                  -
                  - - -
                  -

                  Processes the render queue, rendering entities on the map. -This function handles both the rendering of new entities and the deletion of old ones. -It ensures that the quantity of entities processed per cycle does not exceed a set limit.

                  -
                  - - - - - - - - - - - - - - - - - - - - - - - - - -
                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                  - - - - -
                  - - - - -
                  - -

                  - - static window.MapDataRequest#processRequestQueue() - - - - -

                  - - - -
                  -
                  - - -
                  -

                  Processes the request queue for fetching map data tiles. Manages the number of simultaneous tile requests, -tile error handling, and updates the request status.

                  -
                  - - - - - - - - - - - - - - - - - - - - - - - - - -
                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                  - - - - -
                  - - - - -
                  - -

                  - - static window.MapDataRequest#processRequestQueue() - - - - -

                  - - - -
                  -
                  - - -
                  -

                  Processes the request queue for fetching map data tiles. Manages the number of simultaneous tile requests, -tile error handling, and updates the request status.

                  -
                  - - - - - - - - - - - - - - - - - - - - - - - - - -
                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                  - - - - -
                  - - - - -
                  - -

                  - - static window.MapDataRequest#pushRenderQueue(id, data, status) - - - - -

                  - - - -
                  -
                  - - -
                  -

                  Pushes a tile to the render queue for processing. The queue is processed to render entities on the map.

                  -
                  - - - - - - - - - -
                  -
                  Parameters:
                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                  NameTypeDescription
                  id - - -string - - - -

                  The identifier of the tile.

                  data - - -Object - - - -

                  Data associated with the tile, including game entity GUIDs and entities.

                  status - - -string - - - -

                  The status of the tile, such as 'render-queue'.

                  - -
                  - - - - - - - - - - - - - - - - - -
                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                  - - - - -
                  - - - - -
                  - -

                  - - static window.MapDataRequest#pushRenderQueue(id, data, status) - - - - -

                  - - - -
                  -
                  - - -
                  -

                  Pushes a tile to the render queue for processing. The queue is processed to render entities on the map.

                  -
                  - - - - - - - - - -
                  -
                  Parameters:
                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                  NameTypeDescription
                  id - - -string - - - -

                  The identifier of the tile.

                  data - - -Object - - - -

                  Data associated with the tile, including game entity GUIDs and entities.

                  status - - -string - - - -

                  The status of the tile, such as 'render-queue'.

                  - -
                  - - - - - - - - - - - - - - - - - -
                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                  - - - - -
                  - - - - -
                  - -

                  - - static window.MapDataRequest#refresh() - - - - -

                  - - - -
                  -
                  - - -
                  -

                  Initiates the map data refresh process. This includes resetting necessary properties, -preparing requests for map data, and handling cached data.

                  -
                  - - - - - - - - - - - - - - - - - - - - - - - - - -
                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                  - - - - -
                  - - - - -
                  - -

                  - - static window.MapDataRequest#refresh() - - - - -

                  - - - -
                  -
                  - - -
                  -

                  Initiates the map data refresh process. This includes resetting necessary properties, -preparing requests for map data, and handling cached data.

                  -
                  - - - - - - - - - - - - - - - - - - - - - - - - - -
                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                  - - - - -
                  - - - - -
                  - -

                  - - static window.MapDataRequest#refreshOnTimeout(seconds) - - - - -

                  - - - -
                  -
                  - - -
                  -

                  Sets a timeout to refresh the map data.

                  -
                  - - - - - - - - - -
                  -
                  Parameters:
                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                  NameTypeDescription
                  seconds - - -number - - - -

                  Time in seconds to wait before refreshing the map data.

                  - -
                  - - - - - - - - - - - - - - - - - -
                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                  - - - - -
                  - - - - -
                  - -

                  - - static window.MapDataRequest#refreshOnTimeout(seconds) - - - - -

                  - - - -
                  -
                  - - -
                  -

                  Sets a timeout to refresh the map data.

                  -
                  - - - - - - - - - -
                  -
                  Parameters:
                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                  NameTypeDescription
                  seconds - - -number - - - -

                  Time in seconds to wait before refreshing the map data.

                  - -
                  - - - - - - - - - - - - - - - - - -
                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                  - - - - -
                  - - - - -
                  - -

                  - - static window.MapDataRequest#requeueTile(id, error) - - - - -

                  - - - -
                  -
                  - - -
                  -

                  Re-queues a tile for data fetching in case of an error or timeouts. -Handles retry limits and uses stale data if available.

                  -
                  - - - - - - - - - -
                  -
                  Parameters:
                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                  NameTypeDescription
                  id - - -string - - - -

                  The tile identifier.

                  error - - -boolean - - - -

                  Flag indicating whether the tile fetch encountered an error.

                  - -
                  - @@ -8182,14 +962,14 @@
                  Parameters:
                  -

                  +

                  - static window.MapDataRequest#requeueTile(id, error) + static window.MapDataRequest#pauseRenderQueue(pause)

                  @@ -8201,8 +981,7 @@

                  -

                  Re-queues a tile for data fetching in case of an error or timeouts. -Handles retry limits and uses stale data if available.

                  +

                  Pauses or resumes the render queue processing. When paused, the queue timer is cleared.

                  @@ -8238,30 +1017,7 @@

                  Parameters:
                  - id - - - - - -string - - - - - - - - - -

                  The tile identifier.

                  - - - - - - - error + pause @@ -8277,7 +1033,7 @@
                  Parameters:
                  -

                  Flag indicating whether the tile fetch encountered an error.

                  +

                  Flag indicating whether to pause (true) or resume (false) the render queue processing.

                  @@ -8345,14 +1101,14 @@
                  Parameters:
                  -

                  +

                  - static window.MapDataRequest#resetRenderQueue() + static window.MapDataRequest#processRenderQueue()

                  @@ -8364,7 +1120,9 @@

                  -

                  Resets the render queue, clearing existing queued render tasks and stopping any active timer.

                  +

                  Processes the render queue, rendering entities on the map. +This function handles both the rendering of new entities and the deletion of old ones. +It ensures that the quantity of entities processed per cycle does not exceed a set limit.

                  @@ -8434,14 +1192,14 @@

                  -

                  +

                  - static window.MapDataRequest#resetRenderQueue() + static window.MapDataRequest#processRequestQueue()

                  @@ -8453,7 +1211,8 @@

                  -

                  Resets the render queue, clearing existing queued render tasks and stopping any active timer.

                  +

                  Processes the request queue for fetching map data tiles. Manages the number of simultaneous tile requests, +tile error handling, and updates the request status.

                  @@ -8523,14 +1282,14 @@

                  -

                  +

                  - static window.MapDataRequest#sendTileRequest(tiles) + static window.MapDataRequest#pushRenderQueue(id, data, status)

                  @@ -8542,8 +1301,7 @@

                  -

                  Sends requests for a group of tiles to the server. -Updates the debugTiles state and manages the count of active requests.

                  +

                  Pushes a tile to the render queue for processing. The queue is processed to render entities on the map.

                  @@ -8579,13 +1337,13 @@

                  Parameters:
                  - tiles + id -Array +string @@ -8595,7 +1353,53 @@
                  Parameters:
                  -

                  An array of tile identifiers to request.

                  +

                  The identifier of the tile.

                  + + + + + + + data + + + + + +Object + + + + + + + + + +

                  Data associated with the tile, including game entity GUIDs and entities.

                  + + + + + + + status + + + + + +string + + + + + + + + + +

                  The status of the tile, such as 'render-queue'.

                  @@ -8663,14 +1467,14 @@
                  Parameters:
                  -

                  +

                  - static window.MapDataRequest#sendTileRequest(tiles) + static window.MapDataRequest#refresh()

                  @@ -8682,8 +1486,8 @@

                  -

                  Sends requests for a group of tiles to the server. -Updates the debugTiles state and manages the count of active requests.

                  +

                  Initiates the map data refresh process. This includes resetting necessary properties, +preparing requests for map data, and handling cached data.

                  @@ -8694,56 +1498,6 @@

                  -
                  -
                  Parameters:
                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                  NameTypeDescription
                  tiles - - -Array - - - -

                  An array of tile identifiers to request.

                  - -
                  - @@ -8803,14 +1557,14 @@

                  Parameters:
                  -

                  +

                  - static window.MapDataRequest#setStatus(short, long, progress) + static window.MapDataRequest#refreshOnTimeout(seconds)

                  @@ -8822,7 +1576,7 @@

                  -

                  Sets the current status of the map data request, including a short description, long description, and progress.

                  +

                  Sets a timeout to refresh the map data.

                  @@ -8858,53 +1612,7 @@

                  Parameters:
                  - short - - - - - -string - - - - - - - - - -

                  Short description of the current status.

                  - - - - - - - long - - - - - -string - - - - - - - - - -

                  Long description of the current status.

                  - - - - - - - progress + seconds @@ -8920,7 +1628,7 @@
                  Parameters:
                  -

                  Progress indicator, typically represented as a percentage.

                  +

                  Time in seconds to wait before refreshing the map data.

                  @@ -8988,14 +1696,14 @@
                  Parameters:
                  -

                  +

                  - static window.MapDataRequest#setStatus(short, long, progress) + static window.MapDataRequest#requeueTile(id, error)

                  @@ -9007,7 +1715,8 @@

                  -

                  Sets the current status of the map data request, including a short description, long description, and progress.

                  +

                  Re-queues a tile for data fetching in case of an error or timeouts. +Handles retry limits and uses stale data if available.

                  @@ -9043,30 +1752,7 @@

                  Parameters:
                  - short - - - - - -string - - - - - - - - - -

                  Short description of the current status.

                  - - - - - - - long + id @@ -9082,20 +1768,20 @@
                  Parameters:
                  -

                  Long description of the current status.

                  +

                  The tile identifier.

                  - progress + error -number +boolean @@ -9105,7 +1791,7 @@
                  Parameters:
                  -

                  Progress indicator, typically represented as a percentage.

                  +

                  Flag indicating whether the tile fetch encountered an error.

                  @@ -9173,14 +1859,14 @@
                  Parameters:
                  -

                  +

                  - static window.MapDataRequest#start() + static window.MapDataRequest#resetRenderQueue()

                  @@ -9192,7 +1878,7 @@

                  -

                  Starts the data request process, setting up hooks and callbacks.

                  +

                  Resets the render queue, clearing existing queued render tasks and stopping any active timer.

                  @@ -9262,14 +1948,14 @@

                  -

                  +

                  - static window.MapDataRequest#start() + static window.MapDataRequest#sendTileRequest(tiles)

                  @@ -9281,7 +1967,8 @@

                  -

                  Starts the data request process, setting up hooks and callbacks.

                  +

                  Sends requests for a group of tiles to the server. +Updates the debugTiles state and manages the count of active requests.

                  @@ -9292,6 +1979,56 @@

                  +
                  +
                  Parameters:
                  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
                  NameTypeDescription
                  tiles + + +Array + + + +

                  An array of tile identifiers to request.

                  + +
                  + @@ -9351,14 +2088,14 @@

                  -

                  +

                  - static window.MapDataRequest#startQueueTimer(delay) + static window.MapDataRequest#setStatus(short, long, progress)

                  @@ -9370,7 +2107,7 @@

                  -

                  Starts a timer to process the render queue after a specified delay.

                  +

                  Sets the current status of the map data request, including a short description, long description, and progress.

                  @@ -9406,7 +2143,53 @@

                  Parameters:
                  - delay + short + + + + + +string + + + + + + + + + +

                  Short description of the current status.

                  + + + + + + + long + + + + + +string + + + + + + + + + +

                  Long description of the current status.

                  + + + + + + + progress @@ -9422,7 +2205,7 @@
                  Parameters:
                  -

                  The delay in seconds before processing the render queue.

                  +

                  Progress indicator, typically represented as a percentage.

                  @@ -9468,6 +2251,95 @@
                  Parameters:
                  + + + + + + + + + + +

                  + + + + + + + + + +
                  + +

                  + + static window.MapDataRequest#start() + + + + +

                  + + + +
                  +
                  + + +
                  +

                  Starts the data request process, setting up hooks and callbacks.

                  +
                  + + + + + + + + + + + + + + + + + + + + + + + + + +
                  + + + + + + + + + + + + + + + + + + + + diff --git a/Render.html b/Render.html index d50d9135d..fcfe78424 100644 --- a/Render.html +++ b/Render.html @@ -34,7 +34,7 @@

                  IITC-CE

                    - +
                    @@ -310,14 +310,14 @@
                    Parameters:
                    -

                    +

                    - static window.Render#addPortalToMapLayer(portal) + static window.Render#bringPortalsToFront()

                    @@ -329,7 +329,7 @@

                    -

                    Adds a portal to the visible map layer.

                    +

                    Brings portal markers to the front of the map view, ensuring they are rendered above links and fields.

                    @@ -340,56 +340,6 @@

                    -
                    -
                    Parameters:
                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                    NameTypeDescription
                    portal - - -Object - - - -

                    The portal object to add to the map layer.

                    - -
                    - @@ -449,14 +399,14 @@

                    Parameters:
                    -

                    +

                    - static window.Render#bringPortalsToFront() + static window.Render#clearFieldsOutsideBounds(bounds)

                    @@ -468,7 +418,7 @@

                    -

                    Brings portal markers to the front of the map view, ensuring they are rendered above links and fields.

                    +

                    Clears fields that are outside the specified bounds.

                    @@ -479,94 +429,55 @@

                    +
                    +
                    Parameters:
                    + + + + + + + - - - - - - - - - - - - - - - -
                    - - - - - - - - - - - - - - - - - - - - - - - - - - +
                    - + - - + + + + + - - + + + - -
                    - -

                    +

                    - + - + + + + + +
                    NameTypeDescription
                    bounds - static window.Render#bringPortalsToFront() - - - - +L.LatLngBounds - - - -
                    - -
                    -

                    Brings portal markers to the front of the map view, ensuring they are rendered above links and fields.

                    -
                    - + +

                    The bounds to check against for field removal.

                    +
                    @@ -627,14 +538,14 @@

                    -

                    +

                    - static window.Render#clearFieldsOutsideBounds(bounds) + static window.Render#clearLinksOutsideBounds(bounds)

                    @@ -646,7 +557,7 @@

                    -

                    Clears fields that are outside the specified bounds.

                    +

                    Clears links that are outside the specified bounds.

                    @@ -698,7 +609,7 @@

                    Parameters:
                    -

                    The bounds to check against for field removal.

                    +

                    The bounds to check against for link removal.

                    @@ -766,14 +677,14 @@
                    Parameters:
                    -

                    +

                    - static window.Render#clearFieldsOutsideBounds(bounds) + static window.Render#clearPortalsOutsideBounds(bounds)

                    @@ -785,7 +696,7 @@

                    -

                    Clears fields that are outside the specified bounds.

                    +

                    Clears portals outside the specified bounds.

                    @@ -837,7 +748,7 @@

                    Parameters:
                    -

                    The bounds to check against for field removal.

                    +

                    The bounds to check against.

                    @@ -905,14 +816,14 @@
                    Parameters:
                    -

                    +

                    - static window.Render#clearLinksOutsideBounds(bounds) + static window.Render#createFieldEntity(ent)

                    @@ -924,7 +835,7 @@

                    -

                    Clears links that are outside the specified bounds.

                    +

                    Creates a field entity from the provided game entity data.

                    @@ -960,13 +871,13 @@

                    Parameters:
                    - bounds + ent -L.LatLngBounds +Array @@ -976,7 +887,7 @@
                    Parameters:
                    -

                    The bounds to check against for link removal.

                    +

                    An array representing the game entity.

                    @@ -1044,14 +955,14 @@
                    Parameters:
                    -

                    +

                    - static window.Render#clearLinksOutsideBounds(bounds) + static window.Render#createLinkEntity(ent)

                    @@ -1063,7 +974,7 @@

                    -

                    Clears links that are outside the specified bounds.

                    +

                    Creates a link entity from the provided game entity data.

                    @@ -1099,13 +1010,13 @@

                    Parameters:
                    - bounds + ent -L.LatLngBounds +Array @@ -1115,7 +1026,7 @@
                    Parameters:
                    -

                    The bounds to check against for link removal.

                    +

                    An array representing the game entity.

                    @@ -1183,14 +1094,14 @@
                    Parameters:
                    -

                    +

                    - static window.Render#clearPortalsOutsideBounds(bounds) + static window.Render#createPlaceholderPortalEntity(guid, latE6, lngE6, team, timestampopt)

                    @@ -1202,7 +1113,8 @@

                    -

                    Clears portals outside the specified bounds.

                    +

                    Creates a placeholder portal entity. This is used when the portal is not fully loaded, +but its existence is known from links/fields.

                    @@ -1226,6 +1138,8 @@

                    Parameters:
                    Type + Attributes + @@ -1238,37 +1152,171 @@
                    Parameters:
                    - bounds + guid -L.LatLngBounds +string + + + + + + -

                    The bounds to check against.

                    - + - - - +

                    The globally unique identifier of the portal.

                    + - - + + + latE6 + - + + + +number - + + + + + + + + + + + + + + + + +

                    The latitude of the portal in E6 format.

                    + + + + + + + lngE6 + + + + + +number + + + + + + + + + + + + + + + + + +

                    The longitude of the portal in E6 format.

                    + + + + + + + team + + + + + +string + + + + + + + + + + + + + + + + + +

                    The team faction of the portal.

                    + + + + + + + timestamp + + + + + +number + + + + + + + + + <optional>
                    + + + + + + + + + + +

                    The timestamp of the portal data.

                    + + + + + + + + + + + + + + @@ -1322,14 +1370,14 @@
                    Parameters:
                    -

                    +

                    - static window.Render#clearPortalsOutsideBounds(bounds) + static window.Render#createPortalEntity(ent, details)

                    @@ -1341,7 +1389,8 @@

                    -

                    Clears portals outside the specified bounds.

                    +

                    Creates a portal entity from the provided game entity data. +If the portal already exists and the new data is more recent, it replaces the existing data.

                    @@ -1377,13 +1426,13 @@

                    Parameters:
                    - bounds + ent -L.LatLngBounds +Array @@ -1393,7 +1442,30 @@
                    Parameters:
                    -

                    The bounds to check against.

                    +

                    An array representing the game entity.

                    + + + + + + + details + + + + + +string + + + + + + + + + +

                    Detail level expected in window.decodeArray.portal (e.g., 'core', 'summary').

                    @@ -1461,14 +1533,14 @@
                    Parameters:
                    -

                    +

                    - static window.Render#createFieldEntity(ent) + static window.Render#deleteEntity(guid)

                    @@ -1480,7 +1552,7 @@

                    -

                    Creates a field entity from the provided game entity data.

                    +

                    Deletes an entity (portal, link, or field) from the map based on its GUID.

                    @@ -1516,13 +1588,13 @@

                    Parameters:
                    - ent + guid -Array +string @@ -1532,7 +1604,7 @@
                    Parameters:
                    -

                    An array representing the game entity.

                    +

                    The globally unique identifier of the entity to delete.

                    @@ -1600,14 +1672,14 @@
                    Parameters:
                    -

                    +

                    - static window.Render#createFieldEntity(ent) + static window.Render#deleteFieldEntity(guid)

                    @@ -1619,7 +1691,7 @@

                    -

                    Creates a field entity from the provided game entity data.

                    +

                    Deletes a field entity from the map based on its GUID.

                    @@ -1655,13 +1727,13 @@

                    Parameters:
                    - ent + guid -Array +string @@ -1671,7 +1743,7 @@
                    Parameters:
                    -

                    An array representing the game entity.

                    +

                    The globally unique identifier of the field to delete.

                    @@ -1739,14 +1811,14 @@
                    Parameters:
                    -

                    +

                    - static window.Render#createLinkEntity(ent) + static window.Render#deleteLinkEntity(guid)

                    @@ -1758,7 +1830,7 @@

                    -

                    Creates a link entity from the provided game entity data.

                    +

                    Deletes a link entity from the map based on its GUID.

                    @@ -1794,13 +1866,13 @@

                    Parameters:
                    - ent + guid -Array +string @@ -1810,7 +1882,7 @@
                    Parameters:
                    -

                    An array representing the game entity.

                    +

                    The globally unique identifier of the link to delete.

                    @@ -1878,14 +1950,14 @@
                    Parameters:
                    -

                    +

                    - static window.Render#createLinkEntity(ent) + static window.Render#deletePortalEntity(guid)

                    @@ -1897,7 +1969,7 @@

                    -

                    Creates a link entity from the provided game entity data.

                    +

                    Deletes a portal entity from the map based on its GUID.

                    @@ -1933,13 +2005,13 @@

                    Parameters:
                    - ent + guid -Array +string @@ -1949,7 +2021,7 @@
                    Parameters:
                    -

                    An array representing the game entity.

                    +

                    The globally unique identifier of the portal to delete.

                    @@ -2017,14 +2089,14 @@
                    Parameters:
                    -

                    +

                    - static window.Render#createPlaceholderPortalEntity(guid, latE6, lngE6, team, timestampopt) + static window.Render#endRenderPass()

                    @@ -2036,8 +2108,8 @@

                    -

                    Creates a placeholder portal entity. This is used when the portal is not fully loaded, -but its existence is known from links/fields.

                    +

                    Ends a render pass. This includes cleanup and processing of any remaining data. +Called when the render is considered complete.

                    @@ -2048,8603 +2120,14 @@

                    -
                    -
                    Parameters:
                    - - - - - - - - + - - - + - + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                    NameTypeAttributesDescription
                    guid - - -string - - - - - - - - - -

                    The globally unique identifier of the portal.

                    latE6 - - -number - - - - - - - - - -

                    The latitude of the portal in E6 format.

                    lngE6 - - -number - - - - - - - - - -

                    The longitude of the portal in E6 format.

                    team - - -string - - - - - - - - - -

                    The team faction of the portal.

                    timestamp - - -number - - - - - - <optional>
                    - - - - - -

                    The timestamp of the portal data.

                    - -
                    - - - - - - - - - - - - - - - - - -
                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                    - - - - -

                    - - - - -
                    - -

                    - - static window.Render#createPlaceholderPortalEntity(guid, latE6, lngE6, team, timestampopt) - - - - -

                    - - - -
                    -
                    - - -
                    -

                    Creates a placeholder portal entity. This is used when the portal is not fully loaded, -but its existence is known from links/fields.

                    -
                    - - - - - - - - - -
                    -
                    Parameters:
                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                    NameTypeAttributesDescription
                    guid - - -string - - - - - - - - - -

                    The globally unique identifier of the portal.

                    latE6 - - -number - - - - - - - - - -

                    The latitude of the portal in E6 format.

                    lngE6 - - -number - - - - - - - - - -

                    The longitude of the portal in E6 format.

                    team - - -string - - - - - - - - - -

                    The team faction of the portal.

                    timestamp - - -number - - - - - - <optional>
                    - - - - - -

                    The timestamp of the portal data.

                    - -
                    - - - - - - - - - - - - - - - - - -
                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                    - - - - -
                    - - - - -
                    - -

                    - - static window.Render#createPortalEntity(ent, details) - - - - -

                    - - - -
                    -
                    - - -
                    -

                    Creates a portal entity from the provided game entity data. -If the portal already exists and the new data is more recent, it replaces the existing data.

                    -
                    - - - - - - - - - -
                    -
                    Parameters:
                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                    NameTypeDescription
                    ent - - -Array - - - -

                    An array representing the game entity.

                    details - - -string - - - -

                    Detail level expected in window.decodeArray.portal (e.g., 'core', 'summary').

                    - -
                    - - - - - - - - - - - - - - - - - -
                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                    - - - - -
                    - - - - -
                    - -

                    - - static window.Render#createPortalEntity(ent, details) - - - - -

                    - - - -
                    -
                    - - -
                    -

                    Creates a portal entity from the provided game entity data. -If the portal already exists and the new data is more recent, it replaces the existing data.

                    -
                    - - - - - - - - - -
                    -
                    Parameters:
                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                    NameTypeDescription
                    ent - - -Array - - - -

                    An array representing the game entity.

                    details - - -string - - - -

                    Detail level expected in window.decodeArray.portal (e.g., 'core', 'summary').

                    - -
                    - - - - - - - - - - - - - - - - - -
                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                    - - - - -
                    - - - - -
                    - -

                    - - static window.Render#deleteEntity(guid) - - - - -

                    - - - -
                    -
                    - - -
                    -

                    Deletes an entity (portal, link, or field) from the map based on its GUID.

                    -
                    - - - - - - - - - -
                    -
                    Parameters:
                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                    NameTypeDescription
                    guid - - -string - - - -

                    The globally unique identifier of the entity to delete.

                    - -
                    - - - - - - - - - - - - - - - - - -
                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                    - - - - -
                    - - - - -
                    - -

                    - - static window.Render#deleteEntity(guid) - - - - -

                    - - - -
                    -
                    - - -
                    -

                    Deletes an entity (portal, link, or field) from the map based on its GUID.

                    -
                    - - - - - - - - - -
                    -
                    Parameters:
                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                    NameTypeDescription
                    guid - - -string - - - -

                    The globally unique identifier of the entity to delete.

                    - -
                    - - - - - - - - - - - - - - - - - -
                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                    - - - - -
                    - - - - -
                    - -

                    - - static window.Render#deleteFieldEntity(guid) - - - - -

                    - - - -
                    -
                    - - -
                    -

                    Deletes a field entity from the map based on its GUID.

                    -
                    - - - - - - - - - -
                    -
                    Parameters:
                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                    NameTypeDescription
                    guid - - -string - - - -

                    The globally unique identifier of the field to delete.

                    - -
                    - - - - - - - - - - - - - - - - - -
                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                    - - - - -
                    - - - - -
                    - -

                    - - static window.Render#deleteFieldEntity(guid) - - - - -

                    - - - -
                    -
                    - - -
                    -

                    Deletes a field entity from the map based on its GUID.

                    -
                    - - - - - - - - - -
                    -
                    Parameters:
                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                    NameTypeDescription
                    guid - - -string - - - -

                    The globally unique identifier of the field to delete.

                    - -
                    - - - - - - - - - - - - - - - - - -
                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                    - - - - -
                    - - - - -
                    - -

                    - - static window.Render#deleteLinkEntity(guid) - - - - -

                    - - - -
                    -
                    - - -
                    -

                    Deletes a link entity from the map based on its GUID.

                    -
                    - - - - - - - - - -
                    -
                    Parameters:
                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                    NameTypeDescription
                    guid - - -string - - - -

                    The globally unique identifier of the link to delete.

                    - -
                    - - - - - - - - - - - - - - - - - -
                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                    - - - - -
                    - - - - -
                    - -

                    - - static window.Render#deleteLinkEntity(guid) - - - - -

                    - - - -
                    -
                    - - -
                    -

                    Deletes a link entity from the map based on its GUID.

                    -
                    - - - - - - - - - -
                    -
                    Parameters:
                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                    NameTypeDescription
                    guid - - -string - - - -

                    The globally unique identifier of the link to delete.

                    - -
                    - - - - - - - - - - - - - - - - - -
                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                    - - - - -
                    - - - - -
                    - -

                    - - static window.Render#deletePortalEntity(guid) - - - - -

                    - - - -
                    -
                    - - -
                    -

                    Deletes a portal entity from the map based on its GUID.

                    -
                    - - - - - - - - - -
                    -
                    Parameters:
                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                    NameTypeDescription
                    guid - - -string - - - -

                    The globally unique identifier of the portal to delete.

                    - -
                    - - - - - - - - - - - - - - - - - -
                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                    - - - - -
                    - - - - -
                    - -

                    - - static window.Render#deletePortalEntity(guid) - - - - -

                    - - - -
                    -
                    - - -
                    -

                    Deletes a portal entity from the map based on its GUID.

                    -
                    - - - - - - - - - -
                    -
                    Parameters:
                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                    NameTypeDescription
                    guid - - -string - - - -

                    The globally unique identifier of the portal to delete.

                    - -
                    - - - - - - - - - - - - - - - - - -
                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                    - - - - -
                    - - - - -
                    - -

                    - - static window.Render#endRenderPass() - - - - -

                    - - - -
                    -
                    - - -
                    -

                    Ends a render pass. This includes cleanup and processing of any remaining data. -Called when the render is considered complete.

                    -
                    - - - - - - - - - - - - - - - - - - - - - - - - - -
                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                    - - - - -
                    - - - - -
                    - -

                    - - static window.Render#endRenderPass() - - - - -

                    - - - -
                    -
                    - - -
                    -

                    Ends a render pass. This includes cleanup and processing of any remaining data. -Called when the render is considered complete.

                    -
                    - - - - - - - - - - - - - - - - - - - - - - - - - -
                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                    - - - - -
                    - - - - -
                    - -

                    - - static window.Render#processDeletedGameEntityGuids(deleted) - - - - -

                    - - - -
                    -
                    - - -
                    -

                    Processes deleted game entity GUIDs and removes them from the map.

                    -
                    - - - - - - - - - -
                    -
                    Parameters:
                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                    NameTypeDescription
                    deleted - - -Array - - - -

                    Array of deleted game entity GUIDs.

                    - -
                    - - - - - - - - - - - - - - - - - -
                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                    - - - - -
                    - - - - -
                    - -

                    - - static window.Render#processDeletedGameEntityGuids(deleted) - - - - -

                    - - - -
                    -
                    - - -
                    -

                    Processes deleted game entity GUIDs and removes them from the map.

                    -
                    - - - - - - - - - -
                    -
                    Parameters:
                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                    NameTypeDescription
                    deleted - - -Array - - - -

                    Array of deleted game entity GUIDs.

                    - -
                    - - - - - - - - - - - - - - - - - -
                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                    - - - - -
                    - - - - -
                    - -

                    - - static window.Render#processGameEntities(entities, details) - - - - -

                    - - - -
                    -
                    - - -
                    -

                    Processes game entities (fields, links, portals) and creates them on the map.

                    -
                    - - - - - - - - - -
                    -
                    Parameters:
                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                    NameTypeDescription
                    entities - - -Array - - - -

                    Array of game entities.

                    details - - -Object - - - -

                    Details for the window.decodeArray.portal function.

                    - -
                    - - - - - - - - - - - - - - - - - -
                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                    - - - - -
                    - - - - -
                    - -

                    - - static window.Render#processGameEntities(entities, details) - - - - -

                    - - - -
                    -
                    - - -
                    -

                    Processes game entities (fields, links, portals) and creates them on the map.

                    -
                    - - - - - - - - - -
                    -
                    Parameters:
                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                    NameTypeDescription
                    entities - - -Array - - - -

                    Array of game entities.

                    details - - -Object - - - -

                    Details for the window.decodeArray.portal function.

                    - -
                    - - - - - - - - - - - - - - - - - -
                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                    - - - - -
                    - - - - -
                    - -

                    - - static window.Render#processTileData(tiledata) - - - - -

                    - - - -
                    -
                    - - -
                    -

                    Processes tile data including deleted entity GUIDs and game entities.

                    -
                    - - - - - - - - - -
                    -
                    Parameters:
                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                    NameTypeDescription
                    tiledata - - -Object - - - -

                    Data for a specific map tile.

                    - -
                    - - - - - - - - - - - - - - - - - -
                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                    - - - - -
                    - - - - -
                    - -

                    - - static window.Render#processTileData(tiledata) - - - - -

                    - - - -
                    -
                    - - -
                    -

                    Processes tile data including deleted entity GUIDs and game entities.

                    -
                    - - - - - - - - - -
                    -
                    Parameters:
                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                    NameTypeDescription
                    tiledata - - -Object - - - -

                    Data for a specific map tile.

                    - -
                    - - - - - - - - - - - - - - - - - -
                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                    - - - - -
                    - - - - -
                    - -

                    - - static window.Render#removePortalFromMapLayer(portal) - - - - -

                    - - - -
                    -
                    - - -
                    -

                    Removes a portal from the visible map layer.

                    -
                    - - - - - - - - - -
                    -
                    Parameters:
                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                    NameTypeDescription
                    portal - - -Object - - - -

                    The portal object to remove from the map layer.

                    - -
                    - - - - - - - - - - - - - - - - - -
                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                    - - - - -
                    - - - - -
                    - -

                    - - static window.Render#removePortalFromMapLayer(portal) - - - - -

                    - - - -
                    -
                    - - -
                    -

                    Removes a portal from the visible map layer.

                    -
                    - - - - - - - - - -
                    -
                    Parameters:
                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                    NameTypeDescription
                    portal - - -Object - - - -

                    The portal object to remove from the map layer.

                    - -
                    - - - - - - - - - - - - - - - - - -
                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                    - - - - -
                    - - - - -
                    - -

                    - - static window.Render#rescalePortalMarkers() - - - - -

                    - - - -
                    -
                    - - -
                    -

                    Rescales portal markers based on the current map zoom level.

                    -
                    - - - - - - - - - - - - - - - - - - - - - - - - - -
                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                    - - - - -
                    - - - - -
                    - -

                    - - static window.Render#rescalePortalMarkers() - - - - -

                    - - - -
                    -
                    - - -
                    -

                    Rescales portal markers based on the current map zoom level.

                    -
                    - - - - - - - - - - - - - - - - - - - - - - - - - -
                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                    - - - - -
                    - - - - -
                    - -

                    - - static window.Render#startRenderPass(bounds) - - - - -

                    - - - -
                    -
                    - - -
                    -

                    Initiates a render pass. It's called at the start of making a batch of data requests to the servers.

                    -
                    - - - - - - - - - -
                    -
                    Parameters:
                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                    NameTypeDescription
                    bounds - - -L.LatLngBounds - - - -

                    The bounds within which the render pass will occur.

                    - -
                    - - - - - - - - - - - - - - - - - -
                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                    - - - - -
                    - - - - -
                    - -

                    - - static window.Render#startRenderPass(bounds) - - - - -

                    - - - -
                    -
                    - - -
                    -

                    Initiates a render pass. It's called at the start of making a batch of data requests to the servers.

                    -
                    - - - - - - - - - -
                    -
                    Parameters:
                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                    NameTypeDescription
                    bounds - - -L.LatLngBounds - - - -

                    The bounds within which the render pass will occur.

                    - -
                    - - - - - - - - - - - - - - - - - -
                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                    - - - - -
                    - - - - - - - -
                    - -
                    - - - - - - - -
                    - -
                    - -

                    Render()

                    - - -
                    - -
                    - -
                    - - - -
                    - -

                    - - new Render() - - - - -

                    - - - -
                    -
                    - - -
                    -

                    Manages rendering of map data (portals, links, fields) into Leaflet.

                    -
                    - - - - - - - - - - - - - - - - - - - - - - - - - -
                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                    - - - - -
                    - - -
                    - - - - - - - - - - - - - - - - - -

                    Methods

                    - -
                    - - -
                    - -

                    - - static window.Render#addPortalToMapLayer(portal) - - - - -

                    - - - -
                    -
                    - - -
                    -

                    Adds a portal to the visible map layer.

                    -
                    - - - - - - - - - -
                    -
                    Parameters:
                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                    NameTypeDescription
                    portal - - -Object - - - -

                    The portal object to add to the map layer.

                    - -
                    - - - - - - - - - - - - - - - - - -
                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                    - - - - -
                    - - - - -
                    - -

                    - - static window.Render#addPortalToMapLayer(portal) - - - - -

                    - - - -
                    -
                    - - -
                    -

                    Adds a portal to the visible map layer.

                    -
                    - - - - - - - - - -
                    -
                    Parameters:
                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                    NameTypeDescription
                    portal - - -Object - - - -

                    The portal object to add to the map layer.

                    - -
                    - - - - - - - - - - - - - - - - - -
                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                    - - - - -
                    - - - - -
                    - -

                    - - static window.Render#bringPortalsToFront() - - - - -

                    - - - -
                    -
                    - - -
                    -

                    Brings portal markers to the front of the map view, ensuring they are rendered above links and fields.

                    -
                    - - - - - - - - - - - - - - - - - - - - - - - - - -
                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                    - - - - -
                    - - - - -
                    - -

                    - - static window.Render#bringPortalsToFront() - - - - -

                    - - - -
                    -
                    - - -
                    -

                    Brings portal markers to the front of the map view, ensuring they are rendered above links and fields.

                    -
                    - - - - - - - - - - - - - - - - - - - - - - - - - -
                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                    - - - - -
                    - - - - -
                    - -

                    - - static window.Render#clearFieldsOutsideBounds(bounds) - - - - -

                    - - - -
                    -
                    - - -
                    -

                    Clears fields that are outside the specified bounds.

                    -
                    - - - - - - - - - -
                    -
                    Parameters:
                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                    NameTypeDescription
                    bounds - - -L.LatLngBounds - - - -

                    The bounds to check against for field removal.

                    - -
                    - - - - - - - - - - - - - - - - - -
                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                    - - - - -
                    - - - - -
                    - -

                    - - static window.Render#clearFieldsOutsideBounds(bounds) - - - - -

                    - - - -
                    -
                    - - -
                    -

                    Clears fields that are outside the specified bounds.

                    -
                    - - - - - - - - - -
                    -
                    Parameters:
                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                    NameTypeDescription
                    bounds - - -L.LatLngBounds - - - -

                    The bounds to check against for field removal.

                    - -
                    - - - - - - - - - - - - - - - - - -
                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                    - - - - -
                    - - - - -
                    - -

                    - - static window.Render#clearLinksOutsideBounds(bounds) - - - - -

                    - - - -
                    -
                    - - -
                    -

                    Clears links that are outside the specified bounds.

                    -
                    - - - - - - - - - -
                    -
                    Parameters:
                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                    NameTypeDescription
                    bounds - - -L.LatLngBounds - - - -

                    The bounds to check against for link removal.

                    - -
                    - - - - - - - - - - - - - - - - - -
                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                    - - - - -
                    - - - - -
                    - -

                    - - static window.Render#clearLinksOutsideBounds(bounds) - - - - -

                    - - - -
                    -
                    - - -
                    -

                    Clears links that are outside the specified bounds.

                    -
                    - - - - - - - - - -
                    -
                    Parameters:
                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                    NameTypeDescription
                    bounds - - -L.LatLngBounds - - - -

                    The bounds to check against for link removal.

                    - -
                    - - - - - - - - - - - - - - - - - -
                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                    - - - - -
                    - - - - -
                    - -

                    - - static window.Render#clearPortalsOutsideBounds(bounds) - - - - -

                    - - - -
                    -
                    - - -
                    -

                    Clears portals outside the specified bounds.

                    -
                    - - - - - - - - - -
                    -
                    Parameters:
                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                    NameTypeDescription
                    bounds - - -L.LatLngBounds - - - -

                    The bounds to check against.

                    - -
                    - - - - - - - - - - - - - - - - - -
                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                    - - - - -
                    - - - - -
                    - -

                    - - static window.Render#clearPortalsOutsideBounds(bounds) - - - - -

                    - - - -
                    -
                    - - -
                    -

                    Clears portals outside the specified bounds.

                    -
                    - - - - - - - - - -
                    -
                    Parameters:
                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                    NameTypeDescription
                    bounds - - -L.LatLngBounds - - - -

                    The bounds to check against.

                    - -
                    - - - - - - - - - - - - - - - - - -
                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                    - - - - -
                    - - - - -
                    - -

                    - - static window.Render#createFieldEntity(ent) - - - - -

                    - - - -
                    -
                    - - -
                    -

                    Creates a field entity from the provided game entity data.

                    -
                    - - - - - - - - - -
                    -
                    Parameters:
                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                    NameTypeDescription
                    ent - - -Array - - - -

                    An array representing the game entity.

                    - -
                    - - - - - - - - - - - - - - - - - -
                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                    - - - - -
                    - - - - -
                    - -

                    - - static window.Render#createFieldEntity(ent) - - - - -

                    - - - -
                    -
                    - - -
                    -

                    Creates a field entity from the provided game entity data.

                    -
                    - - - - - - - - - -
                    -
                    Parameters:
                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                    NameTypeDescription
                    ent - - -Array - - - -

                    An array representing the game entity.

                    - -
                    - - - - - - - - - - - - - - - - - -
                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                    - - - - -
                    - - - - -
                    - -

                    - - static window.Render#createLinkEntity(ent) - - - - -

                    - - - -
                    -
                    - - -
                    -

                    Creates a link entity from the provided game entity data.

                    -
                    - - - - - - - - - -
                    -
                    Parameters:
                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                    NameTypeDescription
                    ent - - -Array - - - -

                    An array representing the game entity.

                    - -
                    - - - - - - - - - - - - - - - - - -
                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                    - - - - -
                    - - - - -
                    - -

                    - - static window.Render#createLinkEntity(ent) - - - - -

                    - - - -
                    -
                    - - -
                    -

                    Creates a link entity from the provided game entity data.

                    -
                    - - - - - - - - - -
                    -
                    Parameters:
                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                    NameTypeDescription
                    ent - - -Array - - - -

                    An array representing the game entity.

                    - -
                    - - - - - - - - - - - - - - - - - -
                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                    - - - - -
                    - - - - -
                    - -

                    - - static window.Render#createPlaceholderPortalEntity(guid, latE6, lngE6, team, timestampopt) - - - - -

                    - - - -
                    -
                    - - -
                    -

                    Creates a placeholder portal entity. This is used when the portal is not fully loaded, -but its existence is known from links/fields.

                    -
                    - - - - - - - - - -
                    -
                    Parameters:
                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                    NameTypeAttributesDescription
                    guid - - -string - - - - - - - - - -

                    The globally unique identifier of the portal.

                    latE6 - - -number - - - - - - - - - -

                    The latitude of the portal in E6 format.

                    lngE6 - - -number - - - - - - - - - -

                    The longitude of the portal in E6 format.

                    team - - -string - - - - - - - - - -

                    The team faction of the portal.

                    timestamp - - -number - - - - - - <optional>
                    - - - - - -

                    The timestamp of the portal data.

                    - -
                    - - - - - - - - - - - - - - - - - -
                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                    - - - - -
                    - - - - -
                    - -

                    - - static window.Render#createPlaceholderPortalEntity(guid, latE6, lngE6, team, timestampopt) - - - - -

                    - - - -
                    -
                    - - -
                    -

                    Creates a placeholder portal entity. This is used when the portal is not fully loaded, -but its existence is known from links/fields.

                    -
                    - - - - - - - - - -
                    -
                    Parameters:
                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                    NameTypeAttributesDescription
                    guid - - -string - - - - - - - - - -

                    The globally unique identifier of the portal.

                    latE6 - - -number - - - - - - - - - -

                    The latitude of the portal in E6 format.

                    lngE6 - - -number - - - - - - - - - -

                    The longitude of the portal in E6 format.

                    team - - -string - - - - - - - - - -

                    The team faction of the portal.

                    timestamp - - -number - - - - - - <optional>
                    - - - - - -

                    The timestamp of the portal data.

                    - -
                    - - - - - - - - - - - - - - - - - -
                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                    - - - - -
                    - - - - -
                    - -

                    - - static window.Render#createPortalEntity(ent, details) - - - - -

                    - - - -
                    -
                    - - -
                    -

                    Creates a portal entity from the provided game entity data. -If the portal already exists and the new data is more recent, it replaces the existing data.

                    -
                    - - - - - - - - - -
                    -
                    Parameters:
                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                    NameTypeDescription
                    ent - - -Array - - - -

                    An array representing the game entity.

                    details - - -string - - - -

                    Detail level expected in window.decodeArray.portal (e.g., 'core', 'summary').

                    - -
                    - - - - - - - - - - - - - - - - - -
                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                    - - - - -
                    - - - - -
                    - -

                    - - static window.Render#createPortalEntity(ent, details) - - - - -

                    - - - -
                    -
                    - - -
                    -

                    Creates a portal entity from the provided game entity data. -If the portal already exists and the new data is more recent, it replaces the existing data.

                    -
                    - - - - - - - - - -
                    -
                    Parameters:
                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                    NameTypeDescription
                    ent - - -Array - - - -

                    An array representing the game entity.

                    details - - -string - - - -

                    Detail level expected in window.decodeArray.portal (e.g., 'core', 'summary').

                    - -
                    - - - - - - - - - - - - - - - - - -
                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                    - - - - -
                    - - - - -
                    - -

                    - - static window.Render#deleteEntity(guid) - - - - -

                    - - - -
                    -
                    - - -
                    -

                    Deletes an entity (portal, link, or field) from the map based on its GUID.

                    -
                    - - - - - - - - - -
                    -
                    Parameters:
                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                    NameTypeDescription
                    guid - - -string - - - -

                    The globally unique identifier of the entity to delete.

                    - -
                    - - - - - - - - - - - - - - - - - -
                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                    - - - - -
                    - - - - -
                    - -

                    - - static window.Render#deleteEntity(guid) - - - - -

                    - - - -
                    -
                    - - -
                    -

                    Deletes an entity (portal, link, or field) from the map based on its GUID.

                    -
                    - - - - - - - - - -
                    -
                    Parameters:
                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                    NameTypeDescription
                    guid - - -string - - - -

                    The globally unique identifier of the entity to delete.

                    - -
                    - - - - - - - - - - - - - - - - - -
                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                    - - - - -
                    - - - - -
                    - -

                    - - static window.Render#deleteFieldEntity(guid) - - - - -

                    - - - -
                    -
                    - - -
                    -

                    Deletes a field entity from the map based on its GUID.

                    -
                    - - - - - - - - - -
                    -
                    Parameters:
                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                    NameTypeDescription
                    guid - - -string - - - -

                    The globally unique identifier of the field to delete.

                    - -
                    - - - - - - - - - - - - - - - - - -
                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                    - - - - -
                    - - - - -
                    - -

                    - - static window.Render#deleteFieldEntity(guid) - - - - -

                    - - - -
                    -
                    - - -
                    -

                    Deletes a field entity from the map based on its GUID.

                    -
                    - - - - - - - - - -
                    -
                    Parameters:
                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                    NameTypeDescription
                    guid - - -string - - - -

                    The globally unique identifier of the field to delete.

                    - -
                    - - - - - - - - - - - - - - - - - -
                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                    - - - - -
                    - - - - -
                    - -

                    - - static window.Render#deleteLinkEntity(guid) - - - - -

                    - - - -
                    -
                    - - -
                    -

                    Deletes a link entity from the map based on its GUID.

                    -
                    - - - - - - - - - -
                    -
                    Parameters:
                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                    NameTypeDescription
                    guid - - -string - - - -

                    The globally unique identifier of the link to delete.

                    - -
                    - - - - - - - - - - - - - - - - - -
                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                    - - - - -
                    - - - - -
                    - -

                    - - static window.Render#deleteLinkEntity(guid) - - - - -

                    - - - -
                    -
                    - - -
                    -

                    Deletes a link entity from the map based on its GUID.

                    -
                    - - - - - - - - - -
                    -
                    Parameters:
                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                    NameTypeDescription
                    guid - - -string - - - -

                    The globally unique identifier of the link to delete.

                    - -
                    - - - - - - - - - - - - - - - - - -
                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                    - - - - -
                    - - - - -
                    - -

                    - - static window.Render#deletePortalEntity(guid) - - - - -

                    - - - -
                    -
                    - - -
                    -

                    Deletes a portal entity from the map based on its GUID.

                    -
                    - - - - - - - - - -
                    -
                    Parameters:
                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                    NameTypeDescription
                    guid - - -string - - - -

                    The globally unique identifier of the portal to delete.

                    - -
                    - - - - - - - - - - - - - - - - - -
                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                    - - - - -
                    - - - - -
                    - -

                    - - static window.Render#deletePortalEntity(guid) - - - - -

                    - - - -
                    -
                    - - -
                    -

                    Deletes a portal entity from the map based on its GUID.

                    -
                    - - - - - - - - - -
                    -
                    Parameters:
                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                    NameTypeDescription
                    guid - - -string - - - -

                    The globally unique identifier of the portal to delete.

                    - -
                    - - - - - - - - - - - - - - - - - -
                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                    - - - - -
                    - - - - -
                    - -

                    - - static window.Render#endRenderPass() - - - - -

                    - - - -
                    -
                    - - -
                    -

                    Ends a render pass. This includes cleanup and processing of any remaining data. -Called when the render is considered complete.

                    -
                    - - - - - - - - - - - - - - - - - - - - - - - - - -
                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                    - - - - -
                    - - - - -
                    - -

                    - - static window.Render#endRenderPass() - - - - -

                    - - - -
                    -
                    - - -
                    -

                    Ends a render pass. This includes cleanup and processing of any remaining data. -Called when the render is considered complete.

                    -
                    - - - - - - - - - - - - - - - - - - - - - - - - - -
                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                    - - - - -
                    - - - - -
                    - -

                    - - static window.Render#processDeletedGameEntityGuids(deleted) - - - - -

                    - - - -
                    -
                    - - -
                    -

                    Processes deleted game entity GUIDs and removes them from the map.

                    -
                    - - - - - - - - - -
                    -
                    Parameters:
                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                    NameTypeDescription
                    deleted - - -Array - - - -

                    Array of deleted game entity GUIDs.

                    - -
                    - - - - - - - - - - - - - - - - - -
                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                    - - - - -
                    - - - - -
                    - -

                    - - static window.Render#processDeletedGameEntityGuids(deleted) - - - - -

                    - - - -
                    -
                    - - -
                    -

                    Processes deleted game entity GUIDs and removes them from the map.

                    -
                    - - - - - - - - - -
                    -
                    Parameters:
                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                    NameTypeDescription
                    deleted - - -Array - - - -

                    Array of deleted game entity GUIDs.

                    - -
                    - - - - - - - - - - - - - - - - - -
                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                    - - - - -
                    - - - - -
                    - -

                    - - static window.Render#processGameEntities(entities, details) - - - - -

                    - - - -
                    -
                    - - -
                    -

                    Processes game entities (fields, links, portals) and creates them on the map.

                    -
                    - - - - - - - - - -
                    -
                    Parameters:
                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                    NameTypeDescription
                    entities - - -Array - - - -

                    Array of game entities.

                    details - - -Object - - - -

                    Details for the window.decodeArray.portal function.

                    - -
                    - - - - - - - - - - - - - - - - - -
                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                    - - - - -
                    - - - - -
                    - -

                    - - static window.Render#processGameEntities(entities, details) - - - - -

                    - - - -
                    -
                    - - -
                    -

                    Processes game entities (fields, links, portals) and creates them on the map.

                    -
                    - - - - - - - - - -
                    -
                    Parameters:
                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                    NameTypeDescription
                    entities - - -Array - - - -

                    Array of game entities.

                    details - - -Object - - - -

                    Details for the window.decodeArray.portal function.

                    - -
                    - - - - - - - - - - - - - - - - - -
                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                    - - - - -
                    - - - - -
                    - -

                    - - static window.Render#processTileData(tiledata) - - - - -

                    - - - -
                    -
                    - - -
                    -

                    Processes tile data including deleted entity GUIDs and game entities.

                    -
                    - - - - - - - - - -
                    -
                    Parameters:
                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                    NameTypeDescription
                    tiledata - - -Object - - - -

                    Data for a specific map tile.

                    - -
                    - - - - - - - - - + @@ -10696,14 +2179,14 @@
                    Parameters:
                    -

                    +

                    - static window.Render#processTileData(tiledata) + static window.Render#processDeletedGameEntityGuids(deleted)

                    @@ -10715,7 +2198,7 @@

                    -

                    Processes tile data including deleted entity GUIDs and game entities.

                    +

                    Processes deleted game entity GUIDs and removes them from the map.

                    @@ -10751,13 +2234,13 @@

                    Parameters:
                    - tiledata + deleted -Object +Array @@ -10767,7 +2250,7 @@
                    Parameters:
                    -

                    Data for a specific map tile.

                    +

                    Array of deleted game entity GUIDs.

                    @@ -10835,14 +2318,14 @@
                    Parameters:
                    -

                    +

                    - static window.Render#removePortalFromMapLayer(portal) + static window.Render#processGameEntities(entities, details)

                    @@ -10854,7 +2337,7 @@

                    -

                    Removes a portal from the visible map layer.

                    +

                    Processes game entities (fields, links, portals) and creates them on the map.

                    @@ -10890,7 +2373,30 @@

                    Parameters:
                    - portal + entities + + + + + +Array + + + + + + + + + +

                    Array of game entities.

                    + + + + + + + details @@ -10906,7 +2412,7 @@
                    Parameters:
                    -

                    The portal object to remove from the map layer.

                    +

                    Details for the window.decodeArray.portal function.

                    @@ -10974,14 +2480,14 @@
                    Parameters:
                    -

                    +

                    - static window.Render#removePortalFromMapLayer(portal) + static window.Render#processTileData(tiledata)

                    @@ -10993,7 +2499,7 @@

                    -

                    Removes a portal from the visible map layer.

                    +

                    Processes tile data including deleted entity GUIDs and game entities.

                    @@ -11029,7 +2535,7 @@

                    Parameters:
                    - portal + tiledata @@ -11045,7 +2551,7 @@
                    Parameters:
                    -

                    The portal object to remove from the map layer.

                    +

                    Data for a specific map tile.

                    @@ -11113,14 +2619,14 @@
                    Parameters:
                    -

                    +

                    - static window.Render#rescalePortalMarkers() + static window.Render#removePortalFromMapLayer(portal)

                    @@ -11132,7 +2638,7 @@

                    -

                    Rescales portal markers based on the current map zoom level.

                    +

                    Removes a portal from the visible map layer.

                    @@ -11143,94 +2649,55 @@

                    +
                    +
                    Parameters:
                    + + + + + + + - - - - - - - - - - - - - - - -
                    - - - - - - - - - - - - - - - - - - - - - - - - - - +
                    - + - - + + + + + - - + + + - -
                    - -

                    +

                    - + - + + + + + +
                    NameTypeDescription
                    portal - static window.Render#rescalePortalMarkers() - - - - +Object - - - -
                    - -
                    -

                    Rescales portal markers based on the current map zoom level.

                    -
                    - + +

                    The portal object to remove from the map layer.

                    +
                    @@ -11291,14 +2758,14 @@

                    -

                    +

                    - static window.Render#startRenderPass(bounds) + static window.Render#rescalePortalMarkers()

                    @@ -11310,7 +2777,7 @@

                    -

                    Initiates a render pass. It's called at the start of making a batch of data requests to the servers.

                    +

                    Rescales portal markers based on the current map zoom level.

                    @@ -11321,56 +2788,6 @@

                    -
                    -
                    Parameters:
                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                    NameTypeDescription
                    bounds - - -L.LatLngBounds - - - -

                    The bounds within which the render pass will occur.

                    - -
                    - diff --git a/RenderDebugTiles.html b/RenderDebugTiles.html index 95a64e052..78b3dac21 100644 --- a/RenderDebugTiles.html +++ b/RenderDebugTiles.html @@ -34,7 +34,7 @@

                    IITC-CE

                      - +
                      @@ -311,257 +311,6 @@
                      Parameters:
                      - - - - - - - - - - -

                      - - - - - - - - - -
                      - -

                      - - static window.RenderDebugTiles#create(id, bounds) - - - - -

                      - - - -
                      -
                      - - -
                      -

                      Creates a new debug tile with the specified ID and bounds.

                      -
                      - - - - - - - - - -
                      -
                      Parameters:
                      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                      NameTypeDescription
                      id - - -string - - - -

                      The ID of the debug tile.

                      bounds - - -L.LatLngBounds - - - -

                      The geographical bounds of the tile.

                      - -
                      - - - - - - - - - - - - - - - - - -
                      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                      - - - - -
                      - - - - -
                      - -

                      - - static window.RenderDebugTiles#reset() - - - - -

                      - - - -
                      -
                      - - -
                      -

                      Resets the debug tiles by clearing all layers, rectangles and clear times.

                      -
                      - - - - - - - - - - - - - - - - - - - - - - - - - -
                      - - - - - - - - - - - - - - - - - - - - @@ -586,2258 +335,12 @@

                      - static window.RenderDebugTiles#reset() - - - - -

                      - - - - -
                      - - -
                      -

                      Resets the debug tiles by clearing all layers, rectangles and clear times.

                      -
                      - - - - - - - - - - - - - - - - - - - - - - - - - -
                      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                      - - - - -
                      - - - - -
                      - -

                      - - static window.RenderDebugTiles#runClearPass() - - - - -

                      - - - -
                      -
                      - - -
                      -

                      Executes a pass to clear debug tiles that have exceeded their fade time. -This function adjusts the opacity of the tiles and removes them if necessary.

                      -
                      - - - - - - - - - - - - - - - - - - - - - - - - - -
                      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                      - - - - -
                      - - - - -
                      - -

                      - - static window.RenderDebugTiles#runClearPass() - - - - -

                      - - - -
                      -
                      - - -
                      -

                      Executes a pass to clear debug tiles that have exceeded their fade time. -This function adjusts the opacity of the tiles and removes them if necessary.

                      -
                      - - - - - - - - - - - - - - - - - - - - - - - - - -
                      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                      - - - - -
                      - - - - -
                      - -

                      - - static window.RenderDebugTiles#setColour(id, bordercol, fillcol) - - - - -

                      - - - -
                      -
                      - - -
                      -

                      Sets the color of the border and fill for a specific debug tile.

                      -
                      - - - - - - - - - -
                      -
                      Parameters:
                      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                      NameTypeDescription
                      id - - -string - - - -

                      The ID of the debug tile.

                      bordercol - - -string - - - -

                      The color for the border.

                      fillcol - - -string - - - -

                      The color for the fill.

                      - -
                      - - - - - - - - - - - - - - - - - -
                      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                      - - - - -
                      - - - - -
                      - -

                      - - static window.RenderDebugTiles#setColour(id, bordercol, fillcol) - - - - -

                      - - - -
                      -
                      - - -
                      -

                      Sets the color of the border and fill for a specific debug tile.

                      -
                      - - - - - - - - - -
                      -
                      Parameters:
                      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                      NameTypeDescription
                      id - - -string - - - -

                      The ID of the debug tile.

                      bordercol - - -string - - - -

                      The color for the border.

                      fillcol - - -string - - - -

                      The color for the fill.

                      - -
                      - - - - - - - - - - - - - - - - - -
                      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                      - - - - -
                      - - - - -
                      - -

                      - - static window.RenderDebugTiles#setState(id, state) - - - - -

                      - - - -
                      -
                      - - -
                      -

                      Sets the state of a specific debug tile. Changes its color based on the state.

                      -
                      - - - - - - - - - -
                      -
                      Parameters:
                      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                      NameTypeDescription
                      id - - -string - - - -

                      The ID of the debug tile.

                      state - - -string - - - -

                      The state of the tile (e.g., 'ok', 'error', 'requested').

                      - -
                      - - - - - - - - - - - - - - - - - -
                      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                      - - - - -
                      - - - - -
                      - -

                      - - static window.RenderDebugTiles#setState(id, state) - - - - -

                      - - - -
                      -
                      - - -
                      -

                      Sets the state of a specific debug tile. Changes its color based on the state.

                      -
                      - - - - - - - - - -
                      -
                      Parameters:
                      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                      NameTypeDescription
                      id - - -string - - - -

                      The ID of the debug tile.

                      state - - -string - - - -

                      The state of the tile (e.g., 'ok', 'error', 'requested').

                      - -
                      - - - - - - - - - - - - - - - - - -
                      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                      - - - - -
                      - - - - -
                      - -

                      - - static window.RenderDebugTiles#startTimer(waitTime) - - - - -

                      - - - -
                      -
                      - - -
                      -

                      Starts a timer to run the clear pass function after a specified wait time.

                      -
                      - - - - - - - - - -
                      -
                      Parameters:
                      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                      NameTypeDescription
                      waitTime - - -number - - - -

                      The wait time in milliseconds before running the clear pass.

                      - -
                      - - - - - - - - - - - - - - - - - -
                      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                      - - - - -
                      - - - - -
                      - -

                      - - static window.RenderDebugTiles#startTimer(waitTime) - - - - -

                      - - - -
                      -
                      - - -
                      -

                      Starts a timer to run the clear pass function after a specified wait time.

                      -
                      - - - - - - - - - -
                      -
                      Parameters:
                      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                      NameTypeDescription
                      waitTime - - -number - - - -

                      The wait time in milliseconds before running the clear pass.

                      - -
                      - - - - - - - - - - - - - - - - - -
                      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                      - - - - -
                      - -
                      - - - - - -
                      - -
                      - - - - - - - -
                      - -
                      - -

                      RenderDebugTiles()

                      - - -
                      - -
                      - -
                      - - - -
                      - -

                      - - new RenderDebugTiles() - - - - -

                      - - - -
                      -
                      - - -
                      -

                      Contains functions for rendering debug tiles on the map. These are used for debugging map data tiles.

                      -
                      - - - - - - - - - - - - - - - - - - - - - - - - - -
                      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                      - - - - -
                      - - -
                      - - - - - - - - - - - - - - - - - -

                      Methods

                      - -
                      - - -
                      - -

                      - - static window.RenderDebugTiles#create(id, bounds) - - - - -

                      - - - -
                      -
                      - - -
                      -

                      Creates a new debug tile with the specified ID and bounds.

                      -
                      - - - - - - - - - -
                      -
                      Parameters:
                      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                      NameTypeDescription
                      id - - -string - - - -

                      The ID of the debug tile.

                      bounds - - -L.LatLngBounds - - - -

                      The geographical bounds of the tile.

                      - -
                      - - - - - - - - - - - - - - - - - -
                      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                      - - - - -
                      - - - - -
                      - -

                      - - static window.RenderDebugTiles#create(id, bounds) - - - - -

                      - - - -
                      -
                      - - -
                      -

                      Creates a new debug tile with the specified ID and bounds.

                      -
                      - - - - - - - - - -
                      -
                      Parameters:
                      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                      NameTypeDescription
                      id - - -string - - - -

                      The ID of the debug tile.

                      bounds - - -L.LatLngBounds - - - -

                      The geographical bounds of the tile.

                      - -
                      - - - - - - - - - - - - - - - - - -
                      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                      - - - - -
                      - - - - -
                      - -

                      - - static window.RenderDebugTiles#reset() - - - - -

                      - - - -
                      -
                      - - -
                      -

                      Resets the debug tiles by clearing all layers, rectangles and clear times.

                      -
                      - - - - - - - - - - - - - - - - - - - - - - - - - -
                      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                      - - - - -
                      - - - - -
                      - -

                      - - static window.RenderDebugTiles#reset() - - - - -

                      - - - -
                      -
                      - - -
                      -

                      Resets the debug tiles by clearing all layers, rectangles and clear times.

                      -
                      - - - - - - - - - - - - - - - - - - - - - - - - - -
                      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                      - - - - -
                      - - - - -
                      - -

                      - - static window.RenderDebugTiles#runClearPass() - - - - -

                      - - - -
                      -
                      - - -
                      -

                      Executes a pass to clear debug tiles that have exceeded their fade time. -This function adjusts the opacity of the tiles and removes them if necessary.

                      -
                      - - - - - - - - - - - - - - - - - - - - - - - - - -
                      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                      - - - - -
                      - - - - -
                      - -

                      - - static window.RenderDebugTiles#runClearPass() - - - - -

                      - - - -
                      -
                      - - -
                      -

                      Executes a pass to clear debug tiles that have exceeded their fade time. -This function adjusts the opacity of the tiles and removes them if necessary.

                      -
                      - - - - - - - - - - - - - - - - - - - - - - - - - -
                      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                      - - - - -
                      - - - - -
                      - -

                      - - static window.RenderDebugTiles#setColour(id, bordercol, fillcol) - - - - -

                      - - - -
                      -
                      - - -
                      -

                      Sets the color of the border and fill for a specific debug tile.

                      -
                      - - - - - - - - - -
                      -
                      Parameters:
                      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                      NameTypeDescription
                      id - - -string - - - -

                      The ID of the debug tile.

                      bordercol - - -string - - - -

                      The color for the border.

                      fillcol - - -string - - - -

                      The color for the fill.

                      - -
                      - - - - - - - - - - - - - - - - - -
                      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                      - - - - -
                      - - - - -
                      - -

                      - - static window.RenderDebugTiles#setColour(id, bordercol, fillcol) + static window.RenderDebugTiles#reset()

                      @@ -2849,7 +352,7 @@

                      -

                      Sets the color of the border and fill for a specific debug tile.

                      +

                      Resets the debug tiles by clearing all layers, rectangles and clear times.

                      @@ -2860,102 +363,6 @@

                      -
                      -
                      Parameters:
                      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                      NameTypeDescription
                      id - - -string - - - -

                      The ID of the debug tile.

                      bordercol - - -string - - - -

                      The color for the border.

                      fillcol - - -string - - - -

                      The color for the fill.

                      - -
                      - @@ -3015,14 +422,14 @@

                      Parameters:
                      -

                      +

                      - static window.RenderDebugTiles#setState(id, state) + static window.RenderDebugTiles#runClearPass()

                      @@ -3034,7 +441,8 @@

                      -

                      Sets the state of a specific debug tile. Changes its color based on the state.

                      +

                      Executes a pass to clear debug tiles that have exceeded their fade time. +This function adjusts the opacity of the tiles and removes them if necessary.

                      @@ -3045,79 +453,6 @@

                      -
                      -
                      Parameters:
                      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                      NameTypeDescription
                      id - - -string - - - -

                      The ID of the debug tile.

                      state - - -string - - - -

                      The state of the tile (e.g., 'ok', 'error', 'requested').

                      - -
                      - @@ -3177,14 +512,14 @@

                      Parameters:
                      -

                      +

                      - static window.RenderDebugTiles#setState(id, state) + static window.RenderDebugTiles#setColour(id, bordercol, fillcol)

                      @@ -3196,7 +531,7 @@

                      -

                      Sets the state of a specific debug tile. Changes its color based on the state.

                      +

                      Sets the color of the border and fill for a specific debug tile.

                      @@ -3255,7 +590,7 @@

                      Parameters:
                      - state + bordercol @@ -3271,7 +606,30 @@
                      Parameters:
                      -

                      The state of the tile (e.g., 'ok', 'error', 'requested').

                      +

                      The color for the border.

                      + + + + + + + fillcol + + + + + +string + + + + + + + + + +

                      The color for the fill.

                      @@ -3339,14 +697,14 @@
                      Parameters:
                      -

                      +

                      - static window.RenderDebugTiles#startTimer(waitTime) + static window.RenderDebugTiles#setState(id, state)

                      @@ -3358,7 +716,7 @@

                      -

                      Starts a timer to run the clear pass function after a specified wait time.

                      +

                      Sets the state of a specific debug tile. Changes its color based on the state.

                      @@ -3394,13 +752,13 @@

                      Parameters:
                      - waitTime + id -number +string @@ -3410,7 +768,30 @@
                      Parameters:
                      -

                      The wait time in milliseconds before running the clear pass.

                      +

                      The ID of the debug tile.

                      + + + + + + + state + + + + + +string + + + + + + + + + +

                      The state of the tile (e.g., 'ok', 'error', 'requested').

                      diff --git a/code__deprecated.js.html b/code__deprecated.js.html index 9bc1aa801..6705cc71b 100644 --- a/code__deprecated.js.html +++ b/code__deprecated.js.html @@ -36,7 +36,7 @@

                      IITC-CE

                        - +
                        diff --git a/code_app.js.html b/code_app.js.html index 326877395..dc3400e8b 100644 --- a/code_app.js.html +++ b/code_app.js.html @@ -36,7 +36,7 @@

                        IITC-CE

                          - +
                          diff --git a/code_artifact.js.html b/code_artifact.js.html index e9e382c23..6e443d928 100644 --- a/code_artifact.js.html +++ b/code_artifact.js.html @@ -36,7 +36,7 @@

                          IITC-CE

                            - +
                            diff --git a/code_boot.js.html b/code_boot.js.html index 88e8eb521..32fdb9207 100644 --- a/code_boot.js.html +++ b/code_boot.js.html @@ -36,7 +36,7 @@

                            IITC-CE

                              - +
                              diff --git a/code_chat.js.html b/code_chat.js.html index d8dc607d8..7b9d2fe4f 100644 --- a/code_chat.js.html +++ b/code_chat.js.html @@ -36,7 +36,7 @@

                              IITC-CE

                                - +
                                diff --git a/code_data_cache.js.html b/code_data_cache.js.html index 369603e67..433a40230 100644 --- a/code_data_cache.js.html +++ b/code_data_cache.js.html @@ -36,7 +36,7 @@

                                IITC-CE

                                  - +
                                  diff --git a/code_dialog.js.html b/code_dialog.js.html index aa65ce5ab..abc9c0183 100644 --- a/code_dialog.js.html +++ b/code_dialog.js.html @@ -36,7 +36,7 @@

                                  IITC-CE

                                    - +
                                    diff --git a/code_dialog_about.js.html b/code_dialog_about.js.html index 00e6884f9..9cb16fd9d 100644 --- a/code_dialog_about.js.html +++ b/code_dialog_about.js.html @@ -36,7 +36,7 @@

                                    IITC-CE

                                      - +
                                      diff --git a/code_entity_decode.js.html b/code_entity_decode.js.html index 2bbfee74b..af032a715 100644 --- a/code_entity_decode.js.html +++ b/code_entity_decode.js.html @@ -36,7 +36,7 @@

                                      IITC-CE

                                        - +
                                        diff --git a/code_entity_info.js.html b/code_entity_info.js.html index bf651a192..2fd187766 100644 --- a/code_entity_info.js.html +++ b/code_entity_info.js.html @@ -36,7 +36,7 @@

                                        IITC-CE

                                          - +
                                          diff --git a/code_extract_niantic_parameters.js.html b/code_extract_niantic_parameters.js.html index 0fbb10382..df88d1cd9 100644 --- a/code_extract_niantic_parameters.js.html +++ b/code_extract_niantic_parameters.js.html @@ -36,7 +36,7 @@

                                          IITC-CE

                                            - +
                                            diff --git a/code_filters.js.html b/code_filters.js.html index 250f32cdf..e7f07efe6 100644 --- a/code_filters.js.html +++ b/code_filters.js.html @@ -36,7 +36,7 @@

                                            IITC-CE

                                              - +
                                              @@ -50,11 +50,65 @@

                                              IITC-CE

                                              /* global IITC, L */
                                               
                                              -/** # Filters API
                                              -
                                              -  @memberof IITC
                                              -  @namespace filters
                                              -*/
                                              +/**
                                              + * ### Filters API
                                              + *
                                              + * Filters API is a mechanism to hide intel entities using their properties (faction,
                                              + * health, timestamp...). It provides two level APIs: a set of named filters that
                                              + * apply globally (any entity matching one of the filters will be hidden), and low
                                              + * level API to test an entity against a filter for generic purpose.
                                              + * This comes with a Leaflet layer system following the old layer system, the filter
                                              + * is disabled when the layer is added to the map and is enabled when removed.
                                              + *
                                              + * A filter applies to a combinaison of portal/link/field and is described by
                                              + *  - data properties that must (all) match
                                              + *  - or a predicate for complex filter
                                              + *
                                              + *   `{ portal: true, link: true, data: { team: 'E' }}`
                                              + *       filters any ENL portal/link
                                              + *
                                              + *   `[{ link: true, data: { oGuid: "some guid" }}, { link: true, data: { dGuid: "some guid" }}]`
                                              + *       filters any links on portal with guid "some guid"
                                              + *
                                              + *   `{ field: true, pred: function (f) { return f.options.timestamp < Date.parse('2021-10-31'); } }`
                                              + *       filters any fields made before Halloween 2021
                                              + *
                                              + * Data properties can be specified as value, or as a complex expression (required
                                              + * for array data properties). A complex expression is a 2-array, first element is
                                              + * an operator, second is the argument of the operator for the property.
                                              + * The operators are:
                                              + *  - `['eq', value]` : this is equivalent to type directly `value`
                                              + *  - `['not', ]`
                                              + *  - `['or', [exp1, exp2,...]]`: the expression matches if one of the exp1.. matches
                                              + *  - `['and', [exp1, exp2...]]`: matches if all exp1 matches (useful for array
                                              + *   properties)
                                              + *  - `['some', exp]`: when the property is an array, matches if one of the element
                                              + *   matches `exp`
                                              + *  - `['every', exp]`: all elements must match `exp`
                                              + *  - `['<', number]`: for number comparison (and <= > >=)
                                              + *
                                              + * Examples:
                                              + *
                                              + *   `{ portal: true, data:  ['not', { history: { scoutControlled: false }, ornaments:
                                              + *   ['some', 'sc5_p'] }] }`
                                              + *       filters all portals but the one never scout controlled that have a scout
                                              + *       volatile ornament
                                              + *
                                              + *   `{ portal: true, data: ['not', { resonators: ['every', { owner: 'some agent' } ] } ] }`
                                              + *       filters all portals that have resonators not owned from 'some agent'
                                              + *       (note: that would need to load portal details)
                                              + *
                                              + *   `{ portal: true, data: { level: ['or', [1,4,5]], health: ['>', 85] } }`
                                              + *       filters all portals with level 1,4 or 5 and health over 85
                                              + *
                                              + *   `{ portal: true, link: true, field: true, options: { timestamp: ['<',
                                              + *   Date.now() - 3600000] } }`
                                              + *       filters all entities with no change since 1 hour (from the creation of
                                              + *       the filter)
                                              + *
                                              + * @memberof IITC
                                              + * @namespace filters
                                              + */
                                               
                                               IITC.filters = {};
                                               /**
                                              diff --git a/code_game_status.js.html b/code_game_status.js.html
                                              index 7f0ae7dce..61eaad1bb 100644
                                              --- a/code_game_status.js.html
                                              +++ b/code_game_status.js.html
                                              @@ -36,7 +36,7 @@ 

                                              IITC-CE

                                                - +
                                                diff --git a/code_hooks.js.html b/code_hooks.js.html index ab894a6ba..ca2275582 100644 --- a/code_hooks.js.html +++ b/code_hooks.js.html @@ -36,7 +36,7 @@

                                                IITC-CE

                                                  - +
                                                  diff --git a/code_idle.js.html b/code_idle.js.html index 797aa2454..70614a8ed 100644 --- a/code_idle.js.html +++ b/code_idle.js.html @@ -36,7 +36,7 @@

                                                  IITC-CE

                                                    - +
                                                    diff --git a/code_layerchooser.js.html b/code_layerchooser.js.html index cf30873bf..d781a69d3 100644 --- a/code_layerchooser.js.html +++ b/code_layerchooser.js.html @@ -36,7 +36,7 @@

                                                    IITC-CE

                                                      - +
                                                      diff --git a/code_map.js.html b/code_map.js.html index f636c9f1f..01eb38f0d 100644 --- a/code_map.js.html +++ b/code_map.js.html @@ -36,7 +36,7 @@

                                                      IITC-CE

                                                        - +
                                                        diff --git a/code_map_data_calc_tools.js.html b/code_map_data_calc_tools.js.html index b91da64e4..4eff7555f 100644 --- a/code_map_data_calc_tools.js.html +++ b/code_map_data_calc_tools.js.html @@ -36,7 +36,7 @@

                                                        IITC-CE

                                                          - +
                                                          diff --git a/code_map_data_debug.js.html b/code_map_data_debug.js.html index 8edea550b..97ea02976 100644 --- a/code_map_data_debug.js.html +++ b/code_map_data_debug.js.html @@ -36,7 +36,7 @@

                                                          IITC-CE

                                                            - +
                                                            diff --git a/code_map_data_render.js.html b/code_map_data_render.js.html index 7a73f00de..d5a3474c5 100644 --- a/code_map_data_render.js.html +++ b/code_map_data_render.js.html @@ -36,7 +36,7 @@

                                                            IITC-CE

                                                              - +
                                                              diff --git a/code_map_data_request.js.html b/code_map_data_request.js.html index 8118af739..bd269f9bc 100644 --- a/code_map_data_request.js.html +++ b/code_map_data_request.js.html @@ -36,7 +36,7 @@

                                                              IITC-CE

                                                                - +
                                                                diff --git a/code_ornaments.js.html b/code_ornaments.js.html index 722691ced..b1a119986 100644 --- a/code_ornaments.js.html +++ b/code_ornaments.js.html @@ -36,7 +36,7 @@

                                                                IITC-CE

                                                                  - +
                                                                  diff --git a/code_panes.js.html b/code_panes.js.html index b5d7d4777..7a89fa45e 100644 --- a/code_panes.js.html +++ b/code_panes.js.html @@ -36,7 +36,7 @@

                                                                  IITC-CE

                                                                    - +
                                                                    diff --git a/code_player_names.js.html b/code_player_names.js.html index 8b140fefb..acad06dd9 100644 --- a/code_player_names.js.html +++ b/code_player_names.js.html @@ -36,7 +36,7 @@

                                                                    IITC-CE

                                                                      - +
                                                                      diff --git a/code_portal_data.js.html b/code_portal_data.js.html index e938c1c3b..1ee09c819 100644 --- a/code_portal_data.js.html +++ b/code_portal_data.js.html @@ -36,7 +36,7 @@

                                                                      IITC-CE

                                                                        - +
                                                                        diff --git a/code_portal_detail.js.html b/code_portal_detail.js.html index 20d3bc7e3..9f69f0f5d 100644 --- a/code_portal_detail.js.html +++ b/code_portal_detail.js.html @@ -36,7 +36,7 @@

                                                                        IITC-CE

                                                                          - +
                                                                          diff --git a/code_portal_detail_display.js.html b/code_portal_detail_display.js.html index fedfc9b8e..eaf702eb3 100644 --- a/code_portal_detail_display.js.html +++ b/code_portal_detail_display.js.html @@ -36,7 +36,7 @@

                                                                          IITC-CE

                                                                            - +
                                                                            diff --git a/code_portal_detail_display_tools.js.html b/code_portal_detail_display_tools.js.html index 38a70ae5c..1eb7f0e97 100644 --- a/code_portal_detail_display_tools.js.html +++ b/code_portal_detail_display_tools.js.html @@ -36,7 +36,7 @@

                                                                            IITC-CE

                                                                              - +
                                                                              diff --git a/code_portal_highlighter.js.html b/code_portal_highlighter.js.html index 58b175ba7..2d1bdd980 100644 --- a/code_portal_highlighter.js.html +++ b/code_portal_highlighter.js.html @@ -36,7 +36,7 @@

                                                                              IITC-CE

                                                                                - +
                                                                                diff --git a/code_portal_info.js.html b/code_portal_info.js.html index b65890346..7f5f74304 100644 --- a/code_portal_info.js.html +++ b/code_portal_info.js.html @@ -36,7 +36,7 @@

                                                                                IITC-CE

                                                                                  - +
                                                                                  diff --git a/code_portal_marker.js.html b/code_portal_marker.js.html index 37d5daff3..d867561e0 100644 --- a/code_portal_marker.js.html +++ b/code_portal_marker.js.html @@ -36,7 +36,7 @@

                                                                                  IITC-CE

                                                                                    - +
                                                                                    diff --git a/code_redeeming.js.html b/code_redeeming.js.html index 1be6ddf89..ad09423c7 100644 --- a/code_redeeming.js.html +++ b/code_redeeming.js.html @@ -36,7 +36,7 @@

                                                                                    IITC-CE

                                                                                      - +
                                                                                      diff --git a/code_region_scoreboard.js.html b/code_region_scoreboard.js.html index 37462f854..e821ea45e 100644 --- a/code_region_scoreboard.js.html +++ b/code_region_scoreboard.js.html @@ -36,7 +36,7 @@

                                                                                      IITC-CE

                                                                                        - +
                                                                                        diff --git a/code_request_handling.js.html b/code_request_handling.js.html index b5a36cf99..fa18f5f5d 100644 --- a/code_request_handling.js.html +++ b/code_request_handling.js.html @@ -36,7 +36,7 @@

                                                                                        IITC-CE

                                                                                          - +
                                                                                          diff --git a/code_search.js.html b/code_search.js.html index a2b83f443..dc801fc80 100644 --- a/code_search.js.html +++ b/code_search.js.html @@ -36,7 +36,7 @@

                                                                                          IITC-CE

                                                                                            - +
                                                                                            diff --git a/code_send_request.js.html b/code_send_request.js.html index 5a1efe1af..ffe0ca878 100644 --- a/code_send_request.js.html +++ b/code_send_request.js.html @@ -36,7 +36,7 @@

                                                                                            IITC-CE

                                                                                              - +
                                                                                              diff --git a/code_sidebar.js.html b/code_sidebar.js.html index bf33d76dc..4854d9b47 100644 --- a/code_sidebar.js.html +++ b/code_sidebar.js.html @@ -36,7 +36,7 @@

                                                                                              IITC-CE

                                                                                                - +
                                                                                                diff --git a/code_smartphone.js.html b/code_smartphone.js.html index 6186a00d5..7d4ef284a 100644 --- a/code_smartphone.js.html +++ b/code_smartphone.js.html @@ -36,7 +36,7 @@

                                                                                                IITC-CE

                                                                                                  - +
                                                                                                  diff --git a/code_status_bar.js.html b/code_status_bar.js.html index c98337b3c..fdf4c9feb 100644 --- a/code_status_bar.js.html +++ b/code_status_bar.js.html @@ -36,7 +36,7 @@

                                                                                                  IITC-CE

                                                                                                    - +
                                                                                                    diff --git a/code_toolbox.js.html b/code_toolbox.js.html index ab6377a57..eb16902f1 100644 --- a/code_toolbox.js.html +++ b/code_toolbox.js.html @@ -36,7 +36,7 @@

                                                                                                    IITC-CE

                                                                                                      - +
                                                                                                      diff --git a/code_utils_file.js.html b/code_utils_file.js.html index 433f3e789..d11abb8a3 100644 --- a/code_utils_file.js.html +++ b/code_utils_file.js.html @@ -36,7 +36,7 @@

                                                                                                      IITC-CE

                                                                                                        - +
                                                                                                        diff --git a/code_utils_misc.js.html b/code_utils_misc.js.html index ddb1c52d0..c62127d14 100644 --- a/code_utils_misc.js.html +++ b/code_utils_misc.js.html @@ -36,7 +36,7 @@

                                                                                                        IITC-CE

                                                                                                          - +
                                                                                                          diff --git a/config_options.html b/config_options.html index bbfa44ccc..8c0253ca8 100644 --- a/config_options.html +++ b/config_options.html @@ -34,7 +34,7 @@

                                                                                                          IITC-CE

                                                                                                            - +
                                                                                                            @@ -180,166 +180,6 @@
                                                                                                            Type:
                                                                                                            - - - - - - - - - - -
                                                                                                            - - - - - - - - - - -
                                                                                                            -

                                                                                                            - static window.ACCESS_INDICATOR_COLOR :string - - - -

                                                                                                            - - -
                                                                                                            -
                                                                                                            - -
                                                                                                            -

                                                                                                            What colour should the hacking range circle be (the small circle that appears around a selected portal, -marking a ~40 metre radius), string(css colour value), default ‘orange’

                                                                                                            -
                                                                                                            - - - - - - - -
                                                                                                            - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                            - - - - - -
                                                                                                            - - - - -
                                                                                                            -

                                                                                                            - static window.CHAT_REQUEST_SCROLL_TOP :number - - - -

                                                                                                            - - -
                                                                                                            -
                                                                                                            - -
                                                                                                            -

                                                                                                            Controls requesting chat data based on the pixel distance from the line currently in view -and the top of history, in pixels, default 200

                                                                                                            -
                                                                                                            - - - - - - - -
                                                                                                            - - - - - - - - - - - - - - - - - - - - @@ -499,85 +339,6 @@
                                                                                                            Type:
                                                                                                            - - - - - - - - - - -
                                                                                                            - - - - - -
                                                                                                            - - - - -
                                                                                                            -

                                                                                                            - static window.CHAT_SHRINKED :number - - - -

                                                                                                            - - -
                                                                                                            -
                                                                                                            - -
                                                                                                            -

                                                                                                            Controls height of chat when chat is collapsed, in pixels, default 60

                                                                                                            -
                                                                                                            - - - - - - - -
                                                                                                            - - - - - - - - - - - - - - - - - - - - @@ -625,5086 +386,7 @@
                                                                                                            Type:
                                                                                                            • -string - - -
                                                                                                            • -
                                                                                                            - - --> - - - - -
                                                                                                            - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                            - - - - - -
                                                                                                            - - - - -
                                                                                                            -

                                                                                                            - static window.COLOR_SELECTED_PORTAL :string - - - -

                                                                                                            - - -
                                                                                                            -
                                                                                                            - -
                                                                                                            -

                                                                                                            What colour should the selected portal be, string(css hex code), default ‘#f0f’ (hot pink)

                                                                                                            -
                                                                                                            - - - - - - - -
                                                                                                            - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                            - - - - - -
                                                                                                            - - - - -
                                                                                                            -

                                                                                                            - static window.COLORS :Array.<string> - - - -

                                                                                                            - - -
                                                                                                            -
                                                                                                            - -
                                                                                                            -

                                                                                                            Defines the color values associated with different teams, used in various elements such as portals, player names, etc. -The colors are represented in a CSS hex code format. -The array format represents: [none, res, enl, mac].

                                                                                                            -
                                                                                                            - - - - - - - -
                                                                                                            - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                            - - - - - -
                                                                                                            - - - - -
                                                                                                            -

                                                                                                            - static window.COLORS :Array.<string> - - - -

                                                                                                            - - -
                                                                                                            -
                                                                                                            - -
                                                                                                            -

                                                                                                            Defines the color values associated with different teams, used in various elements such as portals, player names, etc. -The colors are represented in a CSS hex code format. -The array format represents: [none, res, enl, mac].

                                                                                                            -
                                                                                                            - - - - - - - -
                                                                                                            - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                            - - - - - -
                                                                                                            - - - - -
                                                                                                            -

                                                                                                            - static window.COLORS_LVL :Array.<string> - - - -

                                                                                                            - - -
                                                                                                            -
                                                                                                            - -
                                                                                                            -

                                                                                                            Colour values for levels, consistent with Ingress, with index 0 being white for neutral portals.

                                                                                                            -
                                                                                                            - - - - - - - -
                                                                                                            - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                            - - - - - -
                                                                                                            - - - - -
                                                                                                            -

                                                                                                            - static window.COLORS_LVL :Array.<string> - - - -

                                                                                                            - - -
                                                                                                            -
                                                                                                            - -
                                                                                                            -

                                                                                                            Colour values for levels, consistent with Ingress, with index 0 being white for neutral portals.

                                                                                                            -
                                                                                                            - - - - - - - -
                                                                                                            - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                            - - - - - -
                                                                                                            - - - - -
                                                                                                            -

                                                                                                            - static window.COLORS_MOD :object - - - -

                                                                                                            - - -
                                                                                                            -
                                                                                                            - -
                                                                                                            -

                                                                                                            Colour values for displaying mods, consistent with Ingress. Very Rare also used for AXA shields and Ultra Links.

                                                                                                            -
                                                                                                            - - - - - - - -
                                                                                                            Properties:
                                                                                                            - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                            NameTypeDefaultDescription
                                                                                                            VERY_RARE - - -string - - - - - - #b08cff - -
                                                                                                            RARE - - -string - - - - - - #73a8ff - -
                                                                                                            COMMON - - -string - - - - - - #8cffbf - -
                                                                                                            - - - - -
                                                                                                            - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                            - - - - - -
                                                                                                            - - - - -
                                                                                                            -

                                                                                                            - static window.COLORS_MOD :object - - - -

                                                                                                            - - -
                                                                                                            -
                                                                                                            - -
                                                                                                            -

                                                                                                            Colour values for displaying mods, consistent with Ingress. Very Rare also used for AXA shields and Ultra Links.

                                                                                                            -
                                                                                                            - - - - - - - -
                                                                                                            Properties:
                                                                                                            - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                            NameTypeDefaultDescription
                                                                                                            VERY_RARE - - -string - - - - - - #b08cff - -
                                                                                                            RARE - - -string - - - - - - #73a8ff - -
                                                                                                            COMMON - - -string - - - - - - #8cffbf - -
                                                                                                            - - - - -
                                                                                                            - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                            - - - - - -
                                                                                                            - - - - -
                                                                                                            -

                                                                                                            - static window.DEFAULT_PORTAL_IMG :string - - - -

                                                                                                            - - -
                                                                                                            -
                                                                                                            - -
                                                                                                            -

                                                                                                            URL of the default image for the portal

                                                                                                            -
                                                                                                            - - - - - - - -
                                                                                                            - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                            - - - - - -
                                                                                                            - - - - -
                                                                                                            -

                                                                                                            - static window.DEFAULT_PORTAL_IMG :string - - - -

                                                                                                            - - -
                                                                                                            -
                                                                                                            - -
                                                                                                            -

                                                                                                            URL of the default image for the portal

                                                                                                            -
                                                                                                            - - - - - - - -
                                                                                                            - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                            - - - - - -
                                                                                                            - - - - -
                                                                                                            -

                                                                                                            - static window.DEFAULT_ZOOM :number - - - -

                                                                                                            - - -
                                                                                                            -
                                                                                                            - -
                                                                                                            -

                                                                                                            Used when zoom level is not specified explicitly (must contain all the portals)

                                                                                                            -
                                                                                                            - - - - - - - -
                                                                                                            - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                            - - - - - -
                                                                                                            - - - - -
                                                                                                            -

                                                                                                            - static window.DEFAULT_ZOOM :number - - - -

                                                                                                            - - -
                                                                                                            -
                                                                                                            - -
                                                                                                            -

                                                                                                            Used when zoom level is not specified explicitly (must contain all the portals)

                                                                                                            -
                                                                                                            - - - - - - - -
                                                                                                            - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                            - - - - - -
                                                                                                            - - - - -
                                                                                                            -

                                                                                                            - static window.HIDDEN_SCROLLBAR_ASSUMED_WIDTH :number - - - -

                                                                                                            - - -
                                                                                                            -
                                                                                                            - -
                                                                                                            -

                                                                                                            How much space to leave for scrollbars, in pixels, default 20.

                                                                                                            -
                                                                                                            - - - - - - - -
                                                                                                            - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                            - - - - - -
                                                                                                            - - - - -
                                                                                                            -

                                                                                                            - static window.HIDDEN_SCROLLBAR_ASSUMED_WIDTH :number - - - -

                                                                                                            - - -
                                                                                                            -
                                                                                                            - -
                                                                                                            -

                                                                                                            How much space to leave for scrollbars, in pixels, default 20.

                                                                                                            -
                                                                                                            - - - - - - - -
                                                                                                            - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                            - - - - - -
                                                                                                            - - - - -
                                                                                                            -

                                                                                                            - static window.MAX_IDLE_TIME :number - - - -

                                                                                                            - - -
                                                                                                            -
                                                                                                            - -
                                                                                                            -

                                                                                                            The maximum idle time in seconds before the map stops updating, in seconds, default 15*60 (15 mins)

                                                                                                            -
                                                                                                            - - - - - - - -
                                                                                                            - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                            - - - - - -
                                                                                                            - - - - -
                                                                                                            -

                                                                                                            - static window.MAX_IDLE_TIME :number - - - -

                                                                                                            - - -
                                                                                                            -
                                                                                                            - -
                                                                                                            -

                                                                                                            The maximum idle time in seconds before the map stops updating, in seconds, default 15*60 (15 mins)

                                                                                                            -
                                                                                                            - - - - - - - -
                                                                                                            - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                            - - - - - -
                                                                                                            - - - - -
                                                                                                            -

                                                                                                            - static window.MIN_ZOOM :number - - - -

                                                                                                            - - -
                                                                                                            -
                                                                                                            - -
                                                                                                            -

                                                                                                            Min zoom for intel map - should match that used by stock intel, default 3

                                                                                                            -
                                                                                                            - - - - - - - -
                                                                                                            - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                            - - - - - -
                                                                                                            - - - - -
                                                                                                            -

                                                                                                            - static window.MIN_ZOOM :number - - - -

                                                                                                            - - -
                                                                                                            -
                                                                                                            - -
                                                                                                            -

                                                                                                            Min zoom for intel map - should match that used by stock intel, default 3

                                                                                                            -
                                                                                                            - - - - - - - -
                                                                                                            - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                            - - - - - -
                                                                                                            - - - - -
                                                                                                            -

                                                                                                            - static window.MINIMUM_OVERRIDE_REFRESH :number - - - -

                                                                                                            - - -
                                                                                                            -
                                                                                                            - -
                                                                                                            -

                                                                                                            Limit on refresh time since previous refresh, limiting repeated move refresh rate, in seconds, default 10

                                                                                                            -
                                                                                                            - - - - - - - -
                                                                                                            - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                            - - - - - -
                                                                                                            - - - - -
                                                                                                            -

                                                                                                            - static window.MINIMUM_OVERRIDE_REFRESH :number - - - -

                                                                                                            - - -
                                                                                                            -
                                                                                                            - -
                                                                                                            -

                                                                                                            Limit on refresh time since previous refresh, limiting repeated move refresh rate, in seconds, default 10

                                                                                                            -
                                                                                                            - - - - - - - -
                                                                                                            - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                            - - - - - -
                                                                                                            - - - - -
                                                                                                            -

                                                                                                            - static window.NOMINATIM :string - - - -

                                                                                                            - - -
                                                                                                            -
                                                                                                            - -
                                                                                                            -

                                                                                                            URL to call the Nominatim geocoder service, string.

                                                                                                            -
                                                                                                            - - - - - - - -
                                                                                                            - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                            - - - - - -
                                                                                                            - - - - -
                                                                                                            -

                                                                                                            - static window.NOMINATIM :string - - - -

                                                                                                            - - -
                                                                                                            -
                                                                                                            - -
                                                                                                            -

                                                                                                            URL to call the Nominatim geocoder service, string.

                                                                                                            -
                                                                                                            - - - - - - - -
                                                                                                            - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                            - - - - - -
                                                                                                            - - - - -
                                                                                                            -

                                                                                                            - static window.ON_MOVE_REFRESH :number - - - -

                                                                                                            - - -
                                                                                                            -
                                                                                                            - -
                                                                                                            -

                                                                                                            Wait this long before refreshing the view after the map has been moved, in seconds, default 2.5

                                                                                                            -
                                                                                                            - - - - - - - -
                                                                                                            - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                            - - - - - -
                                                                                                            - - - - -
                                                                                                            -

                                                                                                            - static window.ON_MOVE_REFRESH :number - - - -

                                                                                                            - - -
                                                                                                            -
                                                                                                            - -
                                                                                                            -

                                                                                                            Wait this long before refreshing the view after the map has been moved, in seconds, default 2.5

                                                                                                            -
                                                                                                            - - - - - - - -
                                                                                                            - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                            - - - - - -
                                                                                                            - - - - -
                                                                                                            -

                                                                                                            - static window.RANGE_INDICATOR_COLOR :string - - - -

                                                                                                            - - -
                                                                                                            -
                                                                                                            - -
                                                                                                            -

                                                                                                            What colour should the linkable range circle be, string(css colour value), default ‘red’

                                                                                                            -
                                                                                                            - - - - - - - -
                                                                                                            - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                            - - - - - -
                                                                                                            - - - - -
                                                                                                            -

                                                                                                            - static window.RANGE_INDICATOR_COLOR :string - - - -

                                                                                                            - - -
                                                                                                            -
                                                                                                            - -
                                                                                                            -

                                                                                                            What colour should the linkable range circle be, string(css colour value), default ‘red’

                                                                                                            -
                                                                                                            - - - - - - - -
                                                                                                            - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                            - - - - - -
                                                                                                            - - - - -
                                                                                                            -

                                                                                                            - static window.REFRESH :number - - - -

                                                                                                            - - -
                                                                                                            -
                                                                                                            - -
                                                                                                            -

                                                                                                            Controls how often the map should refresh, in seconds, default 30.

                                                                                                            -
                                                                                                            - - - - - - - -
                                                                                                            - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                            - - - - - -
                                                                                                            - - - - -
                                                                                                            -

                                                                                                            - static window.REFRESH :number - - - -

                                                                                                            - - -
                                                                                                            -
                                                                                                            - -
                                                                                                            -

                                                                                                            Controls how often the map should refresh, in seconds, default 30.

                                                                                                            -
                                                                                                            - - - - - - - -
                                                                                                            - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                            - - - - - -
                                                                                                            - - - - -
                                                                                                            -

                                                                                                            - static window.REFRESH_GAME_SCORE :number - - - -

                                                                                                            - - -
                                                                                                            -
                                                                                                            - -
                                                                                                            -

                                                                                                            Controls how long to wait between refreshing the global score, in seconds, default 15*60 (15 mins)

                                                                                                            -
                                                                                                            - - - - - - - -
                                                                                                            - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                            - - - - - -
                                                                                                            - - - - -
                                                                                                            -

                                                                                                            - static window.REFRESH_GAME_SCORE :number - - - -

                                                                                                            - - -
                                                                                                            -
                                                                                                            - -
                                                                                                            -

                                                                                                            Controls how long to wait between refreshing the global score, in seconds, default 15*60 (15 mins)

                                                                                                            -
                                                                                                            - - - - - - - -
                                                                                                            - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                            - - - - - -
                                                                                                            - - - - -
                                                                                                            -

                                                                                                            - static window.SIDEBAR_WIDTH :number - - - -

                                                                                                            - - -
                                                                                                            -
                                                                                                            - -
                                                                                                            -

                                                                                                            How wide should the sidebar be, in pixels, default 300.

                                                                                                            -
                                                                                                            - - - - - - - -
                                                                                                            - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                            - - - - - -
                                                                                                            - - - - -
                                                                                                            -

                                                                                                            - static window.SIDEBAR_WIDTH :number - - - -

                                                                                                            - - -
                                                                                                            -
                                                                                                            - -
                                                                                                            -

                                                                                                            How wide should the sidebar be, in pixels, default 300.

                                                                                                            -
                                                                                                            - - - - - - - -
                                                                                                            - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                            - - - - - -
                                                                                                            - - - - -
                                                                                                            -

                                                                                                            - static window.ZOOM_LEVEL_ADJ :number - - - -

                                                                                                            - - -
                                                                                                            -
                                                                                                            - -
                                                                                                            -

                                                                                                            Controls the extra refresh delay per zoom level, in seconds, default 5.

                                                                                                            -
                                                                                                            - - - - - - - -
                                                                                                            - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                            - - - - - -
                                                                                                            - - - - -
                                                                                                            -

                                                                                                            - static window.ZOOM_LEVEL_ADJ :number - - - -

                                                                                                            - - -
                                                                                                            -
                                                                                                            - -
                                                                                                            -

                                                                                                            Controls the extra refresh delay per zoom level, in seconds, default 5.

                                                                                                            -
                                                                                                            - - - - - - - -
                                                                                                            - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                            - - - - - -
                                                                                                            - - - - - - - - - -
                                                                                                            - -
                                                                                                            - - - - - - - -
                                                                                                            - -
                                                                                                            - -

                                                                                                            config_options

                                                                                                            - - -
                                                                                                            - -
                                                                                                            - -
                                                                                                            - - -

                                                                                                            CONFIG OPTIONS

                                                                                                            - - - - - -
                                                                                                            - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                            - - - - -
                                                                                                            - - - - - - - - - - - - - - - -

                                                                                                            Members

                                                                                                            - -
                                                                                                            - - -
                                                                                                            -

                                                                                                            - static window.ACCESS_INDICATOR_COLOR :string - - - -

                                                                                                            - - -
                                                                                                            -
                                                                                                            - -
                                                                                                            -

                                                                                                            What colour should the hacking range circle be (the small circle that appears around a selected portal, -marking a ~40 metre radius), string(css colour value), default ‘orange’

                                                                                                            -
                                                                                                            - - - - - - - -
                                                                                                            - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                            - - - - - -
                                                                                                            - - - - -
                                                                                                            -

                                                                                                            - static window.ACCESS_INDICATOR_COLOR :string - - - -

                                                                                                            - - -
                                                                                                            -
                                                                                                            - -
                                                                                                            -

                                                                                                            What colour should the hacking range circle be (the small circle that appears around a selected portal, -marking a ~40 metre radius), string(css colour value), default ‘orange’

                                                                                                            -
                                                                                                            - - - - - - - -
                                                                                                            - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                            - - - - - -
                                                                                                            - - - - -
                                                                                                            -

                                                                                                            - static window.CHAT_REQUEST_SCROLL_TOP :number - - - -

                                                                                                            - - -
                                                                                                            -
                                                                                                            - -
                                                                                                            -

                                                                                                            Controls requesting chat data based on the pixel distance from the line currently in view -and the top of history, in pixels, default 200

                                                                                                            -
                                                                                                            - - - - - - - -
                                                                                                            - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                            - - - - - -
                                                                                                            - - - - -
                                                                                                            -

                                                                                                            - static window.CHAT_REQUEST_SCROLL_TOP :number - - - -

                                                                                                            - - -
                                                                                                            -
                                                                                                            - -
                                                                                                            -

                                                                                                            Controls requesting chat data based on the pixel distance from the line currently in view -and the top of history, in pixels, default 200

                                                                                                            -
                                                                                                            - - - - - - - -
                                                                                                            - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                            - - - - - -
                                                                                                            - - - - -
                                                                                                            -

                                                                                                            - static window.CHAT_SHRINKED :number - - - -

                                                                                                            - - -
                                                                                                            -
                                                                                                            - -
                                                                                                            -

                                                                                                            Controls height of chat when chat is collapsed, in pixels, default 60

                                                                                                            -
                                                                                                            - - - - - - - -
                                                                                                            - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                            - - - - - -
                                                                                                            - - - - -
                                                                                                            -

                                                                                                            - static window.CHAT_SHRINKED :number - - - -

                                                                                                            - - -
                                                                                                            -
                                                                                                            - -
                                                                                                            -

                                                                                                            Controls height of chat when chat is collapsed, in pixels, default 60

                                                                                                            -
                                                                                                            - - - - - - - -
                                                                                                            - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                            - - - - - -
                                                                                                            - - - - -
                                                                                                            -

                                                                                                            - static window.COLOR_SELECTED_PORTAL :string - - - -

                                                                                                            - - -
                                                                                                            -
                                                                                                            - -
                                                                                                            -

                                                                                                            What colour should the selected portal be, string(css hex code), default ‘#f0f’ (hot pink)

                                                                                                            -
                                                                                                            - - - - - - - -
                                                                                                            - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                            - - - - - -
                                                                                                            - - - - -
                                                                                                            -

                                                                                                            - static window.COLOR_SELECTED_PORTAL :string - - - -

                                                                                                            - - -
                                                                                                            -
                                                                                                            - -
                                                                                                            -

                                                                                                            What colour should the selected portal be, string(css hex code), default ‘#f0f’ (hot pink)

                                                                                                            -
                                                                                                            - - - - - - - -
                                                                                                            - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                            - - - - - -
                                                                                                            - - - - -
                                                                                                            -

                                                                                                            - static window.COLORS :Array.<string> - - - -

                                                                                                            - - -
                                                                                                            -
                                                                                                            - -
                                                                                                            -

                                                                                                            Defines the color values associated with different teams, used in various elements such as portals, player names, etc. -The colors are represented in a CSS hex code format. -The array format represents: [none, res, enl, mac].

                                                                                                            -
                                                                                                            - - - - - - - -
                                                                                                            - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                            - - - - - -
                                                                                                            - - - - -
                                                                                                            -

                                                                                                            - static window.COLORS :Array.<string> - - - -

                                                                                                            - - -
                                                                                                            -
                                                                                                            - -
                                                                                                            -

                                                                                                            Defines the color values associated with different teams, used in various elements such as portals, player names, etc. -The colors are represented in a CSS hex code format. -The array format represents: [none, res, enl, mac].

                                                                                                            -
                                                                                                            - - - - - - - -
                                                                                                            - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                            - - - - - -
                                                                                                            - - - - -
                                                                                                            -

                                                                                                            - static window.COLORS_LVL :Array.<string> - - - -

                                                                                                            - - -
                                                                                                            -
                                                                                                            - -
                                                                                                            -

                                                                                                            Colour values for levels, consistent with Ingress, with index 0 being white for neutral portals.

                                                                                                            -
                                                                                                            - - - - - - - -
                                                                                                            - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                            - - - - - -
                                                                                                            - - - - -
                                                                                                            -

                                                                                                            - static window.COLORS_LVL :Array.<string> - - - -

                                                                                                            - - -
                                                                                                            -
                                                                                                            - -
                                                                                                            -

                                                                                                            Colour values for levels, consistent with Ingress, with index 0 being white for neutral portals.

                                                                                                            -
                                                                                                            - - - - - - - -
                                                                                                            - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                            - - - - - -
                                                                                                            - - - - -
                                                                                                            -

                                                                                                            - static window.COLORS_MOD :object - - - -

                                                                                                            - - -
                                                                                                            -
                                                                                                            - -
                                                                                                            -

                                                                                                            Colour values for displaying mods, consistent with Ingress. Very Rare also used for AXA shields and Ultra Links.

                                                                                                            -
                                                                                                            - - - - - - - -
                                                                                                            Properties:
                                                                                                            - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                            NameTypeDefaultDescription
                                                                                                            VERY_RARE - - -string - - - - - - #b08cff - -
                                                                                                            RARE - - -string - - - - - - #73a8ff - -
                                                                                                            COMMON - - -string - - - - - - #8cffbf - -
                                                                                                            - - - - -
                                                                                                            - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                            - - - - - -
                                                                                                            - - - - -
                                                                                                            -

                                                                                                            - static window.COLORS_MOD :object - - - -

                                                                                                            - - -
                                                                                                            -
                                                                                                            - -
                                                                                                            -

                                                                                                            Colour values for displaying mods, consistent with Ingress. Very Rare also used for AXA shields and Ultra Links.

                                                                                                            -
                                                                                                            - - - - - - - -
                                                                                                            Properties:
                                                                                                            - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                            NameTypeDefaultDescription
                                                                                                            VERY_RARE - - -string - - - - - - #b08cff - -
                                                                                                            RARE - - -string - - - - - - #73a8ff - -
                                                                                                            COMMON - - -string - - - - - - #8cffbf - -
                                                                                                            - - - - -
                                                                                                            - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                            - - - - - -
                                                                                                            - - - - -
                                                                                                            -

                                                                                                            - static window.DEFAULT_PORTAL_IMG :string - - - -

                                                                                                            - - -
                                                                                                            -
                                                                                                            - -
                                                                                                            -

                                                                                                            URL of the default image for the portal

                                                                                                            -
                                                                                                            - - - - - - - -
                                                                                                            - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                            - - - - - -
                                                                                                            - - - - -
                                                                                                            -

                                                                                                            - static window.DEFAULT_PORTAL_IMG :string - - - -

                                                                                                            - - -
                                                                                                            -
                                                                                                            - -
                                                                                                            -

                                                                                                            URL of the default image for the portal

                                                                                                            -
                                                                                                            - - - - - - - -
                                                                                                            - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                            - - - - - -
                                                                                                            - - - - -
                                                                                                            -

                                                                                                            - static window.DEFAULT_ZOOM :number - - - -

                                                                                                            - - -
                                                                                                            -
                                                                                                            - -
                                                                                                            -

                                                                                                            Used when zoom level is not specified explicitly (must contain all the portals)

                                                                                                            -
                                                                                                            - - - - - - - -
                                                                                                            - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                            - - - - - -
                                                                                                            - - - - -
                                                                                                            -

                                                                                                            - static window.DEFAULT_ZOOM :number - - - -

                                                                                                            - - -
                                                                                                            -
                                                                                                            - -
                                                                                                            -

                                                                                                            Used when zoom level is not specified explicitly (must contain all the portals)

                                                                                                            -
                                                                                                            - - - - - - - -
                                                                                                            - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                            - - - - - -
                                                                                                            - - - - -
                                                                                                            -

                                                                                                            - static window.HIDDEN_SCROLLBAR_ASSUMED_WIDTH :number - - - -

                                                                                                            - - -
                                                                                                            -
                                                                                                            - -
                                                                                                            -

                                                                                                            How much space to leave for scrollbars, in pixels, default 20.

                                                                                                            -
                                                                                                            - - - - - - - -
                                                                                                            - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                            - - - - - -
                                                                                                            - - - - -
                                                                                                            -

                                                                                                            - static window.HIDDEN_SCROLLBAR_ASSUMED_WIDTH :number - - - -

                                                                                                            - - -
                                                                                                            -
                                                                                                            - -
                                                                                                            -

                                                                                                            How much space to leave for scrollbars, in pixels, default 20.

                                                                                                            -
                                                                                                            - - - - - - - -
                                                                                                            - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                            - - - - - -
                                                                                                            - - - - -
                                                                                                            -

                                                                                                            - static window.MAX_IDLE_TIME :number - - - -

                                                                                                            - - -
                                                                                                            -
                                                                                                            - -
                                                                                                            -

                                                                                                            The maximum idle time in seconds before the map stops updating, in seconds, default 15*60 (15 mins)

                                                                                                            -
                                                                                                            - - - - - - - -
                                                                                                            - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                            - - - - - -
                                                                                                            - - - - -
                                                                                                            -

                                                                                                            - static window.MAX_IDLE_TIME :number - - - -

                                                                                                            - - -
                                                                                                            -
                                                                                                            - -
                                                                                                            -

                                                                                                            The maximum idle time in seconds before the map stops updating, in seconds, default 15*60 (15 mins)

                                                                                                            -
                                                                                                            - - - - - - - -
                                                                                                            - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                            - - - - - -
                                                                                                            - - - - -
                                                                                                            -

                                                                                                            - static window.MIN_ZOOM :number - - - -

                                                                                                            - - -
                                                                                                            -
                                                                                                            - -
                                                                                                            -

                                                                                                            Min zoom for intel map - should match that used by stock intel, default 3

                                                                                                            -
                                                                                                            - - - - - - - -
                                                                                                            - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                            - - - - - -
                                                                                                            - - - - -
                                                                                                            -

                                                                                                            - static window.MIN_ZOOM :number - - - -

                                                                                                            - - -
                                                                                                            -
                                                                                                            - -
                                                                                                            -

                                                                                                            Min zoom for intel map - should match that used by stock intel, default 3

                                                                                                            -
                                                                                                            - - - - - - - -
                                                                                                            Properties:
                                                                                                            - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                            NameTypeAttributesDescription
                                                                                                            id - - -string - - - - - - <optional>
                                                                                                            - - - -

                                                                                                            Optional. The ID of the button.

                                                                                                            label - - -string -| - -undefined - - - - - - - -

                                                                                                            The label text of the button.

                                                                                                            action - - -function -| - -undefined - - - - - - - -

                                                                                                            The onclick action for the button.

                                                                                                            class - - -string -| - -null - - - - - - <optional>
                                                                                                            - - - -

                                                                                                            Optional. The class(es) for the button.

                                                                                                            title - - -string -| - -null - - - - - - <optional>
                                                                                                            - - - -

                                                                                                            Optional. The title (tooltip) for the button.

                                                                                                            access_key - - -string -| - -null - - - - - - <optional>
                                                                                                            - - - -

                                                                                                            Optional. The access key for the button.

                                                                                                            mouseover - - -function -| - -null - - - - - - <optional>
                                                                                                            - - - -

                                                                                                            Optional. The mouseover event for the button.

                                                                                                            icon - - -string -| - -null - - - - - - <optional>
                                                                                                            - - - -

                                                                                                            Optional. Icon name from FontAwesome for the button.

                                                                                                            - - - - -
                                                                                                            - - - - - - - - - - - - - - - - - - - - diff --git a/index.html b/index.html index 6ea17b3b3..dcc52df64 100644 --- a/index.html +++ b/index.html @@ -34,7 +34,7 @@

                                                                                                            IITC-CE

                                                                                                              - +
                                                                                                              diff --git a/ingress_constants.html b/ingress_constants.html index c106b0c72..13c74a413 100644 --- a/ingress_constants.html +++ b/ingress_constants.html @@ -34,7 +34,7 @@

                                                                                                              IITC-CE

                                                                                                                - +
                                                                                                                @@ -180,85 +180,6 @@
                                                                                                                Type:
                                                                                                                - - - - - - - - - - -
                                                                                                                - - - - - -
                                                                                                                - - - - -
                                                                                                                -

                                                                                                                - static, constant window.BASE_HACK_COOLDOWN :number - - - -

                                                                                                                - - -
                                                                                                                -
                                                                                                                - -
                                                                                                                -

                                                                                                                The base value of how long you need to wait between portal hacks, in seconds.

                                                                                                                -
                                                                                                                - - - - - - - -
                                                                                                                - - - - - - - - - - - - - - - - - - - - @@ -360,12 +281,12 @@
                                                                                                                Type:
                                                                                                                -

                                                                                                                - static, constant window.BASE_HACK_COUNT :number +

                                                                                                                + static, constant window.CAPTURE_PORTAL :number

                                                                                                                @@ -375,7 +296,7 @@

                                                                                                                -

                                                                                                                Base value, how many times at most you can hack the portal.

                                                                                                                +

                                                                                                                AP for capturing a portal

                                                                                                                @@ -439,12 +360,12 @@
                                                                                                                Type:
                                                                                                                -

                                                                                                                - static, constant window.CAPTURE_PORTAL :number +

                                                                                                                + static, constant window.COMPLETION_BONUS :number

                                                                                                                @@ -454,7 +375,7 @@

                                                                                                                -

                                                                                                                AP for capturing a portal

                                                                                                                +

                                                                                                                AP for deploying all resonators on portal

                                                                                                                @@ -518,12 +439,12 @@
                                                                                                                Type:
                                                                                                                -

                                                                                                                - static, constant window.CAPTURE_PORTAL :number +

                                                                                                                + static, constant window.DEPLOY_RESONATOR :number

                                                                                                                @@ -533,7 +454,7 @@

                                                                                                                -

                                                                                                                AP for capturing a portal

                                                                                                                +

                                                                                                                AP for deploying a resonator

                                                                                                                @@ -597,12 +518,12 @@
                                                                                                                Type:
                                                                                                                -

                                                                                                                - static, constant window.COMPLETION_BONUS :number +

                                                                                                                + static, constant window.DESTROY_FIELD :number

                                                                                                                @@ -612,7 +533,7 @@

                                                                                                                -

                                                                                                                AP for deploying all resonators on portal

                                                                                                                +

                                                                                                                AP for destroying field

                                                                                                                @@ -676,12 +597,12 @@
                                                                                                                Type:
                                                                                                                -

                                                                                                                - static, constant window.COMPLETION_BONUS :number +

                                                                                                                @@ -691,7 +612,7 @@

                                                                                                                -

                                                                                                                AP for deploying all resonators on portal

                                                                                                                +

                                                                                                                AP for destroying link

                                                                                                                @@ -755,12 +676,12 @@
                                                                                                                Type:
                                                                                                                -

                                                                                                                - static, constant window.DEPLOY_RESONATOR :number +

                                                                                                                + static, constant window.DESTROY_RESONATOR :number

                                                                                                                @@ -770,7 +691,7 @@

                                                                                                                -

                                                                                                                AP for deploying a resonator

                                                                                                                +

                                                                                                                AP for destroying portal

                                                                                                                @@ -834,12 +755,12 @@
                                                                                                                Type:
                                                                                                                -

                                                                                                                - static, constant window.DEPLOY_RESONATOR :number +

                                                                                                                + static, constant window.HACK_RANGE :number

                                                                                                                @@ -849,7 +770,7 @@

                                                                                                                -

                                                                                                                AP for deploying a resonator

                                                                                                                +

                                                                                                                Maximum radius around a portal from which the portal is hackable, metres.

                                                                                                                @@ -913,12 +834,12 @@
                                                                                                                Type:
                                                                                                                -

                                                                                                                - static, constant window.DESTROY_FIELD :number +

                                                                                                                @@ -928,7 +849,7 @@

                                                                                                                -

                                                                                                                AP for destroying field

                                                                                                                +

                                                                                                                The maximum radius around the portal from which the Machine can link

                                                                                                                @@ -938,7 +859,7 @@
                                                                                                                Type:
                                                                                                                • -number +Array.<number>
                                                                                                                • @@ -992,12 +913,12 @@
                                                                                                                  Type:
                                                                                                                  -

                                                                                                                  - static, constant window.DESTROY_FIELD :number +

                                                                                                                  + static, constant window.MAX_PORTAL_LEVEL :number

                                                                                                                  @@ -1007,7 +928,7 @@

                                                                                                                  -

                                                                                                                  AP for destroying field

                                                                                                                  +

                                                                                                                  Maximum portal level.

                                                                                                                  @@ -1071,12 +992,12 @@
                                                                                                                  Type:
                                                                                                                  -

                                                                                                                  + static, constant window.MAX_RESO_PER_PLAYER :Array.<number>

                                                                                                                  @@ -1086,7 +1007,7 @@

                                                                                                                - - - - - - - -
                                                                                                                - -
                                                                                                                - - - - - - - -
                                                                                                                - -
                                                                                                                - -

                                                                                                                ingress_constants

                                                                                                                - - -
                                                                                                                - -
                                                                                                                - -
                                                                                                                - - -

                                                                                                                INGRESS CONSTANTS -http://decodeingress.me/2012/11/18/ingress-portal-levels-and-link-range/

                                                                                                                - - - - - -
                                                                                                                - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                - - - - -
                                                                                                                - - - - - - - - - - - - - - - -

                                                                                                                Members

                                                                                                                - -
                                                                                                                - - -
                                                                                                                -

                                                                                                                - static, constant window.BASE_HACK_COOLDOWN :number - - - -

                                                                                                                - - -
                                                                                                                -
                                                                                                                - -
                                                                                                                -

                                                                                                                The base value of how long you need to wait between portal hacks, in seconds.

                                                                                                                -
                                                                                                                - - - - - - - -
                                                                                                                - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                - - - - - -
                                                                                                                - - - - -
                                                                                                                -

                                                                                                                - static, constant window.BASE_HACK_COOLDOWN :number - - - -

                                                                                                                - - -
                                                                                                                -
                                                                                                                - -
                                                                                                                -

                                                                                                                The base value of how long you need to wait between portal hacks, in seconds.

                                                                                                                -
                                                                                                                - - - - - - - -
                                                                                                                - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                - - - - - -
                                                                                                                - - - - -
                                                                                                                -

                                                                                                                - static, constant window.BASE_HACK_COUNT :number - - - -

                                                                                                                - - -
                                                                                                                -
                                                                                                                - -
                                                                                                                -

                                                                                                                Base value, how many times at most you can hack the portal.

                                                                                                                -
                                                                                                                - - - - - - - -
                                                                                                                - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                - - - - - -
                                                                                                                - - - - -
                                                                                                                -

                                                                                                                - static, constant window.BASE_HACK_COUNT :number - - - -

                                                                                                                - - -
                                                                                                                -
                                                                                                                - -
                                                                                                                -

                                                                                                                Base value, how many times at most you can hack the portal.

                                                                                                                -
                                                                                                                - - - - - - - -
                                                                                                                - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                - - - - - -
                                                                                                                - - - - -
                                                                                                                -

                                                                                                                - static, constant window.CAPTURE_PORTAL :number - - - -

                                                                                                                - - -
                                                                                                                -
                                                                                                                - -
                                                                                                                -

                                                                                                                AP for capturing a portal

                                                                                                                -
                                                                                                                - - - - - - - -
                                                                                                                - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                - - - - - -
                                                                                                                - - - - -
                                                                                                                -

                                                                                                                - static, constant window.CAPTURE_PORTAL :number - - - -

                                                                                                                - - -
                                                                                                                -
                                                                                                                - -
                                                                                                                -

                                                                                                                AP for capturing a portal

                                                                                                                -
                                                                                                                - - - - - - - -
                                                                                                                - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                - - - - - -
                                                                                                                - - - - -
                                                                                                                -

                                                                                                                - static, constant window.COMPLETION_BONUS :number - - - -

                                                                                                                - - -
                                                                                                                -
                                                                                                                - -
                                                                                                                -

                                                                                                                AP for deploying all resonators on portal

                                                                                                                -
                                                                                                                - - - - - - - -
                                                                                                                - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                - - - - - -
                                                                                                                - - - - -
                                                                                                                -

                                                                                                                - static, constant window.COMPLETION_BONUS :number - - - -

                                                                                                                - - -
                                                                                                                -
                                                                                                                - -
                                                                                                                -

                                                                                                                AP for deploying all resonators on portal

                                                                                                                -
                                                                                                                - - - - - - - -
                                                                                                                - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                - - - - - -
                                                                                                                - - - - -
                                                                                                                -

                                                                                                                - static, constant window.DEPLOY_RESONATOR :number - - - -

                                                                                                                - - -
                                                                                                                -
                                                                                                                - -
                                                                                                                -

                                                                                                                AP for deploying a resonator

                                                                                                                -
                                                                                                                - - - - - - - -
                                                                                                                - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                - - - - - -
                                                                                                                - - - - -
                                                                                                                -

                                                                                                                - static, constant window.DEPLOY_RESONATOR :number - - - -

                                                                                                                - - -
                                                                                                                -
                                                                                                                - -
                                                                                                                -

                                                                                                                AP for deploying a resonator

                                                                                                                -
                                                                                                                - - - - - - - -
                                                                                                                - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                - - - - - -
                                                                                                                - - - - -
                                                                                                                -

                                                                                                                - static, constant window.DESTROY_FIELD :number - - - -

                                                                                                                - - -
                                                                                                                -
                                                                                                                - -
                                                                                                                -

                                                                                                                AP for destroying field

                                                                                                                -
                                                                                                                - - - - - - - -
                                                                                                                - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                - - - - - -
                                                                                                                - - - - -
                                                                                                                -

                                                                                                                - static, constant window.DESTROY_FIELD :number - - - -

                                                                                                                - - -
                                                                                                                -
                                                                                                                - -
                                                                                                                -

                                                                                                                AP for destroying field

                                                                                                                -
                                                                                                                - - - - - - - -
                                                                                                                - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                - - - - - -
                                                                                                                - - - - -
                                                                                                                - - - -
                                                                                                                -
                                                                                                                - -
                                                                                                                -

                                                                                                                AP for destroying link

                                                                                                                -
                                                                                                                - - - - - - - -
                                                                                                                - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                - - - - - -
                                                                                                                - - - - -
                                                                                                                - - - -
                                                                                                                -
                                                                                                                - -
                                                                                                                -

                                                                                                                AP for destroying link

                                                                                                                -
                                                                                                                - - - - - - - -
                                                                                                                - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                - - - - - -
                                                                                                                - - - - -
                                                                                                                -

                                                                                                                - static, constant window.DESTROY_RESONATOR :number - - - -

                                                                                                                - - -
                                                                                                                -
                                                                                                                - -
                                                                                                                -

                                                                                                                AP for destroying portal

                                                                                                                -
                                                                                                                - - - - - - - -
                                                                                                                - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                - - - - - -
                                                                                                                - - - - -
                                                                                                                -

                                                                                                                - static, constant window.DESTROY_RESONATOR :number - - - -

                                                                                                                - - -
                                                                                                                -
                                                                                                                - -
                                                                                                                -

                                                                                                                AP for destroying portal

                                                                                                                -
                                                                                                                - - - - - - - -
                                                                                                                - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                - - - - - -
                                                                                                                - - - - -
                                                                                                                -

                                                                                                                - static, constant window.HACK_RANGE :number - - - -

                                                                                                                - - -
                                                                                                                -
                                                                                                                - -
                                                                                                                -

                                                                                                                Maximum radius around a portal from which the portal is hackable, metres.

                                                                                                                -
                                                                                                                - - - - - - - -
                                                                                                                - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                - - - - - -
                                                                                                                - - - - -
                                                                                                                -

                                                                                                                - static, constant window.HACK_RANGE :number - - - -

                                                                                                                - - -
                                                                                                                -
                                                                                                                - -
                                                                                                                -

                                                                                                                Maximum radius around a portal from which the portal is hackable, metres.

                                                                                                                -
                                                                                                                - - - - - - - -
                                                                                                                - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                - - - - - -
                                                                                                                - - - - -
                                                                                                                - - - -
                                                                                                                -
                                                                                                                - -
                                                                                                                -

                                                                                                                The maximum radius around the portal from which the Machine can link

                                                                                                                -
                                                                                                                - - - - - - - -
                                                                                                                - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                - - - - - -
                                                                                                                - - - - -
                                                                                                                - - - -
                                                                                                                -
                                                                                                                - -
                                                                                                                -

                                                                                                                The maximum radius around the portal from which the Machine can link

                                                                                                                -
                                                                                                                - - - - - - - -
                                                                                                                - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                - - - - - -
                                                                                                                - - - - -
                                                                                                                -

                                                                                                                - static, constant window.MAX_PORTAL_LEVEL :number - - - -

                                                                                                                - - -
                                                                                                                -
                                                                                                                - -
                                                                                                                -

                                                                                                                Maximum portal level.

                                                                                                                -
                                                                                                                - - - - - - - -
                                                                                                                - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                - - - - - -
                                                                                                                - - - - -
                                                                                                                -

                                                                                                                - static, constant window.MAX_PORTAL_LEVEL :number - - - -

                                                                                                                - - -
                                                                                                                -
                                                                                                                - -
                                                                                                                -

                                                                                                                Maximum portal level.

                                                                                                                -
                                                                                                                - - - - - - - -
                                                                                                                - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                - - - - - -
                                                                                                                - - - - -
                                                                                                                -

                                                                                                                - static, constant window.MAX_RESO_PER_PLAYER :Array.<number> - - - -

                                                                                                                - - -
                                                                                                                -
                                                                                                                - -
                                                                                                                -

                                                                                                                How many resonators of a given level can one deploy; 1-based array where the index is the resonator level.

                                                                                                                -
                                                                                                                - - - - - - - -
                                                                                                                - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                - - - - - -
                                                                                                                - - - - -
                                                                                                                -

                                                                                                                - static, constant window.MAX_RESO_PER_PLAYER :Array.<number> - - - -

                                                                                                                - - -
                                                                                                                -
                                                                                                                - -
                                                                                                                -

                                                                                                                How many resonators of a given level can one deploy; 1-based array where the index is the resonator level.

                                                                                                                -
                                                                                                                - - - - - - - -
                                                                                                                - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                - - - - - -
                                                                                                                - - - - -
                                                                                                                -

                                                                                                                - static, constant window.OCTANTS :Array.<string> - - - -

                                                                                                                - - -
                                                                                                                -
                                                                                                                - -
                                                                                                                -

                                                                                                                Resonator octant cardinal directions

                                                                                                                -
                                                                                                                - - - - - - - -
                                                                                                                - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                - - - - - -
                                                                                                                - - - - -
                                                                                                                -

                                                                                                                - static, constant window.OCTANTS :Array.<string> - - - -

                                                                                                                - - -
                                                                                                                -
                                                                                                                - -
                                                                                                                -

                                                                                                                Resonator octant cardinal directions

                                                                                                                -
                                                                                                                - - - - - - - -
                                                                                                                - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                - - - - - -
                                                                                                                - - - - -
                                                                                                                -

                                                                                                                - static, constant window.OCTANTS_ARROW :Array.<string> - - - -

                                                                                                                - - -
                                                                                                                -
                                                                                                                - -
                                                                                                                -

                                                                                                                Resonator octant arrows

                                                                                                                -
                                                                                                                - - - - - - - -
                                                                                                                - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                - - - - - -
                                                                                                                - - - - -
                                                                                                                -

                                                                                                                - static, constant window.OCTANTS_ARROW :Array.<string> - - - -

                                                                                                                - - -
                                                                                                                -
                                                                                                                - -
                                                                                                                -

                                                                                                                Resonator octant arrows

                                                                                                                -
                                                                                                                - - - - - - - -
                                                                                                                - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                - - - - - -
                                                                                                                - - - - -
                                                                                                                -

                                                                                                                - static, constant window.RESO_NRG :Array.<number> - - - -

                                                                                                                - - -
                                                                                                                -
                                                                                                                - -
                                                                                                                -

                                                                                                                Resonator energy per level, 1-based array, XM

                                                                                                                -
                                                                                                                - - - - - - - -
                                                                                                                - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                - - - - - -
                                                                                                                - - - - -
                                                                                                                -

                                                                                                                - static, constant window.RESO_NRG :Array.<number> - - - -

                                                                                                                - - -
                                                                                                                -
                                                                                                                - -
                                                                                                                -

                                                                                                                Resonator energy per level, 1-based array, XM

                                                                                                                +

                                                                                                                Resonator energy per level, 1-based array, XM

                                                                                                                @@ -5171,85 +1365,6 @@
                                                                                                                Type:
                                                                                                                - - - - - - - - - - -
                                                                                                                - - - - - - - - - - -
                                                                                                                -

                                                                                                                - static, constant window.UPGRADE_ANOTHERS_RESONATOR :number - - - -

                                                                                                                - - -
                                                                                                                -
                                                                                                                - -
                                                                                                                -

                                                                                                                AP for upgrading another's resonator

                                                                                                                -
                                                                                                                - - - - - - - -
                                                                                                                - - - - - - - - - - - - - - - - - - - - diff --git a/module-_deprecated.html b/module-_deprecated.html index 4a76136e7..1b3187d3a 100644 --- a/module-_deprecated.html +++ b/module-_deprecated.html @@ -34,7 +34,7 @@

                                                                                                                IITC-CE

                                                                                                                  - +
                                                                                                                  @@ -52,8 +52,6 @@

                                                                                                                  _deprecated

                                                                                                                  - - @@ -120,77 +118,6 @@

                                                                                                                  _deprecated

                                                                                                                  - - - - - - - - - - -
                                                                                                                  - - - - -
                                                                                                                  - - - - -
                                                                                                                  - -
                                                                                                                  -
                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                  - - - - - - - - - - - - - - - - - - - - @@ -401,14 +328,14 @@
                                                                                                                  Returns:
                                                                                                                  -

                                                                                                                  +

                                                                                                                  - inner findPortalLatLng(guid) → {L.LatLng|undefined} + inner getPortalApGain(guid) → {Object|undefined}

                                                                                                                  @@ -420,8 +347,8 @@

                                                                                                                  -

                                                                                                                  Finds the latitude and longitude for a portal using all available data sources. -This includes the list of portals, cached portal details, and information from links and fields.

                                                                                                                  +

                                                                                                                  Estimates the AP gain from a portal, based only on summary data from portals, links, and fields. +Not entirely accurate - but available for all portals on the screen

                                                                                                                  @@ -501,7 +428,7 @@

                                                                                                                  Returns:
                                                                                                                  -L.LatLng +Object | undefined @@ -510,7 +437,7 @@
                                                                                                                  Returns:
                                                                                                                  --

                                                                                                                  The LatLng location of the portal, or undefined if not found.

                                                                                                                  +-

                                                                                                                  An object containing various AP gain values, or undefined if the portal is not found.

                                                                                                                  @@ -567,14 +494,14 @@
                                                                                                                  Returns:
                                                                                                                  -

                                                                                                                  +

                                                                                                                  - inner getPortalApGain(guid) → {Object|undefined} + inner portalApGainMaths(resCount, linkCount, fieldCount) → {Object}

                                                                                                                  @@ -586,8 +513,8 @@

                                                                                                                  -

                                                                                                                  Estimates the AP gain from a portal, based only on summary data from portals, links, and fields. -Not entirely accurate - but available for all portals on the screen

                                                                                                                  +

                                                                                                                  Calculates the potential AP gain for capturing or destroying a portal, based on the number of resonators, +links, and fields. It does not account for AP gained from resonator upgrades or mod deployment.

                                                                                                                  @@ -623,13 +550,13 @@

                                                                                                                  Parameters:
                                                                                                                  - guid + resCount -string +number @@ -639,163 +566,43 @@
                                                                                                                  Parameters:
                                                                                                                  -

                                                                                                                  The GUID of the portal.

                                                                                                                  +

                                                                                                                  The number of resonators on the portal.

                                                                                                                  - - - - - - - - - - - - - - - - - -
                                                                                                                  -
                                                                                                                  Returns:
                                                                                                                  - - - - - -Object -| - -undefined - - - - - --

                                                                                                                  An object containing various AP gain values, or undefined if the portal is not found.

                                                                                                                  - - - + -
                                                                                                                  - - - - - -
                                                                                                                  - - - - - - - - - - - - - - - - -
                                                                                                                  Deprecated:
                                                                                                                  • Yes
                                                                                                                  - - - - - - - - - - - - - - - -
                                                                                                                  - - - - -
                                                                                                                  - + linkCount - -
                                                                                                                  - -

                                                                                                                  + - inner getPortalApGain(guid) → {Object|undefined} - - - -

                                                                                                                  - - - -
                                                                                                                  -
                                                                                                                  - - -
                                                                                                                  -

                                                                                                                  Estimates the AP gain from a portal, based only on summary data from portals, links, and fields. -Not entirely accurate - but available for all portals on the screen

                                                                                                                  -
                                                                                                                  - - - - - - - +number - -
                                                                                                                  -
                                                                                                                  Parameters:
                                                                                                                  - - - - - - - - + + - + - + - - - + + - - + - - - - -
                                                                                                                  NameTypeDescription

                                                                                                                  The number of links connected to the portal.

                                                                                                                  guidfieldCount -string +number @@ -805,2042 +612,7 @@
                                                                                                                  Parameters:
                                                                                                                  -

                                                                                                                  The GUID of the portal.

                                                                                                                  - -
                                                                                                                  - - - - - - - - - - - - - -
                                                                                                                  -
                                                                                                                  Returns:
                                                                                                                  - - - - - -Object -| - -undefined - - - - - --

                                                                                                                  An object containing various AP gain values, or undefined if the portal is not found.

                                                                                                                  - - - - - -
                                                                                                                  - - - - - -
                                                                                                                  - - - - - - - - - - - - - - - - -
                                                                                                                  Deprecated:
                                                                                                                  • Yes
                                                                                                                  - - - - - - - - - - - - - - - -
                                                                                                                  - - - - -
                                                                                                                  - - - - -
                                                                                                                  - -

                                                                                                                  - - inner portalApGainMaths(resCount, linkCount, fieldCount) → {Object} - - - - -

                                                                                                                  - - - -
                                                                                                                  -
                                                                                                                  - - -
                                                                                                                  -

                                                                                                                  Calculates the potential AP gain for capturing or destroying a portal, based on the number of resonators, -links, and fields. It does not account for AP gained from resonator upgrades or mod deployment.

                                                                                                                  -
                                                                                                                  - - - - - - - - - -
                                                                                                                  -
                                                                                                                  Parameters:
                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                  NameTypeDescription
                                                                                                                  resCount - - -number - - - -

                                                                                                                  The number of resonators on the portal.

                                                                                                                  linkCount - - -number - - - -

                                                                                                                  The number of links connected to the portal.

                                                                                                                  fieldCount - - -number - - - -

                                                                                                                  The number of fields using the portal as a vertex.

                                                                                                                  - -
                                                                                                                  - - - - - - - - - - - - - -
                                                                                                                  -
                                                                                                                  Returns:
                                                                                                                  - - - - - -Object - - - - - --

                                                                                                                  An object containing detailed AP gain values for various actions such as deploying resonators, -destroying resonators, creating fields, destroying links, capturing the portal, and total -AP for destroying and capturing.

                                                                                                                  - - - - - -
                                                                                                                  - - - - - -
                                                                                                                  - - - - - - - - - - - - - - - - -
                                                                                                                  Deprecated:
                                                                                                                  • Yes
                                                                                                                  - - - - - - - - - - - - - - - -
                                                                                                                  - - - - -
                                                                                                                  - - - - -
                                                                                                                  - -

                                                                                                                  - - inner portalApGainMaths(resCount, linkCount, fieldCount) → {Object} - - - - -

                                                                                                                  - - - -
                                                                                                                  -
                                                                                                                  - - -
                                                                                                                  -

                                                                                                                  Calculates the potential AP gain for capturing or destroying a portal, based on the number of resonators, -links, and fields. It does not account for AP gained from resonator upgrades or mod deployment.

                                                                                                                  -
                                                                                                                  - - - - - - - - - -
                                                                                                                  -
                                                                                                                  Parameters:
                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                  NameTypeDescription
                                                                                                                  resCount - - -number - - - -

                                                                                                                  The number of resonators on the portal.

                                                                                                                  linkCount - - -number - - - -

                                                                                                                  The number of links connected to the portal.

                                                                                                                  fieldCount - - -number - - - -

                                                                                                                  The number of fields using the portal as a vertex.

                                                                                                                  - -
                                                                                                                  - - - - - - - - - - - - - -
                                                                                                                  -
                                                                                                                  Returns:
                                                                                                                  - - - - - -Object - - - - - --

                                                                                                                  An object containing detailed AP gain values for various actions such as deploying resonators, -destroying resonators, creating fields, destroying links, capturing the portal, and total -AP for destroying and capturing.

                                                                                                                  - - - - - -
                                                                                                                  - - - - - -
                                                                                                                  - - - - - - - - - - - - - - - - -
                                                                                                                  Deprecated:
                                                                                                                  • Yes
                                                                                                                  - - - - - - - - - - - - - - - -
                                                                                                                  - - - - -
                                                                                                                  - - - - -
                                                                                                                  - -

                                                                                                                  - - inner potentialPortalLevel(d) → {number} - - - - -

                                                                                                                  - - - -
                                                                                                                  -
                                                                                                                  - - -
                                                                                                                  -

                                                                                                                  Calculates the potential level a player can upgrade a portal to.

                                                                                                                  -
                                                                                                                  - - - - - - - - - -
                                                                                                                  -
                                                                                                                  Parameters:
                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                  NameTypeDescription
                                                                                                                  d - - -Object - - - -

                                                                                                                  The portal detail object containing resonator and ownership information.

                                                                                                                  - -
                                                                                                                  - - - - - - - - - - - - - -
                                                                                                                  -
                                                                                                                  Returns:
                                                                                                                  - - - - - -number - - - - - --

                                                                                                                  The potential level to which the player can upgrade the portal.

                                                                                                                  - - - - - -
                                                                                                                  - - - - - -
                                                                                                                  - - - - - - - - - - - - - - - - -
                                                                                                                  Deprecated:
                                                                                                                  • Yes
                                                                                                                  - - - - - - - - - - - - - - - -
                                                                                                                  - - - - -
                                                                                                                  - - - - -
                                                                                                                  - -

                                                                                                                  - - inner potentialPortalLevel(d) → {number} - - - - -

                                                                                                                  - - - -
                                                                                                                  -
                                                                                                                  - - -
                                                                                                                  -

                                                                                                                  Calculates the potential level a player can upgrade a portal to.

                                                                                                                  -
                                                                                                                  - - - - - - - - - -
                                                                                                                  -
                                                                                                                  Parameters:
                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                  NameTypeDescription
                                                                                                                  d - - -Object - - - -

                                                                                                                  The portal detail object containing resonator and ownership information.

                                                                                                                  - -
                                                                                                                  - - - - - - - - - - - - - -
                                                                                                                  -
                                                                                                                  Returns:
                                                                                                                  - - - - - -number - - - - - --

                                                                                                                  The potential level to which the player can upgrade the portal.

                                                                                                                  - - - - - -
                                                                                                                  - - - - - -
                                                                                                                  - - - - - - - - - - - - - - - - -
                                                                                                                  Deprecated:
                                                                                                                  • Yes
                                                                                                                  - - - - - - - - - - - - - - - -
                                                                                                                  - - - - -
                                                                                                                  - - - - - - - -
                                                                                                                  - -
                                                                                                                  - - - - - - - -
                                                                                                                  - -
                                                                                                                  - -

                                                                                                                  _deprecated

                                                                                                                  - - - - - - -
                                                                                                                  - -
                                                                                                                  - -
                                                                                                                  - - -

                                                                                                                  This file contains functions that are not use by IITC itself -and won't most likely not receive any updated

                                                                                                                  - - - - - -
                                                                                                                  - -
                                                                                                                  -
                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                  - - - - -
                                                                                                                  - - - - -
                                                                                                                  - -
                                                                                                                  -
                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                  - - - - -
                                                                                                                  - - - -
                                                                                                                  - - - - - - - - - - - - - - - - - -

                                                                                                                  Methods

                                                                                                                  - -
                                                                                                                  - - -
                                                                                                                  - -

                                                                                                                  - - inner findPortalLatLng(guid) → {L.LatLng|undefined} - - - - -

                                                                                                                  - - - -
                                                                                                                  -
                                                                                                                  - - -
                                                                                                                  -

                                                                                                                  Finds the latitude and longitude for a portal using all available data sources. -This includes the list of portals, cached portal details, and information from links and fields.

                                                                                                                  -
                                                                                                                  - - - - - - - - - -
                                                                                                                  -
                                                                                                                  Parameters:
                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                  NameTypeDescription
                                                                                                                  guid - - -string - - - -

                                                                                                                  The GUID of the portal.

                                                                                                                  - -
                                                                                                                  - - - - - - - - - - - - - -
                                                                                                                  -
                                                                                                                  Returns:
                                                                                                                  - - - - - -L.LatLng -| - -undefined - - - - - --

                                                                                                                  The LatLng location of the portal, or undefined if not found.

                                                                                                                  - - - - - -
                                                                                                                  - - - - - -
                                                                                                                  - - - - - - - - - - - - - - - - -
                                                                                                                  Deprecated:
                                                                                                                  • Yes
                                                                                                                  - - - - - - - - - - - - - - - -
                                                                                                                  - - - - -
                                                                                                                  - - - - -
                                                                                                                  - -

                                                                                                                  - - inner findPortalLatLng(guid) → {L.LatLng|undefined} - - - - -

                                                                                                                  - - - -
                                                                                                                  -
                                                                                                                  - - -
                                                                                                                  -

                                                                                                                  Finds the latitude and longitude for a portal using all available data sources. -This includes the list of portals, cached portal details, and information from links and fields.

                                                                                                                  -
                                                                                                                  - - - - - - - - - -
                                                                                                                  -
                                                                                                                  Parameters:
                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                  NameTypeDescription
                                                                                                                  guid - - -string - - - -

                                                                                                                  The GUID of the portal.

                                                                                                                  - -
                                                                                                                  - - - - - - - - - - - - - -
                                                                                                                  -
                                                                                                                  Returns:
                                                                                                                  - - - - - -L.LatLng -| - -undefined - - - - - --

                                                                                                                  The LatLng location of the portal, or undefined if not found.

                                                                                                                  - - - - - -
                                                                                                                  - - - - - -
                                                                                                                  - - - - - - - - - - - - - - - - -
                                                                                                                  Deprecated:
                                                                                                                  • Yes
                                                                                                                  - - - - - - - - - - - - - - - -
                                                                                                                  - - - - -
                                                                                                                  - - - - -
                                                                                                                  - -

                                                                                                                  - - inner getPortalApGain(guid) → {Object|undefined} - - - - -

                                                                                                                  - - - -
                                                                                                                  -
                                                                                                                  - - -
                                                                                                                  -

                                                                                                                  Estimates the AP gain from a portal, based only on summary data from portals, links, and fields. -Not entirely accurate - but available for all portals on the screen

                                                                                                                  -
                                                                                                                  - - - - - - - - - -
                                                                                                                  -
                                                                                                                  Parameters:
                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                  NameTypeDescription
                                                                                                                  guid - - -string - - - -

                                                                                                                  The GUID of the portal.

                                                                                                                  - -
                                                                                                                  - - - - - - - - - - - - - -
                                                                                                                  -
                                                                                                                  Returns:
                                                                                                                  - - - - - -Object -| - -undefined - - - - - --

                                                                                                                  An object containing various AP gain values, or undefined if the portal is not found.

                                                                                                                  - - - - - -
                                                                                                                  - - - - - -
                                                                                                                  - - - - - - - - - - - - - - - - -
                                                                                                                  Deprecated:
                                                                                                                  • Yes
                                                                                                                  - - - - - - - - - - - - - - - -
                                                                                                                  - - - - -
                                                                                                                  - - - - -
                                                                                                                  - -

                                                                                                                  - - inner getPortalApGain(guid) → {Object|undefined} - - - - -

                                                                                                                  - - - -
                                                                                                                  -
                                                                                                                  - - -
                                                                                                                  -

                                                                                                                  Estimates the AP gain from a portal, based only on summary data from portals, links, and fields. -Not entirely accurate - but available for all portals on the screen

                                                                                                                  -
                                                                                                                  - - - - - - - - - -
                                                                                                                  -
                                                                                                                  Parameters:
                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                  NameTypeDescription
                                                                                                                  guid - - -string - - - -

                                                                                                                  The GUID of the portal.

                                                                                                                  - -
                                                                                                                  - - - - - - - - - - - - - -
                                                                                                                  -
                                                                                                                  Returns:
                                                                                                                  - - - - - -Object -| - -undefined - - - - - --

                                                                                                                  An object containing various AP gain values, or undefined if the portal is not found.

                                                                                                                  - - - - - -
                                                                                                                  - - - - - -
                                                                                                                  - - - - - - - - - - - - - - - - -
                                                                                                                  Deprecated:
                                                                                                                  • Yes
                                                                                                                  - - - - - - - - - - - - - - - -
                                                                                                                  - - - - -
                                                                                                                  - - - - -
                                                                                                                  - -

                                                                                                                  - - inner portalApGainMaths(resCount, linkCount, fieldCount) → {Object} - - - - -

                                                                                                                  - - - -
                                                                                                                  -
                                                                                                                  - - -
                                                                                                                  -

                                                                                                                  Calculates the potential AP gain for capturing or destroying a portal, based on the number of resonators, -links, and fields. It does not account for AP gained from resonator upgrades or mod deployment.

                                                                                                                  -
                                                                                                                  - - - - - - - - - -
                                                                                                                  -
                                                                                                                  Parameters:
                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                  NameTypeDescription
                                                                                                                  resCount - - -number - - - -

                                                                                                                  The number of resonators on the portal.

                                                                                                                  linkCount - - -number - - - -

                                                                                                                  The number of links connected to the portal.

                                                                                                                  fieldCount - - -number - - - -

                                                                                                                  The number of fields using the portal as a vertex.

                                                                                                                  - -
                                                                                                                  - - - - - - - - - - - - - -
                                                                                                                  -
                                                                                                                  Returns:
                                                                                                                  - - - - - -Object - - - - - --

                                                                                                                  An object containing detailed AP gain values for various actions such as deploying resonators, -destroying resonators, creating fields, destroying links, capturing the portal, and total -AP for destroying and capturing.

                                                                                                                  - - - - - -
                                                                                                                  - - - - - -
                                                                                                                  - - - - - - - - - - - - - - - - -
                                                                                                                  Deprecated:
                                                                                                                  • Yes
                                                                                                                  - - - - - - - - - - - - - - - -
                                                                                                                  - - - - -
                                                                                                                  - - - - -
                                                                                                                  - -

                                                                                                                  - - inner portalApGainMaths(resCount, linkCount, fieldCount) → {Object} - - - - -

                                                                                                                  - - - -
                                                                                                                  -
                                                                                                                  - - -
                                                                                                                  -

                                                                                                                  Calculates the potential AP gain for capturing or destroying a portal, based on the number of resonators, -links, and fields. It does not account for AP gained from resonator upgrades or mod deployment.

                                                                                                                  -
                                                                                                                  - - - - - - - - - -
                                                                                                                  -
                                                                                                                  Parameters:
                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + @@ -3067,168 +839,6 @@
                                                                                                                  Returns:
                                                                                                                  -
                                                                                                                  Deprecated:
                                                                                                                  • Yes
                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                  - -

                                                                                                                  - - inner potentialPortalLevel(d) → {number} - - - - -

                                                                                                                  - - - -
                                                                                                                  -
                                                                                                                  - - -
                                                                                                                  -

                                                                                                                  Calculates the potential level a player can upgrade a portal to.

                                                                                                                  -
                                                                                                                  - - - - - - - - - -
                                                                                                                  -
                                                                                                                  Parameters:
                                                                                                                  - -
                                                                                                                  NameTypeDescription
                                                                                                                  resCount - - -number - - - -

                                                                                                                  The number of resonators on the portal.

                                                                                                                  linkCount - - -number - - - -

                                                                                                                  The number of links connected to the portal.

                                                                                                                  fieldCount - - -number - - - -

                                                                                                                  The number of fields using the portal as a vertex.

                                                                                                                  The number of fields using the portal as a vertex.

                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                  NameTypeDescription
                                                                                                                  d - - -Object - - - -

                                                                                                                  The portal detail object containing resonator and ownership information.

                                                                                                                  - -
                                                                                                                  - - - - - - - - - - - - - -
                                                                                                                  -
                                                                                                                  Returns:
                                                                                                                  - - - - - -number - - - - - --

                                                                                                                  The potential level to which the player can upgrade the portal.

                                                                                                                  - - - - - -
                                                                                                                  - - - - - -
                                                                                                                  - - - - - - - - - - - - - - - -
                                                                                                                  Deprecated:
                                                                                                                  • Yes
                                                                                                                  diff --git a/module-app.html b/module-app.html index a0f11aa31..d60cc4721 100644 --- a/module-app.html +++ b/module-app.html @@ -34,7 +34,7 @@

                                                                                                                  IITC-CE

                                                                                                                    - +
                                                                                                                    @@ -52,8 +52,6 @@

                                                                                                                    app

                                                                                                                    - - @@ -120,77 +118,6 @@

                                                                                                                    app

                                                                                                                    - - - - - - - - - - -
                                                                                                                    - - - - -
                                                                                                                    - - - - -
                                                                                                                    - -
                                                                                                                    -
                                                                                                                    - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                    - - - - - - - - - - - - - - - - - - - - @@ -289,85 +216,6 @@
                                                                                                                    Type:
                                                                                                                    - - - - - - - - - - -
                                                                                                                    - - - - - -
                                                                                                                    - - - - -
                                                                                                                    -

                                                                                                                    - static isApp :boolean - - - -

                                                                                                                    - - -
                                                                                                                    -
                                                                                                                    - -
                                                                                                                    -

                                                                                                                    Global flag indicating whether the app is running as a standalone app or within a browser.

                                                                                                                    -
                                                                                                                    - - - - - - - -
                                                                                                                    - - - - - - - - - - - - - - - - - - - - @@ -560,1255 +408,6 @@
                                                                                                                    Returns:
                                                                                                                    - - - - - - - - - - -
                                                                                                                    - - - - -
                                                                                                                    - - - - -
                                                                                                                    - -

                                                                                                                    - - inner debounce(callback, time) → {function} - - - - -

                                                                                                                    - - - -
                                                                                                                    -
                                                                                                                    - - -
                                                                                                                    -

                                                                                                                    Returns a function, that, as long as it continues to be invoked, will not be triggered. -The function will be called after it stops being called for N milliseconds. -source: https://gist.github.com/nmsdvid/8807205#gistcomment-2641356

                                                                                                                    -
                                                                                                                    - - - - - - - - - -
                                                                                                                    -
                                                                                                                    Parameters:
                                                                                                                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                    NameTypeDescription
                                                                                                                    callback - - -function - - - -

                                                                                                                    The function to debounce.

                                                                                                                    time - - -number - - - -

                                                                                                                    The debounce time in milliseconds.

                                                                                                                    - -
                                                                                                                    - - - - - - - - - - - - - -
                                                                                                                    -
                                                                                                                    Returns:
                                                                                                                    - - - - - -function - - - - - --

                                                                                                                    Returns a debounced version of the given function.

                                                                                                                    - - - - - -
                                                                                                                    - - - - - -
                                                                                                                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                    - - - - -
                                                                                                                    - - - - -
                                                                                                                    - -

                                                                                                                    - - inner useAppPanes() → {boolean} - - - - -

                                                                                                                    - - - -
                                                                                                                    -
                                                                                                                    - - -
                                                                                                                    -

                                                                                                                    Determines whether to use the interface for mobile devices depending on the application environment and device type.

                                                                                                                    -
                                                                                                                    - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                    -
                                                                                                                    Returns:
                                                                                                                    - - - - - -boolean - - - - - --

                                                                                                                    Returns true if app panes should be used, false otherwise.

                                                                                                                    - - - - - -
                                                                                                                    - - - - - -
                                                                                                                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                    - - - - -
                                                                                                                    - - - - -
                                                                                                                    - -

                                                                                                                    - - inner useAppPanes() → {boolean} - - - - -

                                                                                                                    - - - -
                                                                                                                    -
                                                                                                                    - - -
                                                                                                                    -

                                                                                                                    Determines whether to use the interface for mobile devices depending on the application environment and device type.

                                                                                                                    -
                                                                                                                    - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                    -
                                                                                                                    Returns:
                                                                                                                    - - - - - -boolean - - - - - --

                                                                                                                    Returns true if app panes should be used, false otherwise.

                                                                                                                    - - - - - -
                                                                                                                    - - - - - -
                                                                                                                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                    - - - - -
                                                                                                                    - -
                                                                                                                    - - - - - -
                                                                                                                    - -
                                                                                                                    - - - - - - - -
                                                                                                                    - -
                                                                                                                    - -

                                                                                                                    app

                                                                                                                    - - - - - - -
                                                                                                                    - -
                                                                                                                    - -
                                                                                                                    - - -

                                                                                                                    This file contains the main JavaScript code for the app, including utility functions, -app-specific behaviors, and integration with the Android environment.

                                                                                                                    - - - - - -
                                                                                                                    - -
                                                                                                                    -
                                                                                                                    - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                    - - - - -
                                                                                                                    - - - - -
                                                                                                                    - -
                                                                                                                    -
                                                                                                                    - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                    - - - - -
                                                                                                                    - - - -
                                                                                                                    - - - - - - - - - - - - - - - -

                                                                                                                    Members

                                                                                                                    - -
                                                                                                                    - - -
                                                                                                                    -

                                                                                                                    - static isApp :boolean - - - -

                                                                                                                    - - -
                                                                                                                    -
                                                                                                                    - -
                                                                                                                    -

                                                                                                                    Global flag indicating whether the app is running as a standalone app or within a browser.

                                                                                                                    -
                                                                                                                    - - - - - - - -
                                                                                                                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                    - - - - - -
                                                                                                                    - - - - -
                                                                                                                    -

                                                                                                                    - static isApp :boolean - - - -

                                                                                                                    - - -
                                                                                                                    -
                                                                                                                    - -
                                                                                                                    -

                                                                                                                    Global flag indicating whether the app is running as a standalone app or within a browser.

                                                                                                                    -
                                                                                                                    - - - - - - - -
                                                                                                                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                    - - - - - -
                                                                                                                    - -
                                                                                                                    - - - -

                                                                                                                    Methods

                                                                                                                    - -
                                                                                                                    - - -
                                                                                                                    - -

                                                                                                                    - - inner debounce(callback, time) → {function} - - - - -

                                                                                                                    - - - -
                                                                                                                    -
                                                                                                                    - - -
                                                                                                                    -

                                                                                                                    Returns a function, that, as long as it continues to be invoked, will not be triggered. -The function will be called after it stops being called for N milliseconds. -source: https://gist.github.com/nmsdvid/8807205#gistcomment-2641356

                                                                                                                    -
                                                                                                                    - - - - - - - - - -
                                                                                                                    -
                                                                                                                    Parameters:
                                                                                                                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                    NameTypeDescription
                                                                                                                    callback - - -function - - - -

                                                                                                                    The function to debounce.

                                                                                                                    time - - -number - - - -

                                                                                                                    The debounce time in milliseconds.

                                                                                                                    - -
                                                                                                                    - - - - - - - - - - - - - -
                                                                                                                    -
                                                                                                                    Returns:
                                                                                                                    - - - - - -function - - - - - --

                                                                                                                    Returns a debounced version of the given function.

                                                                                                                    - - - - - -
                                                                                                                    - - - - - -
                                                                                                                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                    - - - - -
                                                                                                                    - - - - -
                                                                                                                    - -

                                                                                                                    - - inner debounce(callback, time) → {function} - - - - -

                                                                                                                    - - - -
                                                                                                                    -
                                                                                                                    - - -
                                                                                                                    -

                                                                                                                    Returns a function, that, as long as it continues to be invoked, will not be triggered. -The function will be called after it stops being called for N milliseconds. -source: https://gist.github.com/nmsdvid/8807205#gistcomment-2641356

                                                                                                                    -
                                                                                                                    - - - - - - - - - -
                                                                                                                    -
                                                                                                                    Parameters:
                                                                                                                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                    NameTypeDescription
                                                                                                                    callback - - -function - - - -

                                                                                                                    The function to debounce.

                                                                                                                    time - - -number - - - -

                                                                                                                    The debounce time in milliseconds.

                                                                                                                    - -
                                                                                                                    - - - - - - - - - - - - - -
                                                                                                                    -
                                                                                                                    Returns:
                                                                                                                    - - - - - -function - - - - - --

                                                                                                                    Returns a debounced version of the given function.

                                                                                                                    - - - - - -
                                                                                                                    - - - - - -
                                                                                                                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                    - - - - -
                                                                                                                    - - - - -
                                                                                                                    - -

                                                                                                                    - - inner useAppPanes() → {boolean} - - - - -

                                                                                                                    - - - -
                                                                                                                    -
                                                                                                                    - - -
                                                                                                                    -

                                                                                                                    Determines whether to use the interface for mobile devices depending on the application environment and device type.

                                                                                                                    -
                                                                                                                    - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                    -
                                                                                                                    Returns:
                                                                                                                    - - - - - -boolean - - - - - --

                                                                                                                    Returns true if app panes should be used, false otherwise.

                                                                                                                    - - - - - -
                                                                                                                    - - - - - -
                                                                                                                    - - - - - - - - - - - - - - - - - - - - diff --git a/module-boot.html b/module-boot.html index 3f120278a..9ed0a0c5f 100644 --- a/module-boot.html +++ b/module-boot.html @@ -34,7 +34,7 @@

                                                                                                                    IITC-CE

                                                                                                                      - +
                                                                                                                      @@ -52,8 +52,6 @@

                                                                                                                      boot

                                                                                                                      - - @@ -120,77 +118,6 @@

                                                                                                                      boot

                                                                                                                      - - - - - - - - - - -
                                                                                                                      - - - - -
                                                                                                                      - - - - -
                                                                                                                      - -
                                                                                                                      -
                                                                                                                      - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                      - - - - - - - - - - - - - - - - - - - - @@ -325,14 +252,14 @@

                                                                                                                      -

                                                                                                                      +

                                                                                                                      - inner boot() + inner checkingIntelURL()

                                                                                                                      @@ -344,8 +271,7 @@

                                                                                                                      -

                                                                                                                      The main boot function that initializes IITC. It is responsible for setting up the map, -loading plugins, and initializing various components of IITC.

                                                                                                                      +

                                                                                                                      Checks if the IITC is being run on the official Intel URL. If not, it displays a warning dialog.

                                                                                                                      @@ -415,14 +341,14 @@

                                                                                                                      -

                                                                                                                      +

                                                                                                                      - inner checkingIntelURL() + inner prepPluginsToLoad() → {function}

                                                                                                                      @@ -434,7 +360,7 @@

                                                                                                                      -

                                                                                                                      Checks if the IITC is being run on the official Intel URL. If not, it displays a warning dialog.

                                                                                                                      +

                                                                                                                      Prepares plugins to load by sorting them based on their specified priority.

                                                                                                                      @@ -456,6 +382,27 @@

                                                                                                                      + +
                                                                                                                      +
                                                                                                                      Returns:
                                                                                                                      + + + + + +function + + + + + +-

                                                                                                                      A loader function that loads plugins up to a specified priority.

                                                                                                                      + + + + + +
                                                                                                                      @@ -504,14 +451,14 @@

                                                                                                                      -

                                                                                                                      +

                                                                                                                      - inner checkingIntelURL() + inner registerMarkerForOMS(marker)

                                                                                                                      @@ -523,7 +470,7 @@

                                                                                                                      -

                                                                                                                      Checks if the IITC is being run on the official Intel URL. If not, it displays a warning dialog.

                                                                                                                      +

                                                                                                                      Registers a marker with the OverlappingMarkerSpiderfier to manage its click events.

                                                                                                                      @@ -534,6 +481,56 @@

                                                                                                                      +
                                                                                                                      +
                                                                                                                      Parameters:
                                                                                                                      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
                                                                                                                      NameTypeDescription
                                                                                                                      marker + + +L.Marker + + + +

                                                                                                                      The Leaflet marker to be managed by OMS.

                                                                                                                      + +
                                                                                                                      + @@ -593,14 +590,14 @@

                                                                                                                      -

                                                                                                                      +

                                                                                                                      - inner prepPluginsToLoad() → {function} + inner setupIngressMarkers()

                                                                                                                      @@ -612,7 +609,7 @@

                                                                                                                      -

                                                                                                                      Prepares plugins to load by sorting them based on their specified priority.

                                                                                                                      +

                                                                                                                      Initializes Ingress markers with custom icons.

                                                                                                                      @@ -634,27 +631,6 @@

                                                                                                                      - -
                                                                                                                      -
                                                                                                                      Returns:
                                                                                                                      - - - - - -function - - - - - --

                                                                                                                      A loader function that loads plugins up to a specified priority.

                                                                                                                      - - - - - -
                                                                                                                      @@ -703,14 +679,14 @@

                                                                                                                      Returns:
                                                                                                                      -

                                                                                                                      +

                                                                                                                      - inner prepPluginsToLoad() → {function} + inner setupOMS()

                                                                                                                      @@ -722,58 +698,15 @@

                                                                                                                      -

                                                                                                                      Prepares plugins to load by sorting them based on their specified priority.

                                                                                                                      -
                                                                                                                      - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                      -
                                                                                                                      Returns:
                                                                                                                      - - - - - -function - - - - - --

                                                                                                                      A loader function that loads plugins up to a specified priority.

                                                                                                                      - - - - - +

                                                                                                                      Sets up the OverlappingMarkerSpiderfier (OMS) library for handling overlapping markers on the map. +OMS doesn't cancel the original click event, so the topmost marker will get a click event while spiderfying. +Also, OMS only supports a global callback for all managed markers. Therefore, we will use a custom event that gets fired +for each marker.

                                                                                                                      - -
                                                                                                                      - - - @@ -791,2548 +724,6 @@
                                                                                                                      Returns:
                                                                                                                      - - - - - - - - - - -
                                                                                                                      - - - - -

                                                                                                                      - - - - -
                                                                                                                      - -

                                                                                                                      - - inner registerMarkerForOMS(marker) - - - - -

                                                                                                                      - - - -
                                                                                                                      -
                                                                                                                      - - -
                                                                                                                      -

                                                                                                                      Registers a marker with the OverlappingMarkerSpiderfier to manage its click events.

                                                                                                                      -
                                                                                                                      - - - - - - - - - -
                                                                                                                      -
                                                                                                                      Parameters:
                                                                                                                      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                      NameTypeDescription
                                                                                                                      marker - - -L.Marker - - - -

                                                                                                                      The Leaflet marker to be managed by OMS.

                                                                                                                      - -
                                                                                                                      - - - - - - - - - - - - - - - - - -
                                                                                                                      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                      - - - - -
                                                                                                                      - - - - -
                                                                                                                      - -

                                                                                                                      - - inner registerMarkerForOMS(marker) - - - - -

                                                                                                                      - - - -
                                                                                                                      -
                                                                                                                      - - -
                                                                                                                      -

                                                                                                                      Registers a marker with the OverlappingMarkerSpiderfier to manage its click events.

                                                                                                                      -
                                                                                                                      - - - - - - - - - -
                                                                                                                      -
                                                                                                                      Parameters:
                                                                                                                      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                      NameTypeDescription
                                                                                                                      marker - - -L.Marker - - - -

                                                                                                                      The Leaflet marker to be managed by OMS.

                                                                                                                      - -
                                                                                                                      - - - - - - - - - - - - - - - - - -
                                                                                                                      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                      - - - - -
                                                                                                                      - - - - -
                                                                                                                      - -

                                                                                                                      - - inner setupIngressMarkers() - - - - -

                                                                                                                      - - - -
                                                                                                                      -
                                                                                                                      - - -
                                                                                                                      -

                                                                                                                      Initializes Ingress markers with custom icons.

                                                                                                                      -
                                                                                                                      - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                      - - - - -
                                                                                                                      - - - - -
                                                                                                                      - -

                                                                                                                      - - inner setupIngressMarkers() - - - - -

                                                                                                                      - - - -
                                                                                                                      -
                                                                                                                      - - -
                                                                                                                      -

                                                                                                                      Initializes Ingress markers with custom icons.

                                                                                                                      -
                                                                                                                      - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                      - - - - -
                                                                                                                      - - - - -
                                                                                                                      - -

                                                                                                                      - - inner setupOMS() - - - - -

                                                                                                                      - - - -
                                                                                                                      -
                                                                                                                      - - -
                                                                                                                      -

                                                                                                                      Sets up the OverlappingMarkerSpiderfier (OMS) library for handling overlapping markers on the map. -OMS doesn't cancel the original click event, so the topmost marker will get a click event while spiderfying. -Also, OMS only supports a global callback for all managed markers. Therefore, we will use a custom event that gets fired -for each marker.

                                                                                                                      -
                                                                                                                      - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                      - - - - -
                                                                                                                      - - - - -
                                                                                                                      - -

                                                                                                                      - - inner setupOMS() - - - - -

                                                                                                                      - - - -
                                                                                                                      -
                                                                                                                      - - -
                                                                                                                      -

                                                                                                                      Sets up the OverlappingMarkerSpiderfier (OMS) library for handling overlapping markers on the map. -OMS doesn't cancel the original click event, so the topmost marker will get a click event while spiderfying. -Also, OMS only supports a global callback for all managed markers. Therefore, we will use a custom event that gets fired -for each marker.

                                                                                                                      -
                                                                                                                      - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                      - - - - -
                                                                                                                      - - - - -
                                                                                                                      - -

                                                                                                                      - - inner setupTooltips(elementopt) - - - - -

                                                                                                                      - - - -
                                                                                                                      -
                                                                                                                      - - -
                                                                                                                      -

                                                                                                                      Initializes tooltips for a specified element or the entire document if no element is provided. -This function sets up jQuery UI tooltips with customized behavior. It ensures that only one tooltip -is visible at a time by closing others when a new one opens. The content of the tooltip is derived -from the 'title' attribute of the HTML element and is processed by the convertTextToTableMagic function.

                                                                                                                      -

                                                                                                                      Additionally, this function sets up a one-time event handler (if not already set) on the document -to remove tooltips when clicked. This is controlled by the tooltipClearerHasBeenSetup flag to prevent -multiple bindings of the event handler.

                                                                                                                      -
                                                                                                                      - - - - - - - - - -
                                                                                                                      -
                                                                                                                      Parameters:
                                                                                                                      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                      NameTypeAttributesDefaultDescription
                                                                                                                      element - - -jQuery -| - -HTMLElement - - - - - - <optional>
                                                                                                                      - - - - - -
                                                                                                                      - - document - -

                                                                                                                      The jQuery or DOM element to which the tooltips will be attached. -If not provided, the document itself is used.

                                                                                                                      - -
                                                                                                                      - - - - - - - - - - - - - - - - - -
                                                                                                                      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                      - - - - -
                                                                                                                      - - - - -
                                                                                                                      - -

                                                                                                                      - - inner setupTooltips(elementopt) - - - - -

                                                                                                                      - - - -
                                                                                                                      -
                                                                                                                      - - -
                                                                                                                      -

                                                                                                                      Initializes tooltips for a specified element or the entire document if no element is provided. -This function sets up jQuery UI tooltips with customized behavior. It ensures that only one tooltip -is visible at a time by closing others when a new one opens. The content of the tooltip is derived -from the 'title' attribute of the HTML element and is processed by the convertTextToTableMagic function.

                                                                                                                      -

                                                                                                                      Additionally, this function sets up a one-time event handler (if not already set) on the document -to remove tooltips when clicked. This is controlled by the tooltipClearerHasBeenSetup flag to prevent -multiple bindings of the event handler.

                                                                                                                      -
                                                                                                                      - - - - - - - - - -
                                                                                                                      -
                                                                                                                      Parameters:
                                                                                                                      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                      NameTypeAttributesDefaultDescription
                                                                                                                      element - - -jQuery -| - -HTMLElement - - - - - - <optional>
                                                                                                                      - - - - - -
                                                                                                                      - - document - -

                                                                                                                      The jQuery or DOM element to which the tooltips will be attached. -If not provided, the document itself is used.

                                                                                                                      - -
                                                                                                                      - - - - - - - - - - - - - - - - - -
                                                                                                                      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                      - - - - -
                                                                                                                      - -
                                                                                                                      - - - - - -
                                                                                                                      - -
                                                                                                                      - - - - - - - -
                                                                                                                      - -
                                                                                                                      - -

                                                                                                                      boot

                                                                                                                      - - - - - - -
                                                                                                                      - -
                                                                                                                      - -
                                                                                                                      - - -

                                                                                                                      These functions set up specific areas after the boot function created a basic framework. -All of these functions should only ever be run once.

                                                                                                                      - - - - - -
                                                                                                                      - -
                                                                                                                      -
                                                                                                                      - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                      - - - - -
                                                                                                                      - - - - -
                                                                                                                      - -
                                                                                                                      -
                                                                                                                      - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                      - - - - -
                                                                                                                      - - - -
                                                                                                                      - - - - - - - - - - - - - - - - - -

                                                                                                                      Methods

                                                                                                                      - -
                                                                                                                      - - -
                                                                                                                      - -

                                                                                                                      - - inner boot() - - - - -

                                                                                                                      - - - -
                                                                                                                      -
                                                                                                                      - - -
                                                                                                                      -

                                                                                                                      The main boot function that initializes IITC. It is responsible for setting up the map, -loading plugins, and initializing various components of IITC.

                                                                                                                      -
                                                                                                                      - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                      - - - - -
                                                                                                                      - - - - -
                                                                                                                      - -

                                                                                                                      - - inner boot() - - - - -

                                                                                                                      - - - -
                                                                                                                      -
                                                                                                                      - - -
                                                                                                                      -

                                                                                                                      The main boot function that initializes IITC. It is responsible for setting up the map, -loading plugins, and initializing various components of IITC.

                                                                                                                      -
                                                                                                                      - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                      - - - - -
                                                                                                                      - - - - -
                                                                                                                      - -

                                                                                                                      - - inner checkingIntelURL() - - - - -

                                                                                                                      - - - -
                                                                                                                      -
                                                                                                                      - - -
                                                                                                                      -

                                                                                                                      Checks if the IITC is being run on the official Intel URL. If not, it displays a warning dialog.

                                                                                                                      -
                                                                                                                      - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                      - - - - -
                                                                                                                      - - - - -
                                                                                                                      - -

                                                                                                                      - - inner checkingIntelURL() - - - - -

                                                                                                                      - - - -
                                                                                                                      -
                                                                                                                      - - -
                                                                                                                      -

                                                                                                                      Checks if the IITC is being run on the official Intel URL. If not, it displays a warning dialog.

                                                                                                                      -
                                                                                                                      - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                      - - - - -
                                                                                                                      - - - - -
                                                                                                                      - -

                                                                                                                      - - inner prepPluginsToLoad() → {function} - - - - -

                                                                                                                      - - - -
                                                                                                                      -
                                                                                                                      - - -
                                                                                                                      -

                                                                                                                      Prepares plugins to load by sorting them based on their specified priority.

                                                                                                                      -
                                                                                                                      - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                      -
                                                                                                                      Returns:
                                                                                                                      - - - - - -function - - - - - --

                                                                                                                      A loader function that loads plugins up to a specified priority.

                                                                                                                      - - - - - -
                                                                                                                      - - - - - -
                                                                                                                      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                      - - - - -
                                                                                                                      - - - - -
                                                                                                                      - -

                                                                                                                      - - inner prepPluginsToLoad() → {function} - - - - -

                                                                                                                      - - - -
                                                                                                                      -
                                                                                                                      - - -
                                                                                                                      -

                                                                                                                      Prepares plugins to load by sorting them based on their specified priority.

                                                                                                                      -
                                                                                                                      - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                      -
                                                                                                                      Returns:
                                                                                                                      - - - - - -function - - - - - --

                                                                                                                      A loader function that loads plugins up to a specified priority.

                                                                                                                      - - - - - -
                                                                                                                      - - - - - -
                                                                                                                      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                      - - - - -
                                                                                                                      - - - - -
                                                                                                                      - -

                                                                                                                      - - inner registerMarkerForOMS(marker) - - - - -

                                                                                                                      - - - -
                                                                                                                      -
                                                                                                                      - - -
                                                                                                                      -

                                                                                                                      Registers a marker with the OverlappingMarkerSpiderfier to manage its click events.

                                                                                                                      -
                                                                                                                      - - - - - - - - - -
                                                                                                                      -
                                                                                                                      Parameters:
                                                                                                                      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                      NameTypeDescription
                                                                                                                      marker - - -L.Marker - - - -

                                                                                                                      The Leaflet marker to be managed by OMS.

                                                                                                                      - -
                                                                                                                      - - - - - - - - - - - - - - - - - -
                                                                                                                      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                      - - - - -
                                                                                                                      - - - - -
                                                                                                                      - -

                                                                                                                      - - inner registerMarkerForOMS(marker) - - - - -

                                                                                                                      - - - -
                                                                                                                      -
                                                                                                                      - - -
                                                                                                                      -

                                                                                                                      Registers a marker with the OverlappingMarkerSpiderfier to manage its click events.

                                                                                                                      -
                                                                                                                      - - - - - - - - - -
                                                                                                                      -
                                                                                                                      Parameters:
                                                                                                                      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                      NameTypeDescription
                                                                                                                      marker - - -L.Marker - - - -

                                                                                                                      The Leaflet marker to be managed by OMS.

                                                                                                                      - -
                                                                                                                      - - - - - - - - - - - - - - - - - -
                                                                                                                      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                      - - - - -
                                                                                                                      - - - - -
                                                                                                                      - -

                                                                                                                      - - inner setupIngressMarkers() - - - - -

                                                                                                                      - - - -
                                                                                                                      -
                                                                                                                      - - -
                                                                                                                      -

                                                                                                                      Initializes Ingress markers with custom icons.

                                                                                                                      -
                                                                                                                      - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                      - - - - -
                                                                                                                      - - - - -
                                                                                                                      - -

                                                                                                                      - - inner setupIngressMarkers() - - - - -

                                                                                                                      - - - -
                                                                                                                      -
                                                                                                                      - - -
                                                                                                                      -

                                                                                                                      Initializes Ingress markers with custom icons.

                                                                                                                      -
                                                                                                                      - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                      - - - - -
                                                                                                                      - - - - -
                                                                                                                      - -

                                                                                                                      - - inner setupOMS() - - - - -

                                                                                                                      - - - -
                                                                                                                      -
                                                                                                                      - - -
                                                                                                                      -

                                                                                                                      Sets up the OverlappingMarkerSpiderfier (OMS) library for handling overlapping markers on the map. -OMS doesn't cancel the original click event, so the topmost marker will get a click event while spiderfying. -Also, OMS only supports a global callback for all managed markers. Therefore, we will use a custom event that gets fired -for each marker.

                                                                                                                      -
                                                                                                                      - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                      - - - - -
                                                                                                                      - - - - -
                                                                                                                      - -

                                                                                                                      - - inner setupOMS() - - - - -

                                                                                                                      - - - -
                                                                                                                      -
                                                                                                                      - - -
                                                                                                                      -

                                                                                                                      Sets up the OverlappingMarkerSpiderfier (OMS) library for handling overlapping markers on the map. -OMS doesn't cancel the original click event, so the topmost marker will get a click event while spiderfying. -Also, OMS only supports a global callback for all managed markers. Therefore, we will use a custom event that gets fired -for each marker.

                                                                                                                      -
                                                                                                                      - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                      - - - - -
                                                                                                                      - - - - -
                                                                                                                      - -

                                                                                                                      - - inner setupTooltips(elementopt) - - - - -

                                                                                                                      - - - -
                                                                                                                      -
                                                                                                                      - - -
                                                                                                                      -

                                                                                                                      Initializes tooltips for a specified element or the entire document if no element is provided. -This function sets up jQuery UI tooltips with customized behavior. It ensures that only one tooltip -is visible at a time by closing others when a new one opens. The content of the tooltip is derived -from the 'title' attribute of the HTML element and is processed by the convertTextToTableMagic function.

                                                                                                                      -

                                                                                                                      Additionally, this function sets up a one-time event handler (if not already set) on the document -to remove tooltips when clicked. This is controlled by the tooltipClearerHasBeenSetup flag to prevent -multiple bindings of the event handler.

                                                                                                                      -
                                                                                                                      - - - - - - - - - -
                                                                                                                      -
                                                                                                                      Parameters:
                                                                                                                      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                      NameTypeAttributesDefaultDescription
                                                                                                                      element - - -jQuery -| - -HTMLElement - - - - - - <optional>
                                                                                                                      - - - - - -
                                                                                                                      - - document - -

                                                                                                                      The jQuery or DOM element to which the tooltips will be attached. -If not provided, the document itself is used.

                                                                                                                      - -
                                                                                                                      - - - - - - - - - - - - - diff --git a/module-dialog.html b/module-dialog.html index 77350e8ed..616aa3f28 100644 --- a/module-dialog.html +++ b/module-dialog.html @@ -34,7 +34,7 @@

                                                                                                                      IITC-CE

                                                                                                                        - +
                                                                                                                        @@ -52,8 +52,6 @@

                                                                                                                        dialog

                                                                                                                        - - @@ -119,77 +117,6 @@

                                                                                                                        dialog

                                                                                                                        - - - - - - - - - - -
                                                                                                                        - - - - - - - - - -
                                                                                                                        - -
                                                                                                                        -
                                                                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                        - - - - - - - - - - - - - - - - - - - - @@ -288,85 +215,6 @@
                                                                                                                        Type:
                                                                                                                        - - - - - - - - - - -
                                                                                                                        - - - - - -
                                                                                                                        - - - - -
                                                                                                                        -

                                                                                                                        - static window.DIALOG_ID :number - - - -

                                                                                                                        - - -
                                                                                                                        -
                                                                                                                        - -
                                                                                                                        -

                                                                                                                        The global ID of onscreen dialogs. Starts at 0.

                                                                                                                        -
                                                                                                                        - - - - - - - -
                                                                                                                        - - - - - - - - - - - - - - - - - - - - @@ -635,2871 +483,6 @@
                                                                                                                        Returns:
                                                                                                                        - - - -
                                                                                                                        - - - - -
                                                                                                                        - - - - -
                                                                                                                        - -

                                                                                                                        - - inner alert(text, isHTMLopt, closeCallbackopt) → {jQuery} - - - - -

                                                                                                                        - - - -
                                                                                                                        -
                                                                                                                        - - -
                                                                                                                        -

                                                                                                                        Creates an alert dialog with default settings. This function is a simplified wrapper around window.dialog. -It provides a quick way to create basic alert dialogs with optional HTML content and a close callback.

                                                                                                                        -
                                                                                                                        - - - - - - - - - -
                                                                                                                        -
                                                                                                                        Parameters:
                                                                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                        NameTypeAttributesDefaultDescription
                                                                                                                        text - - -string - - - - - - - - - - - -

                                                                                                                        The text or HTML content to display in the alert dialog.

                                                                                                                        isHTML - - -boolean - - - - - - <optional>
                                                                                                                        - - - - - -
                                                                                                                        - - false - -

                                                                                                                        Specifies whether the text parameter should be treated as HTML. -If true, the text will be inserted as HTML, otherwise as plain text.

                                                                                                                        closeCallback - - -function - - - - - - <optional>
                                                                                                                        - - - - - -
                                                                                                                        - -

                                                                                                                        A callback function to be executed when the alert dialog is closed.

                                                                                                                        - -
                                                                                                                        - - - - - - - - - - - - - -
                                                                                                                        -
                                                                                                                        Returns:
                                                                                                                        - - - - - -jQuery - - - - - --

                                                                                                                        The jQuery object representing the created alert dialog.

                                                                                                                        - - - - - -
                                                                                                                        - - - - - -
                                                                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                        - - - - -
                                                                                                                        - - - - -
                                                                                                                        - -

                                                                                                                        - - inner dialog(options) → {jQuery} - - - - -

                                                                                                                        - - - -
                                                                                                                        -
                                                                                                                        - - -
                                                                                                                        -

                                                                                                                        Creates a dialog and puts it onscreen with various options and callbacks.

                                                                                                                        -
                                                                                                                        - - - - - - - - - -
                                                                                                                        -
                                                                                                                        Parameters:
                                                                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                        NameTypeDescription
                                                                                                                        options - - -Object - - - -

                                                                                                                        Configuration options for the dialog.

                                                                                                                        -
                                                                                                                        Properties
                                                                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                        NameTypeAttributesDefaultDescription
                                                                                                                        text - - -string -| - -HTMLElement - - - - - - <optional>
                                                                                                                        - - - - - -
                                                                                                                        - -

                                                                                                                        The text or HTML to display in the dialog. -Text is auto-converted to HTML.

                                                                                                                        title - - -string - - - - - - <optional>
                                                                                                                        - - - - - -
                                                                                                                        - -

                                                                                                                        The dialog's title.

                                                                                                                        modal - - -boolean - - - - - - <optional>
                                                                                                                        - - - - - -
                                                                                                                        - - false - -

                                                                                                                        Whether to open a modal dialog. Implies draggable=false; -dialogClass='ui-dialog-modal'. Note that modal dialogs hijack -the entire screen and should only be used in specific cases. -If IITC is running on mobile, modal will always be true.

                                                                                                                        id - - -string - - - - - - <optional>
                                                                                                                        - - - - - -
                                                                                                                        - -

                                                                                                                        A unique ID for this dialog. If a dialog with this ID is already open, -it will be automatically closed.

                                                                                                                        closeCallback - - -function - - - - - - <optional>
                                                                                                                        - - - - - -
                                                                                                                        - -

                                                                                                                        A callback to run on close.

                                                                                                                        collapseCallback - - -function - - - - - - <optional>
                                                                                                                        - - - - - -
                                                                                                                        - -

                                                                                                                        A callback to run on dialog collapse.

                                                                                                                        expandCallback - - -function - - - - - - <optional>
                                                                                                                        - - - - - -
                                                                                                                        - -

                                                                                                                        A callback to run on dialog expansion.

                                                                                                                        collapseExpandCallback - - -function - - - - - - <optional>
                                                                                                                        - - - - - -
                                                                                                                        - -

                                                                                                                        A callback to run on both collapse and expand. -Overrides collapseCallback and expandCallback. -Receives a boolean argument collapsing.

                                                                                                                        focusCallback - - -function - - - - - - <optional>
                                                                                                                        - - - - - -
                                                                                                                        - -

                                                                                                                        A callback to run when the dialog gains focus.

                                                                                                                        blurCallback - - -function - - - - - - <optional>
                                                                                                                        - - - - - -
                                                                                                                        - -

                                                                                                                        A callback to run when the dialog loses focus.

                                                                                                                        - -
                                                                                                                        - -
                                                                                                                        - - - - - - - - - - - - - -
                                                                                                                        -
                                                                                                                        Returns:
                                                                                                                        - - - - - -jQuery - - - - - --

                                                                                                                        The jQuery object representing the created dialog.

                                                                                                                        - - - - - -
                                                                                                                        - - - - - -
                                                                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                        See:
                                                                                                                        -
                                                                                                                        -
                                                                                                                          -
                                                                                                                        • http://docs.jquery.com/UI/API/1.8/Dialog for a list of all jQuery UI Dialog options. -If you previously applied a class to your dialog after creating it with alert(), -dialogClass may be particularly useful.
                                                                                                                        • -
                                                                                                                        -
                                                                                                                        - - - -
                                                                                                                        - - - - -
                                                                                                                        - - - - -
                                                                                                                        - -

                                                                                                                        - - inner dialog(options) → {jQuery} - - - - -

                                                                                                                        - - - -
                                                                                                                        -
                                                                                                                        - - -
                                                                                                                        -

                                                                                                                        Creates a dialog and puts it onscreen with various options and callbacks.

                                                                                                                        -
                                                                                                                        - - - - - - - - - -
                                                                                                                        -
                                                                                                                        Parameters:
                                                                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                        NameTypeDescription
                                                                                                                        options - - -Object - - - -

                                                                                                                        Configuration options for the dialog.

                                                                                                                        -
                                                                                                                        Properties
                                                                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                        NameTypeAttributesDefaultDescription
                                                                                                                        text - - -string -| - -HTMLElement - - - - - - <optional>
                                                                                                                        - - - - - -
                                                                                                                        - -

                                                                                                                        The text or HTML to display in the dialog. -Text is auto-converted to HTML.

                                                                                                                        title - - -string - - - - - - <optional>
                                                                                                                        - - - - - -
                                                                                                                        - -

                                                                                                                        The dialog's title.

                                                                                                                        modal - - -boolean - - - - - - <optional>
                                                                                                                        - - - - - -
                                                                                                                        - - false - -

                                                                                                                        Whether to open a modal dialog. Implies draggable=false; -dialogClass='ui-dialog-modal'. Note that modal dialogs hijack -the entire screen and should only be used in specific cases. -If IITC is running on mobile, modal will always be true.

                                                                                                                        id - - -string - - - - - - <optional>
                                                                                                                        - - - - - -
                                                                                                                        - -

                                                                                                                        A unique ID for this dialog. If a dialog with this ID is already open, -it will be automatically closed.

                                                                                                                        closeCallback - - -function - - - - - - <optional>
                                                                                                                        - - - - - -
                                                                                                                        - -

                                                                                                                        A callback to run on close.

                                                                                                                        collapseCallback - - -function - - - - - - <optional>
                                                                                                                        - - - - - -
                                                                                                                        - -

                                                                                                                        A callback to run on dialog collapse.

                                                                                                                        expandCallback - - -function - - - - - - <optional>
                                                                                                                        - - - - - -
                                                                                                                        - -

                                                                                                                        A callback to run on dialog expansion.

                                                                                                                        collapseExpandCallback - - -function - - - - - - <optional>
                                                                                                                        - - - - - -
                                                                                                                        - -

                                                                                                                        A callback to run on both collapse and expand. -Overrides collapseCallback and expandCallback. -Receives a boolean argument collapsing.

                                                                                                                        focusCallback - - -function - - - - - - <optional>
                                                                                                                        - - - - - -
                                                                                                                        - -

                                                                                                                        A callback to run when the dialog gains focus.

                                                                                                                        blurCallback - - -function - - - - - - <optional>
                                                                                                                        - - - - - -
                                                                                                                        - -

                                                                                                                        A callback to run when the dialog loses focus.

                                                                                                                        - -
                                                                                                                        - -
                                                                                                                        - - - - - - - - - - - - - -
                                                                                                                        -
                                                                                                                        Returns:
                                                                                                                        - - - - - -jQuery - - - - - --

                                                                                                                        The jQuery object representing the created dialog.

                                                                                                                        - - - - - -
                                                                                                                        - - - - - -
                                                                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                        See:
                                                                                                                        -
                                                                                                                        -
                                                                                                                          -
                                                                                                                        • http://docs.jquery.com/UI/API/1.8/Dialog for a list of all jQuery UI Dialog options. -If you previously applied a class to your dialog after creating it with alert(), -dialogClass may be particularly useful.
                                                                                                                        • -
                                                                                                                        -
                                                                                                                        - - - -
                                                                                                                        - - - - -
                                                                                                                        - - - - - - - -
                                                                                                                        - -
                                                                                                                        - - - - - - - -
                                                                                                                        - -
                                                                                                                        - -

                                                                                                                        dialog

                                                                                                                        - - - - - - -
                                                                                                                        - -
                                                                                                                        - -
                                                                                                                        - - -

                                                                                                                        Dialogs inspired by TES III: Morrowind. Long live House Telvanni.

                                                                                                                        - - - - - -
                                                                                                                        - -
                                                                                                                        -
                                                                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                        - - - - -
                                                                                                                        - - - - -
                                                                                                                        - -
                                                                                                                        -
                                                                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                        - - - - -
                                                                                                                        - - - -
                                                                                                                        - - - - - - - - - - - - - - - -

                                                                                                                        Members

                                                                                                                        - -
                                                                                                                        - - -
                                                                                                                        -

                                                                                                                        - static window.DIALOG_ID :number - - - -

                                                                                                                        - - -
                                                                                                                        -
                                                                                                                        - -
                                                                                                                        -

                                                                                                                        The global ID of onscreen dialogs. Starts at 0.

                                                                                                                        -
                                                                                                                        - - - - - - - -
                                                                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                        - - - - - -
                                                                                                                        - - - - -
                                                                                                                        -

                                                                                                                        - static window.DIALOG_ID :number - - - -

                                                                                                                        - - -
                                                                                                                        -
                                                                                                                        - -
                                                                                                                        -

                                                                                                                        The global ID of onscreen dialogs. Starts at 0.

                                                                                                                        -
                                                                                                                        - - - - - - - -
                                                                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                        - - - - - -
                                                                                                                        - -
                                                                                                                        - - - -

                                                                                                                        Methods

                                                                                                                        - -
                                                                                                                        - - -
                                                                                                                        - -

                                                                                                                        - - inner alert(text, isHTMLopt, closeCallbackopt) → {jQuery} - - - - -

                                                                                                                        - - - -
                                                                                                                        -
                                                                                                                        - - -
                                                                                                                        -

                                                                                                                        Creates an alert dialog with default settings. This function is a simplified wrapper around window.dialog. -It provides a quick way to create basic alert dialogs with optional HTML content and a close callback.

                                                                                                                        -
                                                                                                                        - - - - - - - - - -
                                                                                                                        -
                                                                                                                        Parameters:
                                                                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                        NameTypeAttributesDefaultDescription
                                                                                                                        text - - -string - - - - - - - - - - - -

                                                                                                                        The text or HTML content to display in the alert dialog.

                                                                                                                        isHTML - - -boolean - - - - - - <optional>
                                                                                                                        - - - - - -
                                                                                                                        - - false - -

                                                                                                                        Specifies whether the text parameter should be treated as HTML. -If true, the text will be inserted as HTML, otherwise as plain text.

                                                                                                                        closeCallback - - -function - - - - - - <optional>
                                                                                                                        - - - - - -
                                                                                                                        - -

                                                                                                                        A callback function to be executed when the alert dialog is closed.

                                                                                                                        - -
                                                                                                                        - - - - - - - - - - - - - -
                                                                                                                        -
                                                                                                                        Returns:
                                                                                                                        - - - - - -jQuery - - - - - --

                                                                                                                        The jQuery object representing the created alert dialog.

                                                                                                                        - - - - - -
                                                                                                                        - - - - - -
                                                                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                        - - - - -
                                                                                                                        - - - - -
                                                                                                                        - -

                                                                                                                        - - inner alert(text, isHTMLopt, closeCallbackopt) → {jQuery} - - - - -

                                                                                                                        - - - -
                                                                                                                        -
                                                                                                                        - - -
                                                                                                                        -

                                                                                                                        Creates an alert dialog with default settings. This function is a simplified wrapper around window.dialog. -It provides a quick way to create basic alert dialogs with optional HTML content and a close callback.

                                                                                                                        -
                                                                                                                        - - - - - - - - - -
                                                                                                                        -
                                                                                                                        Parameters:
                                                                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                        NameTypeAttributesDefaultDescription
                                                                                                                        text - - -string - - - - - - - - - - - -

                                                                                                                        The text or HTML content to display in the alert dialog.

                                                                                                                        isHTML - - -boolean - - - - - - <optional>
                                                                                                                        - - - - - -
                                                                                                                        - - false - -

                                                                                                                        Specifies whether the text parameter should be treated as HTML. -If true, the text will be inserted as HTML, otherwise as plain text.

                                                                                                                        closeCallback - - -function - - - - - - <optional>
                                                                                                                        - - - - - -
                                                                                                                        - -

                                                                                                                        A callback function to be executed when the alert dialog is closed.

                                                                                                                        - -
                                                                                                                        - - - - - - - - - - - - - -
                                                                                                                        -
                                                                                                                        Returns:
                                                                                                                        - - - - - -jQuery - - - - - --

                                                                                                                        The jQuery object representing the created alert dialog.

                                                                                                                        - - - - - -
                                                                                                                        - - - - - -
                                                                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                        - - - - -
                                                                                                                        - - - - -
                                                                                                                        - -

                                                                                                                        - - inner dialog(options) → {jQuery} - - - - -

                                                                                                                        - - - -
                                                                                                                        -
                                                                                                                        - - -
                                                                                                                        -

                                                                                                                        Creates a dialog and puts it onscreen with various options and callbacks.

                                                                                                                        -
                                                                                                                        - - - - - - - - - -
                                                                                                                        -
                                                                                                                        Parameters:
                                                                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                        NameTypeDescription
                                                                                                                        options - - -Object - - - -

                                                                                                                        Configuration options for the dialog.

                                                                                                                        -
                                                                                                                        Properties
                                                                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                        NameTypeAttributesDefaultDescription
                                                                                                                        text - - -string -| - -HTMLElement - - - - - - <optional>
                                                                                                                        - - - - - -
                                                                                                                        - -

                                                                                                                        The text or HTML to display in the dialog. -Text is auto-converted to HTML.

                                                                                                                        title - - -string - - - - - - <optional>
                                                                                                                        - - - - - -
                                                                                                                        - -

                                                                                                                        The dialog's title.

                                                                                                                        modal - - -boolean - - - - - - <optional>
                                                                                                                        - - - - - -
                                                                                                                        - - false - -

                                                                                                                        Whether to open a modal dialog. Implies draggable=false; -dialogClass='ui-dialog-modal'. Note that modal dialogs hijack -the entire screen and should only be used in specific cases. -If IITC is running on mobile, modal will always be true.

                                                                                                                        id - - -string - - - - - - <optional>
                                                                                                                        - - - - - -
                                                                                                                        - -

                                                                                                                        A unique ID for this dialog. If a dialog with this ID is already open, -it will be automatically closed.

                                                                                                                        closeCallback - - -function - - - - - - <optional>
                                                                                                                        - - - - - -
                                                                                                                        - -

                                                                                                                        A callback to run on close.

                                                                                                                        collapseCallback - - -function - - - - - - <optional>
                                                                                                                        - - - - - -
                                                                                                                        - -

                                                                                                                        A callback to run on dialog collapse.

                                                                                                                        expandCallback - - -function - - - - - - <optional>
                                                                                                                        - - - - - -
                                                                                                                        - -

                                                                                                                        A callback to run on dialog expansion.

                                                                                                                        collapseExpandCallback - - -function - - - - - - <optional>
                                                                                                                        - - - - - -
                                                                                                                        - -

                                                                                                                        A callback to run on both collapse and expand. -Overrides collapseCallback and expandCallback. -Receives a boolean argument collapsing.

                                                                                                                        focusCallback - - -function - - - - - - <optional>
                                                                                                                        - - - - - -
                                                                                                                        - -

                                                                                                                        A callback to run when the dialog gains focus.

                                                                                                                        blurCallback - - -function - - - - - - <optional>
                                                                                                                        - - - - - -
                                                                                                                        - -

                                                                                                                        A callback to run when the dialog loses focus.

                                                                                                                        - -
                                                                                                                        - -
                                                                                                                        - - - - - - - - - - - - - -
                                                                                                                        -
                                                                                                                        Returns:
                                                                                                                        - - - - - -jQuery - - - - - --

                                                                                                                        The jQuery object representing the created dialog.

                                                                                                                        - - - - - -
                                                                                                                        - - - - - -
                                                                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                        See:
                                                                                                                        -
                                                                                                                        -
                                                                                                                          -
                                                                                                                        • http://docs.jquery.com/UI/API/1.8/Dialog for a list of all jQuery UI Dialog options. -If you previously applied a class to your dialog after creating it with alert(), -dialogClass may be particularly useful.
                                                                                                                        • -
                                                                                                                        -
                                                                                                                        diff --git a/module-dialog_about.html b/module-dialog_about.html index 7a888468e..acaf0ddf9 100644 --- a/module-dialog_about.html +++ b/module-dialog_about.html @@ -34,7 +34,7 @@

                                                                                                                        IITC-CE

                                                                                                                          - +
                                                                                                                          @@ -52,8 +52,6 @@

                                                                                                                          dialog_about

                                                                                                                          - - @@ -119,77 +117,6 @@

                                                                                                                          dialog_about

                                                                                                                          - - - - - - - - - - -
                                                                                                                          - - - - -
                                                                                                                          - - - - -
                                                                                                                          - -
                                                                                                                          -
                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                          - - - - - - - - - - - - - - - - - - - - @@ -417,14 +344,14 @@
                                                                                                                          Returns:
                                                                                                                          -

                                                                                                                          +

                                                                                                                          - inner convertPluginInfo(info, index) → {Object} + inner createChangelog(plugin) → {string}

                                                                                                                          @@ -436,7 +363,7 @@

                                                                                                                          -

                                                                                                                          Converts plugin information into a structured object for easier processing.

                                                                                                                          +

                                                                                                                          Creates a changelog section for a given plugin.

                                                                                                                          @@ -472,7 +399,7 @@

                                                                                                                          Parameters:
                                                                                                                          - info + plugin @@ -488,30 +415,7 @@
                                                                                                                          Parameters:
                                                                                                                          -

                                                                                                                          The plugin information object.

                                                                                                                          - - - - - - - index - - - - - -number - - - - - - - - - -

                                                                                                                          The index of the plugin in the array.

                                                                                                                          +

                                                                                                                          The plugin for which to create the changelog.

                                                                                                                          @@ -539,13 +443,13 @@
                                                                                                                          Returns:
                                                                                                                          -Object +string --

                                                                                                                          Structured plugin information.

                                                                                                                          +-

                                                                                                                          HTML string representing the changelog.

                                                                                                                          @@ -600,14 +504,14 @@
                                                                                                                          Returns:
                                                                                                                          -

                                                                                                                          +

                                                                                                                          - inner createChangelog(plugin) → {string} + inner createDialogContent() → {string}

                                                                                                                          @@ -619,7 +523,7 @@

                                                                                                                          -

                                                                                                                          Creates a changelog section for a given plugin.

                                                                                                                          +

                                                                                                                          Creates the content for the 'About IITC' dialog.

                                                                                                                          @@ -630,56 +534,6 @@

                                                                                                                          -
                                                                                                                          -
                                                                                                                          Parameters:
                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                          NameTypeDescription
                                                                                                                          plugin - - -Object - - - -

                                                                                                                          The plugin for which to create the changelog.

                                                                                                                          - -
                                                                                                                          - @@ -705,7 +559,7 @@

                                                                                                                          Returns:
                                                                                                                          --

                                                                                                                          HTML string representing the changelog.

                                                                                                                          +-

                                                                                                                          HTML content for the about dialog.

                                                                                                                          @@ -760,14 +614,14 @@
                                                                                                                          Returns:
                                                                                                                          -

                                                                                                                          +

                                                                                                                          - inner createChangelog(plugin) → {string} + inner formatVerInfo(p, extraopt) → {string}

                                                                                                                          @@ -779,7 +633,10 @@

                                                                                                                          -

                                                                                                                          Creates a changelog section for a given plugin.

                                                                                                                          +

                                                                                                                          Formats version information for plugins and the main script. +If an 'extra' parameter is provided and matches the end of the version string, it is removed. +This is used to cut off a common timestamp appended to versions. +The function also prepares a tooltip showing the build number and date, if available.

                                                                                                                          @@ -803,6 +660,8 @@

                                                                                                                          Parameters:
                                                                                                                          Type + Attributes + @@ -815,7 +674,7 @@
                                                                                                                          Parameters:
                                                                                                                          - plugin + p @@ -828,10 +687,51 @@
                                                                                                                          Parameters:
                                                                                                                          + + + + + + + + + + + +

                                                                                                                          The plugin or script object containing version information.

                                                                                                                          + + + + + + + extra + + + + + +string + + + + + + + + + <optional>
                                                                                                                          + + + + + + + -

                                                                                                                          The plugin for which to create the changelog.

                                                                                                                          +

                                                                                                                          An optional extra string to be removed from the version information.

                                                                                                                          @@ -865,7 +765,7 @@
                                                                                                                          Returns:
                                                                                                                          --

                                                                                                                          HTML string representing the changelog.

                                                                                                                          +-

                                                                                                                          Formatted version string with optional HTML tooltip.

                                                                                                                          @@ -920,14 +820,14 @@
                                                                                                                          Returns:
                                                                                                                          -

                                                                                                                          +

                                                                                                                          - inner createDialogContent() → {string} + inner getIITCVersion() → {string}

                                                                                                                          @@ -939,7 +839,7 @@

                                                                                                                          -

                                                                                                                          Creates the content for the 'About IITC' dialog.

                                                                                                                          +

                                                                                                                          Retrieves the IITC version string.

                                                                                                                          @@ -975,7 +875,7 @@

                                                                                                                          Returns:
                                                                                                                          --

                                                                                                                          HTML content for the about dialog.

                                                                                                                          +-

                                                                                                                          The IITC version string.

                                                                                                                          @@ -1030,14 +930,14 @@
                                                                                                                          Returns:
                                                                                                                          -

                                                                                                                          +

                                                                                                                          - inner createDialogContent() → {string} + inner getIITCVersionAddition() → {string}

                                                                                                                          @@ -1049,7 +949,7 @@

                                                                                                                          -

                                                                                                                          Creates the content for the 'About IITC' dialog.

                                                                                                                          +

                                                                                                                          Extracts the additional version information from the IITC script version.

                                                                                                                          @@ -1085,7 +985,7 @@

                                                                                                                          Returns:
                                                                                                                          --

                                                                                                                          HTML content for the about dialog.

                                                                                                                          +-

                                                                                                                          The additional version information, if any.

                                                                                                                          @@ -1140,4289 +1040,14 @@
                                                                                                                          Returns:
                                                                                                                          -

                                                                                                                          +

                                                                                                                          - inner formatVerInfo(p, extraopt) → {string} + inner getPlugins() → {string} - -

                                                                                                                          - - - -
                                                                                                                          -
                                                                                                                          - - -
                                                                                                                          -

                                                                                                                          Formats version information for plugins and the main script. -If an 'extra' parameter is provided and matches the end of the version string, it is removed. -This is used to cut off a common timestamp appended to versions. -The function also prepares a tooltip showing the build number and date, if available.

                                                                                                                          -
                                                                                                                          - - - - - - - - - -
                                                                                                                          -
                                                                                                                          Parameters:
                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                          NameTypeAttributesDescription
                                                                                                                          p - - -Object - - - - - - - - - -

                                                                                                                          The plugin or script object containing version information.

                                                                                                                          extra - - -string - - - - - - <optional>
                                                                                                                          - - - - - -

                                                                                                                          An optional extra string to be removed from the version information.

                                                                                                                          - -
                                                                                                                          - - - - - - - - - - - - - -
                                                                                                                          -
                                                                                                                          Returns:
                                                                                                                          - - - - - -string - - - - - --

                                                                                                                          Formatted version string with optional HTML tooltip.

                                                                                                                          - - - - - -
                                                                                                                          - - - - - -
                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                          - - - - -
                                                                                                                          - - - - -
                                                                                                                          - -

                                                                                                                          - - inner formatVerInfo(p, extraopt) → {string} - - - - -

                                                                                                                          - - - -
                                                                                                                          -
                                                                                                                          - - -
                                                                                                                          -

                                                                                                                          Formats version information for plugins and the main script. -If an 'extra' parameter is provided and matches the end of the version string, it is removed. -This is used to cut off a common timestamp appended to versions. -The function also prepares a tooltip showing the build number and date, if available.

                                                                                                                          -
                                                                                                                          - - - - - - - - - -
                                                                                                                          -
                                                                                                                          Parameters:
                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                          NameTypeAttributesDescription
                                                                                                                          p - - -Object - - - - - - - - - -

                                                                                                                          The plugin or script object containing version information.

                                                                                                                          extra - - -string - - - - - - <optional>
                                                                                                                          - - - - - -

                                                                                                                          An optional extra string to be removed from the version information.

                                                                                                                          - -
                                                                                                                          - - - - - - - - - - - - - -
                                                                                                                          -
                                                                                                                          Returns:
                                                                                                                          - - - - - -string - - - - - --

                                                                                                                          Formatted version string with optional HTML tooltip.

                                                                                                                          - - - - - -
                                                                                                                          - - - - - -
                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                          - - - - -
                                                                                                                          - - - - -
                                                                                                                          - -

                                                                                                                          - - inner getIITCVersion() → {string} - - - - -

                                                                                                                          - - - -
                                                                                                                          -
                                                                                                                          - - -
                                                                                                                          -

                                                                                                                          Retrieves the IITC version string.

                                                                                                                          -
                                                                                                                          - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                          -
                                                                                                                          Returns:
                                                                                                                          - - - - - -string - - - - - --

                                                                                                                          The IITC version string.

                                                                                                                          - - - - - -
                                                                                                                          - - - - - -
                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                          - - - - -
                                                                                                                          - - - - -
                                                                                                                          - -

                                                                                                                          - - inner getIITCVersion() → {string} - - - - -

                                                                                                                          - - - -
                                                                                                                          -
                                                                                                                          - - -
                                                                                                                          -

                                                                                                                          Retrieves the IITC version string.

                                                                                                                          -
                                                                                                                          - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                          -
                                                                                                                          Returns:
                                                                                                                          - - - - - -string - - - - - --

                                                                                                                          The IITC version string.

                                                                                                                          - - - - - -
                                                                                                                          - - - - - -
                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                          - - - - -
                                                                                                                          - - - - -
                                                                                                                          - -

                                                                                                                          - - inner getIITCVersionAddition() → {string} - - - - -

                                                                                                                          - - - -
                                                                                                                          -
                                                                                                                          - - -
                                                                                                                          -

                                                                                                                          Extracts the additional version information from the IITC script version.

                                                                                                                          -
                                                                                                                          - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                          -
                                                                                                                          Returns:
                                                                                                                          - - - - - -string - - - - - --

                                                                                                                          The additional version information, if any.

                                                                                                                          - - - - - -
                                                                                                                          - - - - - -
                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                          - - - - -
                                                                                                                          - - - - -
                                                                                                                          - -

                                                                                                                          - - inner getIITCVersionAddition() → {string} - - - - -

                                                                                                                          - - - -
                                                                                                                          -
                                                                                                                          - - -
                                                                                                                          -

                                                                                                                          Extracts the additional version information from the IITC script version.

                                                                                                                          -
                                                                                                                          - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                          -
                                                                                                                          Returns:
                                                                                                                          - - - - - -string - - - - - --

                                                                                                                          The additional version information, if any.

                                                                                                                          - - - - - -
                                                                                                                          - - - - - -
                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                          - - - - -
                                                                                                                          - - - - -
                                                                                                                          - -

                                                                                                                          - - inner getPlugins() → {string} - - - - -

                                                                                                                          - - - -
                                                                                                                          -
                                                                                                                          - - -
                                                                                                                          -

                                                                                                                          Retrieves a list of plugins currently loaded in IITC. The list includes plugin names, versions, and descriptions.

                                                                                                                          -
                                                                                                                          - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                          -
                                                                                                                          Returns:
                                                                                                                          - - - - - -string - - - - - --

                                                                                                                          Formatted list of plugins in HTML.

                                                                                                                          - - - - - -
                                                                                                                          - - - - - -
                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                          - - - - -
                                                                                                                          - - - - -
                                                                                                                          - -

                                                                                                                          - - inner getPlugins() → {string} - - - - -

                                                                                                                          - - - -
                                                                                                                          -
                                                                                                                          - - -
                                                                                                                          -

                                                                                                                          Retrieves a list of plugins currently loaded in IITC. The list includes plugin names, versions, and descriptions.

                                                                                                                          -
                                                                                                                          - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                          -
                                                                                                                          Returns:
                                                                                                                          - - - - - -string - - - - - --

                                                                                                                          Formatted list of plugins in HTML.

                                                                                                                          - - - - - -
                                                                                                                          - - - - - -
                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                          - - - - -
                                                                                                                          - - - - -
                                                                                                                          - -

                                                                                                                          - - inner isShortOnLocalStorage() → {boolean} - - - - -

                                                                                                                          - - - -
                                                                                                                          -
                                                                                                                          - - -
                                                                                                                          -

                                                                                                                          Checks if the browser's local storage is running short on available space. -This function tries to write a specific amount of data to the local storage and captures any errors. -If an error occurs, it is an indication that the local storage has limited free space left.

                                                                                                                          -
                                                                                                                          - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                          -
                                                                                                                          Returns:
                                                                                                                          - - - - - -boolean - - - - - --

                                                                                                                          Returns true if the local storage is running short on space, otherwise false.

                                                                                                                          - - - - - -
                                                                                                                          - - - - - -
                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                          - - - - -
                                                                                                                          - - - - -
                                                                                                                          - -

                                                                                                                          - - inner isShortOnLocalStorage() → {boolean} - - - - -

                                                                                                                          - - - -
                                                                                                                          -
                                                                                                                          - - -
                                                                                                                          -

                                                                                                                          Checks if the browser's local storage is running short on available space. -This function tries to write a specific amount of data to the local storage and captures any errors. -If an error occurs, it is an indication that the local storage has limited free space left.

                                                                                                                          -
                                                                                                                          - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                          -
                                                                                                                          Returns:
                                                                                                                          - - - - - -boolean - - - - - --

                                                                                                                          Returns true if the local storage is running short on space, otherwise false.

                                                                                                                          - - - - - -
                                                                                                                          - - - - - -
                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                          - - - - -
                                                                                                                          - - - - -
                                                                                                                          - -

                                                                                                                          - - inner isStandardPlugin(plugin) → {boolean} - - - - -

                                                                                                                          - - - -
                                                                                                                          -
                                                                                                                          - - -
                                                                                                                          -

                                                                                                                          Checks if a given plugin is a standard plugin based on the build name and date. -Standard plugins are those that match the build and date of the main IITC script.

                                                                                                                          -
                                                                                                                          - - - - - - - - - -
                                                                                                                          -
                                                                                                                          Parameters:
                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                          NameTypeDescription
                                                                                                                          plugin - - -Object - - - -

                                                                                                                          The plugin object to check.

                                                                                                                          - -
                                                                                                                          - - - - - - - - - - - - - -
                                                                                                                          -
                                                                                                                          Returns:
                                                                                                                          - - - - - -boolean - - - - - --

                                                                                                                          True if the plugin is standard, false otherwise.

                                                                                                                          - - - - - -
                                                                                                                          - - - - - -
                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                          - - - - -
                                                                                                                          - - - - -
                                                                                                                          - -

                                                                                                                          - - inner isStandardPlugin(plugin) → {boolean} - - - - -

                                                                                                                          - - - -
                                                                                                                          -
                                                                                                                          - - -
                                                                                                                          -

                                                                                                                          Checks if a given plugin is a standard plugin based on the build name and date. -Standard plugins are those that match the build and date of the main IITC script.

                                                                                                                          -
                                                                                                                          - - - - - - - - - -
                                                                                                                          -
                                                                                                                          Parameters:
                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                          NameTypeDescription
                                                                                                                          plugin - - -Object - - - -

                                                                                                                          The plugin object to check.

                                                                                                                          - -
                                                                                                                          - - - - - - - - - - - - - -
                                                                                                                          -
                                                                                                                          Returns:
                                                                                                                          - - - - - -boolean - - - - - --

                                                                                                                          True if the plugin is standard, false otherwise.

                                                                                                                          - - - - - -
                                                                                                                          - - - - - -
                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                          - - - - -
                                                                                                                          - - - - -
                                                                                                                          - -

                                                                                                                          - - inner pluginInfoToString(p, extra) → {string} - - - - -

                                                                                                                          - - - -
                                                                                                                          -
                                                                                                                          - - -
                                                                                                                          -

                                                                                                                          Converts plugin information into a string format suitable for display in the 'About IITC' dialog.

                                                                                                                          -
                                                                                                                          - - - - - - - - - -
                                                                                                                          -
                                                                                                                          Parameters:
                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                          NameTypeDescription
                                                                                                                          p - - -Object - - - -

                                                                                                                          The plugin information object.

                                                                                                                          extra - - -string - - - -

                                                                                                                          Additional version information.

                                                                                                                          - -
                                                                                                                          - - - - - - - - - - - - - -
                                                                                                                          -
                                                                                                                          Returns:
                                                                                                                          - - - - - -string - - - - - --

                                                                                                                          Formatted plugin information string.

                                                                                                                          - - - - - -
                                                                                                                          - - - - - -
                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                          - - - - -
                                                                                                                          - - - - -
                                                                                                                          - -

                                                                                                                          - - inner pluginInfoToString(p, extra) → {string} - - - - -

                                                                                                                          - - - -
                                                                                                                          -
                                                                                                                          - - -
                                                                                                                          -

                                                                                                                          Converts plugin information into a string format suitable for display in the 'About IITC' dialog.

                                                                                                                          -
                                                                                                                          - - - - - - - - - -
                                                                                                                          -
                                                                                                                          Parameters:
                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                          NameTypeDescription
                                                                                                                          p - - -Object - - - -

                                                                                                                          The plugin information object.

                                                                                                                          extra - - -string - - - -

                                                                                                                          Additional version information.

                                                                                                                          - -
                                                                                                                          - - - - - - - - - - - - - -
                                                                                                                          -
                                                                                                                          Returns:
                                                                                                                          - - - - - -string - - - - - --

                                                                                                                          Formatted plugin information string.

                                                                                                                          - - - - - -
                                                                                                                          - - - - - -
                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                          - - - - -
                                                                                                                          - -
                                                                                                                          - - - - - -
                                                                                                                          - -
                                                                                                                          - - - - - - - -
                                                                                                                          - -
                                                                                                                          - -

                                                                                                                          dialog_about

                                                                                                                          - - - - - - -
                                                                                                                          - -
                                                                                                                          - -
                                                                                                                          - - -

                                                                                                                          This file contains functions related to the 'About IITC' dialog.

                                                                                                                          - - - - - -
                                                                                                                          - -
                                                                                                                          -
                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                          - - - - -
                                                                                                                          - - - - -
                                                                                                                          - -
                                                                                                                          -
                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                          - - - - -
                                                                                                                          - - - -
                                                                                                                          - - - - - - - - - - - - - - - - - -

                                                                                                                          Methods

                                                                                                                          - -
                                                                                                                          - - -
                                                                                                                          - -

                                                                                                                          - - inner convertPluginInfo(info, index) → {Object} - - - - -

                                                                                                                          - - - -
                                                                                                                          -
                                                                                                                          - - -
                                                                                                                          -

                                                                                                                          Converts plugin information into a structured object for easier processing.

                                                                                                                          -
                                                                                                                          - - - - - - - - - -
                                                                                                                          -
                                                                                                                          Parameters:
                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                          NameTypeDescription
                                                                                                                          info - - -Object - - - -

                                                                                                                          The plugin information object.

                                                                                                                          index - - -number - - - -

                                                                                                                          The index of the plugin in the array.

                                                                                                                          - -
                                                                                                                          - - - - - - - - - - - - - -
                                                                                                                          -
                                                                                                                          Returns:
                                                                                                                          - - - - - -Object - - - - - --

                                                                                                                          Structured plugin information.

                                                                                                                          - - - - - -
                                                                                                                          - - - - - -
                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                          - - - - -
                                                                                                                          - - - - -
                                                                                                                          - -

                                                                                                                          - - inner convertPluginInfo(info, index) → {Object} - - - - -

                                                                                                                          - - - -
                                                                                                                          -
                                                                                                                          - - -
                                                                                                                          -

                                                                                                                          Converts plugin information into a structured object for easier processing.

                                                                                                                          -
                                                                                                                          - - - - - - - - - -
                                                                                                                          -
                                                                                                                          Parameters:
                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                          NameTypeDescription
                                                                                                                          info - - -Object - - - -

                                                                                                                          The plugin information object.

                                                                                                                          index - - -number - - - -

                                                                                                                          The index of the plugin in the array.

                                                                                                                          - -
                                                                                                                          - - - - - - - - - - - - - -
                                                                                                                          -
                                                                                                                          Returns:
                                                                                                                          - - - - - -Object - - - - - --

                                                                                                                          Structured plugin information.

                                                                                                                          - - - - - -
                                                                                                                          - - - - - -
                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                          - - - - -
                                                                                                                          - - - - -
                                                                                                                          - -

                                                                                                                          - - inner createChangelog(plugin) → {string} - - - - -

                                                                                                                          - - - -
                                                                                                                          -
                                                                                                                          - - -
                                                                                                                          -

                                                                                                                          Creates a changelog section for a given plugin.

                                                                                                                          -
                                                                                                                          - - - - - - - - - -
                                                                                                                          -
                                                                                                                          Parameters:
                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                          NameTypeDescription
                                                                                                                          plugin - - -Object - - - -

                                                                                                                          The plugin for which to create the changelog.

                                                                                                                          - -
                                                                                                                          - - - - - - - - - - - - - -
                                                                                                                          -
                                                                                                                          Returns:
                                                                                                                          - - - - - -string - - - - - --

                                                                                                                          HTML string representing the changelog.

                                                                                                                          - - - - - -
                                                                                                                          - - - - - -
                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                          - - - - -
                                                                                                                          - - - - -
                                                                                                                          - -

                                                                                                                          - - inner createChangelog(plugin) → {string} - - - - -

                                                                                                                          - - - -
                                                                                                                          -
                                                                                                                          - - -
                                                                                                                          -

                                                                                                                          Creates a changelog section for a given plugin.

                                                                                                                          -
                                                                                                                          - - - - - - - - - -
                                                                                                                          -
                                                                                                                          Parameters:
                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                          NameTypeDescription
                                                                                                                          plugin - - -Object - - - -

                                                                                                                          The plugin for which to create the changelog.

                                                                                                                          - -
                                                                                                                          - - - - - - - - - - - - - -
                                                                                                                          -
                                                                                                                          Returns:
                                                                                                                          - - - - - -string - - - - - --

                                                                                                                          HTML string representing the changelog.

                                                                                                                          - - - - - -
                                                                                                                          - - - - - -
                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                          - - - - -
                                                                                                                          - - - - -
                                                                                                                          - -

                                                                                                                          - - inner createDialogContent() → {string} - - - - -

                                                                                                                          - - - -
                                                                                                                          -
                                                                                                                          - - -
                                                                                                                          -

                                                                                                                          Creates the content for the 'About IITC' dialog.

                                                                                                                          -
                                                                                                                          - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                          -
                                                                                                                          Returns:
                                                                                                                          - - - - - -string - - - - - --

                                                                                                                          HTML content for the about dialog.

                                                                                                                          - - - - - -
                                                                                                                          - - - - - -
                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                          - - - - -
                                                                                                                          - - - - -
                                                                                                                          - -

                                                                                                                          - - inner createDialogContent() → {string} - - - - -

                                                                                                                          - - - -
                                                                                                                          -
                                                                                                                          - - -
                                                                                                                          -

                                                                                                                          Creates the content for the 'About IITC' dialog.

                                                                                                                          -
                                                                                                                          - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                          -
                                                                                                                          Returns:
                                                                                                                          - - - - - -string - - - - - --

                                                                                                                          HTML content for the about dialog.

                                                                                                                          - - - - - -
                                                                                                                          - - - - - -
                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                          - - - - -
                                                                                                                          - - - - -
                                                                                                                          - -

                                                                                                                          - - inner formatVerInfo(p, extraopt) → {string} - - - - -

                                                                                                                          - - - -
                                                                                                                          -
                                                                                                                          - - -
                                                                                                                          -

                                                                                                                          Formats version information for plugins and the main script. -If an 'extra' parameter is provided and matches the end of the version string, it is removed. -This is used to cut off a common timestamp appended to versions. -The function also prepares a tooltip showing the build number and date, if available.

                                                                                                                          -
                                                                                                                          - - - - - - - - - -
                                                                                                                          -
                                                                                                                          Parameters:
                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                          NameTypeAttributesDescription
                                                                                                                          p - - -Object - - - - - - - - - -

                                                                                                                          The plugin or script object containing version information.

                                                                                                                          extra - - -string - - - - - - <optional>
                                                                                                                          - - - - - -

                                                                                                                          An optional extra string to be removed from the version information.

                                                                                                                          - -
                                                                                                                          - - - - - - - - - - - - - -
                                                                                                                          -
                                                                                                                          Returns:
                                                                                                                          - - - - - -string - - - - - --

                                                                                                                          Formatted version string with optional HTML tooltip.

                                                                                                                          - - - - - -
                                                                                                                          - - - - - -
                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                          - - - - -
                                                                                                                          - - - - -
                                                                                                                          - -

                                                                                                                          - - inner formatVerInfo(p, extraopt) → {string} - - - - -

                                                                                                                          - - - -
                                                                                                                          -
                                                                                                                          - - -
                                                                                                                          -

                                                                                                                          Formats version information for plugins and the main script. -If an 'extra' parameter is provided and matches the end of the version string, it is removed. -This is used to cut off a common timestamp appended to versions. -The function also prepares a tooltip showing the build number and date, if available.

                                                                                                                          -
                                                                                                                          - - - - - - - - - -
                                                                                                                          -
                                                                                                                          Parameters:
                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                          NameTypeAttributesDescription
                                                                                                                          p - - -Object - - - - - - - - - -

                                                                                                                          The plugin or script object containing version information.

                                                                                                                          extra - - -string - - - - - - <optional>
                                                                                                                          - - - - - -

                                                                                                                          An optional extra string to be removed from the version information.

                                                                                                                          - -
                                                                                                                          - - - - - - - - - - - - - -
                                                                                                                          -
                                                                                                                          Returns:
                                                                                                                          - - - - - -string - - - - - --

                                                                                                                          Formatted version string with optional HTML tooltip.

                                                                                                                          - - - - - -
                                                                                                                          - - - - - -
                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                          - - - - -
                                                                                                                          - - - - -
                                                                                                                          - -

                                                                                                                          - - inner getIITCVersion() → {string} - - - - -

                                                                                                                          - - - -
                                                                                                                          -
                                                                                                                          - - -
                                                                                                                          -

                                                                                                                          Retrieves the IITC version string.

                                                                                                                          -
                                                                                                                          - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                          -
                                                                                                                          Returns:
                                                                                                                          - - - - - -string - - - - - --

                                                                                                                          The IITC version string.

                                                                                                                          - - - - - -
                                                                                                                          - - - - - -
                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                          - - - - -
                                                                                                                          - - - - -
                                                                                                                          - -

                                                                                                                          - - inner getIITCVersion() → {string} - - - - -

                                                                                                                          - - - -
                                                                                                                          -
                                                                                                                          - - -
                                                                                                                          -

                                                                                                                          Retrieves the IITC version string.

                                                                                                                          -
                                                                                                                          - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                          -
                                                                                                                          Returns:
                                                                                                                          - - - - - -string - - - - - --

                                                                                                                          The IITC version string.

                                                                                                                          - - - - - -
                                                                                                                          - - - - - -
                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                          - - - - -
                                                                                                                          - - - - -
                                                                                                                          - -

                                                                                                                          - - inner getIITCVersionAddition() → {string} - - - - -

                                                                                                                          - - - -
                                                                                                                          -
                                                                                                                          - - -
                                                                                                                          -

                                                                                                                          Extracts the additional version information from the IITC script version.

                                                                                                                          -
                                                                                                                          - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                          -
                                                                                                                          Returns:
                                                                                                                          - - - - - -string - - - - - --

                                                                                                                          The additional version information, if any.

                                                                                                                          - - - - - -
                                                                                                                          - - - - - -
                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                          - - - - -
                                                                                                                          - - - - -
                                                                                                                          - -

                                                                                                                          - - inner getIITCVersionAddition() → {string} - - - - -

                                                                                                                          - - - -
                                                                                                                          -
                                                                                                                          - - -
                                                                                                                          -

                                                                                                                          Extracts the additional version information from the IITC script version.

                                                                                                                          -
                                                                                                                          - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                          -
                                                                                                                          Returns:
                                                                                                                          - - - - - -string - - - - - --

                                                                                                                          The additional version information, if any.

                                                                                                                          - - - - - -
                                                                                                                          - - - - - -
                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                          - - - - -
                                                                                                                          - - - - -
                                                                                                                          - -

                                                                                                                          - - inner getPlugins() → {string} - - - - -

                                                                                                                          - - - -
                                                                                                                          -
                                                                                                                          - - -
                                                                                                                          -

                                                                                                                          Retrieves a list of plugins currently loaded in IITC. The list includes plugin names, versions, and descriptions.

                                                                                                                          -
                                                                                                                          - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                          -
                                                                                                                          Returns:
                                                                                                                          - - - - - -string - - - - - --

                                                                                                                          Formatted list of plugins in HTML.

                                                                                                                          - - - - - -
                                                                                                                          - - - - - -
                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                          - - - - -
                                                                                                                          - - - - -
                                                                                                                          - -

                                                                                                                          - - inner getPlugins() → {string} - - - - -

                                                                                                                          - - - -
                                                                                                                          -
                                                                                                                          - - -
                                                                                                                          -

                                                                                                                          Retrieves a list of plugins currently loaded in IITC. The list includes plugin names, versions, and descriptions.

                                                                                                                          -
                                                                                                                          - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                          -
                                                                                                                          Returns:
                                                                                                                          - - - - - -string - - - - - --

                                                                                                                          Formatted list of plugins in HTML.

                                                                                                                          - - - - - -
                                                                                                                          - - - - - -
                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                          - - - - -
                                                                                                                          - - - - -
                                                                                                                          - -

                                                                                                                          - - inner isShortOnLocalStorage() → {boolean} - - - - -

                                                                                                                          - - - -
                                                                                                                          -
                                                                                                                          - - -
                                                                                                                          -

                                                                                                                          Checks if the browser's local storage is running short on available space. -This function tries to write a specific amount of data to the local storage and captures any errors. -If an error occurs, it is an indication that the local storage has limited free space left.

                                                                                                                          -
                                                                                                                          - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                          -
                                                                                                                          Returns:
                                                                                                                          - - - - - -boolean - - - - - --

                                                                                                                          Returns true if the local storage is running short on space, otherwise false.

                                                                                                                          - - - - - -
                                                                                                                          - - - - - -
                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                          - - - - -
                                                                                                                          - - - - -
                                                                                                                          - -

                                                                                                                          - - inner isShortOnLocalStorage() → {boolean} - - -

                                                                                                                          @@ -5434,9 +1059,7 @@

                                                                                                                          -

                                                                                                                          Checks if the browser's local storage is running short on available space. -This function tries to write a specific amount of data to the local storage and captures any errors. -If an error occurs, it is an indication that the local storage has limited free space left.

                                                                                                                          +

                                                                                                                          Retrieves a list of plugins currently loaded in IITC. The list includes plugin names, versions, and descriptions.

                                                                                                                          @@ -5466,13 +1089,13 @@

                                                                                                                          Returns:
                                                                                                                          -boolean +string --

                                                                                                                          Returns true if the local storage is running short on space, otherwise false.

                                                                                                                          +-

                                                                                                                          Formatted list of plugins in HTML.

                                                                                                                          @@ -5527,14 +1150,14 @@
                                                                                                                          Returns:
                                                                                                                          -

                                                                                                                          +

                                                                                                                          - inner isStandardPlugin(plugin) → {boolean} + inner isShortOnLocalStorage() → {boolean}

                                                                                                                          @@ -5546,8 +1169,9 @@

                                                                                                                          -

                                                                                                                          Checks if a given plugin is a standard plugin based on the build name and date. -Standard plugins are those that match the build and date of the main IITC script.

                                                                                                                          +

                                                                                                                          Checks if the browser's local storage is running short on available space. +This function tries to write a specific amount of data to the local storage and captures any errors. +If an error occurs, it is an indication that the local storage has limited free space left.

                                                                                                                          @@ -5558,56 +1182,6 @@

                                                                                                                          -
                                                                                                                          -
                                                                                                                          Parameters:
                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                          NameTypeDescription
                                                                                                                          plugin - - -Object - - - -

                                                                                                                          The plugin object to check.

                                                                                                                          - -
                                                                                                                          - @@ -5633,7 +1207,7 @@

                                                                                                                          Returns:
                                                                                                                          --

                                                                                                                          True if the plugin is standard, false otherwise.

                                                                                                                          +-

                                                                                                                          Returns true if the local storage is running short on space, otherwise false.

                                                                                                                          @@ -6010,189 +1584,6 @@
                                                                                                                          Returns:
                                                                                                                          - - - - - - - - - - -
                                                                                                                          - - - - - - - - - -
                                                                                                                          - -

                                                                                                                          - - inner pluginInfoToString(p, extra) → {string} - - - - -

                                                                                                                          - - - -
                                                                                                                          -
                                                                                                                          - - -
                                                                                                                          -

                                                                                                                          Converts plugin information into a string format suitable for display in the 'About IITC' dialog.

                                                                                                                          -
                                                                                                                          - - - - - - - - - -
                                                                                                                          -
                                                                                                                          Parameters:
                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                          NameTypeDescription
                                                                                                                          p - - -Object - - - -

                                                                                                                          The plugin information object.

                                                                                                                          extra - - -string - - - -

                                                                                                                          Additional version information.

                                                                                                                          - -
                                                                                                                          - - - - - - - - - - - - - -
                                                                                                                          -
                                                                                                                          Returns:
                                                                                                                          - - - - - -string - - - - - --

                                                                                                                          Formatted plugin information string.

                                                                                                                          - - - - - -
                                                                                                                          - - - - - -
                                                                                                                          - - - - - - - - - - - - - - - - - - - - diff --git a/module-entity_decode.html b/module-entity_decode.html index 4d0204454..f9beb95e5 100644 --- a/module-entity_decode.html +++ b/module-entity_decode.html @@ -34,7 +34,7 @@

                                                                                                                          IITC-CE

                                                                                                                            - +
                                                                                                                            @@ -52,8 +52,6 @@

                                                                                                                            entity_decode

                                                                                                                            - - @@ -121,77 +119,6 @@

                                                                                                                            entity_decode

                                                                                                                            - - - - - - - - - - -
                                                                                                                            - - - - -
                                                                                                                            - - - - -
                                                                                                                            - -
                                                                                                                            -
                                                                                                                            - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                            - - - - - - - - - - - - - - - - - - - - @@ -396,14 +323,14 @@
                                                                                                                            Returns:
                                                                                                                            -

                                                                                                                            +

                                                                                                                            - inner corePortalData(a) → {Object} + inner detailsPortalData(a) → {Object}

                                                                                                                            @@ -415,7 +342,7 @@

                                                                                                                            -

                                                                                                                            Parses the core portal data from an array.

                                                                                                                            +

                                                                                                                            Parses the detailed portal data from an array.

                                                                                                                            @@ -501,7 +428,7 @@

                                                                                                                            Returns:
                                                                                                                            --

                                                                                                                            An object containing the core data of a portal.

                                                                                                                            +-

                                                                                                                            An object containing the detailed data of a portal.

                                                                                                                            @@ -556,14 +483,14 @@
                                                                                                                            Returns:
                                                                                                                            -

                                                                                                                            +

                                                                                                                            - inner detailsPortalData(a) → {Object} + inner extendedPortalData(a) → {Object}

                                                                                                                            @@ -575,7 +502,7 @@

                                                                                                                            -

                                                                                                                            Parses the detailed portal data from an array.

                                                                                                                            +

                                                                                                                            Parses the extended portal data from an array.

                                                                                                                            @@ -661,7 +588,7 @@

                                                                                                                            Returns:
                                                                                                                            --

                                                                                                                            An object containing the detailed data of a portal.

                                                                                                                            +-

                                                                                                                            An object containing the extended data of a portal.

                                                                                                                            @@ -716,14 +643,14 @@
                                                                                                                            Returns:
                                                                                                                            -

                                                                                                                            +

                                                                                                                            - inner detailsPortalData(a) → {Object} + inner parseArtifactBrief(arr) → {Object|null}

                                                                                                                            @@ -735,7 +662,7 @@

                                                                                                                            -

                                                                                                                            Parses the detailed portal data from an array.

                                                                                                                            +

                                                                                                                            Parses an artifact brief array into an object.

                                                                                                                            @@ -771,7 +698,7 @@

                                                                                                                            Parameters:
                                                                                                                            - a + arr @@ -787,7 +714,7 @@
                                                                                                                            Parameters:
                                                                                                                            -

                                                                                                                            The portal data array.

                                                                                                                            +

                                                                                                                            The artifact brief array.

                                                                                                                            @@ -816,12 +743,15 @@
                                                                                                                            Returns:
                                                                                                                            Object +| +null --

                                                                                                                            An object containing the detailed data of a portal.

                                                                                                                            + +-

                                                                                                                            Parsed artifact brief object or null if the input is falsy.

                                                                                                                            @@ -876,14 +806,14 @@
                                                                                                                            Returns:
                                                                                                                            -

                                                                                                                            +

                                                                                                                            - inner extendedPortalData(a) → {Object} + inner parseArtifactDetail(arr) → {Object|null}

                                                                                                                            @@ -895,7 +825,7 @@

                                                                                                                            -

                                                                                                                            Parses the extended portal data from an array.

                                                                                                                            +

                                                                                                                            Parses an artifact detail array into an object.

                                                                                                                            @@ -931,7 +861,7 @@

                                                                                                                            Parameters:
                                                                                                                            - a + arr @@ -947,7 +877,7 @@
                                                                                                                            Parameters:
                                                                                                                            -

                                                                                                                            The portal data array.

                                                                                                                            +

                                                                                                                            The artifact detail array.

                                                                                                                            @@ -976,12 +906,15 @@
                                                                                                                            Returns:
                                                                                                                            Object +| + +null --

                                                                                                                            An object containing the extended data of a portal.

                                                                                                                            +-

                                                                                                                            Parsed artifact detail object or null if the input is falsy.

                                                                                                                            @@ -1036,14 +969,14 @@
                                                                                                                            Returns:
                                                                                                                            -

                                                                                                                            +

                                                                                                                            - inner extendedPortalData(a) → {Object} + inner parseHistoryDetail(bitarray) → {Object}

                                                                                                                            @@ -1055,7 +988,7 @@

                                                                                                                            -

                                                                                                                            Parses the extended portal data from an array.

                                                                                                                            +

                                                                                                                            Parses a history detail bit array into an object.

                                                                                                                            @@ -1091,13 +1024,13 @@

                                                                                                                            Parameters:
                                                                                                                            - a + bitarray -Array +number @@ -1107,7 +1040,7 @@
                                                                                                                            Parameters:
                                                                                                                            -

                                                                                                                            The portal data array.

                                                                                                                            +

                                                                                                                            The history detail bit array.

                                                                                                                            @@ -1141,7 +1074,7 @@
                                                                                                                            Returns:
                                                                                                                            --

                                                                                                                            An object containing the extended data of a portal.

                                                                                                                            +-

                                                                                                                            Parsed history detail object.

                                                                                                                            @@ -1196,14 +1129,14 @@
                                                                                                                            Returns:
                                                                                                                            -

                                                                                                                            +

                                                                                                                            - inner parseArtifactBrief(arr) → {Object|null} + inner parseMod(arr) → {Object|null}

                                                                                                                            @@ -1215,7 +1148,7 @@

                                                                                                                            -

                                                                                                                            Parses an artifact brief array into an object.

                                                                                                                            +

                                                                                                                            Parses a mod array into an object.

                                                                                                                            @@ -1267,7 +1200,7 @@

                                                                                                                            Parameters:
                                                                                                                            -

                                                                                                                            The artifact brief array.

                                                                                                                            +

                                                                                                                            The mod array.

                                                                                                                            @@ -1304,7 +1237,7 @@
                                                                                                                            Returns:
                                                                                                                            --

                                                                                                                            Parsed artifact brief object or null if the input is falsy.

                                                                                                                            +-

                                                                                                                            Parsed mod object or null if the input is falsy.

                                                                                                                            @@ -1359,14 +1292,14 @@
                                                                                                                            Returns:
                                                                                                                            -

                                                                                                                            +

                                                                                                                            - inner parseArtifactBrief(arr) → {Object|null} + inner parseResonator(arr) → {Object|null}

                                                                                                                            @@ -1378,7 +1311,7 @@

                                                                                                                            -

                                                                                                                            Parses an artifact brief array into an object.

                                                                                                                            +

                                                                                                                            Parses a resonator array into an object.

                                                                                                                            @@ -1430,4412 +1363,7 @@

                                                                                                                            Parameters:
                                                                                                                            -

                                                                                                                            The artifact brief array.

                                                                                                                            - - - - - - - - - - - - - - - - - - - - -
                                                                                                                            -
                                                                                                                            Returns:
                                                                                                                            - - - - - -Object -| - -null - - - - - --

                                                                                                                            Parsed artifact brief object or null if the input is falsy.

                                                                                                                            - - - - - -
                                                                                                                            - - - - - -
                                                                                                                            - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                            - - - - -
                                                                                                                            - - - - -
                                                                                                                            - -

                                                                                                                            - - inner parseArtifactDetail(arr) → {Object|null} - - - - -

                                                                                                                            - - - -
                                                                                                                            -
                                                                                                                            - - -
                                                                                                                            -

                                                                                                                            Parses an artifact detail array into an object.

                                                                                                                            -
                                                                                                                            - - - - - - - - - -
                                                                                                                            -
                                                                                                                            Parameters:
                                                                                                                            - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                            NameTypeDescription
                                                                                                                            arr - - -Array - - - -

                                                                                                                            The artifact detail array.

                                                                                                                            - -
                                                                                                                            - - - - - - - - - - - - - -
                                                                                                                            -
                                                                                                                            Returns:
                                                                                                                            - - - - - -Object -| - -null - - - - - --

                                                                                                                            Parsed artifact detail object or null if the input is falsy.

                                                                                                                            - - - - - -
                                                                                                                            - - - - - -
                                                                                                                            - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                            - - - - -
                                                                                                                            - - - - -
                                                                                                                            - -

                                                                                                                            - - inner parseArtifactDetail(arr) → {Object|null} - - - - -

                                                                                                                            - - - -
                                                                                                                            -
                                                                                                                            - - -
                                                                                                                            -

                                                                                                                            Parses an artifact detail array into an object.

                                                                                                                            -
                                                                                                                            - - - - - - - - - -
                                                                                                                            -
                                                                                                                            Parameters:
                                                                                                                            - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                            NameTypeDescription
                                                                                                                            arr - - -Array - - - -

                                                                                                                            The artifact detail array.

                                                                                                                            - -
                                                                                                                            - - - - - - - - - - - - - -
                                                                                                                            -
                                                                                                                            Returns:
                                                                                                                            - - - - - -Object -| - -null - - - - - --

                                                                                                                            Parsed artifact detail object or null if the input is falsy.

                                                                                                                            - - - - - -
                                                                                                                            - - - - - -
                                                                                                                            - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                            - - - - -
                                                                                                                            - - - - -
                                                                                                                            - -

                                                                                                                            - - inner parseHistoryDetail(bitarray) → {Object} - - - - -

                                                                                                                            - - - -
                                                                                                                            -
                                                                                                                            - - -
                                                                                                                            -

                                                                                                                            Parses a history detail bit array into an object.

                                                                                                                            -
                                                                                                                            - - - - - - - - - -
                                                                                                                            -
                                                                                                                            Parameters:
                                                                                                                            - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                            NameTypeDescription
                                                                                                                            bitarray - - -number - - - -

                                                                                                                            The history detail bit array.

                                                                                                                            - -
                                                                                                                            - - - - - - - - - - - - - -
                                                                                                                            -
                                                                                                                            Returns:
                                                                                                                            - - - - - -Object - - - - - --

                                                                                                                            Parsed history detail object.

                                                                                                                            - - - - - -
                                                                                                                            - - - - - -
                                                                                                                            - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                            - - - - -
                                                                                                                            - - - - -
                                                                                                                            - -

                                                                                                                            - - inner parseHistoryDetail(bitarray) → {Object} - - - - -

                                                                                                                            - - - -
                                                                                                                            -
                                                                                                                            - - -
                                                                                                                            -

                                                                                                                            Parses a history detail bit array into an object.

                                                                                                                            -
                                                                                                                            - - - - - - - - - -
                                                                                                                            -
                                                                                                                            Parameters:
                                                                                                                            - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                            NameTypeDescription
                                                                                                                            bitarray - - -number - - - -

                                                                                                                            The history detail bit array.

                                                                                                                            - -
                                                                                                                            - - - - - - - - - - - - - -
                                                                                                                            -
                                                                                                                            Returns:
                                                                                                                            - - - - - -Object - - - - - --

                                                                                                                            Parsed history detail object.

                                                                                                                            - - - - - -
                                                                                                                            - - - - - -
                                                                                                                            - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                            - - - - -
                                                                                                                            - - - - -
                                                                                                                            - -

                                                                                                                            - - inner parseMod(arr) → {Object|null} - - - - -

                                                                                                                            - - - -
                                                                                                                            -
                                                                                                                            - - -
                                                                                                                            -

                                                                                                                            Parses a mod array into an object.

                                                                                                                            -
                                                                                                                            - - - - - - - - - -
                                                                                                                            -
                                                                                                                            Parameters:
                                                                                                                            - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                            NameTypeDescription
                                                                                                                            arr - - -Array - - - -

                                                                                                                            The mod array.

                                                                                                                            - -
                                                                                                                            - - - - - - - - - - - - - -
                                                                                                                            -
                                                                                                                            Returns:
                                                                                                                            - - - - - -Object -| - -null - - - - - --

                                                                                                                            Parsed mod object or null if the input is falsy.

                                                                                                                            - - - - - -
                                                                                                                            - - - - - -
                                                                                                                            - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                            - - - - -
                                                                                                                            - - - - -
                                                                                                                            - -

                                                                                                                            - - inner parseMod(arr) → {Object|null} - - - - -

                                                                                                                            - - - -
                                                                                                                            -
                                                                                                                            - - -
                                                                                                                            -

                                                                                                                            Parses a mod array into an object.

                                                                                                                            -
                                                                                                                            - - - - - - - - - -
                                                                                                                            -
                                                                                                                            Parameters:
                                                                                                                            - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                            NameTypeDescription
                                                                                                                            arr - - -Array - - - -

                                                                                                                            The mod array.

                                                                                                                            - -
                                                                                                                            - - - - - - - - - - - - - -
                                                                                                                            -
                                                                                                                            Returns:
                                                                                                                            - - - - - -Object -| - -null - - - - - --

                                                                                                                            Parsed mod object or null if the input is falsy.

                                                                                                                            - - - - - -
                                                                                                                            - - - - - -
                                                                                                                            - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                            - - - - -
                                                                                                                            - - - - -
                                                                                                                            - -

                                                                                                                            - - inner parseResonator(arr) → {Object|null} - - - - -

                                                                                                                            - - - -
                                                                                                                            -
                                                                                                                            - - -
                                                                                                                            -

                                                                                                                            Parses a resonator array into an object.

                                                                                                                            -
                                                                                                                            - - - - - - - - - -
                                                                                                                            -
                                                                                                                            Parameters:
                                                                                                                            - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                            NameTypeDescription
                                                                                                                            arr - - -Array - - - -

                                                                                                                            The resonator array.

                                                                                                                            - -
                                                                                                                            - - - - - - - - - - - - - -
                                                                                                                            -
                                                                                                                            Returns:
                                                                                                                            - - - - - -Object -| - -null - - - - - --

                                                                                                                            Parsed resonator object or null if the input is falsy.

                                                                                                                            - - - - - -
                                                                                                                            - - - - - -
                                                                                                                            - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                            - - - - -
                                                                                                                            - - - - -
                                                                                                                            - -

                                                                                                                            - - inner parseResonator(arr) → {Object|null} - - - - -

                                                                                                                            - - - -
                                                                                                                            -
                                                                                                                            - - -
                                                                                                                            -

                                                                                                                            Parses a resonator array into an object.

                                                                                                                            -
                                                                                                                            - - - - - - - - - -
                                                                                                                            -
                                                                                                                            Parameters:
                                                                                                                            - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                            NameTypeDescription
                                                                                                                            arr - - -Array - - - -

                                                                                                                            The resonator array.

                                                                                                                            - -
                                                                                                                            - - - - - - - - - - - - - -
                                                                                                                            -
                                                                                                                            Returns:
                                                                                                                            - - - - - -Object -| - -null - - - - - --

                                                                                                                            Parsed resonator object or null if the input is falsy.

                                                                                                                            - - - - - -
                                                                                                                            - - - - - -
                                                                                                                            - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                            - - - - -
                                                                                                                            - - - - -
                                                                                                                            - -

                                                                                                                            - - inner summaryPortalData(a) → {Object} - - - - -

                                                                                                                            - - - -
                                                                                                                            -
                                                                                                                            - - -
                                                                                                                            -

                                                                                                                            Parses the summary portal data from an array.

                                                                                                                            -
                                                                                                                            - - - - - - - - - -
                                                                                                                            -
                                                                                                                            Parameters:
                                                                                                                            - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                            NameTypeDescription
                                                                                                                            a - - -Array - - - -

                                                                                                                            The portal data array.

                                                                                                                            - -
                                                                                                                            - - - - - - - - - - - - - -
                                                                                                                            -
                                                                                                                            Returns:
                                                                                                                            - - - - - -Object - - - - - --

                                                                                                                            An object containing the summary data of a portal.

                                                                                                                            - - - - - -
                                                                                                                            - - - - - -
                                                                                                                            - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                            - - - - -
                                                                                                                            - - - - -
                                                                                                                            - -

                                                                                                                            - - inner summaryPortalData(a) → {Object} - - - - -

                                                                                                                            - - - -
                                                                                                                            -
                                                                                                                            - - -
                                                                                                                            -

                                                                                                                            Parses the summary portal data from an array.

                                                                                                                            -
                                                                                                                            - - - - - - - - - -
                                                                                                                            -
                                                                                                                            Parameters:
                                                                                                                            - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                            NameTypeDescription
                                                                                                                            a - - -Array - - - -

                                                                                                                            The portal data array.

                                                                                                                            - -
                                                                                                                            - - - - - - - - - - - - - -
                                                                                                                            -
                                                                                                                            Returns:
                                                                                                                            - - - - - -Object - - - - - --

                                                                                                                            An object containing the summary data of a portal.

                                                                                                                            - - - - - -
                                                                                                                            - - - - - -
                                                                                                                            - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                            - - - - -
                                                                                                                            - - - - - - - -
                                                                                                                            - -
                                                                                                                            - - - - - - - -
                                                                                                                            - -
                                                                                                                            - -

                                                                                                                            entity_decode

                                                                                                                            - - - - - - -
                                                                                                                            - -
                                                                                                                            - -
                                                                                                                            - - -

                                                                                                                            Decode the on-network array entity format into an object format closer to that used before -makes much more sense as an object, means that existing code didn't need to change, and it's what the -stock intel site does internally too (the array format is only on the network)

                                                                                                                            - - - - - -
                                                                                                                            - -
                                                                                                                            -
                                                                                                                            - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                            - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                            - - - - -
                                                                                                                            - - - - -
                                                                                                                            - -
                                                                                                                            -
                                                                                                                            - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                            - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                            - - - - -
                                                                                                                            - - - -
                                                                                                                            - - - - - - - - - - - - - - - - - -

                                                                                                                            Methods

                                                                                                                            - -
                                                                                                                            - - -
                                                                                                                            - -

                                                                                                                            - - inner corePortalData(a) → {Object} - - - - -

                                                                                                                            - - - -
                                                                                                                            -
                                                                                                                            - - -
                                                                                                                            -

                                                                                                                            Parses the core portal data from an array.

                                                                                                                            -
                                                                                                                            - - - - - - - - - -
                                                                                                                            -
                                                                                                                            Parameters:
                                                                                                                            - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                            NameTypeDescription
                                                                                                                            a - - -Array - - - -

                                                                                                                            The portal data array.

                                                                                                                            - -
                                                                                                                            - - - - - - - - - - - - - -
                                                                                                                            -
                                                                                                                            Returns:
                                                                                                                            - - - - - -Object - - - - - --

                                                                                                                            An object containing the core data of a portal.

                                                                                                                            - - - - - -
                                                                                                                            - - - - - -
                                                                                                                            - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                            - - - - -
                                                                                                                            - - - - -
                                                                                                                            - -

                                                                                                                            - - inner corePortalData(a) → {Object} - - - - -

                                                                                                                            - - - -
                                                                                                                            -
                                                                                                                            - - -
                                                                                                                            -

                                                                                                                            Parses the core portal data from an array.

                                                                                                                            -
                                                                                                                            - - - - - - - - - -
                                                                                                                            -
                                                                                                                            Parameters:
                                                                                                                            - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                            NameTypeDescription
                                                                                                                            a - - -Array - - - -

                                                                                                                            The portal data array.

                                                                                                                            - -
                                                                                                                            - - - - - - - - - - - - - -
                                                                                                                            -
                                                                                                                            Returns:
                                                                                                                            - - - - - -Object - - - - - --

                                                                                                                            An object containing the core data of a portal.

                                                                                                                            - - - - - -
                                                                                                                            - - - - - -
                                                                                                                            - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                            - - - - -
                                                                                                                            - - - - -
                                                                                                                            - -

                                                                                                                            - - inner detailsPortalData(a) → {Object} - - - - -

                                                                                                                            - - - -
                                                                                                                            -
                                                                                                                            - - -
                                                                                                                            -

                                                                                                                            Parses the detailed portal data from an array.

                                                                                                                            -
                                                                                                                            - - - - - - - - - -
                                                                                                                            -
                                                                                                                            Parameters:
                                                                                                                            - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                            NameTypeDescription
                                                                                                                            a - - -Array - - - -

                                                                                                                            The portal data array.

                                                                                                                            - -
                                                                                                                            - - - - - - - - - - - - - -
                                                                                                                            -
                                                                                                                            Returns:
                                                                                                                            - - - - - -Object - - - - - --

                                                                                                                            An object containing the detailed data of a portal.

                                                                                                                            - - - - - -
                                                                                                                            - - - - - -
                                                                                                                            - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                            - - - - -
                                                                                                                            - - - - -
                                                                                                                            - -

                                                                                                                            - - inner detailsPortalData(a) → {Object} - - - - -

                                                                                                                            - - - -
                                                                                                                            -
                                                                                                                            - - -
                                                                                                                            -

                                                                                                                            Parses the detailed portal data from an array.

                                                                                                                            -
                                                                                                                            - - - - - - - - - -
                                                                                                                            -
                                                                                                                            Parameters:
                                                                                                                            - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                            NameTypeDescription
                                                                                                                            a - - -Array - - - -

                                                                                                                            The portal data array.

                                                                                                                            - -
                                                                                                                            - - - - - - - - - - - - - -
                                                                                                                            -
                                                                                                                            Returns:
                                                                                                                            - - - - - -Object - - - - - --

                                                                                                                            An object containing the detailed data of a portal.

                                                                                                                            - - - - - -
                                                                                                                            - - - - - -
                                                                                                                            - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                            - - - - -
                                                                                                                            - - - - -
                                                                                                                            - -

                                                                                                                            - - inner extendedPortalData(a) → {Object} - - - - -

                                                                                                                            - - - -
                                                                                                                            -
                                                                                                                            - - -
                                                                                                                            -

                                                                                                                            Parses the extended portal data from an array.

                                                                                                                            -
                                                                                                                            - - - - - - - - - -
                                                                                                                            -
                                                                                                                            Parameters:
                                                                                                                            - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                            NameTypeDescription
                                                                                                                            a - - -Array - - - -

                                                                                                                            The portal data array.

                                                                                                                            - -
                                                                                                                            - - - - - - - - - - - - - -
                                                                                                                            -
                                                                                                                            Returns:
                                                                                                                            - - - - - -Object - - - - - --

                                                                                                                            An object containing the extended data of a portal.

                                                                                                                            - - - - - -
                                                                                                                            - - - - - -
                                                                                                                            - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                            - - - - -
                                                                                                                            - - - - -
                                                                                                                            - -

                                                                                                                            - - inner extendedPortalData(a) → {Object} - - - - -

                                                                                                                            - - - -
                                                                                                                            -
                                                                                                                            - - -
                                                                                                                            -

                                                                                                                            Parses the extended portal data from an array.

                                                                                                                            -
                                                                                                                            - - - - - - - - - -
                                                                                                                            -
                                                                                                                            Parameters:
                                                                                                                            - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                            NameTypeDescription
                                                                                                                            a - - -Array - - - -

                                                                                                                            The portal data array.

                                                                                                                            - -
                                                                                                                            - - - - - - - - - - - - - -
                                                                                                                            -
                                                                                                                            Returns:
                                                                                                                            - - - - - -Object - - - - - --

                                                                                                                            An object containing the extended data of a portal.

                                                                                                                            - - - - - -
                                                                                                                            - - - - - -
                                                                                                                            - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                            - - - - -
                                                                                                                            - - - - -
                                                                                                                            - -

                                                                                                                            - - inner parseArtifactBrief(arr) → {Object|null} - - - - -

                                                                                                                            - - - -
                                                                                                                            -
                                                                                                                            - - -
                                                                                                                            -

                                                                                                                            Parses an artifact brief array into an object.

                                                                                                                            -
                                                                                                                            - - - - - - - - - -
                                                                                                                            -
                                                                                                                            Parameters:
                                                                                                                            - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                            NameTypeDescription
                                                                                                                            arr - - -Array - - - -

                                                                                                                            The artifact brief array.

                                                                                                                            - -
                                                                                                                            - - - - - - - - - - - - - -
                                                                                                                            -
                                                                                                                            Returns:
                                                                                                                            - - - - - -Object -| - -null - - - - - --

                                                                                                                            Parsed artifact brief object or null if the input is falsy.

                                                                                                                            - - - - - -
                                                                                                                            - - - - - -
                                                                                                                            - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                            - - - - -
                                                                                                                            - - - - -
                                                                                                                            - -

                                                                                                                            - - inner parseArtifactBrief(arr) → {Object|null} - - - - -

                                                                                                                            - - - -
                                                                                                                            -
                                                                                                                            - - -
                                                                                                                            -

                                                                                                                            Parses an artifact brief array into an object.

                                                                                                                            -
                                                                                                                            - - - - - - - - - -
                                                                                                                            -
                                                                                                                            Parameters:
                                                                                                                            - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                            NameTypeDescription
                                                                                                                            arr - - -Array - - - -

                                                                                                                            The artifact brief array.

                                                                                                                            - -
                                                                                                                            - - - - - - - - - - - - - -
                                                                                                                            -
                                                                                                                            Returns:
                                                                                                                            - - - - - -Object -| - -null - - - - - --

                                                                                                                            Parsed artifact brief object or null if the input is falsy.

                                                                                                                            - - - - - -
                                                                                                                            - - - - - -
                                                                                                                            - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                            - - - - -
                                                                                                                            - - - - -
                                                                                                                            - -

                                                                                                                            - - inner parseArtifactDetail(arr) → {Object|null} - - - - -

                                                                                                                            - - - -
                                                                                                                            -
                                                                                                                            - - -
                                                                                                                            -

                                                                                                                            Parses an artifact detail array into an object.

                                                                                                                            -
                                                                                                                            - - - - - - - - - -
                                                                                                                            -
                                                                                                                            Parameters:
                                                                                                                            - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                            NameTypeDescription
                                                                                                                            arr - - -Array - - - -

                                                                                                                            The artifact detail array.

                                                                                                                            - -
                                                                                                                            - - - - - - - - - - - - - -
                                                                                                                            -
                                                                                                                            Returns:
                                                                                                                            - - - - - -Object -| - -null - - - - - --

                                                                                                                            Parsed artifact detail object or null if the input is falsy.

                                                                                                                            - - - - - -
                                                                                                                            - - - - - -
                                                                                                                            - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                            - - - - -
                                                                                                                            - - - - -
                                                                                                                            - -

                                                                                                                            - - inner parseArtifactDetail(arr) → {Object|null} - - - - -

                                                                                                                            - - - -
                                                                                                                            -
                                                                                                                            - - -
                                                                                                                            -

                                                                                                                            Parses an artifact detail array into an object.

                                                                                                                            -
                                                                                                                            - - - - - - - - - -
                                                                                                                            -
                                                                                                                            Parameters:
                                                                                                                            - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                            NameTypeDescription
                                                                                                                            arr - - -Array - - - -

                                                                                                                            The artifact detail array.

                                                                                                                            - -
                                                                                                                            - - - - - - - - - - - - - -
                                                                                                                            -
                                                                                                                            Returns:
                                                                                                                            - - - - - -Object -| - -null - - - - - --

                                                                                                                            Parsed artifact detail object or null if the input is falsy.

                                                                                                                            - - - - - -
                                                                                                                            - - - - - -
                                                                                                                            - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                            - - - - -
                                                                                                                            - - - - -
                                                                                                                            - -

                                                                                                                            - - inner parseHistoryDetail(bitarray) → {Object} - - - - -

                                                                                                                            - - - -
                                                                                                                            -
                                                                                                                            - - -
                                                                                                                            -

                                                                                                                            Parses a history detail bit array into an object.

                                                                                                                            -
                                                                                                                            - - - - - - - - - -
                                                                                                                            -
                                                                                                                            Parameters:
                                                                                                                            - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                            NameTypeDescription
                                                                                                                            bitarray - - -number - - - -

                                                                                                                            The history detail bit array.

                                                                                                                            - -
                                                                                                                            - - - - - - - - - - - - - -
                                                                                                                            -
                                                                                                                            Returns:
                                                                                                                            - - - - - -Object - - - - - --

                                                                                                                            Parsed history detail object.

                                                                                                                            - - - - - -
                                                                                                                            - - - - - -
                                                                                                                            - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                            - - - - -
                                                                                                                            - - - - -
                                                                                                                            - -

                                                                                                                            - - inner parseHistoryDetail(bitarray) → {Object} - - - - -

                                                                                                                            - - - -
                                                                                                                            -
                                                                                                                            - - -
                                                                                                                            -

                                                                                                                            Parses a history detail bit array into an object.

                                                                                                                            -
                                                                                                                            - - - - - - - - - -
                                                                                                                            -
                                                                                                                            Parameters:
                                                                                                                            - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                            NameTypeDescription
                                                                                                                            bitarray - - -number - - - -

                                                                                                                            The history detail bit array.

                                                                                                                            - -
                                                                                                                            - - - - - - - - - - - - - -
                                                                                                                            -
                                                                                                                            Returns:
                                                                                                                            - - - - - -Object - - - - - --

                                                                                                                            Parsed history detail object.

                                                                                                                            - - - - - -
                                                                                                                            - - - - - -
                                                                                                                            - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                            - - - - -
                                                                                                                            - - - - -
                                                                                                                            - -

                                                                                                                            - - inner parseMod(arr) → {Object|null} - - - - -

                                                                                                                            - - - -
                                                                                                                            -
                                                                                                                            - - -
                                                                                                                            -

                                                                                                                            Parses a mod array into an object.

                                                                                                                            -
                                                                                                                            - - - - - - - - - -
                                                                                                                            -
                                                                                                                            Parameters:
                                                                                                                            - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                            NameTypeDescription
                                                                                                                            arr - - -Array - - - -

                                                                                                                            The mod array.

                                                                                                                            - -
                                                                                                                            - - - - - - - - - - - - - -
                                                                                                                            -
                                                                                                                            Returns:
                                                                                                                            - - - - - -Object -| - -null - - - - - --

                                                                                                                            Parsed mod object or null if the input is falsy.

                                                                                                                            - - - - - -
                                                                                                                            - - - - - -
                                                                                                                            - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                            - - - - -
                                                                                                                            - - - - -
                                                                                                                            - -

                                                                                                                            - - inner parseMod(arr) → {Object|null} - - - - -

                                                                                                                            - - - -
                                                                                                                            -
                                                                                                                            - - -
                                                                                                                            -

                                                                                                                            Parses a mod array into an object.

                                                                                                                            -
                                                                                                                            - - - - - - - - - -
                                                                                                                            -
                                                                                                                            Parameters:
                                                                                                                            - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                            NameTypeDescription
                                                                                                                            arr - - -Array - - - -

                                                                                                                            The mod array.

                                                                                                                            - -
                                                                                                                            - - - - - - - - - - - - - -
                                                                                                                            -
                                                                                                                            Returns:
                                                                                                                            - - - - - -Object -| - -null - - - - - --

                                                                                                                            Parsed mod object or null if the input is falsy.

                                                                                                                            - - - - - -
                                                                                                                            - - - - - -
                                                                                                                            - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                            - - - - -
                                                                                                                            - - - - -
                                                                                                                            - -

                                                                                                                            - - inner parseResonator(arr) → {Object|null} - - - - -

                                                                                                                            - - - -
                                                                                                                            -
                                                                                                                            - - -
                                                                                                                            -

                                                                                                                            Parses a resonator array into an object.

                                                                                                                            -
                                                                                                                            - - - - - - - - - -
                                                                                                                            -
                                                                                                                            Parameters:
                                                                                                                            - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                            NameTypeDescription
                                                                                                                            arr - - -Array - - - -

                                                                                                                            The resonator array.

                                                                                                                            - -
                                                                                                                            - - - - - - - - - - - - - -
                                                                                                                            -
                                                                                                                            Returns:
                                                                                                                            - - - - - -Object -| - -null - - - - - --

                                                                                                                            Parsed resonator object or null if the input is falsy.

                                                                                                                            - - - - - -
                                                                                                                            - - - - - -
                                                                                                                            - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                            - - - - -
                                                                                                                            - - - - -
                                                                                                                            - -

                                                                                                                            - - inner parseResonator(arr) → {Object|null} - - - - -

                                                                                                                            - - - -
                                                                                                                            -
                                                                                                                            - - -
                                                                                                                            -

                                                                                                                            Parses a resonator array into an object.

                                                                                                                            -
                                                                                                                            - - - - - - - - - -
                                                                                                                            -
                                                                                                                            Parameters:
                                                                                                                            - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + @@ -6065,166 +1593,6 @@
                                                                                                                            Returns:
                                                                                                                            - - - - - - - - - - - - - - - - - - - - -
                                                                                                                            - -

                                                                                                                            - - inner summaryPortalData(a) → {Object} - - - - -

                                                                                                                            - - - -
                                                                                                                            -
                                                                                                                            - - -
                                                                                                                            -

                                                                                                                            Parses the summary portal data from an array.

                                                                                                                            -
                                                                                                                            - - - - - - - - - -
                                                                                                                            -
                                                                                                                            Parameters:
                                                                                                                            - -
                                                                                                                            NameTypeDescription
                                                                                                                            arr - - -Array - - - -

                                                                                                                            The resonator array.

                                                                                                                            The resonator array.

                                                                                                                            - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                            NameTypeDescription
                                                                                                                            a - - -Array - - - -

                                                                                                                            The portal data array.

                                                                                                                            - -
                                                                                                                            - - - - - - - - - - - - - -
                                                                                                                            -
                                                                                                                            Returns:
                                                                                                                            - - - - - -Object - - - - - --

                                                                                                                            An object containing the summary data of a portal.

                                                                                                                            - - - - - -
                                                                                                                            - - - - - -
                                                                                                                            - - - - - - - - - - - - - - - - - - - - diff --git a/module-entity_info.html b/module-entity_info.html index c6113abde..ae580c1ce 100644 --- a/module-entity_info.html +++ b/module-entity_info.html @@ -34,7 +34,7 @@

                                                                                                                            IITC-CE

                                                                                                                              - +
                                                                                                                              @@ -52,8 +52,6 @@

                                                                                                                              entity_info

                                                                                                                              - - @@ -120,77 +118,6 @@

                                                                                                                              entity_info

                                                                                                                              - - - - - - - - - - -
                                                                                                                              - - - - -
                                                                                                                              - - - - -
                                                                                                                              - -
                                                                                                                              -
                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                              - - - - - - - - - - - - - - - - - - - - @@ -374,1171 +301,6 @@
                                                                                                                              Returns:
                                                                                                                              - - - - - - - - - - -
                                                                                                                              - - - - -
                                                                                                                              - - - - -
                                                                                                                              - -

                                                                                                                              - - inner getTeam(details) → {number} - - - - -

                                                                                                                              - - - -
                                                                                                                              -
                                                                                                                              - - -
                                                                                                                              -

                                                                                                                              Given the entity detail data, returns the team the entity belongs to. -Uses TEAM_* enum values.

                                                                                                                              -
                                                                                                                              - - - - - - - - - -
                                                                                                                              -
                                                                                                                              Parameters:
                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                              NameTypeDescription
                                                                                                                              details - - -Object - - - -

                                                                                                                              The details hash of an entity.

                                                                                                                              - -
                                                                                                                              - - - - - - - - - - - - - -
                                                                                                                              -
                                                                                                                              Returns:
                                                                                                                              - - - - - -number - - - - - --

                                                                                                                              The team ID the entity belongs to.

                                                                                                                              - - - - - -
                                                                                                                              - - - - - -
                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                              - - - - -
                                                                                                                              - - - - -
                                                                                                                              - -

                                                                                                                              - - inner teamStringToId(teamStr) → {number} - - - - -

                                                                                                                              - - - -
                                                                                                                              -
                                                                                                                              - - -
                                                                                                                              -

                                                                                                                              Converts a team string to a team ID.

                                                                                                                              -
                                                                                                                              - - - - - - - - - -
                                                                                                                              -
                                                                                                                              Parameters:
                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                              NameTypeDescription
                                                                                                                              teamStr - - -string - - - -

                                                                                                                              The team string to convert.

                                                                                                                              - -
                                                                                                                              - - - - - - - - - - - - - -
                                                                                                                              -
                                                                                                                              Returns:
                                                                                                                              - - - - - -number - - - - - --

                                                                                                                              The team ID corresponding to the team string.

                                                                                                                              - - - - - -
                                                                                                                              - - - - - -
                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                              - - - - -
                                                                                                                              - - - - -
                                                                                                                              - -

                                                                                                                              - - inner teamStringToId(teamStr) → {number} - - - - -

                                                                                                                              - - - -
                                                                                                                              -
                                                                                                                              - - -
                                                                                                                              -

                                                                                                                              Converts a team string to a team ID.

                                                                                                                              -
                                                                                                                              - - - - - - - - - -
                                                                                                                              -
                                                                                                                              Parameters:
                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                              NameTypeDescription
                                                                                                                              teamStr - - -string - - - -

                                                                                                                              The team string to convert.

                                                                                                                              - -
                                                                                                                              - - - - - - - - - - - - - -
                                                                                                                              -
                                                                                                                              Returns:
                                                                                                                              - - - - - -number - - - - - --

                                                                                                                              The team ID corresponding to the team string.

                                                                                                                              - - - - - -
                                                                                                                              - - - - - -
                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                              - - - - -
                                                                                                                              - -
                                                                                                                              - - - - - -
                                                                                                                              - -
                                                                                                                              - - - - - - - -
                                                                                                                              - -
                                                                                                                              - -

                                                                                                                              entity_info

                                                                                                                              - - - - - - -
                                                                                                                              - -
                                                                                                                              - -
                                                                                                                              - - -

                                                                                                                              Entity Details Tools -Functions to extract useful data from entity details, such as portals, links, and fields.

                                                                                                                              - - - - - -
                                                                                                                              - -
                                                                                                                              -
                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                              - - - - -
                                                                                                                              - - - - -
                                                                                                                              - -
                                                                                                                              -
                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                              - - - - -
                                                                                                                              - - - -
                                                                                                                              - - - - - - - - - - - - - - - - - -

                                                                                                                              Methods

                                                                                                                              - -
                                                                                                                              - - -
                                                                                                                              - -

                                                                                                                              - - inner getTeam(details) → {number} - - - - -

                                                                                                                              - - - -
                                                                                                                              -
                                                                                                                              - - -
                                                                                                                              -

                                                                                                                              Given the entity detail data, returns the team the entity belongs to. -Uses TEAM_* enum values.

                                                                                                                              -
                                                                                                                              - - - - - - - - - -
                                                                                                                              -
                                                                                                                              Parameters:
                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                              NameTypeDescription
                                                                                                                              details - - -Object - - - -

                                                                                                                              The details hash of an entity.

                                                                                                                              - -
                                                                                                                              - - - - - - - - - - - - - -
                                                                                                                              -
                                                                                                                              Returns:
                                                                                                                              - - - - - -number - - - - - --

                                                                                                                              The team ID the entity belongs to.

                                                                                                                              - - - - - -
                                                                                                                              - - - - - -
                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                              - - - - -
                                                                                                                              - - - - -
                                                                                                                              - -

                                                                                                                              - - inner getTeam(details) → {number} - - - - -

                                                                                                                              - - - -
                                                                                                                              -
                                                                                                                              - - -
                                                                                                                              -

                                                                                                                              Given the entity detail data, returns the team the entity belongs to. -Uses TEAM_* enum values.

                                                                                                                              -
                                                                                                                              - - - - - - - - - -
                                                                                                                              -
                                                                                                                              Parameters:
                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                              NameTypeDescription
                                                                                                                              details - - -Object - - - -

                                                                                                                              The details hash of an entity.

                                                                                                                              - -
                                                                                                                              - - - - - - - - - - - - - -
                                                                                                                              -
                                                                                                                              Returns:
                                                                                                                              - - - - - -number - - - - - --

                                                                                                                              The team ID the entity belongs to.

                                                                                                                              - - - - - -
                                                                                                                              - - - - - -
                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                              - - - - -
                                                                                                                              - - - - -
                                                                                                                              - -

                                                                                                                              - - inner teamStringToId(teamStr) → {number} - - - - -

                                                                                                                              - - - -
                                                                                                                              -
                                                                                                                              - - -
                                                                                                                              -

                                                                                                                              Converts a team string to a team ID.

                                                                                                                              -
                                                                                                                              - - - - - - - - - -
                                                                                                                              -
                                                                                                                              Parameters:
                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                              NameTypeDescription
                                                                                                                              teamStr - - -string - - - -

                                                                                                                              The team string to convert.

                                                                                                                              - -
                                                                                                                              - - - - - - - - - - - - - -
                                                                                                                              -
                                                                                                                              Returns:
                                                                                                                              - - - - - -number - - - - - --

                                                                                                                              The team ID corresponding to the team string.

                                                                                                                              - - - - - -
                                                                                                                              - - - - - -
                                                                                                                              - - - - - - - - - - - - - - - - - - - - diff --git a/module-extract_niantic_parameters.html b/module-extract_niantic_parameters.html index d40063745..4b2835d6d 100644 --- a/module-extract_niantic_parameters.html +++ b/module-extract_niantic_parameters.html @@ -34,7 +34,7 @@

                                                                                                                              IITC-CE

                                                                                                                                - +
                                                                                                                                @@ -52,390 +52,6 @@

                                                                                                                                extract_niantic_parameters

                                                                                                                                - - - - - -
                                                                                                                                - -
                                                                                                                                - - -

                                                                                                                                Extract essential parameters and functions from the Ingress Intel site's minified JavaScript. -Necessary due to Niantic's minification and obfuscation of their Intel Map code.

                                                                                                                                - - - - - -
                                                                                                                                - -
                                                                                                                                -
                                                                                                                                - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                - - - - -
                                                                                                                                - - - - -
                                                                                                                                - -
                                                                                                                                -
                                                                                                                                - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                - - - - -
                                                                                                                                - - - -
                                                                                                                                - - - - - - - - - - - - - - - - - -

                                                                                                                                Methods

                                                                                                                                - -
                                                                                                                                - - -
                                                                                                                                - -

                                                                                                                                - - inner extractFromStock() - - - - -

                                                                                                                                - - - -
                                                                                                                                -
                                                                                                                                - - -
                                                                                                                                -

                                                                                                                                Main function to extract required parameters from the Ingress Intel site's JavaScript. -Throws an error and shows a dialog if it fails to find the necessary parameters.

                                                                                                                                -
                                                                                                                                - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                - - - - -
                                                                                                                                - - - - -
                                                                                                                                - -

                                                                                                                                - - inner extractFromStock() - - - - -

                                                                                                                                - - - -
                                                                                                                                -
                                                                                                                                - - -
                                                                                                                                -

                                                                                                                                Main function to extract required parameters from the Ingress Intel site's JavaScript. -Throws an error and shows a dialog if it fails to find the necessary parameters.

                                                                                                                                -
                                                                                                                                - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                - - - - -
                                                                                                                                - -
                                                                                                                                - - - - - -
                                                                                                                                - -
                                                                                                                                - - - - - - - -
                                                                                                                                - -
                                                                                                                                - -

                                                                                                                                extract_niantic_parameters

                                                                                                                                - - - - -
                                                                                                                                @@ -502,77 +118,6 @@

                                                                                                                                extract_niantic_parameters

                                                                                                                                - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                - -
                                                                                                                                -
                                                                                                                                - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                - - - - - - - - - - - - - - - - - - - - @@ -685,96 +230,6 @@

                                                                                                                                - - - - - - - - - - -

                                                                                                                                - - - - -
                                                                                                                                - - - - -
                                                                                                                                - -

                                                                                                                                - - inner extractFromStock() - - - - -

                                                                                                                                - - - -
                                                                                                                                -
                                                                                                                                - - -
                                                                                                                                -

                                                                                                                                Main function to extract required parameters from the Ingress Intel site's JavaScript. -Throws an error and shows a dialog if it fails to find the necessary parameters.

                                                                                                                                -
                                                                                                                                - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                - - - - - - - - - - - - - - - - - - - - diff --git a/module-game_status.html b/module-game_status.html index fb12a736a..05cd8fd17 100644 --- a/module-game_status.html +++ b/module-game_status.html @@ -34,7 +34,7 @@

                                                                                                                                IITC-CE

                                                                                                                                  - +
                                                                                                                                  @@ -52,520 +52,6 @@

                                                                                                                                  game_status

                                                                                                                                  - - - - - -
                                                                                                                                  - -
                                                                                                                                  - - -

                                                                                                                                  Contains functions related to updating and displaying the current MindUnit scores in the game. -The MindUnit scores represent the current global score for each faction in Ingress.

                                                                                                                                  - - - - - -
                                                                                                                                  - -
                                                                                                                                  -
                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                  - - - - -
                                                                                                                                  - - - - -
                                                                                                                                  - -
                                                                                                                                  -
                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                  - - - - -
                                                                                                                                  - - - -
                                                                                                                                  - - - - - - - - - - - - - - - - - -

                                                                                                                                  Methods

                                                                                                                                  - -
                                                                                                                                  - - -
                                                                                                                                  - -

                                                                                                                                  - - inner updateGameScore(dataopt) - - - - -

                                                                                                                                  - - - -
                                                                                                                                  -
                                                                                                                                  - - -
                                                                                                                                  -

                                                                                                                                  Updates the game score displayed on the map. -This function queries the current global MindUnit score for each faction from the Ingress servers -and updates the display. The scores are displayed in a percentage format, showing the dominance of each faction. -If the data isn't available, this function attempts to fetch it from the server.

                                                                                                                                  -
                                                                                                                                  - - - - - - - - - -
                                                                                                                                  -
                                                                                                                                  Parameters:
                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                  NameTypeAttributesDescription
                                                                                                                                  data - - -Object - - - - - - <optional>
                                                                                                                                  - - - - - -

                                                                                                                                  The game score data retrieved from the Ingress servers. -If not provided, the function will make a server request to fetch the data.

                                                                                                                                  - -
                                                                                                                                  - - - - - - - - - - - - - - - - - -
                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                  - - - - -
                                                                                                                                  - - - - -
                                                                                                                                  - -

                                                                                                                                  - - inner updateGameScore(dataopt) - - - - -

                                                                                                                                  - - - -
                                                                                                                                  -
                                                                                                                                  - - -
                                                                                                                                  -

                                                                                                                                  Updates the game score displayed on the map. -This function queries the current global MindUnit score for each faction from the Ingress servers -and updates the display. The scores are displayed in a percentage format, showing the dominance of each faction. -If the data isn't available, this function attempts to fetch it from the server.

                                                                                                                                  -
                                                                                                                                  - - - - - - - - - -
                                                                                                                                  -
                                                                                                                                  Parameters:
                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                  NameTypeAttributesDescription
                                                                                                                                  data - - -Object - - - - - - <optional>
                                                                                                                                  - - - - - -

                                                                                                                                  The game score data retrieved from the Ingress servers. -If not provided, the function will make a server request to fetch the data.

                                                                                                                                  - -
                                                                                                                                  - - - - - - - - - - - - - - - - - -
                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                  - - - - -
                                                                                                                                  - -
                                                                                                                                  - - - - - -
                                                                                                                                  - -
                                                                                                                                  - - - - - - - -
                                                                                                                                  - -
                                                                                                                                  - -

                                                                                                                                  game_status

                                                                                                                                  - - - - -
                                                                                                                                  @@ -632,77 +118,6 @@

                                                                                                                                  game_status

                                                                                                                                  - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                  - -
                                                                                                                                  -
                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                  - - - - - - - - - - - - - - - - - - - - @@ -880,161 +295,6 @@
                                                                                                                                  Parameters:
                                                                                                                                  - - - - - - - - - - -
                                                                                                                                  - - - - -
                                                                                                                                  - - - - -
                                                                                                                                  - -

                                                                                                                                  - - inner updateGameScore(dataopt) - - - - -

                                                                                                                                  - - - -
                                                                                                                                  -
                                                                                                                                  - - -
                                                                                                                                  -

                                                                                                                                  Updates the game score displayed on the map. -This function queries the current global MindUnit score for each faction from the Ingress servers -and updates the display. The scores are displayed in a percentage format, showing the dominance of each faction. -If the data isn't available, this function attempts to fetch it from the server.

                                                                                                                                  -
                                                                                                                                  - - - - - - - - - -
                                                                                                                                  -
                                                                                                                                  Parameters:
                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                  NameTypeAttributesDescription
                                                                                                                                  data - - -Object - - - - - - <optional>
                                                                                                                                  - - - - - -

                                                                                                                                  The game score data retrieved from the Ingress servers. -If not provided, the function will make a server request to fetch the data.

                                                                                                                                  - -
                                                                                                                                  - - - - - - - - - - - - - - - - - -
                                                                                                                                  - - - - - - - - - - - - - - - - - - - - diff --git a/module-hooks.html b/module-hooks.html index fe6ac91c4..21cee11fc 100644 --- a/module-hooks.html +++ b/module-hooks.html @@ -34,7 +34,7 @@

                                                                                                                                  IITC-CE

                                                                                                                                    - +
                                                                                                                                    @@ -52,8 +52,6 @@

                                                                                                                                    hooks

                                                                                                                                    - - @@ -166,77 +164,6 @@

                                                                                                                                    hooks

                                                                                                                                    - - - - - - - - - - -
                                                                                                                                    - - - - -
                                                                                                                                    - - - - -
                                                                                                                                    - -
                                                                                                                                    -
                                                                                                                                    - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                    - - - - - - - - - - - - - - - - - - - - @@ -421,168 +348,6 @@
                                                                                                                                    Parameters:
                                                                                                                                    - - - - - - - - - - -
                                                                                                                                    - - - - -
                                                                                                                                    - - - - -
                                                                                                                                    - -

                                                                                                                                    - - inner addHook(event, callback) - - - - -

                                                                                                                                    - - - -
                                                                                                                                    -
                                                                                                                                    - - -
                                                                                                                                    -

                                                                                                                                    Registers a callback function for a specified hook event.

                                                                                                                                    -
                                                                                                                                    - - - - - - - - - -
                                                                                                                                    -
                                                                                                                                    Parameters:
                                                                                                                                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                    NameTypeDescription
                                                                                                                                    event - - -string - - - -

                                                                                                                                    The name of the hook event.

                                                                                                                                    callback - - -function - - - -

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

                                                                                                                                    - -
                                                                                                                                    - - - - - - - - - - - - - - - - - -
                                                                                                                                    - - - - - - - - - - - - - - - - - - - - @@ -746,1676 +511,6 @@
                                                                                                                                    Parameters:
                                                                                                                                    - - - - - - - - - - -
                                                                                                                                    - - - - -
                                                                                                                                    - - - - -
                                                                                                                                    - -

                                                                                                                                    - - inner removeHook(event, callback) - - - - -

                                                                                                                                    - - - -
                                                                                                                                    -
                                                                                                                                    - - -
                                                                                                                                    -

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

                                                                                                                                    -
                                                                                                                                    - - - - - - - - - -
                                                                                                                                    -
                                                                                                                                    Parameters:
                                                                                                                                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                    NameTypeDescription
                                                                                                                                    event - - -string - - - -

                                                                                                                                    The name of the hook event.

                                                                                                                                    callback - - -function - - - -

                                                                                                                                    The callback function to be removed.

                                                                                                                                    - -
                                                                                                                                    - - - - - - - - - - - - - - - - - -
                                                                                                                                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                    - - - - -
                                                                                                                                    - - - - -
                                                                                                                                    - -

                                                                                                                                    - - inner runHooks(event, dataopt) → {boolean} - - - - -

                                                                                                                                    - - - -
                                                                                                                                    -
                                                                                                                                    - - -
                                                                                                                                    -

                                                                                                                                    Executes all callbacks associated with a given hook event.

                                                                                                                                    -
                                                                                                                                    - - - - - - - - - -
                                                                                                                                    -
                                                                                                                                    Parameters:
                                                                                                                                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                    NameTypeAttributesDescription
                                                                                                                                    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.

                                                                                                                                    - - - - - -
                                                                                                                                    - - - - - -
                                                                                                                                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                    - - - - -
                                                                                                                                    - - - - -
                                                                                                                                    - -

                                                                                                                                    - - inner runHooks(event, dataopt) → {boolean} - - - - -

                                                                                                                                    - - - -
                                                                                                                                    -
                                                                                                                                    - - -
                                                                                                                                    -

                                                                                                                                    Executes all callbacks associated with a given hook event.

                                                                                                                                    -
                                                                                                                                    - - - - - - - - - -
                                                                                                                                    -
                                                                                                                                    Parameters:
                                                                                                                                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                    NameTypeAttributesDescription
                                                                                                                                    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.

                                                                                                                                    - - - - - -
                                                                                                                                    - - - - - -
                                                                                                                                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                    - - - - -
                                                                                                                                    - - - - - - - - - -
                                                                                                                                    - - - - - - - -
                                                                                                                                    - -
                                                                                                                                    - -

                                                                                                                                    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.
                                                                                                                                    • -
                                                                                                                                    • publicChatDataAvailable: Runs after data for any of the public chats has been received and processed, -but not yet displayed. Contains both the unprocessed raw AJAX response -and the processed chat data that is going to be used for display.
                                                                                                                                    • -
                                                                                                                                    • 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) - - - - -

                                                                                                                                    - - - -
                                                                                                                                    -
                                                                                                                                    - - -
                                                                                                                                    -

                                                                                                                                    Registers a callback function for a specified hook event.

                                                                                                                                    -
                                                                                                                                    - - - - - - - - - -
                                                                                                                                    -
                                                                                                                                    Parameters:
                                                                                                                                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                    NameTypeDescription
                                                                                                                                    event - - -string - - - -

                                                                                                                                    The name of the hook event.

                                                                                                                                    callback - - -function - - - -

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

                                                                                                                                    - -
                                                                                                                                    - - - - - - - - - - - - - - - - - -
                                                                                                                                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                    - - - - -
                                                                                                                                    - - - - -
                                                                                                                                    - -

                                                                                                                                    - - inner addHook(event, callback) - - - - -

                                                                                                                                    - - - -
                                                                                                                                    -
                                                                                                                                    - - -
                                                                                                                                    -

                                                                                                                                    Registers a callback function for a specified hook event.

                                                                                                                                    -
                                                                                                                                    - - - - - - - - - -
                                                                                                                                    -
                                                                                                                                    Parameters:
                                                                                                                                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                    NameTypeDescription
                                                                                                                                    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) - - - - -

                                                                                                                                    - - - -
                                                                                                                                    -
                                                                                                                                    - - -
                                                                                                                                    -

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

                                                                                                                                    -
                                                                                                                                    - - - - - - - - - -
                                                                                                                                    -
                                                                                                                                    Parameters:
                                                                                                                                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                    NameTypeDescription
                                                                                                                                    event - - -string - - - -

                                                                                                                                    The name of the hook event.

                                                                                                                                    callback - - -function - - - -

                                                                                                                                    The callback function to be removed.

                                                                                                                                    - -
                                                                                                                                    - - - - - - - - - - - - - - - - - -
                                                                                                                                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                    - - - - -
                                                                                                                                    - - - - -
                                                                                                                                    - -

                                                                                                                                    - - inner removeHook(event, callback) - - - - -

                                                                                                                                    - - - -
                                                                                                                                    -
                                                                                                                                    - - -
                                                                                                                                    -

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

                                                                                                                                    -
                                                                                                                                    - - - - - - - - - -
                                                                                                                                    -
                                                                                                                                    Parameters:
                                                                                                                                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                    NameTypeDescription
                                                                                                                                    event - - -string - - - -

                                                                                                                                    The name of the hook event.

                                                                                                                                    callback - - -function - - - -

                                                                                                                                    The callback function to be removed.

                                                                                                                                    - -
                                                                                                                                    - - - - - - - - - - - - - - - - - -
                                                                                                                                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                    - - - - -
                                                                                                                                    - - - - -
                                                                                                                                    - -

                                                                                                                                    - - inner runHooks(event, dataopt) → {boolean} - - - - -

                                                                                                                                    - - - -
                                                                                                                                    -
                                                                                                                                    - - -
                                                                                                                                    -

                                                                                                                                    Executes all callbacks associated with a given hook event.

                                                                                                                                    -
                                                                                                                                    - - - - - - - - - -
                                                                                                                                    -
                                                                                                                                    Parameters:
                                                                                                                                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                    NameTypeAttributesDescription
                                                                                                                                    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.

                                                                                                                                    - - - - - -
                                                                                                                                    - - - - - -
                                                                                                                                    - - - - - - - - - - - - - - - - - - - - diff --git a/module-idle.html b/module-idle.html index 9d45e92c2..a4e54cad0 100644 --- a/module-idle.html +++ b/module-idle.html @@ -34,7 +34,7 @@

                                                                                                                                    IITC-CE

                                                                                                                                      - +
                                                                                                                                      @@ -52,8 +52,6 @@

                                                                                                                                      idle

                                                                                                                                      - - @@ -119,77 +117,6 @@

                                                                                                                                      idle

                                                                                                                                      - - - - - - - - - - -
                                                                                                                                      - - - - -
                                                                                                                                      - - - - -
                                                                                                                                      - -
                                                                                                                                      -
                                                                                                                                      - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                      - - - - - - - - - - - - - - - - - - - - @@ -288,85 +215,6 @@
                                                                                                                                      Type:
                                                                                                                                      - - - - - - - - - - -
                                                                                                                                      - - - - - -
                                                                                                                                      - - - - -
                                                                                                                                      -

                                                                                                                                      - inner idleTime :number - - - -

                                                                                                                                      - - -
                                                                                                                                      -
                                                                                                                                      - -
                                                                                                                                      -

                                                                                                                                      Total time of user inactivity in seconds.

                                                                                                                                      -
                                                                                                                                      - - - - - - - -
                                                                                                                                      - - - - - - - - - - - - - - - - - - - - @@ -535,14 +383,14 @@
                                                                                                                                      Parameters:
                                                                                                                                      -

                                                                                                                                      +

                                                                                                                                      - inner addResumeFunction(f) + inner idleReset()

                                                                                                                                      @@ -554,7 +402,7 @@

                                                                                                                                      -

                                                                                                                                      Registers a function to be called when the user resumes from being idle.

                                                                                                                                      +

                                                                                                                                      Resets the idle timer. This function is called when the user becomes active after being idle.

                                                                                                                                      @@ -565,56 +413,6 @@

                                                                                                                                      -
                                                                                                                                      -
                                                                                                                                      Parameters:
                                                                                                                                      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                      NameTypeDescription
                                                                                                                                      f - - -function - - - -

                                                                                                                                      The function to be executed on resume.

                                                                                                                                      - -
                                                                                                                                      - @@ -674,14 +472,14 @@

                                                                                                                                      Parameters:
                                                                                                                                      -

                                                                                                                                      +

                                                                                                                                      - inner idleReset() + inner idleSet()

                                                                                                                                      @@ -693,7 +491,7 @@

                                                                                                                                      -

                                                                                                                                      Resets the idle timer. This function is called when the user becomes active after being idle.

                                                                                                                                      +

                                                                                                                                      Sets the idle state immediately, regardless of the actual idle time.

                                                                                                                                      @@ -763,14 +561,14 @@

                                                                                                                                      -

                                                                                                                                      +

                                                                                                                                      - inner idleReset() + inner isIdle() → {boolean}

                                                                                                                                      @@ -782,7 +580,7 @@

                                                                                                                                      -

                                                                                                                                      Resets the idle timer. This function is called when the user becomes active after being idle.

                                                                                                                                      +

                                                                                                                                      Checks if the user is currently idle.

                                                                                                                                      @@ -805,1891 +603,30 @@

                                                                                                                                      +
                                                                                                                                      +
                                                                                                                                      Returns:
                                                                                                                                      + + - - - -
                                                                                                                                      - - - - - - - - - - +boolean - - - - - +-

                                                                                                                                      True if the user is idle, false otherwise.

                                                                                                                                      - - - - -
                                                                                                                                      - - - - -

                                                                                                                                      - - - - -
                                                                                                                                      - -

                                                                                                                                      - - inner idleSet() - - - - -

                                                                                                                                      - - - -
                                                                                                                                      -
                                                                                                                                      - - -
                                                                                                                                      -

                                                                                                                                      Sets the idle state immediately, regardless of the actual idle time.

                                                                                                                                      -
                                                                                                                                      - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                      - - - - -
                                                                                                                                      - - - - -
                                                                                                                                      - -

                                                                                                                                      - - inner idleSet() - - - - -

                                                                                                                                      - - - -
                                                                                                                                      -
                                                                                                                                      - - -
                                                                                                                                      -

                                                                                                                                      Sets the idle state immediately, regardless of the actual idle time.

                                                                                                                                      -
                                                                                                                                      - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                      - - - - -
                                                                                                                                      - - - - -
                                                                                                                                      - -

                                                                                                                                      - - inner isIdle() → {boolean} - - - - -

                                                                                                                                      - - - -
                                                                                                                                      -
                                                                                                                                      - - -
                                                                                                                                      -

                                                                                                                                      Checks if the user is currently idle.

                                                                                                                                      -
                                                                                                                                      - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                      -
                                                                                                                                      Returns:
                                                                                                                                      - - - - - -boolean - - - - - --

                                                                                                                                      True if the user is idle, false otherwise.

                                                                                                                                      - - - - - -
                                                                                                                                      - - - - - -
                                                                                                                                      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                      - - - - -
                                                                                                                                      - - - - -
                                                                                                                                      - -

                                                                                                                                      - - inner isIdle() → {boolean} - - - - -

                                                                                                                                      - - - -
                                                                                                                                      -
                                                                                                                                      - - -
                                                                                                                                      -

                                                                                                                                      Checks if the user is currently idle.

                                                                                                                                      -
                                                                                                                                      - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                      -
                                                                                                                                      Returns:
                                                                                                                                      - - - - - -boolean - - - - - --

                                                                                                                                      True if the user is idle, false otherwise.

                                                                                                                                      - - - - - -
                                                                                                                                      - - - - - -
                                                                                                                                      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                      - - - - -
                                                                                                                                      - - - - -
                                                                                                                                      - -

                                                                                                                                      - - inner setupIdle() - - - - -

                                                                                                                                      - - - -
                                                                                                                                      -
                                                                                                                                      - - -
                                                                                                                                      -

                                                                                                                                      Initializes the idle handling setup, attaching necessary event listeners.

                                                                                                                                      -
                                                                                                                                      - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                      - - - - -
                                                                                                                                      - - - - -
                                                                                                                                      - -

                                                                                                                                      - - inner setupIdle() - - - - -

                                                                                                                                      - - - -
                                                                                                                                      -
                                                                                                                                      - - -
                                                                                                                                      -

                                                                                                                                      Initializes the idle handling setup, attaching necessary event listeners.

                                                                                                                                      -
                                                                                                                                      - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                      - - - - -
                                                                                                                                      - -
                                                                                                                                      - - - - - -
                                                                                                                                      - -
                                                                                                                                      - - - - - - - -
                                                                                                                                      - -
                                                                                                                                      - -

                                                                                                                                      idle

                                                                                                                                      - - - - - - -
                                                                                                                                      - -
                                                                                                                                      - -
                                                                                                                                      - - -

                                                                                                                                      Contains functions and logic to handle the idle state of the user.

                                                                                                                                      - - - - - -
                                                                                                                                      - -
                                                                                                                                      -
                                                                                                                                      - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                      - - - - -
                                                                                                                                      - - - - -
                                                                                                                                      - -
                                                                                                                                      -
                                                                                                                                      - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                      - - - - -
                                                                                                                                      - - - -
                                                                                                                                      - - - - - - - - - - - - - - - -

                                                                                                                                      Members

                                                                                                                                      - -
                                                                                                                                      - - -
                                                                                                                                      -

                                                                                                                                      - inner idleTime :number - - - -

                                                                                                                                      - - -
                                                                                                                                      -
                                                                                                                                      - -
                                                                                                                                      -

                                                                                                                                      Total time of user inactivity in seconds.

                                                                                                                                      -
                                                                                                                                      - - - - - - - -
                                                                                                                                      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                      - - - - - -
                                                                                                                                      - - - - -
                                                                                                                                      -

                                                                                                                                      - inner idleTime :number - - - -

                                                                                                                                      - - -
                                                                                                                                      -
                                                                                                                                      - -
                                                                                                                                      -

                                                                                                                                      Total time of user inactivity in seconds.

                                                                                                                                      -
                                                                                                                                      - - - - - - - -
                                                                                                                                      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                      - - - - - -
                                                                                                                                      - -
                                                                                                                                      - - - -

                                                                                                                                      Methods

                                                                                                                                      - -
                                                                                                                                      - - -
                                                                                                                                      - -

                                                                                                                                      - - inner addResumeFunction(f) - - - - -

                                                                                                                                      - - - -
                                                                                                                                      -
                                                                                                                                      - - -
                                                                                                                                      -

                                                                                                                                      Registers a function to be called when the user resumes from being idle.

                                                                                                                                      -
                                                                                                                                      - - - - - - - - - -
                                                                                                                                      -
                                                                                                                                      Parameters:
                                                                                                                                      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                      NameTypeDescription
                                                                                                                                      f - - -function - - - -

                                                                                                                                      The function to be executed on resume.

                                                                                                                                      - -
                                                                                                                                      - - - - - - - - - - - - - - - - - -
                                                                                                                                      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                      - - - - -
                                                                                                                                      - - - - -
                                                                                                                                      - -

                                                                                                                                      - - inner addResumeFunction(f) - - - - -

                                                                                                                                      - - - -
                                                                                                                                      -
                                                                                                                                      - - -
                                                                                                                                      -

                                                                                                                                      Registers a function to be called when the user resumes from being idle.

                                                                                                                                      -
                                                                                                                                      - - - - - - - - - -
                                                                                                                                      -
                                                                                                                                      Parameters:
                                                                                                                                      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                      NameTypeDescription
                                                                                                                                      f - - -function - - - -

                                                                                                                                      The function to be executed on resume.

                                                                                                                                      - -
                                                                                                                                      - - - - - - - - - - - - - - - - - -
                                                                                                                                      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                      - - - - -
                                                                                                                                      - - - - -
                                                                                                                                      - -

                                                                                                                                      - - inner idleReset() - - - - -

                                                                                                                                      - - - -
                                                                                                                                      -
                                                                                                                                      - - -
                                                                                                                                      -

                                                                                                                                      Resets the idle timer. This function is called when the user becomes active after being idle.

                                                                                                                                      -
                                                                                                                                      - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                      - - - - -
                                                                                                                                      - - - - -
                                                                                                                                      - -

                                                                                                                                      - - inner idleReset() - - - - -

                                                                                                                                      - - - -
                                                                                                                                      -
                                                                                                                                      - - -
                                                                                                                                      -

                                                                                                                                      Resets the idle timer. This function is called when the user becomes active after being idle.

                                                                                                                                      -
                                                                                                                                      - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                      - - - - -
                                                                                                                                      - - - - -
                                                                                                                                      - -

                                                                                                                                      - - inner idleSet() - - - - -

                                                                                                                                      - - - -
                                                                                                                                      -
                                                                                                                                      - - -
                                                                                                                                      -

                                                                                                                                      Sets the idle state immediately, regardless of the actual idle time.

                                                                                                                                      -
                                                                                                                                      - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                      - - - - -
                                                                                                                                      - - - - -
                                                                                                                                      - -

                                                                                                                                      - - inner idleSet() - - - - -

                                                                                                                                      - - - -
                                                                                                                                      -
                                                                                                                                      - - -
                                                                                                                                      -

                                                                                                                                      Sets the idle state immediately, regardless of the actual idle time.

                                                                                                                                      -
                                                                                                                                      - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                      - - - - -
                                                                                                                                      - - - - -
                                                                                                                                      - -

                                                                                                                                      - - inner isIdle() → {boolean} - - - - -

                                                                                                                                      - - - -
                                                                                                                                      -
                                                                                                                                      - - -
                                                                                                                                      -

                                                                                                                                      Checks if the user is currently idle.

                                                                                                                                      -
                                                                                                                                      - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                      -
                                                                                                                                      Returns:
                                                                                                                                      - - - - - -boolean - - - - - --

                                                                                                                                      True if the user is idle, false otherwise.

                                                                                                                                      - - - - - -
                                                                                                                                      - - - - - -
                                                                                                                                      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                      - - - - -
                                                                                                                                      - - - - -
                                                                                                                                      - -

                                                                                                                                      - - inner isIdle() → {boolean} - - - - -

                                                                                                                                      - - - -
                                                                                                                                      -
                                                                                                                                      - - -
                                                                                                                                      -

                                                                                                                                      Checks if the user is currently idle.

                                                                                                                                      -
                                                                                                                                      - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                      -
                                                                                                                                      Returns:
                                                                                                                                      - - - - - -boolean - - - - - --

                                                                                                                                      True if the user is idle, false otherwise.

                                                                                                                                      - - - - - -
                                                                                                                                      - - - - - -
                                                                                                                                      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                      - - - - -
                                                                                                                                      - - - - -
                                                                                                                                      - -

                                                                                                                                      - - inner setupIdle() - - - -

                                                                                                                                      - - - -
                                                                                                                                      -
                                                                                                                                      - - -
                                                                                                                                      -

                                                                                                                                      Initializes the idle handling setup, attaching necessary event listeners.

                                                                                                                                      - - - - - - - - - - - - - - - - - - - -
                                                                                                                                      diff --git a/module-map.html b/module-map.html index 3102598b7..5ee716da1 100644 --- a/module-map.html +++ b/module-map.html @@ -34,7 +34,7 @@

                                                                                                                                      IITC-CE

                                                                                                                                        - +
                                                                                                                                        @@ -52,8 +52,6 @@

                                                                                                                                        map

                                                                                                                                        - - @@ -119,77 +117,6 @@

                                                                                                                                        map

                                                                                                                                        - - - - - - - - - - -
                                                                                                                                        - - - - -
                                                                                                                                        - - - - -
                                                                                                                                        - -
                                                                                                                                        -
                                                                                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                        - - - - - - - - - - - - - - - - - - - - @@ -347,14 +274,14 @@
                                                                                                                                        Returns:
                                                                                                                                        -

                                                                                                                                        +

                                                                                                                                        - inner createDefaultBaseMapLayers() → {Object.<String, Object>} + inner createDefaultOverlays() → {Object.<String, L.LayerGroup>}

                                                                                                                                        @@ -366,9 +293,8 @@

                                                                                                                                        -

                                                                                                                                        Initializes and returns a collection of default basemap layers. The function creates a set of base layers -including CartoDB (both dark and light themes), and various Google Maps layers (Default Ingress Map, Roads, -Roads with Traffic, Satellite, Hybrid, and Terrain).

                                                                                                                                        +

                                                                                                                                        Creates and returns the default overlay layers for the map. +Sets up various overlay layers including portals, links, fields, and faction-specific layers.

                                                                                                                                        @@ -398,14 +324,13 @@

                                                                                                                                        Returns:
                                                                                                                                        -Object.<String, Object> +Object.<String, L.LayerGroup> --

                                                                                                                                        An object containing different basemap layers ready to be added to a map. Each property of the -object is a named map layer, with its value being the corresponding Leaflet tile layer object.

                                                                                                                                        +-

                                                                                                                                        An object containing overlay layers for portals, links, fields, and factions

                                                                                                                                        @@ -460,14 +385,14 @@
                                                                                                                                        Returns:
                                                                                                                                        -

                                                                                                                                        +

                                                                                                                                        - inner createDefaultOverlays() → {Object.<String, L.LayerGroup>} + inner getPosition() → {Object}

                                                                                                                                        @@ -479,8 +404,8 @@

                                                                                                                                        -

                                                                                                                                        Creates and returns the default overlay layers for the map. -Sets up various overlay layers including portals, links, fields, and faction-specific layers.

                                                                                                                                        +

                                                                                                                                        Retrieves the last known map position from the URL parameters or cookies. +Prioritizes URL parameters over cookies. Extracts and normalizes the latitude, longitude, and zoom level.

                                                                                                                                        @@ -510,13 +435,13 @@

                                                                                                                                        Returns:
                                                                                                                                        -Object.<String, L.LayerGroup> +Object --

                                                                                                                                        An object containing overlay layers for portals, links, fields, and factions

                                                                                                                                        +-

                                                                                                                                        An object containing the map's position and zoom level, or undefined if not found.

                                                                                                                                        @@ -571,14 +496,14 @@
                                                                                                                                        Returns:
                                                                                                                                        -

                                                                                                                                        +

                                                                                                                                        - inner createDefaultOverlays() → {Object.<String, L.LayerGroup>} + inner normLL(lat, lng, zoom) → {Object}

                                                                                                                                        @@ -590,8 +515,8 @@

                                                                                                                                        -

                                                                                                                                        Creates and returns the default overlay layers for the map. -Sets up various overlay layers including portals, links, fields, and faction-specific layers.

                                                                                                                                        +

                                                                                                                                        Normalizes latitude, longitude, and zoom values. Ensures that the values are valid numbers, providing +defaults if necessary.

                                                                                                                                        @@ -602,116 +527,110 @@

                                                                                                                                        - - - - - - - - - - - - -
                                                                                                                                        -
                                                                                                                                        Returns:
                                                                                                                                        +
                                                                                                                                        +
                                                                                                                                        Parameters:
                                                                                                                                        + + + + + + - - - - -Object.<String, L.LayerGroup> - - - + --

                                                                                                                                        An object containing overlay layers for portals, links, fields, and factions

                                                                                                                                        + + + + + + + + + + - - - + - + - + - + + - + + + + - + - + - + - + + - - + + + + + -
                                                                                                                                        - -

                                                                                                                                        - - inner getPosition() → {Object} - - - -

                                                                                                                                        - - - -
                                                                                                                                        -
                                                                                                                                        - -
                                                                                                                                        -

                                                                                                                                        Retrieves the last known map position from the URL parameters or cookies. -Prioritizes URL parameters over cookies. Extracts and normalizes the latitude, longitude, and zoom level.

                                                                                                                                        -
                                                                                                                                        - - - + - +
                                                                                                                                        + + +
                                                                                                                                        NameTypeDescription
                                                                                                                                        lat + + +number +| +string -
                                                                                                                                        - + +

                                                                                                                                        Latitude value or string that can be converted to a number.

                                                                                                                                        lng + + +number +| - +string - - + +

                                                                                                                                        Longitude value or string that can be converted to a number.

                                                                                                                                        zoom + + +number +| - +string - - +

                                                                                                                                        Zoom level value or string that can be converted to a number.

                                                                                                                                        +
                                                                                                                                        @@ -738,7 +657,7 @@
                                                                                                                                        Returns:
                                                                                                                                        --

                                                                                                                                        An object containing the map's position and zoom level, or undefined if not found.

                                                                                                                                        +-

                                                                                                                                        An object containing normalized center (latitude and longitude) and zoom level.

                                                                                                                                        @@ -771,2155 +690,6 @@
                                                                                                                                        Returns:
                                                                                                                                        - - - - - - - - - - -

                                                                                                                                        - - - - -
                                                                                                                                        - - - - -
                                                                                                                                        - -

                                                                                                                                        - - inner getPosition() → {Object} - - - - -

                                                                                                                                        - - - -
                                                                                                                                        -
                                                                                                                                        - - -
                                                                                                                                        -

                                                                                                                                        Retrieves the last known map position from the URL parameters or cookies. -Prioritizes URL parameters over cookies. Extracts and normalizes the latitude, longitude, and zoom level.

                                                                                                                                        -
                                                                                                                                        - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                        -
                                                                                                                                        Returns:
                                                                                                                                        - - - - - -Object - - - - - --

                                                                                                                                        An object containing the map's position and zoom level, or undefined if not found.

                                                                                                                                        - - - - - -
                                                                                                                                        - - - - - -
                                                                                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                        - - - - -
                                                                                                                                        - - - - -
                                                                                                                                        - -

                                                                                                                                        - - inner normLL(lat, lng, zoom) → {Object} - - - - -

                                                                                                                                        - - - -
                                                                                                                                        -
                                                                                                                                        - - -
                                                                                                                                        -

                                                                                                                                        Normalizes latitude, longitude, and zoom values. Ensures that the values are valid numbers, providing -defaults if necessary.

                                                                                                                                        -
                                                                                                                                        - - - - - - - - - -
                                                                                                                                        -
                                                                                                                                        Parameters:
                                                                                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                        NameTypeDescription
                                                                                                                                        lat - - -number -| - -string - - - -

                                                                                                                                        Latitude value or string that can be converted to a number.

                                                                                                                                        lng - - -number -| - -string - - - -

                                                                                                                                        Longitude value or string that can be converted to a number.

                                                                                                                                        zoom - - -number -| - -string - - - -

                                                                                                                                        Zoom level value or string that can be converted to a number.

                                                                                                                                        - -
                                                                                                                                        - - - - - - - - - - - - - -
                                                                                                                                        -
                                                                                                                                        Returns:
                                                                                                                                        - - - - - -Object - - - - - --

                                                                                                                                        An object containing normalized center (latitude and longitude) and zoom level.

                                                                                                                                        - - - - - -
                                                                                                                                        - - - - - -
                                                                                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                        - - - - -
                                                                                                                                        - - - - -
                                                                                                                                        - -

                                                                                                                                        - - inner normLL(lat, lng, zoom) → {Object} - - - - -

                                                                                                                                        - - - -
                                                                                                                                        -
                                                                                                                                        - - -
                                                                                                                                        -

                                                                                                                                        Normalizes latitude, longitude, and zoom values. Ensures that the values are valid numbers, providing -defaults if necessary.

                                                                                                                                        -
                                                                                                                                        - - - - - - - - - -
                                                                                                                                        -
                                                                                                                                        Parameters:
                                                                                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                        NameTypeDescription
                                                                                                                                        lat - - -number -| - -string - - - -

                                                                                                                                        Latitude value or string that can be converted to a number.

                                                                                                                                        lng - - -number -| - -string - - - -

                                                                                                                                        Longitude value or string that can be converted to a number.

                                                                                                                                        zoom - - -number -| - -string - - - -

                                                                                                                                        Zoom level value or string that can be converted to a number.

                                                                                                                                        - -
                                                                                                                                        - - - - - - - - - - - - - -
                                                                                                                                        -
                                                                                                                                        Returns:
                                                                                                                                        - - - - - -Object - - - - - --

                                                                                                                                        An object containing normalized center (latitude and longitude) and zoom level.

                                                                                                                                        - - - - - -
                                                                                                                                        - - - - - -
                                                                                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                        - - - - -
                                                                                                                                        - - - - -
                                                                                                                                        - -

                                                                                                                                        - - inner setupMap() - - - - -

                                                                                                                                        - - - -
                                                                                                                                        -
                                                                                                                                        - - -
                                                                                                                                        -

                                                                                                                                        Initializes the Leaflet map and configures various map layers and event listeners. -This function is responsible for setting up the base map, -including the default basemap tiles (CartoDB, Default Ingress Map, Google Maps), -and configuring the map's properties such as center, zoom, bounds, and renderer options. -It also clears the 'Loading, please wait' message from the map container.

                                                                                                                                        -

                                                                                                                                        Important functionalities:

                                                                                                                                        -
                                                                                                                                          -
                                                                                                                                        • Adds dummy divs to Leaflet control areas to accommodate IITC UI elements.
                                                                                                                                        • -
                                                                                                                                        • Creates and adds base layers and overlays to the map.
                                                                                                                                        • -
                                                                                                                                        • Configures event listeners for map movements, including aborting pending requests and refreshing map data.
                                                                                                                                        • -
                                                                                                                                        • Manages cookies for map position and zoom level.
                                                                                                                                        • -
                                                                                                                                        • Handles the 'iitcLoaded' hook to set the initial map view and evaluate URL parameters for portal selection.
                                                                                                                                        • -
                                                                                                                                        -
                                                                                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                        - - - - -
                                                                                                                                        - - - - -
                                                                                                                                        - -

                                                                                                                                        - - inner setupMap() - - - - -

                                                                                                                                        - - - -
                                                                                                                                        -
                                                                                                                                        - - -
                                                                                                                                        -

                                                                                                                                        Initializes the Leaflet map and configures various map layers and event listeners. -This function is responsible for setting up the base map, -including the default basemap tiles (CartoDB, Default Ingress Map, Google Maps), -and configuring the map's properties such as center, zoom, bounds, and renderer options. -It also clears the 'Loading, please wait' message from the map container.

                                                                                                                                        -

                                                                                                                                        Important functionalities:

                                                                                                                                        -
                                                                                                                                          -
                                                                                                                                        • Adds dummy divs to Leaflet control areas to accommodate IITC UI elements.
                                                                                                                                        • -
                                                                                                                                        • Creates and adds base layers and overlays to the map.
                                                                                                                                        • -
                                                                                                                                        • Configures event listeners for map movements, including aborting pending requests and refreshing map data.
                                                                                                                                        • -
                                                                                                                                        • Manages cookies for map position and zoom level.
                                                                                                                                        • -
                                                                                                                                        • Handles the 'iitcLoaded' hook to set the initial map view and evaluate URL parameters for portal selection.
                                                                                                                                        • -
                                                                                                                                        -
                                                                                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                        - - - - -
                                                                                                                                        - -
                                                                                                                                        - - - - - -
                                                                                                                                        - -
                                                                                                                                        - - - - - - - -
                                                                                                                                        - -
                                                                                                                                        - -

                                                                                                                                        map

                                                                                                                                        - - - - - - -
                                                                                                                                        - -
                                                                                                                                        - -
                                                                                                                                        - - -

                                                                                                                                        This file provides functions for working with maps.

                                                                                                                                        - - - - - -
                                                                                                                                        - -
                                                                                                                                        -
                                                                                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                        - - - - -
                                                                                                                                        - - - - -
                                                                                                                                        - -
                                                                                                                                        -
                                                                                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                        - - - - -
                                                                                                                                        - - - -
                                                                                                                                        - - - - - - - - - - - - - - - - - -

                                                                                                                                        Methods

                                                                                                                                        - -
                                                                                                                                        - - -
                                                                                                                                        - -

                                                                                                                                        - - inner createDefaultBaseMapLayers() → {Object.<String, Object>} - - - - -

                                                                                                                                        - - - -
                                                                                                                                        -
                                                                                                                                        - - -
                                                                                                                                        -

                                                                                                                                        Initializes and returns a collection of default basemap layers. The function creates a set of base layers -including CartoDB (both dark and light themes), and various Google Maps layers (Default Ingress Map, Roads, -Roads with Traffic, Satellite, Hybrid, and Terrain).

                                                                                                                                        -
                                                                                                                                        - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                        -
                                                                                                                                        Returns:
                                                                                                                                        - - - - - -Object.<String, Object> - - - - - --

                                                                                                                                        An object containing different basemap layers ready to be added to a map. Each property of the -object is a named map layer, with its value being the corresponding Leaflet tile layer object.

                                                                                                                                        - - - - - -
                                                                                                                                        - - - - - -
                                                                                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                        - - - - -
                                                                                                                                        - - - - -
                                                                                                                                        - -

                                                                                                                                        - - inner createDefaultBaseMapLayers() → {Object.<String, Object>} - - - - -

                                                                                                                                        - - - -
                                                                                                                                        -
                                                                                                                                        - - -
                                                                                                                                        -

                                                                                                                                        Initializes and returns a collection of default basemap layers. The function creates a set of base layers -including CartoDB (both dark and light themes), and various Google Maps layers (Default Ingress Map, Roads, -Roads with Traffic, Satellite, Hybrid, and Terrain).

                                                                                                                                        -
                                                                                                                                        - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                        -
                                                                                                                                        Returns:
                                                                                                                                        - - - - - -Object.<String, Object> - - - - - --

                                                                                                                                        An object containing different basemap layers ready to be added to a map. Each property of the -object is a named map layer, with its value being the corresponding Leaflet tile layer object.

                                                                                                                                        - - - - - -
                                                                                                                                        - - - - - -
                                                                                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                        - - - - -
                                                                                                                                        - - - - -
                                                                                                                                        - -

                                                                                                                                        - - inner createDefaultOverlays() → {Object.<String, L.LayerGroup>} - - - - -

                                                                                                                                        - - - -
                                                                                                                                        -
                                                                                                                                        - - -
                                                                                                                                        -

                                                                                                                                        Creates and returns the default overlay layers for the map. -Sets up various overlay layers including portals, links, fields, and faction-specific layers.

                                                                                                                                        -
                                                                                                                                        - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                        -
                                                                                                                                        Returns:
                                                                                                                                        - - - - - -Object.<String, L.LayerGroup> - - - - - --

                                                                                                                                        An object containing overlay layers for portals, links, fields, and factions

                                                                                                                                        - - - - - -
                                                                                                                                        - - - - - -
                                                                                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                        - - - - -
                                                                                                                                        - - - - -
                                                                                                                                        - -

                                                                                                                                        - - inner createDefaultOverlays() → {Object.<String, L.LayerGroup>} - - - - -

                                                                                                                                        - - - -
                                                                                                                                        -
                                                                                                                                        - - -
                                                                                                                                        -

                                                                                                                                        Creates and returns the default overlay layers for the map. -Sets up various overlay layers including portals, links, fields, and faction-specific layers.

                                                                                                                                        -
                                                                                                                                        - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                        -
                                                                                                                                        Returns:
                                                                                                                                        - - - - - -Object.<String, L.LayerGroup> - - - - - --

                                                                                                                                        An object containing overlay layers for portals, links, fields, and factions

                                                                                                                                        - - - - - -
                                                                                                                                        - - - - - -
                                                                                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                        - - - - -
                                                                                                                                        - - - - -
                                                                                                                                        - -

                                                                                                                                        - - inner getPosition() → {Object} - - - - -

                                                                                                                                        - - - -
                                                                                                                                        -
                                                                                                                                        - - -
                                                                                                                                        -

                                                                                                                                        Retrieves the last known map position from the URL parameters or cookies. -Prioritizes URL parameters over cookies. Extracts and normalizes the latitude, longitude, and zoom level.

                                                                                                                                        -
                                                                                                                                        - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                        -
                                                                                                                                        Returns:
                                                                                                                                        - - - - - -Object - - - - - --

                                                                                                                                        An object containing the map's position and zoom level, or undefined if not found.

                                                                                                                                        - - - - - -
                                                                                                                                        - - - - - -
                                                                                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                        - - - - -
                                                                                                                                        - - - - -
                                                                                                                                        - -

                                                                                                                                        - - inner getPosition() → {Object} - - - - -

                                                                                                                                        - - - -
                                                                                                                                        -
                                                                                                                                        - - -
                                                                                                                                        -

                                                                                                                                        Retrieves the last known map position from the URL parameters or cookies. -Prioritizes URL parameters over cookies. Extracts and normalizes the latitude, longitude, and zoom level.

                                                                                                                                        -
                                                                                                                                        - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                        -
                                                                                                                                        Returns:
                                                                                                                                        - - - - - -Object - - - - - --

                                                                                                                                        An object containing the map's position and zoom level, or undefined if not found.

                                                                                                                                        - - - - - -
                                                                                                                                        - - - - - -
                                                                                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                        - - - - -
                                                                                                                                        - - - - -
                                                                                                                                        - -

                                                                                                                                        - - inner normLL(lat, lng, zoom) → {Object} - - - - -

                                                                                                                                        - - - -
                                                                                                                                        -
                                                                                                                                        - - -
                                                                                                                                        -

                                                                                                                                        Normalizes latitude, longitude, and zoom values. Ensures that the values are valid numbers, providing -defaults if necessary.

                                                                                                                                        -
                                                                                                                                        - - - - - - - - - -
                                                                                                                                        -
                                                                                                                                        Parameters:
                                                                                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                        NameTypeDescription
                                                                                                                                        lat - - -number -| - -string - - - -

                                                                                                                                        Latitude value or string that can be converted to a number.

                                                                                                                                        lng - - -number -| - -string - - - -

                                                                                                                                        Longitude value or string that can be converted to a number.

                                                                                                                                        zoom - - -number -| - -string - - - -

                                                                                                                                        Zoom level value or string that can be converted to a number.

                                                                                                                                        - -
                                                                                                                                        - - - - - - - - - - - - - -
                                                                                                                                        -
                                                                                                                                        Returns:
                                                                                                                                        - - - - - -Object - - - - - --

                                                                                                                                        An object containing normalized center (latitude and longitude) and zoom level.

                                                                                                                                        - - - - - -
                                                                                                                                        - - - - - -
                                                                                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                        - - - - -
                                                                                                                                        - - - - -
                                                                                                                                        - -

                                                                                                                                        - - inner normLL(lat, lng, zoom) → {Object} - - - - -

                                                                                                                                        - - - -
                                                                                                                                        -
                                                                                                                                        - - -
                                                                                                                                        -

                                                                                                                                        Normalizes latitude, longitude, and zoom values. Ensures that the values are valid numbers, providing -defaults if necessary.

                                                                                                                                        -
                                                                                                                                        - - - - - - - - - -
                                                                                                                                        -
                                                                                                                                        Parameters:
                                                                                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                        NameTypeDescription
                                                                                                                                        lat - - -number -| - -string - - - -

                                                                                                                                        Latitude value or string that can be converted to a number.

                                                                                                                                        lng - - -number -| - -string - - - -

                                                                                                                                        Longitude value or string that can be converted to a number.

                                                                                                                                        zoom - - -number -| - -string - - - -

                                                                                                                                        Zoom level value or string that can be converted to a number.

                                                                                                                                        - -
                                                                                                                                        - - - - - - - - - - - - - -
                                                                                                                                        -
                                                                                                                                        Returns:
                                                                                                                                        - - - - - -Object - - - - - --

                                                                                                                                        An object containing normalized center (latitude and longitude) and zoom level.

                                                                                                                                        - - - - - -
                                                                                                                                        - - - - - -
                                                                                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                        - - - - -
                                                                                                                                        - - - - -
                                                                                                                                        - -

                                                                                                                                        - - inner setupMap() - - - - -

                                                                                                                                        - - - -
                                                                                                                                        -
                                                                                                                                        - - -
                                                                                                                                        -

                                                                                                                                        Initializes the Leaflet map and configures various map layers and event listeners. -This function is responsible for setting up the base map, -including the default basemap tiles (CartoDB, Default Ingress Map, Google Maps), -and configuring the map's properties such as center, zoom, bounds, and renderer options. -It also clears the 'Loading, please wait' message from the map container.

                                                                                                                                        -

                                                                                                                                        Important functionalities:

                                                                                                                                        -
                                                                                                                                          -
                                                                                                                                        • Adds dummy divs to Leaflet control areas to accommodate IITC UI elements.
                                                                                                                                        • -
                                                                                                                                        • Creates and adds base layers and overlays to the map.
                                                                                                                                        • -
                                                                                                                                        • Configures event listeners for map movements, including aborting pending requests and refreshing map data.
                                                                                                                                        • -
                                                                                                                                        • Manages cookies for map position and zoom level.
                                                                                                                                        • -
                                                                                                                                        • Handles the 'iitcLoaded' hook to set the initial map view and evaluate URL parameters for portal selection.
                                                                                                                                        • -
                                                                                                                                        -
                                                                                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                        - - - - - - - - - - - - - - - - - - - - diff --git a/module-map_data_calc_tools.html b/module-map_data_calc_tools.html index 4d17ff2cb..a02663ce1 100644 --- a/module-map_data_calc_tools.html +++ b/module-map_data_calc_tools.html @@ -34,7 +34,7 @@

                                                                                                                                        IITC-CE

                                                                                                                                          - +
                                                                                                                                          @@ -52,8 +52,6 @@

                                                                                                                                          map_data_calc_tools

                                                                                                                                          - - @@ -125,77 +123,6 @@

                                                                                                                                          map_data_calc_tools

                                                                                                                                          - - - - - - - - - - -
                                                                                                                                          - - - - -
                                                                                                                                          - - - - -
                                                                                                                                          - -
                                                                                                                                          -
                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                          - - - - - - - - - - - - - - - - - - - - @@ -379,167 +306,6 @@
                                                                                                                                          Returns:
                                                                                                                                          - - - - - - - - - - -
                                                                                                                                          - - - - -
                                                                                                                                          - - - - -
                                                                                                                                          - -

                                                                                                                                          - - inner getDataZoomForMapZoom(zoom) → {number} - - - - -

                                                                                                                                          - - - -
                                                                                                                                          -
                                                                                                                                          - - -
                                                                                                                                          -

                                                                                                                                          Determines the data zoom level for a given map zoom level. This function adjusts the zoom level for -data requests based on various factors to optimize caching performance and server load.

                                                                                                                                          -
                                                                                                                                          - - - - - - - - - -
                                                                                                                                          -
                                                                                                                                          Parameters:
                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                          NameTypeDescription
                                                                                                                                          zoom - - -number - - - -

                                                                                                                                          The current map zoom level.

                                                                                                                                          - -
                                                                                                                                          - - - - - - - - - - - - - -
                                                                                                                                          -
                                                                                                                                          Returns:
                                                                                                                                          - - - - - -number - - - - - --

                                                                                                                                          The adjusted zoom level for data requests.

                                                                                                                                          - - - - - -
                                                                                                                                          - - - - - -
                                                                                                                                          - - - - - - - - - - - - - - - - - - - - @@ -701,1288 +467,6 @@
                                                                                                                                          Returns:
                                                                                                                                          - - - - - - - - - - -
                                                                                                                                          - - - - -
                                                                                                                                          - - - - -
                                                                                                                                          - -

                                                                                                                                          - - inner getMapZoomTileParameters(zoom) → {Object} - - - - -

                                                                                                                                          - - - -
                                                                                                                                          -
                                                                                                                                          - - -
                                                                                                                                          -

                                                                                                                                          Gets the map zoom tile parameters for a specific zoom level. It calculates the tile level, number of tiles per edge, -minimum link length, and whether portals are available at the specified zoom level.

                                                                                                                                          -
                                                                                                                                          - - - - - - - - - -
                                                                                                                                          -
                                                                                                                                          Parameters:
                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                          NameTypeDescription
                                                                                                                                          zoom - - -number - - - -

                                                                                                                                          The map zoom level.

                                                                                                                                          - -
                                                                                                                                          - - - - - - - - - - - - - -
                                                                                                                                          -
                                                                                                                                          Returns:
                                                                                                                                          - - - - - -Object - - - - - --

                                                                                                                                          An object containing tile parameters for the given zoom level.

                                                                                                                                          - - - - - -
                                                                                                                                          - - - - - -
                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                          - - - - -
                                                                                                                                          - - - - -
                                                                                                                                          - -

                                                                                                                                          - - inner setupDataTileParams() - - - - -

                                                                                                                                          - - - -
                                                                                                                                          -
                                                                                                                                          - - -
                                                                                                                                          -

                                                                                                                                          Sets up the data tile parameters used for map data requests. This function initializes the TILE_PARAMS -global object with default values or values detected from the stock Intel map.

                                                                                                                                          -
                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                          - - - - -
                                                                                                                                          - - - - -
                                                                                                                                          - -

                                                                                                                                          - - inner setupDataTileParams() - - - - -

                                                                                                                                          - - - -
                                                                                                                                          -
                                                                                                                                          - - -
                                                                                                                                          -

                                                                                                                                          Sets up the data tile parameters used for map data requests. This function initializes the TILE_PARAMS -global object with default values or values detected from the stock Intel map.

                                                                                                                                          -
                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                          - - - - -
                                                                                                                                          - -
                                                                                                                                          - - - - - -
                                                                                                                                          - -
                                                                                                                                          - - - - - - - -
                                                                                                                                          - -
                                                                                                                                          - -

                                                                                                                                          map_data_calc_tools

                                                                                                                                          - - - - - - -
                                                                                                                                          - -
                                                                                                                                          - -
                                                                                                                                          - - -

                                                                                                                                          Contains functions for calculating map data request parameters and converting between lat/lng and map tiles. -Ingress Intel splits up requests for map data (portals, links, fields) into tiles. -To get data for the current viewport (i.e. what is currently visible) it first calculates which tiles intersect. -For all those tiles, it then calculates the lat/lng bounds of that tile and a quadkey. -Both the bounds and the quadkey are “somewhat” required to get complete data. -Conversion functions courtesy of -wiki.openstreetmap.org/wiki/Slippy_map_tilenames

                                                                                                                                          - - - - - -
                                                                                                                                          - -
                                                                                                                                          -
                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                          - - - - -
                                                                                                                                          - - - - -
                                                                                                                                          - -
                                                                                                                                          -
                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                          - - - - -
                                                                                                                                          - - - -
                                                                                                                                          - - - - - - - - - - - - - - - - - -

                                                                                                                                          Methods

                                                                                                                                          - -
                                                                                                                                          - - -
                                                                                                                                          - -

                                                                                                                                          - - inner getDataZoomForMapZoom(zoom) → {number} - - - - -

                                                                                                                                          - - - -
                                                                                                                                          -
                                                                                                                                          - - -
                                                                                                                                          -

                                                                                                                                          Determines the data zoom level for a given map zoom level. This function adjusts the zoom level for -data requests based on various factors to optimize caching performance and server load.

                                                                                                                                          -
                                                                                                                                          - - - - - - - - - -
                                                                                                                                          -
                                                                                                                                          Parameters:
                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                          NameTypeDescription
                                                                                                                                          zoom - - -number - - - -

                                                                                                                                          The current map zoom level.

                                                                                                                                          - -
                                                                                                                                          - - - - - - - - - - - - - -
                                                                                                                                          -
                                                                                                                                          Returns:
                                                                                                                                          - - - - - -number - - - - - --

                                                                                                                                          The adjusted zoom level for data requests.

                                                                                                                                          - - - - - -
                                                                                                                                          - - - - - -
                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                          - - - - -
                                                                                                                                          - - - - -
                                                                                                                                          - -

                                                                                                                                          - - inner getDataZoomForMapZoom(zoom) → {number} - - - - -

                                                                                                                                          - - - -
                                                                                                                                          -
                                                                                                                                          - - -
                                                                                                                                          -

                                                                                                                                          Determines the data zoom level for a given map zoom level. This function adjusts the zoom level for -data requests based on various factors to optimize caching performance and server load.

                                                                                                                                          -
                                                                                                                                          - - - - - - - - - -
                                                                                                                                          -
                                                                                                                                          Parameters:
                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                          NameTypeDescription
                                                                                                                                          zoom - - -number - - - -

                                                                                                                                          The current map zoom level.

                                                                                                                                          - -
                                                                                                                                          - - - - - - - - - - - - - -
                                                                                                                                          -
                                                                                                                                          Returns:
                                                                                                                                          - - - - - -number - - - - - --

                                                                                                                                          The adjusted zoom level for data requests.

                                                                                                                                          - - - - - -
                                                                                                                                          - - - - - -
                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                          - - - - -
                                                                                                                                          - - - - -
                                                                                                                                          - -

                                                                                                                                          - - inner getMapZoomTileParameters(zoom) → {Object} - - - - -

                                                                                                                                          - - - -
                                                                                                                                          -
                                                                                                                                          - - -
                                                                                                                                          -

                                                                                                                                          Gets the map zoom tile parameters for a specific zoom level. It calculates the tile level, number of tiles per edge, -minimum link length, and whether portals are available at the specified zoom level.

                                                                                                                                          -
                                                                                                                                          - - - - - - - - - -
                                                                                                                                          -
                                                                                                                                          Parameters:
                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                          NameTypeDescription
                                                                                                                                          zoom - - -number - - - -

                                                                                                                                          The map zoom level.

                                                                                                                                          - -
                                                                                                                                          - - - - - - - - - - - - - -
                                                                                                                                          -
                                                                                                                                          Returns:
                                                                                                                                          - - - - - -Object - - - - - --

                                                                                                                                          An object containing tile parameters for the given zoom level.

                                                                                                                                          - - - - - -
                                                                                                                                          - - - - - -
                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                          - - - - -
                                                                                                                                          - - - - -
                                                                                                                                          - -

                                                                                                                                          - - inner getMapZoomTileParameters(zoom) → {Object} - - - - -

                                                                                                                                          - - - -
                                                                                                                                          -
                                                                                                                                          - - -
                                                                                                                                          -

                                                                                                                                          Gets the map zoom tile parameters for a specific zoom level. It calculates the tile level, number of tiles per edge, -minimum link length, and whether portals are available at the specified zoom level.

                                                                                                                                          -
                                                                                                                                          - - - - - - - - - -
                                                                                                                                          -
                                                                                                                                          Parameters:
                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                          NameTypeDescription
                                                                                                                                          zoom - - -number - - - -

                                                                                                                                          The map zoom level.

                                                                                                                                          - -
                                                                                                                                          - - - - - - - - - - - - - -
                                                                                                                                          -
                                                                                                                                          Returns:
                                                                                                                                          - - - - - -Object - - - - - --

                                                                                                                                          An object containing tile parameters for the given zoom level.

                                                                                                                                          - - - - - -
                                                                                                                                          - - - - - -
                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                          - - - - -
                                                                                                                                          - - - - -
                                                                                                                                          - -

                                                                                                                                          - - inner setupDataTileParams() - - - - -

                                                                                                                                          - - - -
                                                                                                                                          -
                                                                                                                                          - - -
                                                                                                                                          -

                                                                                                                                          Sets up the data tile parameters used for map data requests. This function initializes the TILE_PARAMS -global object with default values or values detected from the stock Intel map.

                                                                                                                                          -
                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                          - - - - - - - - - - - - - - - - - - - - diff --git a/module-panes.html b/module-panes.html index df0c2afb4..7b30228f5 100644 --- a/module-panes.html +++ b/module-panes.html @@ -34,7 +34,7 @@

                                                                                                                                          IITC-CE

                                                                                                                                            - +
                                                                                                                                            @@ -52,8 +52,6 @@

                                                                                                                                            panes

                                                                                                                                            - - @@ -119,77 +117,6 @@

                                                                                                                                            panes

                                                                                                                                            - - - - - - - - - - -
                                                                                                                                            - - - - -
                                                                                                                                            - - - - -
                                                                                                                                            - -
                                                                                                                                            -
                                                                                                                                            - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                            - - - - - - - - - - - - - - - - - - - - @@ -288,85 +215,6 @@
                                                                                                                                            Type:
                                                                                                                                            - - - - - - - - - - -
                                                                                                                                            - - - - - -
                                                                                                                                            - - - - -
                                                                                                                                            -

                                                                                                                                            - inner currentPane :string - - - -

                                                                                                                                            - - -
                                                                                                                                            -
                                                                                                                                            - -
                                                                                                                                            -

                                                                                                                                            Tracks the currently active pane.

                                                                                                                                            -
                                                                                                                                            - - - - - - - -
                                                                                                                                            - - - - - - - - - - - - - - - - - - - - @@ -463,1053 +311,6 @@

                                                                                                                                            - - - - - - - - - - -

                                                                                                                                            - - - - -
                                                                                                                                            - - - - -
                                                                                                                                            - -

                                                                                                                                            - - inner hideall() - - - - -

                                                                                                                                            - - - -
                                                                                                                                            -
                                                                                                                                            - - -
                                                                                                                                            -

                                                                                                                                            Hides all panes and related elements.

                                                                                                                                            -
                                                                                                                                            - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                            - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                            - - - - -
                                                                                                                                            - - - - -
                                                                                                                                            - -

                                                                                                                                            - - inner show(id) - - - - -

                                                                                                                                            - - - -
                                                                                                                                            -
                                                                                                                                            - - -
                                                                                                                                            -

                                                                                                                                            Shows a specified pane and hides others.

                                                                                                                                            -
                                                                                                                                            - - - - - - - - - -
                                                                                                                                            -
                                                                                                                                            Parameters:
                                                                                                                                            - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                            NameTypeDescription
                                                                                                                                            id - - -string - - - -

                                                                                                                                            The ID of the pane to show.

                                                                                                                                            - -
                                                                                                                                            - - - - - - - - - - - - - - - - - -
                                                                                                                                            - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                            - - - - -
                                                                                                                                            - - - - -
                                                                                                                                            - -

                                                                                                                                            - - inner show(id) - - - - -

                                                                                                                                            - - - -
                                                                                                                                            -
                                                                                                                                            - - -
                                                                                                                                            -

                                                                                                                                            Shows a specified pane and hides others.

                                                                                                                                            -
                                                                                                                                            - - - - - - - - - -
                                                                                                                                            -
                                                                                                                                            Parameters:
                                                                                                                                            - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                            NameTypeDescription
                                                                                                                                            id - - -string - - - -

                                                                                                                                            The ID of the pane to show.

                                                                                                                                            - -
                                                                                                                                            - - - - - - - - - - - - - - - - - -
                                                                                                                                            - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                            - - - - -
                                                                                                                                            - -
                                                                                                                                            - - - - - -
                                                                                                                                            - -
                                                                                                                                            - - - - - - - -
                                                                                                                                            - -
                                                                                                                                            - -

                                                                                                                                            panes

                                                                                                                                            - - - - - - -
                                                                                                                                            - -
                                                                                                                                            - -
                                                                                                                                            - - -

                                                                                                                                            Manages the display of different panes of the IITC interface.

                                                                                                                                            - - - - - -
                                                                                                                                            - -
                                                                                                                                            -
                                                                                                                                            - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                            - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                            - - - - -
                                                                                                                                            - - - - -
                                                                                                                                            - -
                                                                                                                                            -
                                                                                                                                            - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                            - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                            - - - - -
                                                                                                                                            - - - -
                                                                                                                                            - - - - - - - - - - - - - - - -

                                                                                                                                            Members

                                                                                                                                            - -
                                                                                                                                            - - -
                                                                                                                                            -

                                                                                                                                            - inner currentPane :string - - - -

                                                                                                                                            - - -
                                                                                                                                            -
                                                                                                                                            - -
                                                                                                                                            -

                                                                                                                                            Tracks the currently active pane.

                                                                                                                                            -
                                                                                                                                            - - - - - - - -
                                                                                                                                            - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                            - - - - - -
                                                                                                                                            - - - - -
                                                                                                                                            -

                                                                                                                                            - inner currentPane :string - - - -

                                                                                                                                            - - -
                                                                                                                                            -
                                                                                                                                            - -
                                                                                                                                            -

                                                                                                                                            Tracks the currently active pane.

                                                                                                                                            -
                                                                                                                                            - - - - - - - -
                                                                                                                                            - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                            - - - - - -
                                                                                                                                            - -
                                                                                                                                            - - - -

                                                                                                                                            Methods

                                                                                                                                            - -
                                                                                                                                            - - -
                                                                                                                                            - -

                                                                                                                                            - - inner hideall() - - - - -

                                                                                                                                            - - - -
                                                                                                                                            -
                                                                                                                                            - - -
                                                                                                                                            -

                                                                                                                                            Hides all panes and related elements.

                                                                                                                                            -
                                                                                                                                            - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                            - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                            - - - - -
                                                                                                                                            - - - - -
                                                                                                                                            - -

                                                                                                                                            - - inner hideall() - - - - -

                                                                                                                                            - - - -
                                                                                                                                            -
                                                                                                                                            - - -
                                                                                                                                            -

                                                                                                                                            Hides all panes and related elements.

                                                                                                                                            -
                                                                                                                                            - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                            - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                            - - - - -
                                                                                                                                            - - - - -
                                                                                                                                            - -

                                                                                                                                            - - inner show(id) - - - - -

                                                                                                                                            - - - -
                                                                                                                                            -
                                                                                                                                            - - -
                                                                                                                                            -

                                                                                                                                            Shows a specified pane and hides others.

                                                                                                                                            -
                                                                                                                                            - - - - - - - - - -
                                                                                                                                            -
                                                                                                                                            Parameters:
                                                                                                                                            - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                            NameTypeDescription
                                                                                                                                            id - - -string - - - -

                                                                                                                                            The ID of the pane to show.

                                                                                                                                            - -
                                                                                                                                            - - - - - - - - - - - - - - - - - -
                                                                                                                                            - - - - - - - - - - - - - - - - - - - - diff --git a/module-player_names.html b/module-player_names.html index 950a09807..573e4d124 100644 --- a/module-player_names.html +++ b/module-player_names.html @@ -34,7 +34,7 @@

                                                                                                                                            IITC-CE

                                                                                                                                              - +
                                                                                                                                              @@ -52,531 +52,6 @@

                                                                                                                                              player_names

                                                                                                                                              - - - - - -
                                                                                                                                              - -
                                                                                                                                              - - -

                                                                                                                                              Manages player names and provides functions to check if a player is a special system account.

                                                                                                                                              - - - - - -
                                                                                                                                              - -
                                                                                                                                              -
                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                              - - - - -
                                                                                                                                              - - - - -
                                                                                                                                              - -
                                                                                                                                              -
                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                              - - - - -
                                                                                                                                              - - - -
                                                                                                                                              - - - - - - - - - - - - - - - - - -

                                                                                                                                              Methods

                                                                                                                                              - -
                                                                                                                                              - - -
                                                                                                                                              - -

                                                                                                                                              - - inner isSystemPlayer(name) → {boolean} - - - - -

                                                                                                                                              - - - -
                                                                                                                                              -
                                                                                                                                              - - -
                                                                                                                                              -

                                                                                                                                              Checks if a player name is a special system account (e.g., __JARVIS__, __ADA__) -that shouldn't be listed as a regular player.

                                                                                                                                              -
                                                                                                                                              - - - - - - - - - -
                                                                                                                                              -
                                                                                                                                              Parameters:
                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                              NameTypeDescription
                                                                                                                                              name - - -string - - - -

                                                                                                                                              The player name to check.

                                                                                                                                              - -
                                                                                                                                              - - - - - - - - - - - - - -
                                                                                                                                              -
                                                                                                                                              Returns:
                                                                                                                                              - - - - - -boolean - - - - - --

                                                                                                                                              Returns true if the player name is a system account, otherwise false.

                                                                                                                                              - - - - - -
                                                                                                                                              - - - - - -
                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                              - - - - -
                                                                                                                                              - - - - -
                                                                                                                                              - -

                                                                                                                                              - - inner isSystemPlayer(name) → {boolean} - - - - -

                                                                                                                                              - - - -
                                                                                                                                              -
                                                                                                                                              - - -
                                                                                                                                              -

                                                                                                                                              Checks if a player name is a special system account (e.g., __JARVIS__, __ADA__) -that shouldn't be listed as a regular player.

                                                                                                                                              -
                                                                                                                                              - - - - - - - - - -
                                                                                                                                              -
                                                                                                                                              Parameters:
                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                              NameTypeDescription
                                                                                                                                              name - - -string - - - -

                                                                                                                                              The player name to check.

                                                                                                                                              - -
                                                                                                                                              - - - - - - - - - - - - - -
                                                                                                                                              -
                                                                                                                                              Returns:
                                                                                                                                              - - - - - -boolean - - - - - --

                                                                                                                                              Returns true if the player name is a system account, otherwise false.

                                                                                                                                              - - - - - -
                                                                                                                                              - - - - - -
                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                              - - - - -
                                                                                                                                              - -
                                                                                                                                              - - - - - -
                                                                                                                                              - -
                                                                                                                                              - - - - - - - -
                                                                                                                                              - -
                                                                                                                                              - -

                                                                                                                                              player_names

                                                                                                                                              - - - - -
                                                                                                                                              @@ -642,77 +117,6 @@

                                                                                                                                              player_names

                                                                                                                                              - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                              - -
                                                                                                                                              -
                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                              - - - - - - - - - - - - - - - - - - - - @@ -896,167 +300,6 @@
                                                                                                                                              Returns:
                                                                                                                                              - - - - - - - - - - -
                                                                                                                                              - - - - -
                                                                                                                                              - - - - -
                                                                                                                                              - -

                                                                                                                                              - - inner isSystemPlayer(name) → {boolean} - - - - -

                                                                                                                                              - - - -
                                                                                                                                              -
                                                                                                                                              - - -
                                                                                                                                              -

                                                                                                                                              Checks if a player name is a special system account (e.g., __JARVIS__, __ADA__) -that shouldn't be listed as a regular player.

                                                                                                                                              -
                                                                                                                                              - - - - - - - - - -
                                                                                                                                              -
                                                                                                                                              Parameters:
                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                              NameTypeDescription
                                                                                                                                              name - - -string - - - -

                                                                                                                                              The player name to check.

                                                                                                                                              - -
                                                                                                                                              - - - - - - - - - - - - - -
                                                                                                                                              -
                                                                                                                                              Returns:
                                                                                                                                              - - - - - -boolean - - - - - --

                                                                                                                                              Returns true if the player name is a system account, otherwise false.

                                                                                                                                              - - - - - -
                                                                                                                                              - - - - - -
                                                                                                                                              - - - - - - - - - - - - - - - - - - - - diff --git a/module-portal_data.html b/module-portal_data.html index f0e35943a..db92ecad4 100644 --- a/module-portal_data.html +++ b/module-portal_data.html @@ -34,7 +34,7 @@

                                                                                                                                              IITC-CE

                                                                                                                                                - +
                                                                                                                                                @@ -52,8 +52,6 @@

                                                                                                                                                portal_data

                                                                                                                                                - - @@ -119,77 +117,6 @@

                                                                                                                                                portal_data

                                                                                                                                                - - - - - - - - - - -
                                                                                                                                                - - - - -
                                                                                                                                                - - - - -
                                                                                                                                                - -
                                                                                                                                                -
                                                                                                                                                - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                - - - - - - - - - - - - - - - - - - - - @@ -421,14 +348,14 @@
                                                                                                                                                Returns:
                                                                                                                                                -

                                                                                                                                                +

                                                                                                                                                - inner findPortalGuidByPositionE6(latE6, lngE6) → {string|null} + inner getPortalFields(guid) → {Array}

                                                                                                                                                @@ -440,8 +367,7 @@

                                                                                                                                                -

                                                                                                                                                Finds a portal GUID by its position. Searches through currently rendered portals, fields, and links. -If the portal is not found in the current render, it checks a cache of recently seen portals.

                                                                                                                                                +

                                                                                                                                                Searches through the fields for all fields that reference a specified portal.

                                                                                                                                                @@ -477,36 +403,13 @@

                                                                                                                                                Parameters:
                                                                                                                                                - latE6 - - - - - -number - - - - - - - - - -

                                                                                                                                                The latitude in E6 format.

                                                                                                                                                - - - - - - - lngE6 + guid -number +string @@ -516,7 +419,7 @@
                                                                                                                                                Parameters:
                                                                                                                                                -

                                                                                                                                                The longitude in E6 format.

                                                                                                                                                +

                                                                                                                                                The GUID of the portal to search for fields.

                                                                                                                                                @@ -544,16 +447,13 @@
                                                                                                                                                Returns:
                                                                                                                                                -string -| - -null +Array --

                                                                                                                                                The GUID of the portal at the specified location, or null if not found.

                                                                                                                                                +-

                                                                                                                                                An array containing the GUIDs of fields associated with the portal.

                                                                                                                                                @@ -608,14 +508,14 @@
                                                                                                                                                Returns:
                                                                                                                                                -

                                                                                                                                                +

                                                                                                                                                - inner getPortalFields(guid) → {Array} + inner getPortalFieldsCount(guid) → {number}

                                                                                                                                                @@ -627,7 +527,7 @@

                                                                                                                                                -

                                                                                                                                                Searches through the fields for all fields that reference a specified portal.

                                                                                                                                                +

                                                                                                                                                Counts the total number of fields associated with a specified portal.

                                                                                                                                                @@ -679,7 +579,7 @@

                                                                                                                                                Parameters:
                                                                                                                                                -

                                                                                                                                                The GUID of the portal to search for fields.

                                                                                                                                                +

                                                                                                                                                The GUID of the portal.

                                                                                                                                                @@ -707,13 +607,13 @@
                                                                                                                                                Returns:
                                                                                                                                                -Array +number --

                                                                                                                                                An array containing the GUIDs of fields associated with the portal.

                                                                                                                                                +-

                                                                                                                                                The total number of fields associated with the portal.

                                                                                                                                                @@ -768,14 +668,14 @@
                                                                                                                                                Returns:
                                                                                                                                                -

                                                                                                                                                +

                                                                                                                                                @@ -787,7 +687,8 @@

                                                                                                                                                -

                                                                                                                                                Searches through the fields for all fields that reference a specified portal.

                                                                                                                                                +

                                                                                                                                                Search through the links data for all that link from and to a portal. Returns an object with separate lists of in +and out links. May or may not be as accurate as the portal details, depending on how much data the API returns.

                                                                                                                                                @@ -839,7 +740,7 @@

                                                                                                                                                Parameters:
                                                                                                                                                -

                                                                                                                                                The GUID of the portal to search for fields.

                                                                                                                                                +

                                                                                                                                                The GUID of the portal to search for links.

                                                                                                                                                @@ -867,13 +768,13 @@
                                                                                                                                                Returns:
                                                                                                                                                -Array +Object --

                                                                                                                                                An array containing the GUIDs of fields associated with the portal.

                                                                                                                                                +-

                                                                                                                                                An object containing arrays of incoming ('in') and outgoing ('out') link GUIDs.

                                                                                                                                                @@ -928,14 +829,14 @@
                                                                                                                                                Returns:
                                                                                                                                                -

                                                                                                                                                +

                                                                                                                                                - inner getPortalFieldsCount(guid) → {number} + inner getPortalLinksCount(guid) → {number}

                                                                                                                                                @@ -947,7 +848,7 @@

                                                                                                                                                -

                                                                                                                                                Counts the total number of fields associated with a specified portal.

                                                                                                                                                +

                                                                                                                                                Counts the total number of links (both incoming and outgoing) for a specified portal.

                                                                                                                                                @@ -1033,3231 +934,17 @@

                                                                                                                                                Returns:
                                                                                                                                                --

                                                                                                                                                The total number of fields associated with the portal.

                                                                                                                                                - - - - - - - - - - - -
                                                                                                                                                - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                - +-

                                                                                                                                                The total number of links for the portal.

                                                                                                                                                - -
                                                                                                                                                - - -
                                                                                                                                                - -

                                                                                                                                                - inner getPortalFieldsCount(guid) → {number} - - - - -

                                                                                                                                                - - - -
                                                                                                                                                -
                                                                                                                                                - - -
                                                                                                                                                -

                                                                                                                                                Counts the total number of fields associated with a specified portal.

                                                                                                                                                - - - - - -
                                                                                                                                                -
                                                                                                                                                Parameters:
                                                                                                                                                - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                NameTypeDescription
                                                                                                                                                guid - - -string - - - -

                                                                                                                                                The GUID of the portal.

                                                                                                                                                - -
                                                                                                                                                - - - - - - - - - - - - - -
                                                                                                                                                -
                                                                                                                                                Returns:
                                                                                                                                                - - - - - -number - - - - - --

                                                                                                                                                The total number of fields associated with the portal.

                                                                                                                                                - - - - - -
                                                                                                                                                - - - - - -
                                                                                                                                                - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                - - - - -
                                                                                                                                                - - - - -
                                                                                                                                                - - - - - -
                                                                                                                                                -
                                                                                                                                                - - -
                                                                                                                                                -

                                                                                                                                                Search through the links data for all that link from and to a portal. Returns an object with separate lists of in -and out links. May or may not be as accurate as the portal details, depending on how much data the API returns.

                                                                                                                                                -
                                                                                                                                                - - - - - - - - - -
                                                                                                                                                -
                                                                                                                                                Parameters:
                                                                                                                                                - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                NameTypeDescription
                                                                                                                                                guid - - -string - - - -

                                                                                                                                                The GUID of the portal to search for links.

                                                                                                                                                - -
                                                                                                                                                - - - - - - - - - - - - - -
                                                                                                                                                -
                                                                                                                                                Returns:
                                                                                                                                                - - - - - -Object - - - - - --

                                                                                                                                                An object containing arrays of incoming ('in') and outgoing ('out') link GUIDs.

                                                                                                                                                - - - - - -
                                                                                                                                                - - - - - -
                                                                                                                                                - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                - - - - -
                                                                                                                                                - - - - -
                                                                                                                                                - - - - - -
                                                                                                                                                -
                                                                                                                                                - - -
                                                                                                                                                -

                                                                                                                                                Search through the links data for all that link from and to a portal. Returns an object with separate lists of in -and out links. May or may not be as accurate as the portal details, depending on how much data the API returns.

                                                                                                                                                -
                                                                                                                                                - - - - - - - - - -
                                                                                                                                                -
                                                                                                                                                Parameters:
                                                                                                                                                - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                NameTypeDescription
                                                                                                                                                guid - - -string - - - -

                                                                                                                                                The GUID of the portal to search for links.

                                                                                                                                                - -
                                                                                                                                                - - - - - - - - - - - - - -
                                                                                                                                                -
                                                                                                                                                Returns:
                                                                                                                                                - - - - - -Object - - - - - --

                                                                                                                                                An object containing arrays of incoming ('in') and outgoing ('out') link GUIDs.

                                                                                                                                                - - - - - -
                                                                                                                                                - - - - - -
                                                                                                                                                - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                - - - - -
                                                                                                                                                - - - - -
                                                                                                                                                - -

                                                                                                                                                - - inner getPortalLinksCount(guid) → {number} - - - - -

                                                                                                                                                - - - -
                                                                                                                                                -
                                                                                                                                                - - -
                                                                                                                                                -

                                                                                                                                                Counts the total number of links (both incoming and outgoing) for a specified portal.

                                                                                                                                                -
                                                                                                                                                - - - - - - - - - -
                                                                                                                                                -
                                                                                                                                                Parameters:
                                                                                                                                                - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                NameTypeDescription
                                                                                                                                                guid - - -string - - - -

                                                                                                                                                The GUID of the portal.

                                                                                                                                                - -
                                                                                                                                                - - - - - - - - - - - - - -
                                                                                                                                                -
                                                                                                                                                Returns:
                                                                                                                                                - - - - - -number - - - - - --

                                                                                                                                                The total number of links for the portal.

                                                                                                                                                - - - - - -
                                                                                                                                                - - - - - -
                                                                                                                                                - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                - - - - -
                                                                                                                                                - - - - -
                                                                                                                                                - -

                                                                                                                                                - - inner getPortalLinksCount(guid) → {number} - - - - -

                                                                                                                                                - - - -
                                                                                                                                                -
                                                                                                                                                - - -
                                                                                                                                                -

                                                                                                                                                Counts the total number of links (both incoming and outgoing) for a specified portal.

                                                                                                                                                -
                                                                                                                                                - - - - - - - - - -
                                                                                                                                                -
                                                                                                                                                Parameters:
                                                                                                                                                - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                NameTypeDescription
                                                                                                                                                guid - - -string - - - -

                                                                                                                                                The GUID of the portal.

                                                                                                                                                - -
                                                                                                                                                - - - - - - - - - - - - - -
                                                                                                                                                -
                                                                                                                                                Returns:
                                                                                                                                                - - - - - -number - - - - - --

                                                                                                                                                The total number of links for the portal.

                                                                                                                                                - - - - - -
                                                                                                                                                - - - - - -
                                                                                                                                                - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                - - - - -
                                                                                                                                                - - - - -
                                                                                                                                                - -

                                                                                                                                                - - inner pushPortalGuidPositionCache(guid, latE6, lngE6) - - - - -

                                                                                                                                                - - - -
                                                                                                                                                -
                                                                                                                                                - - -
                                                                                                                                                -

                                                                                                                                                Pushes a portal GUID and its position into a cache.

                                                                                                                                                -
                                                                                                                                                - - - - - - - - - -
                                                                                                                                                -
                                                                                                                                                Parameters:
                                                                                                                                                - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                NameTypeDescription
                                                                                                                                                guid - - -string - - - -

                                                                                                                                                The GUID of the portal.

                                                                                                                                                latE6 - - -number - - - -

                                                                                                                                                The latitude in E6 format.

                                                                                                                                                lngE6 - - -number - - - -

                                                                                                                                                The longitude in E6 format.

                                                                                                                                                - -
                                                                                                                                                - - - - - - - - - - - - - - - - - -
                                                                                                                                                - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                - - - - -
                                                                                                                                                - - - - -
                                                                                                                                                - -

                                                                                                                                                - - inner pushPortalGuidPositionCache(guid, latE6, lngE6) - - - - -

                                                                                                                                                - - - -
                                                                                                                                                -
                                                                                                                                                - - -
                                                                                                                                                -

                                                                                                                                                Pushes a portal GUID and its position into a cache.

                                                                                                                                                -
                                                                                                                                                - - - - - - - - - -
                                                                                                                                                -
                                                                                                                                                Parameters:
                                                                                                                                                - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                NameTypeDescription
                                                                                                                                                guid - - -string - - - -

                                                                                                                                                The GUID of the portal.

                                                                                                                                                latE6 - - -number - - - -

                                                                                                                                                The latitude in E6 format.

                                                                                                                                                lngE6 - - -number - - - -

                                                                                                                                                The longitude in E6 format.

                                                                                                                                                - -
                                                                                                                                                - - - - - - - - - - - - - - - - - -
                                                                                                                                                - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                - - - - -
                                                                                                                                                - - - - - - - - - -
                                                                                                                                                - - - - - - - -
                                                                                                                                                - -
                                                                                                                                                - -

                                                                                                                                                portal_data

                                                                                                                                                - - - - - - -
                                                                                                                                                - -
                                                                                                                                                - -
                                                                                                                                                - - -

                                                                                                                                                Contain misc functions to get portal info

                                                                                                                                                - - - - - -
                                                                                                                                                - -
                                                                                                                                                -
                                                                                                                                                - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                - - - - -
                                                                                                                                                - - - - -
                                                                                                                                                - -
                                                                                                                                                -
                                                                                                                                                - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                - - - - -
                                                                                                                                                - - - -
                                                                                                                                                - - - - - - - - - - - - - - - - - -

                                                                                                                                                Methods

                                                                                                                                                - -
                                                                                                                                                - - -
                                                                                                                                                - -

                                                                                                                                                - - inner findPortalGuidByPositionE6(latE6, lngE6) → {string|null} - - - - -

                                                                                                                                                - - - -
                                                                                                                                                -
                                                                                                                                                - - -
                                                                                                                                                -

                                                                                                                                                Finds a portal GUID by its position. Searches through currently rendered portals, fields, and links. -If the portal is not found in the current render, it checks a cache of recently seen portals.

                                                                                                                                                -
                                                                                                                                                - - - - - - - - - -
                                                                                                                                                -
                                                                                                                                                Parameters:
                                                                                                                                                - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                NameTypeDescription
                                                                                                                                                latE6 - - -number - - - -

                                                                                                                                                The latitude in E6 format.

                                                                                                                                                lngE6 - - -number - - - -

                                                                                                                                                The longitude in E6 format.

                                                                                                                                                - -
                                                                                                                                                - - - - - - - - - - - - - -
                                                                                                                                                -
                                                                                                                                                Returns:
                                                                                                                                                - - - - - -string -| - -null - - - - - --

                                                                                                                                                The GUID of the portal at the specified location, or null if not found.

                                                                                                                                                - - - - - -
                                                                                                                                                - - - - - -
                                                                                                                                                - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                - - - - -
                                                                                                                                                - - - - -
                                                                                                                                                - -

                                                                                                                                                - - inner findPortalGuidByPositionE6(latE6, lngE6) → {string|null} - - - - -

                                                                                                                                                - - - -
                                                                                                                                                -
                                                                                                                                                - - -
                                                                                                                                                -

                                                                                                                                                Finds a portal GUID by its position. Searches through currently rendered portals, fields, and links. -If the portal is not found in the current render, it checks a cache of recently seen portals.

                                                                                                                                                -
                                                                                                                                                - - - - - - - - - -
                                                                                                                                                -
                                                                                                                                                Parameters:
                                                                                                                                                - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                NameTypeDescription
                                                                                                                                                latE6 - - -number - - - -

                                                                                                                                                The latitude in E6 format.

                                                                                                                                                lngE6 - - -number - - - -

                                                                                                                                                The longitude in E6 format.

                                                                                                                                                - -
                                                                                                                                                - - - - - - - - - - - - - -
                                                                                                                                                -
                                                                                                                                                Returns:
                                                                                                                                                - - - - - -string -| - -null - - - - - --

                                                                                                                                                The GUID of the portal at the specified location, or null if not found.

                                                                                                                                                - - - - - -
                                                                                                                                                - - - - - -
                                                                                                                                                - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                - - - - -
                                                                                                                                                - - - - -
                                                                                                                                                - -

                                                                                                                                                - - inner getPortalFields(guid) → {Array} - - - - -

                                                                                                                                                - - - -
                                                                                                                                                -
                                                                                                                                                - - -
                                                                                                                                                -

                                                                                                                                                Searches through the fields for all fields that reference a specified portal.

                                                                                                                                                -
                                                                                                                                                - - - - - - - - - -
                                                                                                                                                -
                                                                                                                                                Parameters:
                                                                                                                                                - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                NameTypeDescription
                                                                                                                                                guid - - -string - - - -

                                                                                                                                                The GUID of the portal to search for fields.

                                                                                                                                                - -
                                                                                                                                                - - - - - - - - - - - - - -
                                                                                                                                                -
                                                                                                                                                Returns:
                                                                                                                                                - - - - - -Array - - - - - --

                                                                                                                                                An array containing the GUIDs of fields associated with the portal.

                                                                                                                                                - - - - - -
                                                                                                                                                - - - - - -
                                                                                                                                                - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                - - - - -
                                                                                                                                                - - - - -
                                                                                                                                                - -

                                                                                                                                                - - inner getPortalFields(guid) → {Array} - - - - -

                                                                                                                                                - - - -
                                                                                                                                                -
                                                                                                                                                - - -
                                                                                                                                                -

                                                                                                                                                Searches through the fields for all fields that reference a specified portal.

                                                                                                                                                -
                                                                                                                                                - - - - - - - - - -
                                                                                                                                                -
                                                                                                                                                Parameters:
                                                                                                                                                - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                NameTypeDescription
                                                                                                                                                guid - - -string - - - -

                                                                                                                                                The GUID of the portal to search for fields.

                                                                                                                                                - -
                                                                                                                                                - - - - - - - - - - - - - -
                                                                                                                                                -
                                                                                                                                                Returns:
                                                                                                                                                - - - - - -Array - - - - - --

                                                                                                                                                An array containing the GUIDs of fields associated with the portal.

                                                                                                                                                - - - - - -
                                                                                                                                                - - - - - -
                                                                                                                                                - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                - - - - -
                                                                                                                                                - - - - -
                                                                                                                                                - -

                                                                                                                                                - - inner getPortalFieldsCount(guid) → {number} - - - - -

                                                                                                                                                - - - -
                                                                                                                                                -
                                                                                                                                                - - -
                                                                                                                                                -

                                                                                                                                                Counts the total number of fields associated with a specified portal.

                                                                                                                                                -
                                                                                                                                                - - - - - - - - - -
                                                                                                                                                -
                                                                                                                                                Parameters:
                                                                                                                                                - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                NameTypeDescription
                                                                                                                                                guid - - -string - - - -

                                                                                                                                                The GUID of the portal.

                                                                                                                                                - -
                                                                                                                                                - - - - - - - - - - - - - -
                                                                                                                                                -
                                                                                                                                                Returns:
                                                                                                                                                - - - - - -number - - - - - --

                                                                                                                                                The total number of fields associated with the portal.

                                                                                                                                                - - - - - -
                                                                                                                                                - - - - - -
                                                                                                                                                - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                - - - - -
                                                                                                                                                - - - - -
                                                                                                                                                - -

                                                                                                                                                - - inner getPortalFieldsCount(guid) → {number} - - - - -

                                                                                                                                                - - - -
                                                                                                                                                -
                                                                                                                                                - - -
                                                                                                                                                -

                                                                                                                                                Counts the total number of fields associated with a specified portal.

                                                                                                                                                -
                                                                                                                                                - - - - - - - - - -
                                                                                                                                                -
                                                                                                                                                Parameters:
                                                                                                                                                - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                NameTypeDescription
                                                                                                                                                guid - - -string - - - -

                                                                                                                                                The GUID of the portal.

                                                                                                                                                - -
                                                                                                                                                - - - - - - - - - - - - - -
                                                                                                                                                -
                                                                                                                                                Returns:
                                                                                                                                                - - - - - -number - - - - - --

                                                                                                                                                The total number of fields associated with the portal.

                                                                                                                                                - - - - - -
                                                                                                                                                - - - - - -
                                                                                                                                                - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                - - - - -
                                                                                                                                                - - - - -
                                                                                                                                                - - - - - -
                                                                                                                                                -
                                                                                                                                                - - -
                                                                                                                                                -

                                                                                                                                                Search through the links data for all that link from and to a portal. Returns an object with separate lists of in -and out links. May or may not be as accurate as the portal details, depending on how much data the API returns.

                                                                                                                                                -
                                                                                                                                                - - - - - - - - - -
                                                                                                                                                -
                                                                                                                                                Parameters:
                                                                                                                                                - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                NameTypeDescription
                                                                                                                                                guid - - -string - - - -

                                                                                                                                                The GUID of the portal to search for links.

                                                                                                                                                - -
                                                                                                                                                - - - - - - - - - - - - - -
                                                                                                                                                -
                                                                                                                                                Returns:
                                                                                                                                                - - - - - -Object - - - - - --

                                                                                                                                                An object containing arrays of incoming ('in') and outgoing ('out') link GUIDs.

                                                                                                                                                - - - - - -
                                                                                                                                                - - - - - -
                                                                                                                                                - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                - - - - -
                                                                                                                                                - - - - -
                                                                                                                                                - - - - - -
                                                                                                                                                -
                                                                                                                                                - - -
                                                                                                                                                -

                                                                                                                                                Search through the links data for all that link from and to a portal. Returns an object with separate lists of in -and out links. May or may not be as accurate as the portal details, depending on how much data the API returns.

                                                                                                                                                -
                                                                                                                                                - - - - - - - - - -
                                                                                                                                                -
                                                                                                                                                Parameters:
                                                                                                                                                - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                NameTypeDescription
                                                                                                                                                guid - - -string - - - -

                                                                                                                                                The GUID of the portal to search for links.

                                                                                                                                                - -
                                                                                                                                                - - - - - - - - - - - - - -
                                                                                                                                                -
                                                                                                                                                Returns:
                                                                                                                                                - - - - - -Object - - - - - --

                                                                                                                                                An object containing arrays of incoming ('in') and outgoing ('out') link GUIDs.

                                                                                                                                                - - - - - -
                                                                                                                                                - - - - - -
                                                                                                                                                - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                - - - - -
                                                                                                                                                - - - - -
                                                                                                                                                - -

                                                                                                                                                - - inner getPortalLinksCount(guid) → {number} - - - - -

                                                                                                                                                - - - -
                                                                                                                                                -
                                                                                                                                                - - -
                                                                                                                                                -

                                                                                                                                                Counts the total number of links (both incoming and outgoing) for a specified portal.

                                                                                                                                                -
                                                                                                                                                - - - - - - - - - -
                                                                                                                                                -
                                                                                                                                                Parameters:
                                                                                                                                                - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                NameTypeDescription
                                                                                                                                                guid - - -string - - - -

                                                                                                                                                The GUID of the portal.

                                                                                                                                                - -
                                                                                                                                                - - - - - - - - - - - - - -
                                                                                                                                                -
                                                                                                                                                Returns:
                                                                                                                                                - - - - - -number - - - - - --

                                                                                                                                                The total number of links for the portal.

                                                                                                                                                - - - - - -
                                                                                                                                                - - - - - -
                                                                                                                                                - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                - - - - -
                                                                                                                                                - - - - -
                                                                                                                                                - -

                                                                                                                                                - - inner getPortalLinksCount(guid) → {number} - - - - -

                                                                                                                                                - - - -
                                                                                                                                                -
                                                                                                                                                - - -
                                                                                                                                                -

                                                                                                                                                Counts the total number of links (both incoming and outgoing) for a specified portal.

                                                                                                                                                -
                                                                                                                                                - - - - - - - - - -
                                                                                                                                                -
                                                                                                                                                Parameters:
                                                                                                                                                - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                NameTypeDescription
                                                                                                                                                guid - - -string - - - -

                                                                                                                                                The GUID of the portal.

                                                                                                                                                - -
                                                                                                                                                - - - - - - - - - - - - - -
                                                                                                                                                -
                                                                                                                                                Returns:
                                                                                                                                                - - - - - -number - - - - - --

                                                                                                                                                The total number of links for the portal.

                                                                                                                                                - - - - - -
                                                                                                                                                - - - - - -
                                                                                                                                                - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                - - - - -
                                                                                                                                                - - - - -
                                                                                                                                                - -

                                                                                                                                                - - inner pushPortalGuidPositionCache(guid, latE6, lngE6) - - - - -

                                                                                                                                                - - - -
                                                                                                                                                -
                                                                                                                                                - - -
                                                                                                                                                -

                                                                                                                                                Pushes a portal GUID and its position into a cache.

                                                                                                                                                -
                                                                                                                                                - - - - - - - - - -
                                                                                                                                                -
                                                                                                                                                Parameters:
                                                                                                                                                - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                NameTypeDescription
                                                                                                                                                guid - - -string - - - -

                                                                                                                                                The GUID of the portal.

                                                                                                                                                latE6 - - -number - - - -

                                                                                                                                                The latitude in E6 format.

                                                                                                                                                lngE6 - - -number - - - -

                                                                                                                                                The longitude in E6 format.

                                                                                                                                                - -
                                                                                                                                                - - - - - - - - - - - - - - - -
                                                                                                                                                diff --git a/module-portal_detail_display.html b/module-portal_detail_display.html index e9af5d15b..67be908bd 100644 --- a/module-portal_detail_display.html +++ b/module-portal_detail_display.html @@ -34,7 +34,7 @@

                                                                                                                                                IITC-CE

                                                                                                                                                  - +
                                                                                                                                                  @@ -52,8 +52,6 @@

                                                                                                                                                  portal_detail_display

                                                                                                                                                  - - @@ -120,77 +118,6 @@

                                                                                                                                                  portal_detail_display

                                                                                                                                                  - - - - - - - - - - -
                                                                                                                                                  - - - - -
                                                                                                                                                  - - - - -
                                                                                                                                                  - -
                                                                                                                                                  -
                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - @@ -418,14 +345,14 @@
                                                                                                                                                  Returns:
                                                                                                                                                  -

                                                                                                                                                  +

                                                                                                                                                  - inner getPortalMiscDetails(guid, d) → {string} + inner renderPortalDetails(guid)

                                                                                                                                                  @@ -437,7 +364,7 @@

                                                                                                                                                  -

                                                                                                                                                  Gets miscellaneous details for a specified portal.

                                                                                                                                                  +

                                                                                                                                                  Renders the details of a portal in the sidebar.

                                                                                                                                                  @@ -489,30 +416,7 @@

                                                                                                                                                  Parameters:
                                                                                                                                                  -

                                                                                                                                                  The GUID of the portal.

                                                                                                                                                  - - - - - - - d - - - - - -Object - - - - - - - - - -

                                                                                                                                                  The portal detail object containing various properties of the portal.

                                                                                                                                                  +

                                                                                                                                                  The globally unique identifier of the portal to display details for.

                                                                                                                                                  @@ -533,27 +437,6 @@
                                                                                                                                                  Parameters:
                                                                                                                                                  -
                                                                                                                                                  -
                                                                                                                                                  Returns:
                                                                                                                                                  - - - - - -string - - - - - --

                                                                                                                                                  HTML string representing the miscellaneous details of the portal.

                                                                                                                                                  - - - - - -
                                                                                                                                                  - @@ -601,14 +484,14 @@
                                                                                                                                                  Returns:
                                                                                                                                                  -

                                                                                                                                                  +

                                                                                                                                                  - inner renderPortalDetails(guid) + inner renderPortalUrl(lat, lng, title, guid)

                                                                                                                                                  @@ -620,7 +503,9 @@

                                                                                                                                                  -

                                                                                                                                                  Renders the details of a portal in the sidebar.

                                                                                                                                                  +

                                                                                                                                                  Generates and displays URLs related to the portal. +This includes a permalink for the portal, a link for Ingress Prime, and links to alternative maps. +Function is overwritten in app.js

                                                                                                                                                  @@ -654,6 +539,75 @@

                                                                                                                                                  Parameters:
                                                                                                                                                  + + + lat + + + + + +number + + + + + + + + + +

                                                                                                                                                  The latitude of the portal.

                                                                                                                                                  + + + + + + + lng + + + + + +number + + + + + + + + + +

                                                                                                                                                  The longitude of the portal.

                                                                                                                                                  + + + + + + + title + + + + + +string + + + + + + + + + +

                                                                                                                                                  The title of the portal.

                                                                                                                                                  + + + + guid @@ -672,7 +626,7 @@
                                                                                                                                                  Parameters:
                                                                                                                                                  -

                                                                                                                                                  The globally unique identifier of the portal to display details for.

                                                                                                                                                  +

                                                                                                                                                  The GUID of the portal.

                                                                                                                                                  @@ -740,14 +694,14 @@
                                                                                                                                                  Parameters:
                                                                                                                                                  -

                                                                                                                                                  +

                                                                                                                                                  - inner renderPortalDetails(guid) + inner resetScrollOnNewPortal()

                                                                                                                                                  @@ -759,7 +713,7 @@

                                                                                                                                                  -

                                                                                                                                                  Renders the details of a portal in the sidebar.

                                                                                                                                                  +

                                                                                                                                                  Resets the scroll position of the sidebar when a new portal is selected.

                                                                                                                                                  @@ -770,2881 +724,29 @@

                                                                                                                                                  -
                                                                                                                                                  -
                                                                                                                                                  Parameters:
                                                                                                                                                  - - - - - - - - + - + - + - - - + - - - - - + - +
                                                                                                                                                  - + - + -
                                                                                                                                                  - - - - -
                                                                                                                                                  NameTypeDescription
                                                                                                                                                  guid - - -string + - -

                                                                                                                                                  The globally unique identifier of the portal to display details for.

                                                                                                                                                  - -
                                                                                                                                                  - - - - - - - - - - - - - - - - - -
                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                  - - - - -

                                                                                                                                                  - - - - -
                                                                                                                                                  - -

                                                                                                                                                  - - inner renderPortalUrl(lat, lng, title, guid) - - - - -

                                                                                                                                                  - - - -
                                                                                                                                                  -
                                                                                                                                                  - - -
                                                                                                                                                  -

                                                                                                                                                  Generates and displays URLs related to the portal. -This includes a permalink for the portal, a link for Ingress Prime, and links to alternative maps. -Function is overwritten in app.js

                                                                                                                                                  -
                                                                                                                                                  - - - - - - - - - -
                                                                                                                                                  -
                                                                                                                                                  Parameters:
                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                  NameTypeDescription
                                                                                                                                                  lat - - -number - - - -

                                                                                                                                                  The latitude of the portal.

                                                                                                                                                  lng - - -number - - - -

                                                                                                                                                  The longitude of the portal.

                                                                                                                                                  title - - -string - - - -

                                                                                                                                                  The title of the portal.

                                                                                                                                                  guid - - -string - - - -

                                                                                                                                                  The GUID of the portal.

                                                                                                                                                  - -
                                                                                                                                                  - - - - - - - - - - - - - - - - - -
                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                  - - - - -
                                                                                                                                                  - - - - -
                                                                                                                                                  - -

                                                                                                                                                  - - inner renderPortalUrl(lat, lng, title, guid) - - - - -

                                                                                                                                                  - - - -
                                                                                                                                                  -
                                                                                                                                                  - - -
                                                                                                                                                  -

                                                                                                                                                  Generates and displays URLs related to the portal. -This includes a permalink for the portal, a link for Ingress Prime, and links to alternative maps. -Function is overwritten in app.js

                                                                                                                                                  -
                                                                                                                                                  - - - - - - - - - -
                                                                                                                                                  -
                                                                                                                                                  Parameters:
                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                  NameTypeDescription
                                                                                                                                                  lat - - -number - - - -

                                                                                                                                                  The latitude of the portal.

                                                                                                                                                  lng - - -number - - - -

                                                                                                                                                  The longitude of the portal.

                                                                                                                                                  title - - -string - - - -

                                                                                                                                                  The title of the portal.

                                                                                                                                                  guid - - -string - - - -

                                                                                                                                                  The GUID of the portal.

                                                                                                                                                  - -
                                                                                                                                                  - - - - - - - - - - - - - - - - - -
                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                  - - - - -
                                                                                                                                                  - - - - -
                                                                                                                                                  - -

                                                                                                                                                  - - inner resetScrollOnNewPortal() - - - - -

                                                                                                                                                  - - - -
                                                                                                                                                  -
                                                                                                                                                  - - -
                                                                                                                                                  -

                                                                                                                                                  Resets the scroll position of the sidebar when a new portal is selected.

                                                                                                                                                  -
                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                  - - - - -
                                                                                                                                                  - - - - -
                                                                                                                                                  - -

                                                                                                                                                  - - inner resetScrollOnNewPortal() - - - - -

                                                                                                                                                  - - - -
                                                                                                                                                  -
                                                                                                                                                  - - -
                                                                                                                                                  -

                                                                                                                                                  Resets the scroll position of the sidebar when a new portal is selected.

                                                                                                                                                  -
                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                  - - - - -
                                                                                                                                                  - - - - -
                                                                                                                                                  - -

                                                                                                                                                  - - inner selectPortal(guid) → {boolean} - - - - -

                                                                                                                                                  - - - -
                                                                                                                                                  -
                                                                                                                                                  - - -
                                                                                                                                                  -

                                                                                                                                                  Highlights the selected portal on the map and clears the highlight from the previously selected portal.

                                                                                                                                                  -
                                                                                                                                                  - - - - - - - - - -
                                                                                                                                                  -
                                                                                                                                                  Parameters:
                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                  NameTypeDescription
                                                                                                                                                  guid - - -string - - - -

                                                                                                                                                  The GUID of the portal to select.

                                                                                                                                                  - -
                                                                                                                                                  - - - - - - - - - - - - - -
                                                                                                                                                  -
                                                                                                                                                  Returns:
                                                                                                                                                  - - - - - -boolean - - - - - --

                                                                                                                                                  True if the same portal is re-selected (just an update), false if a different portal is selected.

                                                                                                                                                  - - - - - -
                                                                                                                                                  - - - - - -
                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                  - - - - -
                                                                                                                                                  - - - - -
                                                                                                                                                  - -

                                                                                                                                                  - - inner selectPortal(guid) → {boolean} - - - - -

                                                                                                                                                  - - - -
                                                                                                                                                  -
                                                                                                                                                  - - -
                                                                                                                                                  -

                                                                                                                                                  Highlights the selected portal on the map and clears the highlight from the previously selected portal.

                                                                                                                                                  -
                                                                                                                                                  - - - - - - - - - -
                                                                                                                                                  -
                                                                                                                                                  Parameters:
                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                  NameTypeDescription
                                                                                                                                                  guid - - -string - - - -

                                                                                                                                                  The GUID of the portal to select.

                                                                                                                                                  - -
                                                                                                                                                  - - - - - - - - - - - - - -
                                                                                                                                                  -
                                                                                                                                                  Returns:
                                                                                                                                                  - - - - - -boolean - - - - - --

                                                                                                                                                  True if the same portal is re-selected (just an update), false if a different portal is selected.

                                                                                                                                                  - - - - - -
                                                                                                                                                  - - - - - -
                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                  - - - - -
                                                                                                                                                  - - - - -
                                                                                                                                                  - -

                                                                                                                                                  - - inner setPortalIndicators(p) - - - - -

                                                                                                                                                  - - - -
                                                                                                                                                  -
                                                                                                                                                  - - -
                                                                                                                                                  -

                                                                                                                                                  The function adds circles indicating the hack range and link range of the portal. -If the portal object are null, the indicators are removed.

                                                                                                                                                  -
                                                                                                                                                  - - - - - - - - - -
                                                                                                                                                  -
                                                                                                                                                  Parameters:
                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                  NameTypeDescription
                                                                                                                                                  p - - -Object - - - -

                                                                                                                                                  The portal object for which to set the indicators.

                                                                                                                                                  - -
                                                                                                                                                  - - - - - - - - - - - - - - - - - -
                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                  - - - - -
                                                                                                                                                  - - - - -
                                                                                                                                                  - -

                                                                                                                                                  - - inner setPortalIndicators(p) - - - - -

                                                                                                                                                  - - - -
                                                                                                                                                  -
                                                                                                                                                  - - -
                                                                                                                                                  -

                                                                                                                                                  The function adds circles indicating the hack range and link range of the portal. -If the portal object are null, the indicators are removed.

                                                                                                                                                  -
                                                                                                                                                  - - - - - - - - - -
                                                                                                                                                  -
                                                                                                                                                  Parameters:
                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                  NameTypeDescription
                                                                                                                                                  p - - -Object - - - -

                                                                                                                                                  The portal object for which to set the indicators.

                                                                                                                                                  - -
                                                                                                                                                  - - - - - - - - - - - - - - - - - -
                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                  - - - - -
                                                                                                                                                  - -
                                                                                                                                                  - - - - - -
                                                                                                                                                  - -
                                                                                                                                                  - - - - - - - -
                                                                                                                                                  - -
                                                                                                                                                  - -

                                                                                                                                                  portal_detail_display

                                                                                                                                                  - - - - - - -
                                                                                                                                                  - -
                                                                                                                                                  - -
                                                                                                                                                  - - -

                                                                                                                                                  Main code block that renders the portal details in the sidebar and -methods that highlight the portal in the map view.

                                                                                                                                                  - - - - - -
                                                                                                                                                  - -
                                                                                                                                                  -
                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                  - - - - -
                                                                                                                                                  - - - - -
                                                                                                                                                  - -
                                                                                                                                                  -
                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                  - - - - -
                                                                                                                                                  - - - -
                                                                                                                                                  - - - - - - - - - - - - - - - - - -

                                                                                                                                                  Methods

                                                                                                                                                  - -
                                                                                                                                                  - - -
                                                                                                                                                  - -

                                                                                                                                                  - - inner getPortalMiscDetails(guid, d) → {string} - - - - -

                                                                                                                                                  - - - -
                                                                                                                                                  -
                                                                                                                                                  - - -
                                                                                                                                                  -

                                                                                                                                                  Gets miscellaneous details for a specified portal.

                                                                                                                                                  -
                                                                                                                                                  - - - - - - - - - -
                                                                                                                                                  -
                                                                                                                                                  Parameters:
                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                  NameTypeDescription
                                                                                                                                                  guid - - -string - - - -

                                                                                                                                                  The GUID of the portal.

                                                                                                                                                  d - - -Object - - - -

                                                                                                                                                  The portal detail object containing various properties of the portal.

                                                                                                                                                  - -
                                                                                                                                                  - - - - - - - - - - - - - -
                                                                                                                                                  -
                                                                                                                                                  Returns:
                                                                                                                                                  - - - - - -string - - - - - --

                                                                                                                                                  HTML string representing the miscellaneous details of the portal.

                                                                                                                                                  - - - - - -
                                                                                                                                                  - - - - - -
                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                  - - - - -
                                                                                                                                                  - - - - -
                                                                                                                                                  - -

                                                                                                                                                  - - inner getPortalMiscDetails(guid, d) → {string} - - - - -

                                                                                                                                                  - - - -
                                                                                                                                                  -
                                                                                                                                                  - - -
                                                                                                                                                  -

                                                                                                                                                  Gets miscellaneous details for a specified portal.

                                                                                                                                                  -
                                                                                                                                                  - - - - - - - - - -
                                                                                                                                                  -
                                                                                                                                                  Parameters:
                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                  NameTypeDescription
                                                                                                                                                  guid - - -string - - - -

                                                                                                                                                  The GUID of the portal.

                                                                                                                                                  d - - -Object - - - -

                                                                                                                                                  The portal detail object containing various properties of the portal.

                                                                                                                                                  - -
                                                                                                                                                  - - - - - - - - - - - - - -
                                                                                                                                                  -
                                                                                                                                                  Returns:
                                                                                                                                                  - - - - - -string - - - - - --

                                                                                                                                                  HTML string representing the miscellaneous details of the portal.

                                                                                                                                                  - - - - - -
                                                                                                                                                  - - - - - -
                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                  - - - - -
                                                                                                                                                  - - - - -
                                                                                                                                                  - -

                                                                                                                                                  - - inner renderPortalDetails(guid) - - - - -

                                                                                                                                                  - - - -
                                                                                                                                                  -
                                                                                                                                                  - - -
                                                                                                                                                  -

                                                                                                                                                  Renders the details of a portal in the sidebar.

                                                                                                                                                  -
                                                                                                                                                  - - - - - - - - - -
                                                                                                                                                  -
                                                                                                                                                  Parameters:
                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                  NameTypeDescription
                                                                                                                                                  guid - - -string - - - -

                                                                                                                                                  The globally unique identifier of the portal to display details for.

                                                                                                                                                  - -
                                                                                                                                                  - - - - - - - - - - - - - - - - - -
                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                  - - - - -
                                                                                                                                                  - - - - -
                                                                                                                                                  - -

                                                                                                                                                  - - inner renderPortalDetails(guid) - - - - -

                                                                                                                                                  - - - -
                                                                                                                                                  -
                                                                                                                                                  - - -
                                                                                                                                                  -

                                                                                                                                                  Renders the details of a portal in the sidebar.

                                                                                                                                                  -
                                                                                                                                                  - - - - - - - - - -
                                                                                                                                                  -
                                                                                                                                                  Parameters:
                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                  NameTypeDescription
                                                                                                                                                  guid - - -string - - - -

                                                                                                                                                  The globally unique identifier of the portal to display details for.

                                                                                                                                                  - -
                                                                                                                                                  - - - - - - - - - - - - - - - - - -
                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                  - - - - -
                                                                                                                                                  - - - - -
                                                                                                                                                  - -

                                                                                                                                                  - - inner renderPortalUrl(lat, lng, title, guid) - - - - -

                                                                                                                                                  - - - -
                                                                                                                                                  -
                                                                                                                                                  - - -
                                                                                                                                                  -

                                                                                                                                                  Generates and displays URLs related to the portal. -This includes a permalink for the portal, a link for Ingress Prime, and links to alternative maps. -Function is overwritten in app.js

                                                                                                                                                  -
                                                                                                                                                  - - - - - - - - - -
                                                                                                                                                  -
                                                                                                                                                  Parameters:
                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                  NameTypeDescription
                                                                                                                                                  lat - - -number - - - -

                                                                                                                                                  The latitude of the portal.

                                                                                                                                                  lng - - -number - - - -

                                                                                                                                                  The longitude of the portal.

                                                                                                                                                  title - - -string - - - -

                                                                                                                                                  The title of the portal.

                                                                                                                                                  guid - - -string - - - -

                                                                                                                                                  The GUID of the portal.

                                                                                                                                                  - -
                                                                                                                                                  - - - - - - - - - - - - - - - - - -
                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                  - - - - -
                                                                                                                                                  - - - - -
                                                                                                                                                  - -

                                                                                                                                                  - - inner renderPortalUrl(lat, lng, title, guid) - - - - -

                                                                                                                                                  - - - -
                                                                                                                                                  -
                                                                                                                                                  - - -
                                                                                                                                                  -

                                                                                                                                                  Generates and displays URLs related to the portal. -This includes a permalink for the portal, a link for Ingress Prime, and links to alternative maps. -Function is overwritten in app.js

                                                                                                                                                  -
                                                                                                                                                  - - - - - - - - - -
                                                                                                                                                  -
                                                                                                                                                  Parameters:
                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                  NameTypeDescription
                                                                                                                                                  lat - - -number - - - -

                                                                                                                                                  The latitude of the portal.

                                                                                                                                                  lng - - -number - - - -

                                                                                                                                                  The longitude of the portal.

                                                                                                                                                  title - - -string - - - -

                                                                                                                                                  The title of the portal.

                                                                                                                                                  guid - - -string - - - -

                                                                                                                                                  The GUID of the portal.

                                                                                                                                                  - -
                                                                                                                                                  - - - - - - - - - - - - - - - - - -
                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                  - - - - -
                                                                                                                                                  - - - - -
                                                                                                                                                  - -

                                                                                                                                                  - - inner resetScrollOnNewPortal() - - - - -

                                                                                                                                                  - - - -
                                                                                                                                                  -
                                                                                                                                                  - - -
                                                                                                                                                  -

                                                                                                                                                  Resets the scroll position of the sidebar when a new portal is selected.

                                                                                                                                                  -
                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                  - - - - -
                                                                                                                                                  - - - - -
                                                                                                                                                  - -

                                                                                                                                                  - - inner resetScrollOnNewPortal() - - - - -

                                                                                                                                                  - - - -
                                                                                                                                                  -
                                                                                                                                                  - - -
                                                                                                                                                  -

                                                                                                                                                  Resets the scroll position of the sidebar when a new portal is selected.

                                                                                                                                                  -
                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                  - - - - -
                                                                                                                                                  - - - - -
                                                                                                                                                  - -

                                                                                                                                                  - - inner selectPortal(guid) → {boolean} - - - - -

                                                                                                                                                  - - - -
                                                                                                                                                  -
                                                                                                                                                  - - -
                                                                                                                                                  -

                                                                                                                                                  Highlights the selected portal on the map and clears the highlight from the previously selected portal.

                                                                                                                                                  -
                                                                                                                                                  - - - - - - - - - -
                                                                                                                                                  -
                                                                                                                                                  Parameters:
                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                  NameTypeDescription
                                                                                                                                                  guid - - -string - - - -

                                                                                                                                                  The GUID of the portal to select.

                                                                                                                                                  - -
                                                                                                                                                  - - - - - - - - - - - - - -
                                                                                                                                                  -
                                                                                                                                                  Returns:
                                                                                                                                                  - - - - - -boolean - - - - - --

                                                                                                                                                  True if the same portal is re-selected (just an update), false if a different portal is selected.

                                                                                                                                                  - - - - - -
                                                                                                                                                  - - - - - -
                                                                                                                                                  - - - - - - + @@ -3959,146 +1061,6 @@
                                                                                                                                                  Parameters:
                                                                                                                                                  - - - - - - - - - - -
                                                                                                                                                  - - - - -
                                                                                                                                                  - - - - -
                                                                                                                                                  - -

                                                                                                                                                  - - inner setPortalIndicators(p) - - - - -

                                                                                                                                                  - - - -
                                                                                                                                                  -
                                                                                                                                                  - - -
                                                                                                                                                  -

                                                                                                                                                  The function adds circles indicating the hack range and link range of the portal. -If the portal object are null, the indicators are removed.

                                                                                                                                                  -
                                                                                                                                                  - - - - - - - - - -
                                                                                                                                                  -
                                                                                                                                                  Parameters:
                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                  NameTypeDescription
                                                                                                                                                  p - - -Object - - - -

                                                                                                                                                  The portal object for which to set the indicators.

                                                                                                                                                  - -
                                                                                                                                                  - - - - - - - - - - - - - - - - - -
                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - diff --git a/module-portal_detail_display_tools.html b/module-portal_detail_display_tools.html index 28250c7b7..3e932b9a0 100644 --- a/module-portal_detail_display_tools.html +++ b/module-portal_detail_display_tools.html @@ -34,7 +34,7 @@

                                                                                                                                                  IITC-CE

                                                                                                                                                    - +
                                                                                                                                                    @@ -52,8 +52,6 @@

                                                                                                                                                    portal_detail_display_tools

                                                                                                                                                    - - @@ -120,77 +118,6 @@

                                                                                                                                                    portal_detail_display_tools

                                                                                                                                                    - - - - - - - - - - -
                                                                                                                                                    - - - - -
                                                                                                                                                    - - - - -
                                                                                                                                                    - -
                                                                                                                                                    -
                                                                                                                                                    - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                    - - - - - - - - - - - - - - - - - - - - @@ -441,14 +368,14 @@
                                                                                                                                                    Returns:
                                                                                                                                                    -

                                                                                                                                                    +

                                                                                                                                                    - inner getAttackApGainText(d, fieldCount, linkCount) → {Array} + inner getEnergyText(d) → {Array}

                                                                                                                                                    @@ -460,7 +387,7 @@

                                                                                                                                                    -

                                                                                                                                                    Calculates the AP gain from destroying and then capturing a portal by deploying resonators.

                                                                                                                                                    +

                                                                                                                                                    Generates text representing the current and total energy of a portal.

                                                                                                                                                    @@ -512,53 +439,7 @@

                                                                                                                                                    Parameters:
                                                                                                                                                    -

                                                                                                                                                    The portal detail object containing portal information.

                                                                                                                                                    - - - - - - - fieldCount - - - - - -number - - - - - - - - - -

                                                                                                                                                    The number of fields linked to the portal.

                                                                                                                                                    - - - - - - - linkCount - - - - - -number - - - - - - - - - -

                                                                                                                                                    The number of links connected to the portal.

                                                                                                                                                    +

                                                                                                                                                    The portal detail object containing energy information.

                                                                                                                                                    @@ -592,7 +473,7 @@
                                                                                                                                                    Returns:
                                                                                                                                                    --

                                                                                                                                                    An array containing the label 'AP Gain', total AP gain, and a breakdown tooltip.

                                                                                                                                                    +-

                                                                                                                                                    An array containing the energy label, formatted energy values, and a tooltip title.

                                                                                                                                                    @@ -647,14 +528,14 @@
                                                                                                                                                    Returns:
                                                                                                                                                    -

                                                                                                                                                    +

                                                                                                                                                    - inner getEnergyText(d) → {Array} + inner getHackDetailsText(d) → {Array}

                                                                                                                                                    @@ -666,7 +547,7 @@

                                                                                                                                                    -

                                                                                                                                                    Generates text representing the current and total energy of a portal.

                                                                                                                                                    +

                                                                                                                                                    Provides details about the hack count and cooldown time of a portal.

                                                                                                                                                    @@ -718,7 +599,7 @@

                                                                                                                                                    Parameters:
                                                                                                                                                    -

                                                                                                                                                    The portal detail object containing energy information.

                                                                                                                                                    +

                                                                                                                                                    The portal detail object containing hack information.

                                                                                                                                                    @@ -752,7 +633,7 @@
                                                                                                                                                    Returns:
                                                                                                                                                    --

                                                                                                                                                    An array containing the energy label, formatted energy values, and a tooltip title.

                                                                                                                                                    +-

                                                                                                                                                    An array containing the label 'hacks', short hack info, and a detailed tooltip.

                                                                                                                                                    @@ -807,14 +688,14 @@
                                                                                                                                                    Returns:
                                                                                                                                                    -

                                                                                                                                                    +

                                                                                                                                                    - inner getEnergyText(d) → {Array} + inner getMitigationText(d, linkCount) → {Array}

                                                                                                                                                    @@ -826,7 +707,7 @@

                                                                                                                                                    -

                                                                                                                                                    Generates text representing the current and total energy of a portal.

                                                                                                                                                    +

                                                                                                                                                    Generates text representing the total mitigation provided by shields and links on a portal.

                                                                                                                                                    @@ -878,7 +759,30 @@

                                                                                                                                                    Parameters:
                                                                                                                                                    -

                                                                                                                                                    The portal detail object containing energy information.

                                                                                                                                                    +

                                                                                                                                                    The portal detail object containing mitigation information.

                                                                                                                                                    + + + + + + + linkCount + + + + + +number + + + + + + + + + +

                                                                                                                                                    The number of links connected to the portal.

                                                                                                                                                    @@ -912,7 +816,7 @@
                                                                                                                                                    Returns:
                                                                                                                                                    --

                                                                                                                                                    An array containing the energy label, formatted energy values, and a tooltip title.

                                                                                                                                                    +-

                                                                                                                                                    An array containing the label 'shielding', short mitigation info, and a detailed tooltip.

                                                                                                                                                    @@ -967,14 +871,14 @@
                                                                                                                                                    Returns:
                                                                                                                                                    -

                                                                                                                                                    +

                                                                                                                                                    - inner getHackDetailsText(d) → {Array} + inner getModDetails(d) → {string}

                                                                                                                                                    @@ -986,7 +890,7 @@

                                                                                                                                                    -

                                                                                                                                                    Provides details about the hack count and cooldown time of a portal.

                                                                                                                                                    +

                                                                                                                                                    Given portal details, returns HTML code to display mod details.

                                                                                                                                                    @@ -1038,7 +942,7 @@

                                                                                                                                                    Parameters:
                                                                                                                                                    -

                                                                                                                                                    The portal detail object containing hack information.

                                                                                                                                                    +

                                                                                                                                                    The portal detail object containing mod information.

                                                                                                                                                    @@ -1066,13 +970,13 @@
                                                                                                                                                    Returns:
                                                                                                                                                    -Array +string --

                                                                                                                                                    An array containing the label 'hacks', short hack info, and a detailed tooltip.

                                                                                                                                                    +-

                                                                                                                                                    HTML string representing the mod details of the portal.

                                                                                                                                                    @@ -1127,14 +1031,14 @@
                                                                                                                                                    Returns:
                                                                                                                                                    -

                                                                                                                                                    +

                                                                                                                                                    - inner getHackDetailsText(d) → {Array} + inner getPortalHistoryDetails(d) → {string}

                                                                                                                                                    @@ -1146,7 +1050,7 @@

                                                                                                                                                    -

                                                                                                                                                    Provides details about the hack count and cooldown time of a portal.

                                                                                                                                                    +

                                                                                                                                                    Provides historical details about a portal including visitation, capture, and scout control status.

                                                                                                                                                    @@ -1198,7 +1102,7 @@

                                                                                                                                                    Parameters:
                                                                                                                                                    -

                                                                                                                                                    The portal detail object containing hack information.

                                                                                                                                                    +

                                                                                                                                                    The portal detail object containing the history properties.

                                                                                                                                                    @@ -1226,13 +1130,13 @@
                                                                                                                                                    Returns:
                                                                                                                                                    -Array +string --

                                                                                                                                                    An array containing the label 'hacks', short hack info, and a detailed tooltip.

                                                                                                                                                    +-

                                                                                                                                                    HTML string representing the historical details of the portal.

                                                                                                                                                    @@ -1287,14 +1191,14 @@
                                                                                                                                                    Returns:
                                                                                                                                                    -

                                                                                                                                                    +

                                                                                                                                                    - inner getMitigationText(d, linkCount) → {Array} + inner getRangeText(d) → {Array}

                                                                                                                                                    @@ -1306,7 +1210,7 @@

                                                                                                                                                    -

                                                                                                                                                    Generates text representing the total mitigation provided by shields and links on a portal.

                                                                                                                                                    +

                                                                                                                                                    Returns displayable text and link about portal range including base range, link amp boost, and total range.

                                                                                                                                                    @@ -1358,30 +1262,7 @@

                                                                                                                                                    Parameters:
                                                                                                                                                    -

                                                                                                                                                    The portal detail object containing mitigation information.

                                                                                                                                                    - - - - - - - linkCount - - - - - -number - - - - - - - - - -

                                                                                                                                                    The number of links connected to the portal.

                                                                                                                                                    +

                                                                                                                                                    The portal detail object containing range information.

                                                                                                                                                    @@ -1415,7 +1296,7 @@
                                                                                                                                                    Returns:
                                                                                                                                                    --

                                                                                                                                                    An array containing the label 'shielding', short mitigation info, and a detailed tooltip.

                                                                                                                                                    +-

                                                                                                                                                    An array containing the range label, HTML content, and a tooltip title.

                                                                                                                                                    @@ -1470,14 +1351,14 @@
                                                                                                                                                    Returns:
                                                                                                                                                    -

                                                                                                                                                    +

                                                                                                                                                    - inner getMitigationText(d, linkCount) → {Array} + inner getResonatorDetails(d) → {string}

                                                                                                                                                    @@ -1489,7 +1370,7 @@

                                                                                                                                                    -

                                                                                                                                                    Generates text representing the total mitigation provided by shields and links on a portal.

                                                                                                                                                    +

                                                                                                                                                    Generates HTML details for resonators deployed on a portal.

                                                                                                                                                    @@ -1541,4681 +1422,12 @@

                                                                                                                                                    Parameters:
                                                                                                                                                    -

                                                                                                                                                    The portal detail object containing mitigation information.

                                                                                                                                                    +

                                                                                                                                                    The portal detail object containing resonator information.

                                                                                                                                                    - - - - linkCount - - - - - -number - - - - - - - - - -

                                                                                                                                                    The number of links connected to the portal.

                                                                                                                                                    - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                    -
                                                                                                                                                    Returns:
                                                                                                                                                    - - - - - -Array - - - - - --

                                                                                                                                                    An array containing the label 'shielding', short mitigation info, and a detailed tooltip.

                                                                                                                                                    - - - - - -
                                                                                                                                                    - - - - - -
                                                                                                                                                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                    - - - - -
                                                                                                                                                    - - - - -
                                                                                                                                                    - -

                                                                                                                                                    - - inner getModDetails(d) → {string} - - - - -

                                                                                                                                                    - - - -
                                                                                                                                                    -
                                                                                                                                                    - - -
                                                                                                                                                    -

                                                                                                                                                    Given portal details, returns HTML code to display mod details.

                                                                                                                                                    -
                                                                                                                                                    - - - - - - - - - -
                                                                                                                                                    -
                                                                                                                                                    Parameters:
                                                                                                                                                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                    NameTypeDescription
                                                                                                                                                    d - - -Object - - - -

                                                                                                                                                    The portal detail object containing mod information.

                                                                                                                                                    - -
                                                                                                                                                    - - - - - - - - - - - - - -
                                                                                                                                                    -
                                                                                                                                                    Returns:
                                                                                                                                                    - - - - - -string - - - - - --

                                                                                                                                                    HTML string representing the mod details of the portal.

                                                                                                                                                    - - - - - -
                                                                                                                                                    - - - - - -
                                                                                                                                                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                    - - - - -
                                                                                                                                                    - - - - -
                                                                                                                                                    - -

                                                                                                                                                    - - inner getModDetails(d) → {string} - - - - -

                                                                                                                                                    - - - -
                                                                                                                                                    -
                                                                                                                                                    - - -
                                                                                                                                                    -

                                                                                                                                                    Given portal details, returns HTML code to display mod details.

                                                                                                                                                    -
                                                                                                                                                    - - - - - - - - - -
                                                                                                                                                    -
                                                                                                                                                    Parameters:
                                                                                                                                                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                    NameTypeDescription
                                                                                                                                                    d - - -Object - - - -

                                                                                                                                                    The portal detail object containing mod information.

                                                                                                                                                    - -
                                                                                                                                                    - - - - - - - - - - - - - -
                                                                                                                                                    -
                                                                                                                                                    Returns:
                                                                                                                                                    - - - - - -string - - - - - --

                                                                                                                                                    HTML string representing the mod details of the portal.

                                                                                                                                                    - - - - - -
                                                                                                                                                    - - - - - -
                                                                                                                                                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                    - - - - -
                                                                                                                                                    - - - - -
                                                                                                                                                    - -

                                                                                                                                                    - - inner getPortalHistoryDetails(d) → {string} - - - - -

                                                                                                                                                    - - - -
                                                                                                                                                    -
                                                                                                                                                    - - -
                                                                                                                                                    -

                                                                                                                                                    Provides historical details about a portal including visitation, capture, and scout control status.

                                                                                                                                                    -
                                                                                                                                                    - - - - - - - - - -
                                                                                                                                                    -
                                                                                                                                                    Parameters:
                                                                                                                                                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                    NameTypeDescription
                                                                                                                                                    d - - -Object - - - -

                                                                                                                                                    The portal detail object containing the history properties.

                                                                                                                                                    - -
                                                                                                                                                    - - - - - - - - - - - - - -
                                                                                                                                                    -
                                                                                                                                                    Returns:
                                                                                                                                                    - - - - - -string - - - - - --

                                                                                                                                                    HTML string representing the historical details of the portal.

                                                                                                                                                    - - - - - -
                                                                                                                                                    - - - - - -
                                                                                                                                                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                    - - - - -
                                                                                                                                                    - - - - -
                                                                                                                                                    - -

                                                                                                                                                    - - inner getPortalHistoryDetails(d) → {string} - - - - -

                                                                                                                                                    - - - -
                                                                                                                                                    -
                                                                                                                                                    - - -
                                                                                                                                                    -

                                                                                                                                                    Provides historical details about a portal including visitation, capture, and scout control status.

                                                                                                                                                    -
                                                                                                                                                    - - - - - - - - - -
                                                                                                                                                    -
                                                                                                                                                    Parameters:
                                                                                                                                                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                    NameTypeDescription
                                                                                                                                                    d - - -Object - - - -

                                                                                                                                                    The portal detail object containing the history properties.

                                                                                                                                                    - -
                                                                                                                                                    - - - - - - - - - - - - - -
                                                                                                                                                    -
                                                                                                                                                    Returns:
                                                                                                                                                    - - - - - -string - - - - - --

                                                                                                                                                    HTML string representing the historical details of the portal.

                                                                                                                                                    - - - - - -
                                                                                                                                                    - - - - - -
                                                                                                                                                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                    - - - - -
                                                                                                                                                    - - - - -
                                                                                                                                                    - -

                                                                                                                                                    - - inner getRangeText(d) → {Array} - - - - -

                                                                                                                                                    - - - -
                                                                                                                                                    -
                                                                                                                                                    - - -
                                                                                                                                                    -

                                                                                                                                                    Returns displayable text and link about portal range including base range, link amp boost, and total range.

                                                                                                                                                    -
                                                                                                                                                    - - - - - - - - - -
                                                                                                                                                    -
                                                                                                                                                    Parameters:
                                                                                                                                                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                    NameTypeDescription
                                                                                                                                                    d - - -Object - - - -

                                                                                                                                                    The portal detail object containing range information.

                                                                                                                                                    - -
                                                                                                                                                    - - - - - - - - - - - - - -
                                                                                                                                                    -
                                                                                                                                                    Returns:
                                                                                                                                                    - - - - - -Array - - - - - --

                                                                                                                                                    An array containing the range label, HTML content, and a tooltip title.

                                                                                                                                                    - - - - - -
                                                                                                                                                    - - - - - -
                                                                                                                                                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                    - - - - -
                                                                                                                                                    - - - - -
                                                                                                                                                    - -

                                                                                                                                                    - - inner getRangeText(d) → {Array} - - - - -

                                                                                                                                                    - - - -
                                                                                                                                                    -
                                                                                                                                                    - - -
                                                                                                                                                    -

                                                                                                                                                    Returns displayable text and link about portal range including base range, link amp boost, and total range.

                                                                                                                                                    -
                                                                                                                                                    - - - - - - - - - -
                                                                                                                                                    -
                                                                                                                                                    Parameters:
                                                                                                                                                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                    NameTypeDescription
                                                                                                                                                    d - - -Object - - - -

                                                                                                                                                    The portal detail object containing range information.

                                                                                                                                                    - -
                                                                                                                                                    - - - - - - - - - - - - - -
                                                                                                                                                    -
                                                                                                                                                    Returns:
                                                                                                                                                    - - - - - -Array - - - - - --

                                                                                                                                                    An array containing the range label, HTML content, and a tooltip title.

                                                                                                                                                    - - - - - -
                                                                                                                                                    - - - - - -
                                                                                                                                                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                    - - - - -
                                                                                                                                                    - - - - -
                                                                                                                                                    - -

                                                                                                                                                    - - inner getResonatorDetails(d) → {string} - - - - -

                                                                                                                                                    - - - -
                                                                                                                                                    -
                                                                                                                                                    - - -
                                                                                                                                                    -

                                                                                                                                                    Generates HTML details for resonators deployed on a portal.

                                                                                                                                                    -
                                                                                                                                                    - - - - - - - - - -
                                                                                                                                                    -
                                                                                                                                                    Parameters:
                                                                                                                                                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                    NameTypeDescription
                                                                                                                                                    d - - -Object - - - -

                                                                                                                                                    The portal detail object containing resonator information.

                                                                                                                                                    - -
                                                                                                                                                    - - - - - - - - - - - - - -
                                                                                                                                                    -
                                                                                                                                                    Returns:
                                                                                                                                                    - - - - - -string - - - - - --

                                                                                                                                                    HTML string representing the resonator details of the portal.

                                                                                                                                                    - - - - - -
                                                                                                                                                    - - - - - -
                                                                                                                                                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                    - - - - -
                                                                                                                                                    - - - - -
                                                                                                                                                    - -

                                                                                                                                                    - - inner getResonatorDetails(d) → {string} - - - - -

                                                                                                                                                    - - - -
                                                                                                                                                    -
                                                                                                                                                    - - -
                                                                                                                                                    -

                                                                                                                                                    Generates HTML details for resonators deployed on a portal.

                                                                                                                                                    -
                                                                                                                                                    - - - - - - - - - -
                                                                                                                                                    -
                                                                                                                                                    Parameters:
                                                                                                                                                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                    NameTypeDescription
                                                                                                                                                    d - - -Object - - - -

                                                                                                                                                    The portal detail object containing resonator information.

                                                                                                                                                    - -
                                                                                                                                                    - - - - - - - - - - - - - -
                                                                                                                                                    -
                                                                                                                                                    Returns:
                                                                                                                                                    - - - - - -string - - - - - --

                                                                                                                                                    HTML string representing the resonator details of the portal.

                                                                                                                                                    - - - - - -
                                                                                                                                                    - - - - - -
                                                                                                                                                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                    - - - - -
                                                                                                                                                    - - - - -
                                                                                                                                                    - -

                                                                                                                                                    - - inner renderResonatorDetails(slot, level, nrg, nick) → {Array} - - - - -

                                                                                                                                                    - - - -
                                                                                                                                                    -
                                                                                                                                                    - - -
                                                                                                                                                    -

                                                                                                                                                    Helper function that renders the HTML for a given resonator.

                                                                                                                                                    -
                                                                                                                                                    - - - - - - - - - -
                                                                                                                                                    -
                                                                                                                                                    Parameters:
                                                                                                                                                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                    NameTypeDescription
                                                                                                                                                    slot - - -number - - - -

                                                                                                                                                    The slot number where the resonator is deployed. Starts with 0 (east) and rotates clockwise. -So, last one is 7 (southeast).

                                                                                                                                                    level - - -number - - - -

                                                                                                                                                    The level of the resonator.

                                                                                                                                                    nrg - - -number - - - -

                                                                                                                                                    The energy of the resonator.

                                                                                                                                                    nick - - -string -| - -null - - - -

                                                                                                                                                    The nickname of the owner of the resonator, or null if not applicable.

                                                                                                                                                    - -
                                                                                                                                                    - - - - - - - - - - - - - -
                                                                                                                                                    -
                                                                                                                                                    Returns:
                                                                                                                                                    - - - - - -Array - - - - - --

                                                                                                                                                    An array containing the HTML content of the resonator and the owner's nickname.

                                                                                                                                                    - - - - - -
                                                                                                                                                    - - - - - -
                                                                                                                                                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                    - - - - -
                                                                                                                                                    - - - - -
                                                                                                                                                    - -

                                                                                                                                                    - - inner renderResonatorDetails(slot, level, nrg, nick) → {Array} - - - - -

                                                                                                                                                    - - - -
                                                                                                                                                    -
                                                                                                                                                    - - -
                                                                                                                                                    -

                                                                                                                                                    Helper function that renders the HTML for a given resonator.

                                                                                                                                                    -
                                                                                                                                                    - - - - - - - - - -
                                                                                                                                                    -
                                                                                                                                                    Parameters:
                                                                                                                                                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                    NameTypeDescription
                                                                                                                                                    slot - - -number - - - -

                                                                                                                                                    The slot number where the resonator is deployed. Starts with 0 (east) and rotates clockwise. -So, last one is 7 (southeast).

                                                                                                                                                    level - - -number - - - -

                                                                                                                                                    The level of the resonator.

                                                                                                                                                    nrg - - -number - - - -

                                                                                                                                                    The energy of the resonator.

                                                                                                                                                    nick - - -string -| - -null - - - -

                                                                                                                                                    The nickname of the owner of the resonator, or null if not applicable.

                                                                                                                                                    - -
                                                                                                                                                    - - - - - - - - - - - - - -
                                                                                                                                                    -
                                                                                                                                                    Returns:
                                                                                                                                                    - - - - - -Array - - - - - --

                                                                                                                                                    An array containing the HTML content of the resonator and the owner's nickname.

                                                                                                                                                    - - - - - -
                                                                                                                                                    - - - - - -
                                                                                                                                                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                    - - - - -
                                                                                                                                                    - -
                                                                                                                                                    - - - - - -
                                                                                                                                                    - -
                                                                                                                                                    - - - - - - - -
                                                                                                                                                    - -
                                                                                                                                                    - -

                                                                                                                                                    portal_detail_display_tools

                                                                                                                                                    - - - - - - -
                                                                                                                                                    - -
                                                                                                                                                    - -
                                                                                                                                                    - - -

                                                                                                                                                    Hand any of these functions the details-hash of a portal, and they -will return pretty, displayable HTML or parts thereof.

                                                                                                                                                    - - - - - -
                                                                                                                                                    - -
                                                                                                                                                    -
                                                                                                                                                    - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                    - - - - -
                                                                                                                                                    - - - - -
                                                                                                                                                    - -
                                                                                                                                                    -
                                                                                                                                                    - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                    - - - - -
                                                                                                                                                    - - - -
                                                                                                                                                    - - - - - - - - - - - - - - - - - -

                                                                                                                                                    Methods

                                                                                                                                                    - -
                                                                                                                                                    - - -
                                                                                                                                                    - -

                                                                                                                                                    - - inner getAttackApGainText(d, fieldCount, linkCount) → {Array} - - - - -

                                                                                                                                                    - - - -
                                                                                                                                                    -
                                                                                                                                                    - - -
                                                                                                                                                    -

                                                                                                                                                    Calculates the AP gain from destroying and then capturing a portal by deploying resonators.

                                                                                                                                                    -
                                                                                                                                                    - - - - - - - - - -
                                                                                                                                                    -
                                                                                                                                                    Parameters:
                                                                                                                                                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                    NameTypeDescription
                                                                                                                                                    d - - -Object - - - -

                                                                                                                                                    The portal detail object containing portal information.

                                                                                                                                                    fieldCount - - -number - - - -

                                                                                                                                                    The number of fields linked to the portal.

                                                                                                                                                    linkCount - - -number - - - -

                                                                                                                                                    The number of links connected to the portal.

                                                                                                                                                    - -
                                                                                                                                                    - - - - - - - - - - - - - -
                                                                                                                                                    -
                                                                                                                                                    Returns:
                                                                                                                                                    - - - - - -Array - - - - - --

                                                                                                                                                    An array containing the label 'AP Gain', total AP gain, and a breakdown tooltip.

                                                                                                                                                    - - - - - -
                                                                                                                                                    - - - - - -
                                                                                                                                                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                    - - - - -
                                                                                                                                                    - - - - -
                                                                                                                                                    - -

                                                                                                                                                    - - inner getAttackApGainText(d, fieldCount, linkCount) → {Array} - - - - -

                                                                                                                                                    - - - -
                                                                                                                                                    -
                                                                                                                                                    - - -
                                                                                                                                                    -

                                                                                                                                                    Calculates the AP gain from destroying and then capturing a portal by deploying resonators.

                                                                                                                                                    -
                                                                                                                                                    - - - - - - - - - -
                                                                                                                                                    -
                                                                                                                                                    Parameters:
                                                                                                                                                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                    NameTypeDescription
                                                                                                                                                    d - - -Object - - - -

                                                                                                                                                    The portal detail object containing portal information.

                                                                                                                                                    fieldCount - - -number - - - -

                                                                                                                                                    The number of fields linked to the portal.

                                                                                                                                                    linkCount - - -number - - - -

                                                                                                                                                    The number of links connected to the portal.

                                                                                                                                                    - -
                                                                                                                                                    - - - - - - - - - - - - - -
                                                                                                                                                    -
                                                                                                                                                    Returns:
                                                                                                                                                    - - - - - -Array - - - - - --

                                                                                                                                                    An array containing the label 'AP Gain', total AP gain, and a breakdown tooltip.

                                                                                                                                                    - - - - - -
                                                                                                                                                    - - - - - -
                                                                                                                                                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                    - - - - -
                                                                                                                                                    - - - - -
                                                                                                                                                    - -

                                                                                                                                                    - - inner getEnergyText(d) → {Array} - - - - -

                                                                                                                                                    - - - -
                                                                                                                                                    -
                                                                                                                                                    - - -
                                                                                                                                                    -

                                                                                                                                                    Generates text representing the current and total energy of a portal.

                                                                                                                                                    -
                                                                                                                                                    - - - - - - - - - -
                                                                                                                                                    -
                                                                                                                                                    Parameters:
                                                                                                                                                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                    NameTypeDescription
                                                                                                                                                    d - - -Object - - - -

                                                                                                                                                    The portal detail object containing energy information.

                                                                                                                                                    - -
                                                                                                                                                    - - - - - - - - - - - - - -
                                                                                                                                                    -
                                                                                                                                                    Returns:
                                                                                                                                                    - - - - - -Array - - - - - --

                                                                                                                                                    An array containing the energy label, formatted energy values, and a tooltip title.

                                                                                                                                                    - - - - - -
                                                                                                                                                    - - - - - -
                                                                                                                                                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                    - - - - -
                                                                                                                                                    - - - - -
                                                                                                                                                    - -

                                                                                                                                                    - - inner getEnergyText(d) → {Array} - - - - -

                                                                                                                                                    - - - -
                                                                                                                                                    -
                                                                                                                                                    - - -
                                                                                                                                                    -

                                                                                                                                                    Generates text representing the current and total energy of a portal.

                                                                                                                                                    -
                                                                                                                                                    - - - - - - - - - -
                                                                                                                                                    -
                                                                                                                                                    Parameters:
                                                                                                                                                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                    NameTypeDescription
                                                                                                                                                    d - - -Object - - - -

                                                                                                                                                    The portal detail object containing energy information.

                                                                                                                                                    - -
                                                                                                                                                    - - - - - - - - - - - - - -
                                                                                                                                                    -
                                                                                                                                                    Returns:
                                                                                                                                                    - - - - - -Array - - - - - --

                                                                                                                                                    An array containing the energy label, formatted energy values, and a tooltip title.

                                                                                                                                                    - - - - - -
                                                                                                                                                    - - - - - -
                                                                                                                                                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                    - - - - -
                                                                                                                                                    - - - - -
                                                                                                                                                    - -

                                                                                                                                                    - - inner getHackDetailsText(d) → {Array} - - - - -

                                                                                                                                                    - - - -
                                                                                                                                                    -
                                                                                                                                                    - - -
                                                                                                                                                    -

                                                                                                                                                    Provides details about the hack count and cooldown time of a portal.

                                                                                                                                                    -
                                                                                                                                                    - - - - - - - - - -
                                                                                                                                                    -
                                                                                                                                                    Parameters:
                                                                                                                                                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                    NameTypeDescription
                                                                                                                                                    d - - -Object - - - -

                                                                                                                                                    The portal detail object containing hack information.

                                                                                                                                                    - -
                                                                                                                                                    - - - - - - - - - - - - - -
                                                                                                                                                    -
                                                                                                                                                    Returns:
                                                                                                                                                    - - - - - -Array - - - - - --

                                                                                                                                                    An array containing the label 'hacks', short hack info, and a detailed tooltip.

                                                                                                                                                    - - - - - -
                                                                                                                                                    - - - - - -
                                                                                                                                                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                    - - - - -
                                                                                                                                                    - - - - -
                                                                                                                                                    - -

                                                                                                                                                    - - inner getHackDetailsText(d) → {Array} - - - - -

                                                                                                                                                    - - - -
                                                                                                                                                    -
                                                                                                                                                    - - -
                                                                                                                                                    -

                                                                                                                                                    Provides details about the hack count and cooldown time of a portal.

                                                                                                                                                    -
                                                                                                                                                    - - - - - - - - - -
                                                                                                                                                    -
                                                                                                                                                    Parameters:
                                                                                                                                                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                    NameTypeDescription
                                                                                                                                                    d - - -Object - - - -

                                                                                                                                                    The portal detail object containing hack information.

                                                                                                                                                    - -
                                                                                                                                                    - - - - - - - - - - - - - -
                                                                                                                                                    -
                                                                                                                                                    Returns:
                                                                                                                                                    - - - - - -Array - - - - - --

                                                                                                                                                    An array containing the label 'hacks', short hack info, and a detailed tooltip.

                                                                                                                                                    - - - - - -
                                                                                                                                                    - - - - - -
                                                                                                                                                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                    - - - - -
                                                                                                                                                    - - - - -
                                                                                                                                                    - -

                                                                                                                                                    - - inner getMitigationText(d, linkCount) → {Array} - - - - -

                                                                                                                                                    - - - -
                                                                                                                                                    -
                                                                                                                                                    - - -
                                                                                                                                                    -

                                                                                                                                                    Generates text representing the total mitigation provided by shields and links on a portal.

                                                                                                                                                    -
                                                                                                                                                    - - - - - - - - - -
                                                                                                                                                    -
                                                                                                                                                    Parameters:
                                                                                                                                                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                    NameTypeDescription
                                                                                                                                                    d - - -Object - - - -

                                                                                                                                                    The portal detail object containing mitigation information.

                                                                                                                                                    linkCount - - -number - - - -

                                                                                                                                                    The number of links connected to the portal.

                                                                                                                                                    - -
                                                                                                                                                    - - - - - - - - - - - - - -
                                                                                                                                                    -
                                                                                                                                                    Returns:
                                                                                                                                                    - - - - - -Array - - - - - --

                                                                                                                                                    An array containing the label 'shielding', short mitigation info, and a detailed tooltip.

                                                                                                                                                    - - - - - -
                                                                                                                                                    - - - - - -
                                                                                                                                                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                    - - - - -
                                                                                                                                                    - - - - -
                                                                                                                                                    - -

                                                                                                                                                    - - inner getMitigationText(d, linkCount) → {Array} - - - - -

                                                                                                                                                    - - - -
                                                                                                                                                    -
                                                                                                                                                    - - -
                                                                                                                                                    -

                                                                                                                                                    Generates text representing the total mitigation provided by shields and links on a portal.

                                                                                                                                                    -
                                                                                                                                                    - - - - - - - - - -
                                                                                                                                                    -
                                                                                                                                                    Parameters:
                                                                                                                                                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                    NameTypeDescription
                                                                                                                                                    d - - -Object - - - -

                                                                                                                                                    The portal detail object containing mitigation information.

                                                                                                                                                    linkCount - - -number - - - -

                                                                                                                                                    The number of links connected to the portal.

                                                                                                                                                    - -
                                                                                                                                                    - - - - - - - - - - - - - -
                                                                                                                                                    -
                                                                                                                                                    Returns:
                                                                                                                                                    - - - - - -Array - - - - - --

                                                                                                                                                    An array containing the label 'shielding', short mitigation info, and a detailed tooltip.

                                                                                                                                                    - - - - - -
                                                                                                                                                    - - - - - -
                                                                                                                                                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                    - - - - -
                                                                                                                                                    - - - - -
                                                                                                                                                    - -

                                                                                                                                                    - - inner getModDetails(d) → {string} - - - - -

                                                                                                                                                    - - - -
                                                                                                                                                    -
                                                                                                                                                    - - -
                                                                                                                                                    -

                                                                                                                                                    Given portal details, returns HTML code to display mod details.

                                                                                                                                                    -
                                                                                                                                                    - - - - - - - - - -
                                                                                                                                                    -
                                                                                                                                                    Parameters:
                                                                                                                                                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                    NameTypeDescription
                                                                                                                                                    d - - -Object - - - -

                                                                                                                                                    The portal detail object containing mod information.

                                                                                                                                                    - -
                                                                                                                                                    - - - - - - - - - - - - - -
                                                                                                                                                    -
                                                                                                                                                    Returns:
                                                                                                                                                    - - - - - -string - - - - - --

                                                                                                                                                    HTML string representing the mod details of the portal.

                                                                                                                                                    - - - - - -
                                                                                                                                                    - - - - - -
                                                                                                                                                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                    - - - - -
                                                                                                                                                    - - - - -
                                                                                                                                                    - -

                                                                                                                                                    - - inner getModDetails(d) → {string} - - - - -

                                                                                                                                                    - - - -
                                                                                                                                                    -
                                                                                                                                                    - - -
                                                                                                                                                    -

                                                                                                                                                    Given portal details, returns HTML code to display mod details.

                                                                                                                                                    -
                                                                                                                                                    - - - - - - - - - -
                                                                                                                                                    -
                                                                                                                                                    Parameters:
                                                                                                                                                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                    NameTypeDescription
                                                                                                                                                    d - - -Object - - - -

                                                                                                                                                    The portal detail object containing mod information.

                                                                                                                                                    - -
                                                                                                                                                    - - - - - - - - - - - - - -
                                                                                                                                                    -
                                                                                                                                                    Returns:
                                                                                                                                                    - - - - - -string - - - - - --

                                                                                                                                                    HTML string representing the mod details of the portal.

                                                                                                                                                    - - - - - -
                                                                                                                                                    - - - - - -
                                                                                                                                                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                    - - - - -
                                                                                                                                                    - - - - -
                                                                                                                                                    - -

                                                                                                                                                    - - inner getPortalHistoryDetails(d) → {string} - - - - -

                                                                                                                                                    - - - -
                                                                                                                                                    -
                                                                                                                                                    - - -
                                                                                                                                                    -

                                                                                                                                                    Provides historical details about a portal including visitation, capture, and scout control status.

                                                                                                                                                    -
                                                                                                                                                    - - - - - - - - - -
                                                                                                                                                    -
                                                                                                                                                    Parameters:
                                                                                                                                                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                    NameTypeDescription
                                                                                                                                                    d - - -Object - - - -

                                                                                                                                                    The portal detail object containing the history properties.

                                                                                                                                                    - -
                                                                                                                                                    - - - - - - - - - - - - - -
                                                                                                                                                    -
                                                                                                                                                    Returns:
                                                                                                                                                    - - - - - -string - - - - - --

                                                                                                                                                    HTML string representing the historical details of the portal.

                                                                                                                                                    - - - - - -
                                                                                                                                                    - - - - - -
                                                                                                                                                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                    - - - - -
                                                                                                                                                    - - - - -
                                                                                                                                                    - -

                                                                                                                                                    - - inner getPortalHistoryDetails(d) → {string} - - - - -

                                                                                                                                                    - - - -
                                                                                                                                                    -
                                                                                                                                                    - - -
                                                                                                                                                    -

                                                                                                                                                    Provides historical details about a portal including visitation, capture, and scout control status.

                                                                                                                                                    -
                                                                                                                                                    - - - - - - - - - -
                                                                                                                                                    -
                                                                                                                                                    Parameters:
                                                                                                                                                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                    NameTypeDescription
                                                                                                                                                    d - - -Object - - - -

                                                                                                                                                    The portal detail object containing the history properties.

                                                                                                                                                    - -
                                                                                                                                                    - - - - - - - - - - - - - -
                                                                                                                                                    -
                                                                                                                                                    Returns:
                                                                                                                                                    - - - - - -string - - - - - --

                                                                                                                                                    HTML string representing the historical details of the portal.

                                                                                                                                                    - - - - - -
                                                                                                                                                    - - - - - -
                                                                                                                                                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                    - - - - -
                                                                                                                                                    - - - - -
                                                                                                                                                    - -

                                                                                                                                                    - - inner getRangeText(d) → {Array} - - - - -

                                                                                                                                                    - - - -
                                                                                                                                                    -
                                                                                                                                                    - - -
                                                                                                                                                    -

                                                                                                                                                    Returns displayable text and link about portal range including base range, link amp boost, and total range.

                                                                                                                                                    -
                                                                                                                                                    - - - - - - - - - -
                                                                                                                                                    -
                                                                                                                                                    Parameters:
                                                                                                                                                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                    NameTypeDescription
                                                                                                                                                    d - - -Object - - - -

                                                                                                                                                    The portal detail object containing range information.

                                                                                                                                                    - -
                                                                                                                                                    - - - - - - - - - - - - - -
                                                                                                                                                    -
                                                                                                                                                    Returns:
                                                                                                                                                    - - - - - -Array - - - - - --

                                                                                                                                                    An array containing the range label, HTML content, and a tooltip title.

                                                                                                                                                    - - - - - -
                                                                                                                                                    - - - - - -
                                                                                                                                                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                    - - - - -
                                                                                                                                                    - - - - -
                                                                                                                                                    - -

                                                                                                                                                    - - inner getRangeText(d) → {Array} - - - - -

                                                                                                                                                    - - - -
                                                                                                                                                    -
                                                                                                                                                    - - -
                                                                                                                                                    -

                                                                                                                                                    Returns displayable text and link about portal range including base range, link amp boost, and total range.

                                                                                                                                                    -
                                                                                                                                                    - - - - - - - - - -
                                                                                                                                                    -
                                                                                                                                                    Parameters:
                                                                                                                                                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                    NameTypeDescription
                                                                                                                                                    d - - -Object - - - -

                                                                                                                                                    The portal detail object containing range information.

                                                                                                                                                    - -
                                                                                                                                                    - - - - - - - - - - - - - -
                                                                                                                                                    -
                                                                                                                                                    Returns:
                                                                                                                                                    - - - - - -Array - - - - - --

                                                                                                                                                    An array containing the range label, HTML content, and a tooltip title.

                                                                                                                                                    - - - - - -
                                                                                                                                                    - - - - - -
                                                                                                                                                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                    - - - - -
                                                                                                                                                    - - - - -
                                                                                                                                                    - -

                                                                                                                                                    - - inner getResonatorDetails(d) → {string} - - - - -

                                                                                                                                                    - - - -
                                                                                                                                                    -
                                                                                                                                                    - - -
                                                                                                                                                    -

                                                                                                                                                    Generates HTML details for resonators deployed on a portal.

                                                                                                                                                    -
                                                                                                                                                    - - - - - - - - - -
                                                                                                                                                    -
                                                                                                                                                    Parameters:
                                                                                                                                                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                    NameTypeDescription
                                                                                                                                                    d - - -Object - - - -

                                                                                                                                                    The portal detail object containing resonator information.

                                                                                                                                                    - -
                                                                                                                                                    - - - - - - - - - - - - - -
                                                                                                                                                    -
                                                                                                                                                    Returns:
                                                                                                                                                    - - - - - -string - - - - - --

                                                                                                                                                    HTML string representing the resonator details of the portal.

                                                                                                                                                    - - - - - -
                                                                                                                                                    - - - - - -
                                                                                                                                                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                    - - - - -
                                                                                                                                                    - - - - -
                                                                                                                                                    - -

                                                                                                                                                    - - inner getResonatorDetails(d) → {string} - - - - -

                                                                                                                                                    - - - -
                                                                                                                                                    -
                                                                                                                                                    - - -
                                                                                                                                                    -

                                                                                                                                                    Generates HTML details for resonators deployed on a portal.

                                                                                                                                                    -
                                                                                                                                                    - - - - - - - - - -
                                                                                                                                                    -
                                                                                                                                                    Parameters:
                                                                                                                                                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                    NameTypeDescription
                                                                                                                                                    d - - -Object - - - -

                                                                                                                                                    The portal detail object containing resonator information.

                                                                                                                                                    + +
                                                                                                                                                    @@ -6510,239 +1722,6 @@
                                                                                                                                                    Returns:
                                                                                                                                                    - - - - - - - - - - -
                                                                                                                                                    - - - - - - - - - -
                                                                                                                                                    - -

                                                                                                                                                    - - inner renderResonatorDetails(slot, level, nrg, nick) → {Array} - - - - -

                                                                                                                                                    - - - -
                                                                                                                                                    -
                                                                                                                                                    - - -
                                                                                                                                                    -

                                                                                                                                                    Helper function that renders the HTML for a given resonator.

                                                                                                                                                    -
                                                                                                                                                    - - - - - - - - - -
                                                                                                                                                    -
                                                                                                                                                    Parameters:
                                                                                                                                                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                    NameTypeDescription
                                                                                                                                                    slot - - -number - - - -

                                                                                                                                                    The slot number where the resonator is deployed. Starts with 0 (east) and rotates clockwise. -So, last one is 7 (southeast).

                                                                                                                                                    level - - -number - - - -

                                                                                                                                                    The level of the resonator.

                                                                                                                                                    nrg - - -number - - - -

                                                                                                                                                    The energy of the resonator.

                                                                                                                                                    nick - - -string -| - -null - - - -

                                                                                                                                                    The nickname of the owner of the resonator, or null if not applicable.

                                                                                                                                                    - -
                                                                                                                                                    - - - - - - - - - - - - - -
                                                                                                                                                    -
                                                                                                                                                    Returns:
                                                                                                                                                    - - - - - -Array - - - - - --

                                                                                                                                                    An array containing the HTML content of the resonator and the owner's nickname.

                                                                                                                                                    - - - - - -
                                                                                                                                                    - - - - - -
                                                                                                                                                    - - - - - - - - - - - - - - - - - - - - diff --git a/module-portal_highlighter.html b/module-portal_highlighter.html index e08c8c25f..5ca36bb05 100644 --- a/module-portal_highlighter.html +++ b/module-portal_highlighter.html @@ -34,7 +34,7 @@

                                                                                                                                                    IITC-CE

                                                                                                                                                      - +
                                                                                                                                                      @@ -52,8 +52,6 @@

                                                                                                                                                      portal_highlighter

                                                                                                                                                      - - @@ -119,77 +117,6 @@

                                                                                                                                                      portal_highlighter

                                                                                                                                                      - - - - - - - - - - -
                                                                                                                                                      - - - - -
                                                                                                                                                      - - - - -
                                                                                                                                                      - -
                                                                                                                                                      -
                                                                                                                                                      - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                      - - - - - - - - - - - - - - - - - - - - @@ -397,14 +324,14 @@
                                                                                                                                                      Parameters:
                                                                                                                                                      -

                                                                                                                                                      +

                                                                                                                                                      - inner addPortalHighlighter(name, data) + inner changePortalHighlights(name)

                                                                                                                                                      @@ -416,7 +343,7 @@

                                                                                                                                                      -

                                                                                                                                                      Adds a new portal highlighter to map. The highlighter is a function that will be called for each portal.

                                                                                                                                                      +

                                                                                                                                                      Changes the current portal highlights based on the selected highlighter.

                                                                                                                                                      @@ -468,31 +395,7 @@

                                                                                                                                                      Parameters:
                                                                                                                                                      -

                                                                                                                                                      The name of the highlighter.

                                                                                                                                                      - - - - - - - data - - - - - -function - - - - - - - - - -

                                                                                                                                                      The callback function for the highlighter. -This function receives data about the portal and decides how to highlight it.

                                                                                                                                                      +

                                                                                                                                                      The name of the highlighter to be applied.

                                                                                                                                                      @@ -560,14 +463,14 @@
                                                                                                                                                      Parameters:
                                                                                                                                                      -

                                                                                                                                                      +

                                                                                                                                                      - inner changePortalHighlights(name) + inner highlightPortal(p)

                                                                                                                                                      @@ -579,7 +482,8 @@

                                                                                                                                                      -

                                                                                                                                                      Changes the current portal highlights based on the selected highlighter.

                                                                                                                                                      +

                                                                                                                                                      Applies the currently active highlighter to a specific portal. +This function is typically called for each portal on the map.

                                                                                                                                                      @@ -615,13 +519,13 @@

                                                                                                                                                      Parameters:
                                                                                                                                                      - name + p -string +Object @@ -631,7 +535,7 @@
                                                                                                                                                      Parameters:
                                                                                                                                                      -

                                                                                                                                                      The name of the highlighter to be applied.

                                                                                                                                                      +

                                                                                                                                                      The portal object to be highlighted.

                                                                                                                                                      @@ -699,1963 +603,14 @@
                                                                                                                                                      Parameters:
                                                                                                                                                      -

                                                                                                                                                      +

                                                                                                                                                      - inner changePortalHighlights(name) + inner resetHighlightedPortals() - -

                                                                                                                                                      - - - -
                                                                                                                                                      -
                                                                                                                                                      - - -
                                                                                                                                                      -

                                                                                                                                                      Changes the current portal highlights based on the selected highlighter.

                                                                                                                                                      -
                                                                                                                                                      - - - - - - - - - -
                                                                                                                                                      -
                                                                                                                                                      Parameters:
                                                                                                                                                      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                      NameTypeDescription
                                                                                                                                                      name - - -string - - - -

                                                                                                                                                      The name of the highlighter to be applied.

                                                                                                                                                      - -
                                                                                                                                                      - - - - - - - - - - - - - - - - - -
                                                                                                                                                      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                      - - - - -
                                                                                                                                                      - - - - -
                                                                                                                                                      - -

                                                                                                                                                      - - inner highlightPortal(p) - - - - -

                                                                                                                                                      - - - -
                                                                                                                                                      -
                                                                                                                                                      - - -
                                                                                                                                                      -

                                                                                                                                                      Applies the currently active highlighter to a specific portal. -This function is typically called for each portal on the map.

                                                                                                                                                      -
                                                                                                                                                      - - - - - - - - - -
                                                                                                                                                      -
                                                                                                                                                      Parameters:
                                                                                                                                                      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                      NameTypeDescription
                                                                                                                                                      p - - -Object - - - -

                                                                                                                                                      The portal object to be highlighted.

                                                                                                                                                      - -
                                                                                                                                                      - - - - - - - - - - - - - - - - - -
                                                                                                                                                      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                      - - - - -
                                                                                                                                                      - - - - -
                                                                                                                                                      - -

                                                                                                                                                      - - inner highlightPortal(p) - - - - -

                                                                                                                                                      - - - -
                                                                                                                                                      -
                                                                                                                                                      - - -
                                                                                                                                                      -

                                                                                                                                                      Applies the currently active highlighter to a specific portal. -This function is typically called for each portal on the map.

                                                                                                                                                      -
                                                                                                                                                      - - - - - - - - - -
                                                                                                                                                      -
                                                                                                                                                      Parameters:
                                                                                                                                                      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                      NameTypeDescription
                                                                                                                                                      p - - -Object - - - -

                                                                                                                                                      The portal object to be highlighted.

                                                                                                                                                      - -
                                                                                                                                                      - - - - - - - - - - - - - - - - - -
                                                                                                                                                      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                      - - - - -
                                                                                                                                                      - - - - -
                                                                                                                                                      - -

                                                                                                                                                      - - inner resetHighlightedPortals() - - - - -

                                                                                                                                                      - - - -
                                                                                                                                                      -
                                                                                                                                                      - - -
                                                                                                                                                      -

                                                                                                                                                      Resets the highlighting of all portals, returning them to their default style.

                                                                                                                                                      -
                                                                                                                                                      - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                      - - - - -
                                                                                                                                                      - - - - -
                                                                                                                                                      - -

                                                                                                                                                      - - inner resetHighlightedPortals() - - - - -

                                                                                                                                                      - - - -
                                                                                                                                                      -
                                                                                                                                                      - - -
                                                                                                                                                      -

                                                                                                                                                      Resets the highlighting of all portals, returning them to their default style.

                                                                                                                                                      -
                                                                                                                                                      - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                      - - - - -
                                                                                                                                                      - - - - -
                                                                                                                                                      - -

                                                                                                                                                      - - inner updatePortalHighlighterControl() - - - - -

                                                                                                                                                      - - - -
                                                                                                                                                      -
                                                                                                                                                      - - -
                                                                                                                                                      -

                                                                                                                                                      Updates the portal highlighter dropdown list, recreating the dropdown list of available highlighters.

                                                                                                                                                      -
                                                                                                                                                      - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                      - - - - -
                                                                                                                                                      - - - - -
                                                                                                                                                      - -

                                                                                                                                                      - - inner updatePortalHighlighterControl() - - - - -

                                                                                                                                                      - - - -
                                                                                                                                                      -
                                                                                                                                                      - - -
                                                                                                                                                      -

                                                                                                                                                      Updates the portal highlighter dropdown list, recreating the dropdown list of available highlighters.

                                                                                                                                                      -
                                                                                                                                                      - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                      - - - - -
                                                                                                                                                      - -
                                                                                                                                                      - - - - - -
                                                                                                                                                      - -
                                                                                                                                                      - - - - - - - -
                                                                                                                                                      - -
                                                                                                                                                      - -

                                                                                                                                                      portal_highlighter

                                                                                                                                                      - - - - - - -
                                                                                                                                                      - -
                                                                                                                                                      - -
                                                                                                                                                      - - -

                                                                                                                                                      These functions handle portal highlighters

                                                                                                                                                      - - - - - -
                                                                                                                                                      - -
                                                                                                                                                      -
                                                                                                                                                      - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                      - - - - -
                                                                                                                                                      - - - - -
                                                                                                                                                      - -
                                                                                                                                                      -
                                                                                                                                                      - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                      - - - - -
                                                                                                                                                      - - - -
                                                                                                                                                      - - - - - - - - - - - - - - - - - -

                                                                                                                                                      Methods

                                                                                                                                                      - -
                                                                                                                                                      - - -
                                                                                                                                                      - -

                                                                                                                                                      - - inner addPortalHighlighter(name, data) - - - - -

                                                                                                                                                      - - - -
                                                                                                                                                      -
                                                                                                                                                      - - -
                                                                                                                                                      -

                                                                                                                                                      Adds a new portal highlighter to map. The highlighter is a function that will be called for each portal.

                                                                                                                                                      -
                                                                                                                                                      - - - - - - - - - -
                                                                                                                                                      -
                                                                                                                                                      Parameters:
                                                                                                                                                      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                      NameTypeDescription
                                                                                                                                                      name - - -string - - - -

                                                                                                                                                      The name of the highlighter.

                                                                                                                                                      data - - -function - - - -

                                                                                                                                                      The callback function for the highlighter. -This function receives data about the portal and decides how to highlight it.

                                                                                                                                                      - -
                                                                                                                                                      - - - - - - - - - - - - - - - - - -
                                                                                                                                                      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                      - - - - -
                                                                                                                                                      - - - - -
                                                                                                                                                      - -

                                                                                                                                                      - - inner addPortalHighlighter(name, data) - - - - -

                                                                                                                                                      - - - -
                                                                                                                                                      -
                                                                                                                                                      - - -
                                                                                                                                                      -

                                                                                                                                                      Adds a new portal highlighter to map. The highlighter is a function that will be called for each portal.

                                                                                                                                                      -
                                                                                                                                                      - - - - - - - - - -
                                                                                                                                                      -
                                                                                                                                                      Parameters:
                                                                                                                                                      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                      NameTypeDescription
                                                                                                                                                      name - - -string - - - -

                                                                                                                                                      The name of the highlighter.

                                                                                                                                                      data - - -function - - - -

                                                                                                                                                      The callback function for the highlighter. -This function receives data about the portal and decides how to highlight it.

                                                                                                                                                      - -
                                                                                                                                                      - - - - - - - - - - - - - - - - - -
                                                                                                                                                      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                      - - - - -
                                                                                                                                                      - - - - -
                                                                                                                                                      - -

                                                                                                                                                      - - inner changePortalHighlights(name) - - - - -

                                                                                                                                                      - - - -
                                                                                                                                                      -
                                                                                                                                                      - - -
                                                                                                                                                      -

                                                                                                                                                      Changes the current portal highlights based on the selected highlighter.

                                                                                                                                                      -
                                                                                                                                                      - - - - - - - - - -
                                                                                                                                                      -
                                                                                                                                                      Parameters:
                                                                                                                                                      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                      NameTypeDescription
                                                                                                                                                      name - - -string - - - -

                                                                                                                                                      The name of the highlighter to be applied.

                                                                                                                                                      - -
                                                                                                                                                      - - - - - - - - - - - - - - - - - -
                                                                                                                                                      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                      - - - - -
                                                                                                                                                      - - - - -
                                                                                                                                                      - -

                                                                                                                                                      - - inner changePortalHighlights(name) - - - - -

                                                                                                                                                      - - - -
                                                                                                                                                      -
                                                                                                                                                      - - -
                                                                                                                                                      -

                                                                                                                                                      Changes the current portal highlights based on the selected highlighter.

                                                                                                                                                      -
                                                                                                                                                      - - - - - - - - - -
                                                                                                                                                      -
                                                                                                                                                      Parameters:
                                                                                                                                                      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                      NameTypeDescription
                                                                                                                                                      name - - -string - - - -

                                                                                                                                                      The name of the highlighter to be applied.

                                                                                                                                                      - -
                                                                                                                                                      - - - - - - - - - - - - - - - - - -
                                                                                                                                                      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                      - - - - -
                                                                                                                                                      - - - - -
                                                                                                                                                      - -

                                                                                                                                                      - - inner highlightPortal(p) - - - - -

                                                                                                                                                      - - - -
                                                                                                                                                      -
                                                                                                                                                      - - -
                                                                                                                                                      -

                                                                                                                                                      Applies the currently active highlighter to a specific portal. -This function is typically called for each portal on the map.

                                                                                                                                                      -
                                                                                                                                                      - - - - - - - - - -
                                                                                                                                                      -
                                                                                                                                                      Parameters:
                                                                                                                                                      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                      NameTypeDescription
                                                                                                                                                      p - - -Object - - - -

                                                                                                                                                      The portal object to be highlighted.

                                                                                                                                                      - -
                                                                                                                                                      - - - - - - - - - - - - - - - - - -
                                                                                                                                                      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                      - - - - -
                                                                                                                                                      - - - - -
                                                                                                                                                      - -

                                                                                                                                                      - - inner highlightPortal(p) - - - - -

                                                                                                                                                      - - - -
                                                                                                                                                      -
                                                                                                                                                      - - -
                                                                                                                                                      -

                                                                                                                                                      Applies the currently active highlighter to a specific portal. -This function is typically called for each portal on the map.

                                                                                                                                                      -
                                                                                                                                                      - - - - - - - - - -
                                                                                                                                                      -
                                                                                                                                                      Parameters:
                                                                                                                                                      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                      NameTypeDescription
                                                                                                                                                      p - - -Object - - - -

                                                                                                                                                      The portal object to be highlighted.

                                                                                                                                                      - -
                                                                                                                                                      - - - - - - - - - - - - - - - - - -
                                                                                                                                                      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                      - - - - -
                                                                                                                                                      - - - - -
                                                                                                                                                      - -

                                                                                                                                                      - - inner resetHighlightedPortals() - - - - -

                                                                                                                                                      - - - -
                                                                                                                                                      -
                                                                                                                                                      - - -
                                                                                                                                                      -

                                                                                                                                                      Resets the highlighting of all portals, returning them to their default style.

                                                                                                                                                      -
                                                                                                                                                      - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                      - - - - -
                                                                                                                                                      - - - - -
                                                                                                                                                      - -

                                                                                                                                                      - - inner resetHighlightedPortals() - - -

                                                                                                                                                      @@ -2804,95 +759,6 @@

                                                                                                                                                      - - - - - - - - - - -

                                                                                                                                                      - - - - - - - - - -
                                                                                                                                                      - -

                                                                                                                                                      - - inner updatePortalHighlighterControl() - - - - -

                                                                                                                                                      - - - -
                                                                                                                                                      -
                                                                                                                                                      - - -
                                                                                                                                                      -

                                                                                                                                                      Updates the portal highlighter dropdown list, recreating the dropdown list of available highlighters.

                                                                                                                                                      -
                                                                                                                                                      - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                      - - - - - - - - - - - - - - - - - - - - diff --git a/module-portal_info.html b/module-portal_info.html index 7a3f89534..5f7bba191 100644 --- a/module-portal_info.html +++ b/module-portal_info.html @@ -34,7 +34,7 @@

                                                                                                                                                      IITC-CE

                                                                                                                                                        - +
                                                                                                                                                        @@ -52,8213 +52,27 @@

                                                                                                                                                        portal_info

                                                                                                                                                        - - - - - -
                                                                                                                                                        - -
                                                                                                                                                        - - -

                                                                                                                                                        This file contains functions that handle the extraction and computation of raw data -from portal details for various purposes.

                                                                                                                                                        - - - - - -
                                                                                                                                                        - -
                                                                                                                                                        -
                                                                                                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                        - - - - -
                                                                                                                                                        - - - - -
                                                                                                                                                        - -
                                                                                                                                                        -
                                                                                                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                        - - - - -
                                                                                                                                                        - - - -
                                                                                                                                                        - - - - - - - - - - - - - - - - - -

                                                                                                                                                        Methods

                                                                                                                                                        - -
                                                                                                                                                        - - -
                                                                                                                                                        - -

                                                                                                                                                        - - inner fixPortalImageUrl(url) → {string} - - - - -

                                                                                                                                                        - - - -
                                                                                                                                                        -
                                                                                                                                                        - - -
                                                                                                                                                        -

                                                                                                                                                        Corrects the portal image URL to match the current protocol (http/https).

                                                                                                                                                        -
                                                                                                                                                        - - - - - - - - - -
                                                                                                                                                        -
                                                                                                                                                        Parameters:
                                                                                                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                        NameTypeDescription
                                                                                                                                                        url - - -string - - - -

                                                                                                                                                        The original image URL.

                                                                                                                                                        - -
                                                                                                                                                        - - - - - - - - - - - - - -
                                                                                                                                                        -
                                                                                                                                                        Returns:
                                                                                                                                                        - - - - - -string - - - - - --

                                                                                                                                                        The corrected image URL.

                                                                                                                                                        - - - - - -
                                                                                                                                                        - - - - - -
                                                                                                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                        - - - - -
                                                                                                                                                        - - - - -
                                                                                                                                                        - -

                                                                                                                                                        - - inner fixPortalImageUrl(url) → {string} - - - - -

                                                                                                                                                        - - - -
                                                                                                                                                        -
                                                                                                                                                        - - -
                                                                                                                                                        -

                                                                                                                                                        Corrects the portal image URL to match the current protocol (http/https).

                                                                                                                                                        -
                                                                                                                                                        - - - - - - - - - -
                                                                                                                                                        -
                                                                                                                                                        Parameters:
                                                                                                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                        NameTypeDescription
                                                                                                                                                        url - - -string - - - -

                                                                                                                                                        The original image URL.

                                                                                                                                                        - -
                                                                                                                                                        - - - - - - - - - - - - - -
                                                                                                                                                        -
                                                                                                                                                        Returns:
                                                                                                                                                        - - - - - -string - - - - - --

                                                                                                                                                        The corrected image URL.

                                                                                                                                                        - - - - - -
                                                                                                                                                        - - - - - -
                                                                                                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                        - - - - -
                                                                                                                                                        - - - - -
                                                                                                                                                        - -

                                                                                                                                                        - - inner getAttackApGain(d, fieldCount, linkCount) → {Object} - - - - -

                                                                                                                                                        - - - -
                                                                                                                                                        -
                                                                                                                                                        - - -
                                                                                                                                                        -

                                                                                                                                                        Calculates the potential AP gain from attacking a portal.

                                                                                                                                                        -
                                                                                                                                                        - - - - - - - - - -
                                                                                                                                                        -
                                                                                                                                                        Parameters:
                                                                                                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                        NameTypeDescription
                                                                                                                                                        d - - -Object - - - -

                                                                                                                                                        The portal detail object containing resonator and ownership information.

                                                                                                                                                        fieldCount - - -number - - - -

                                                                                                                                                        The number of fields attached to the portal.

                                                                                                                                                        linkCount - - -number - - - -

                                                                                                                                                        The number of links attached to the portal.

                                                                                                                                                        - -
                                                                                                                                                        - - - - - - - - - - - - - -
                                                                                                                                                        -
                                                                                                                                                        Returns:
                                                                                                                                                        - - - - - -Object - - - - - --

                                                                                                                                                        An object detailing various components of AP gain, including totals for friendly and enemy factions.

                                                                                                                                                        - - - - - -
                                                                                                                                                        - - - - - -
                                                                                                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                        - - - - -
                                                                                                                                                        - - - - -
                                                                                                                                                        - -

                                                                                                                                                        - - inner getAttackApGain(d, fieldCount, linkCount) → {Object} - - - - -

                                                                                                                                                        - - - -
                                                                                                                                                        -
                                                                                                                                                        - - -
                                                                                                                                                        -

                                                                                                                                                        Calculates the potential AP gain from attacking a portal.

                                                                                                                                                        -
                                                                                                                                                        - - - - - - - - - -
                                                                                                                                                        -
                                                                                                                                                        Parameters:
                                                                                                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                        NameTypeDescription
                                                                                                                                                        d - - -Object - - - -

                                                                                                                                                        The portal detail object containing resonator and ownership information.

                                                                                                                                                        fieldCount - - -number - - - -

                                                                                                                                                        The number of fields attached to the portal.

                                                                                                                                                        linkCount - - -number - - - -

                                                                                                                                                        The number of links attached to the portal.

                                                                                                                                                        - -
                                                                                                                                                        - - - - - - - - - - - - - -
                                                                                                                                                        -
                                                                                                                                                        Returns:
                                                                                                                                                        - - - - - -Object - - - - - --

                                                                                                                                                        An object detailing various components of AP gain, including totals for friendly and enemy factions.

                                                                                                                                                        - - - - - -
                                                                                                                                                        - - - - - -
                                                                                                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                        - - - - -
                                                                                                                                                        - - - - -
                                                                                                                                                        - -

                                                                                                                                                        - - inner getCurrentPortalEnergy(d) → {number} - - - - -

                                                                                                                                                        - - - -
                                                                                                                                                        -
                                                                                                                                                        - - -
                                                                                                                                                        -

                                                                                                                                                        Calculates the current energy of a portal based on its resonators.

                                                                                                                                                        -
                                                                                                                                                        - - - - - - - - - -
                                                                                                                                                        -
                                                                                                                                                        Parameters:
                                                                                                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                        NameTypeDescription
                                                                                                                                                        d - - -Object - - - -

                                                                                                                                                        The portal detail object containing resonator information.

                                                                                                                                                        - -
                                                                                                                                                        - - - - - - - - - - - - - -
                                                                                                                                                        -
                                                                                                                                                        Returns:
                                                                                                                                                        - - - - - -number - - - - - --

                                                                                                                                                        The current energy of the portal.

                                                                                                                                                        - - - - - -
                                                                                                                                                        - - - - - -
                                                                                                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                        - - - - -
                                                                                                                                                        - - - - -
                                                                                                                                                        - -

                                                                                                                                                        - - inner getCurrentPortalEnergy(d) → {number} - - - - -

                                                                                                                                                        - - - -
                                                                                                                                                        -
                                                                                                                                                        - - -
                                                                                                                                                        -

                                                                                                                                                        Calculates the current energy of a portal based on its resonators.

                                                                                                                                                        -
                                                                                                                                                        - - - - - - - - - -
                                                                                                                                                        -
                                                                                                                                                        Parameters:
                                                                                                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                        NameTypeDescription
                                                                                                                                                        d - - -Object - - - -

                                                                                                                                                        The portal detail object containing resonator information.

                                                                                                                                                        - -
                                                                                                                                                        - - - - - - - - - - - - - -
                                                                                                                                                        -
                                                                                                                                                        Returns:
                                                                                                                                                        - - - - - -number - - - - - --

                                                                                                                                                        The current energy of the portal.

                                                                                                                                                        - - - - - -
                                                                                                                                                        - - - - - -
                                                                                                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                        - - - - -
                                                                                                                                                        - - - - -
                                                                                                                                                        - -

                                                                                                                                                        - - inner getLinkAmpRangeBoost(d) → {number} - - - - -

                                                                                                                                                        - - - -
                                                                                                                                                        -
                                                                                                                                                        - - -
                                                                                                                                                        -

                                                                                                                                                        Calculates the boost in link range provided by installed Link Amps.

                                                                                                                                                        -
                                                                                                                                                        - - - - - - - - - -
                                                                                                                                                        -
                                                                                                                                                        Parameters:
                                                                                                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                        NameTypeDescription
                                                                                                                                                        d - - -Object - - - -

                                                                                                                                                        The portal detail object containing mod information.

                                                                                                                                                        - -
                                                                                                                                                        - - - - - - - - - - - - - -
                                                                                                                                                        -
                                                                                                                                                        Returns:
                                                                                                                                                        - - - - - -number - - - - - --

                                                                                                                                                        The total boost factor for the link range.

                                                                                                                                                        - - - - - -
                                                                                                                                                        - - - - - -
                                                                                                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                        - - - - -
                                                                                                                                                        - - - - -
                                                                                                                                                        - -

                                                                                                                                                        - - inner getLinkAmpRangeBoost(d) → {number} - - - - -

                                                                                                                                                        - - - -
                                                                                                                                                        -
                                                                                                                                                        - - -
                                                                                                                                                        -

                                                                                                                                                        Calculates the boost in link range provided by installed Link Amps.

                                                                                                                                                        -
                                                                                                                                                        - - - - - - - - - -
                                                                                                                                                        -
                                                                                                                                                        Parameters:
                                                                                                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                        NameTypeDescription
                                                                                                                                                        d - - -Object - - - -

                                                                                                                                                        The portal detail object containing mod information.

                                                                                                                                                        - -
                                                                                                                                                        - - - - - - - - - - - - - -
                                                                                                                                                        -
                                                                                                                                                        Returns:
                                                                                                                                                        - - - - - -number - - - - - --

                                                                                                                                                        The total boost factor for the link range.

                                                                                                                                                        - - - - - -
                                                                                                                                                        - - - - - -
                                                                                                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                        - - - - -
                                                                                                                                                        - - - - -
                                                                                                                                                        - - - - - -
                                                                                                                                                        -
                                                                                                                                                        - - -
                                                                                                                                                        -

                                                                                                                                                        Calculates the maximum number of outgoing links that can be created from a portal.

                                                                                                                                                        -
                                                                                                                                                        - - - - - - - - - -
                                                                                                                                                        -
                                                                                                                                                        Parameters:
                                                                                                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                        NameTypeDescription
                                                                                                                                                        d - - -Object - - - -

                                                                                                                                                        The portal detail object containing mod information.

                                                                                                                                                        - -
                                                                                                                                                        - - - - - - - - - - - - - -
                                                                                                                                                        -
                                                                                                                                                        Returns:
                                                                                                                                                        - - - - - -number - - - - - --

                                                                                                                                                        The maximum number of outgoing links.

                                                                                                                                                        - - - - - -
                                                                                                                                                        - - - - - -
                                                                                                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                        - - - - -
                                                                                                                                                        - - - - -
                                                                                                                                                        - - - - - -
                                                                                                                                                        -
                                                                                                                                                        - - -
                                                                                                                                                        -

                                                                                                                                                        Calculates the maximum number of outgoing links that can be created from a portal.

                                                                                                                                                        -
                                                                                                                                                        - - - - - - - - - -
                                                                                                                                                        -
                                                                                                                                                        Parameters:
                                                                                                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                        NameTypeDescription
                                                                                                                                                        d - - -Object - - - -

                                                                                                                                                        The portal detail object containing mod information.

                                                                                                                                                        - -
                                                                                                                                                        - - - - - - - - - - - - - -
                                                                                                                                                        -
                                                                                                                                                        Returns:
                                                                                                                                                        - - - - - -number - - - - - --

                                                                                                                                                        The maximum number of outgoing links.

                                                                                                                                                        - - - - - -
                                                                                                                                                        - - - - - -
                                                                                                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                        - - - - -
                                                                                                                                                        - - - - -
                                                                                                                                                        - -

                                                                                                                                                        - - inner getPortalAttackValues(d) → {Object} - - - - -

                                                                                                                                                        - - - -
                                                                                                                                                        -
                                                                                                                                                        - - -
                                                                                                                                                        -

                                                                                                                                                        Calculates various attack values of a portal, including hit bonus, force amplifier, and attack frequency.

                                                                                                                                                        -
                                                                                                                                                        - - - - - - - - - -
                                                                                                                                                        -
                                                                                                                                                        Parameters:
                                                                                                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                        NameTypeDescription
                                                                                                                                                        d - - -Object - - - -

                                                                                                                                                        The portal detail object containing mod information.

                                                                                                                                                        - -
                                                                                                                                                        - - - - - - - - - - - - - -
                                                                                                                                                        -
                                                                                                                                                        Returns:
                                                                                                                                                        - - - - - -Object - - - - - --

                                                                                                                                                        An object containing attack values such as hit bonus, force amplifier, and attack frequency.

                                                                                                                                                        - - - - - -
                                                                                                                                                        - - - - - -
                                                                                                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                        - - - - -
                                                                                                                                                        - - - - -
                                                                                                                                                        - -

                                                                                                                                                        - - inner getPortalAttackValues(d) → {Object} - - - - -

                                                                                                                                                        - - - -
                                                                                                                                                        -
                                                                                                                                                        - - -
                                                                                                                                                        -

                                                                                                                                                        Calculates various attack values of a portal, including hit bonus, force amplifier, and attack frequency.

                                                                                                                                                        -
                                                                                                                                                        - - - - - - - - - -
                                                                                                                                                        -
                                                                                                                                                        Parameters:
                                                                                                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                        NameTypeDescription
                                                                                                                                                        d - - -Object - - - -

                                                                                                                                                        The portal detail object containing mod information.

                                                                                                                                                        - -
                                                                                                                                                        - - - - - - - - - - - - - -
                                                                                                                                                        -
                                                                                                                                                        Returns:
                                                                                                                                                        - - - - - -Object - - - - - --

                                                                                                                                                        An object containing attack values such as hit bonus, force amplifier, and attack frequency.

                                                                                                                                                        - - - - - -
                                                                                                                                                        - - - - - -
                                                                                                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                        - - - - -
                                                                                                                                                        - - - - -
                                                                                                                                                        - -

                                                                                                                                                        - - inner getPortalHackDetails(d) → {Object} - - - - -

                                                                                                                                                        - - - -
                                                                                                                                                        -
                                                                                                                                                        - - -
                                                                                                                                                        -

                                                                                                                                                        Calculates hack-related details of a portal, such as hack cooldown and burnout time.

                                                                                                                                                        -
                                                                                                                                                        - - - - - - - - - -
                                                                                                                                                        -
                                                                                                                                                        Parameters:
                                                                                                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                        NameTypeDescription
                                                                                                                                                        d - - -Object - - - -

                                                                                                                                                        The portal detail object containing mod information.

                                                                                                                                                        - -
                                                                                                                                                        - - - - - - - - - - - - - -
                                                                                                                                                        -
                                                                                                                                                        Returns:
                                                                                                                                                        - - - - - -Object - - - - - --

                                                                                                                                                        An object containing hack-related details like cooldown time, hack count, and burnout time.

                                                                                                                                                        - - - - - -
                                                                                                                                                        - - - - - -
                                                                                                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                        - - - - -
                                                                                                                                                        - - - - -
                                                                                                                                                        - -

                                                                                                                                                        - - inner getPortalHackDetails(d) → {Object} - - - - -

                                                                                                                                                        - - - -
                                                                                                                                                        -
                                                                                                                                                        - - -
                                                                                                                                                        -

                                                                                                                                                        Calculates hack-related details of a portal, such as hack cooldown and burnout time.

                                                                                                                                                        -
                                                                                                                                                        - - - - - - - - - -
                                                                                                                                                        -
                                                                                                                                                        Parameters:
                                                                                                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                        NameTypeDescription
                                                                                                                                                        d - - -Object - - - -

                                                                                                                                                        The portal detail object containing mod information.

                                                                                                                                                        - -
                                                                                                                                                        - - - - - - - - - - - - - -
                                                                                                                                                        -
                                                                                                                                                        Returns:
                                                                                                                                                        - - - - - -Object - - - - - --

                                                                                                                                                        An object containing hack-related details like cooldown time, hack count, and burnout time.

                                                                                                                                                        - - - - - -
                                                                                                                                                        - - - - - -
                                                                                                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                        - - - - -
                                                                                                                                                        - - - - -
                                                                                                                                                        - -

                                                                                                                                                        - - inner getPortalLevel(d) → {number} - - - - -

                                                                                                                                                        - - - -
                                                                                                                                                        -
                                                                                                                                                        - - -
                                                                                                                                                        -

                                                                                                                                                        Calculates the displayed level of a portal, which is always rounded down from the actual float value.

                                                                                                                                                        -
                                                                                                                                                        - - - - - - - - - -
                                                                                                                                                        -
                                                                                                                                                        Parameters:
                                                                                                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                        NameTypeDescription
                                                                                                                                                        d - - -Object - - - -

                                                                                                                                                        The portal detail object containing resonator information.

                                                                                                                                                        - -
                                                                                                                                                        - - - - - - - - - - - - - -
                                                                                                                                                        -
                                                                                                                                                        Returns:
                                                                                                                                                        - - - - - -number - - - - - --

                                                                                                                                                        The calculated portal level.

                                                                                                                                                        - - - - - -
                                                                                                                                                        - - - - - -
                                                                                                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                        - - - - -
                                                                                                                                                        - - - - -
                                                                                                                                                        - -

                                                                                                                                                        - - inner getPortalLevel(d) → {number} - - - - -

                                                                                                                                                        - - - -
                                                                                                                                                        -
                                                                                                                                                        - - -
                                                                                                                                                        -

                                                                                                                                                        Calculates the displayed level of a portal, which is always rounded down from the actual float value.

                                                                                                                                                        -
                                                                                                                                                        - - - - - - - - - -
                                                                                                                                                        -
                                                                                                                                                        Parameters:
                                                                                                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                        NameTypeDescription
                                                                                                                                                        d - - -Object - - - -

                                                                                                                                                        The portal detail object containing resonator information.

                                                                                                                                                        - -
                                                                                                                                                        - - - - - - - - - - - - - -
                                                                                                                                                        -
                                                                                                                                                        Returns:
                                                                                                                                                        - - - - - -number - - - - - --

                                                                                                                                                        The calculated portal level.

                                                                                                                                                        - - - - - -
                                                                                                                                                        - - - - - -
                                                                                                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                        - - - - -
                                                                                                                                                        - - - - -
                                                                                                                                                        - -

                                                                                                                                                        - - inner getPortalLinkDefenseBoost(d) → {number} - - - - -

                                                                                                                                                        - - - -
                                                                                                                                                        -
                                                                                                                                                        - - -
                                                                                                                                                        -

                                                                                                                                                        Calculates the link defense boost provided by installed Ultra Link Amps.

                                                                                                                                                        -
                                                                                                                                                        - - - - - - - - - -
                                                                                                                                                        -
                                                                                                                                                        Parameters:
                                                                                                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                        NameTypeDescription
                                                                                                                                                        d - - -Object - - - -

                                                                                                                                                        The portal detail object containing mod information.

                                                                                                                                                        - -
                                                                                                                                                        - - - - - - - - - - - - - -
                                                                                                                                                        -
                                                                                                                                                        Returns:
                                                                                                                                                        - - - - - -number - - - - - --

                                                                                                                                                        The total link defense boost factor.

                                                                                                                                                        - - - - - -
                                                                                                                                                        - - - - - -
                                                                                                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                        - - - - -
                                                                                                                                                        - - - - -
                                                                                                                                                        - -

                                                                                                                                                        - - inner getPortalLinkDefenseBoost(d) → {number} - - - - -

                                                                                                                                                        - - - -
                                                                                                                                                        -
                                                                                                                                                        - - -
                                                                                                                                                        -

                                                                                                                                                        Calculates the link defense boost provided by installed Ultra Link Amps.

                                                                                                                                                        -
                                                                                                                                                        - - - - - - - - - -
                                                                                                                                                        -
                                                                                                                                                        Parameters:
                                                                                                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                        NameTypeDescription
                                                                                                                                                        d - - -Object - - - -

                                                                                                                                                        The portal detail object containing mod information.

                                                                                                                                                        - -
                                                                                                                                                        - - - - - - - - - - - - - -
                                                                                                                                                        -
                                                                                                                                                        Returns:
                                                                                                                                                        - - - - - -number - - - - - --

                                                                                                                                                        The total link defense boost factor.

                                                                                                                                                        - - - - - -
                                                                                                                                                        - - - - - -
                                                                                                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                        - - - - -
                                                                                                                                                        - - - - -
                                                                                                                                                        - -

                                                                                                                                                        - - inner getPortalLinksMitigation(linkCount) → {number} - - - - -

                                                                                                                                                        - - - -
                                                                                                                                                        -
                                                                                                                                                        - - -
                                                                                                                                                        -

                                                                                                                                                        Calculates the additional mitigation provided by links attached to a portal.

                                                                                                                                                        -
                                                                                                                                                        - - - - - - - - - -
                                                                                                                                                        -
                                                                                                                                                        Parameters:
                                                                                                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                        NameTypeDescription
                                                                                                                                                        linkCount - - -number - - - -

                                                                                                                                                        The number of links attached to the portal.

                                                                                                                                                        - -
                                                                                                                                                        - - - - - - - - - - - - - -
                                                                                                                                                        -
                                                                                                                                                        Returns:
                                                                                                                                                        - - - - - -number - - - - - --

                                                                                                                                                        The additional mitigation value provided by the links.

                                                                                                                                                        - - - - - -
                                                                                                                                                        - - - - - -
                                                                                                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                        - - - - -
                                                                                                                                                        - - - - -
                                                                                                                                                        - -

                                                                                                                                                        - - inner getPortalLinksMitigation(linkCount) → {number} - - - - -

                                                                                                                                                        - - - -
                                                                                                                                                        -
                                                                                                                                                        - - -
                                                                                                                                                        -

                                                                                                                                                        Calculates the additional mitigation provided by links attached to a portal.

                                                                                                                                                        -
                                                                                                                                                        - - - - - - - - - -
                                                                                                                                                        -
                                                                                                                                                        Parameters:
                                                                                                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                        NameTypeDescription
                                                                                                                                                        linkCount - - -number - - - -

                                                                                                                                                        The number of links attached to the portal.

                                                                                                                                                        - -
                                                                                                                                                        - - - - - - - - - - - - - -
                                                                                                                                                        -
                                                                                                                                                        Returns:
                                                                                                                                                        - - - - - -number - - - - - --

                                                                                                                                                        The additional mitigation value provided by the links.

                                                                                                                                                        - - - - - -
                                                                                                                                                        - - - - - -
                                                                                                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                        - - - - -
                                                                                                                                                        - - - - -
                                                                                                                                                        - -

                                                                                                                                                        - - inner getPortalMitigationDetails(d, linkCount) → {Object} - - - - -

                                                                                                                                                        - - - -
                                                                                                                                                        -
                                                                                                                                                        - - -
                                                                                                                                                        -

                                                                                                                                                        Calculates detailed mitigation information for a portal, including contributions from shields and links.

                                                                                                                                                        -
                                                                                                                                                        - - - - - - - - - -
                                                                                                                                                        -
                                                                                                                                                        Parameters:
                                                                                                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                        NameTypeDescription
                                                                                                                                                        d - - -Object - - - -

                                                                                                                                                        The portal detail object containing mod and resonator information.

                                                                                                                                                        linkCount - - -number - - - -

                                                                                                                                                        The number of links attached to the portal.

                                                                                                                                                        - -
                                                                                                                                                        - - - - - - - - - - - - - -
                                                                                                                                                        -
                                                                                                                                                        Returns:
                                                                                                                                                        - - - - - -Object - - - - - --

                                                                                                                                                        An object detailing various components of mitigation.

                                                                                                                                                        - - - - - -
                                                                                                                                                        - - - - - -
                                                                                                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                        - - - - -
                                                                                                                                                        - - - - -
                                                                                                                                                        - -

                                                                                                                                                        - - inner getPortalMitigationDetails(d, linkCount) → {Object} - - - - -

                                                                                                                                                        - - - -
                                                                                                                                                        -
                                                                                                                                                        - - -
                                                                                                                                                        -

                                                                                                                                                        Calculates detailed mitigation information for a portal, including contributions from shields and links.

                                                                                                                                                        -
                                                                                                                                                        - - - - - - - - - -
                                                                                                                                                        -
                                                                                                                                                        Parameters:
                                                                                                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                        NameTypeDescription
                                                                                                                                                        d - - -Object - - - -

                                                                                                                                                        The portal detail object containing mod and resonator information.

                                                                                                                                                        linkCount - - -number - - - -

                                                                                                                                                        The number of links attached to the portal.

                                                                                                                                                        - -
                                                                                                                                                        - - - - - - - - - - - - - -
                                                                                                                                                        -
                                                                                                                                                        Returns:
                                                                                                                                                        - - - - - -Object - - - - - --

                                                                                                                                                        An object detailing various components of mitigation.

                                                                                                                                                        - - - - - -
                                                                                                                                                        - - - - - -
                                                                                                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                        - - - - -
                                                                                                                                                        - - - - -
                                                                                                                                                        - -

                                                                                                                                                        - - inner getPortalModsByType(d, type) → {Array} - - - - -

                                                                                                                                                        - - - -
                                                                                                                                                        -
                                                                                                                                                        - - -
                                                                                                                                                        -

                                                                                                                                                        Returns a list of portal mods filtered by a specific type.

                                                                                                                                                        -
                                                                                                                                                        - - - - - - - - - -
                                                                                                                                                        -
                                                                                                                                                        Parameters:
                                                                                                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                        NameTypeDescription
                                                                                                                                                        d - - -Object - - - -

                                                                                                                                                        The portal detail object containing mod information.

                                                                                                                                                        type - - -string - - - -

                                                                                                                                                        The type of mods to filter (e.g., 'RES_SHIELD', 'LINK_AMPLIFIER').

                                                                                                                                                        - -
                                                                                                                                                        - - - - - - - - - - - - - -
                                                                                                                                                        -
                                                                                                                                                        Returns:
                                                                                                                                                        - - - - - -Array - - - - - --

                                                                                                                                                        An array of mods matching the specified type.

                                                                                                                                                        - - - - - -
                                                                                                                                                        - - - - - -
                                                                                                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                        - - - - -
                                                                                                                                                        - - - - -
                                                                                                                                                        - -

                                                                                                                                                        - - inner getPortalModsByType(d, type) → {Array} - - - - -

                                                                                                                                                        - - - -
                                                                                                                                                        -
                                                                                                                                                        - - -
                                                                                                                                                        -

                                                                                                                                                        Returns a list of portal mods filtered by a specific type.

                                                                                                                                                        -
                                                                                                                                                        - - - - - - - - - -
                                                                                                                                                        -
                                                                                                                                                        Parameters:
                                                                                                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                        NameTypeDescription
                                                                                                                                                        d - - -Object - - - -

                                                                                                                                                        The portal detail object containing mod information.

                                                                                                                                                        type - - -string - - - -

                                                                                                                                                        The type of mods to filter (e.g., 'RES_SHIELD', 'LINK_AMPLIFIER').

                                                                                                                                                        - -
                                                                                                                                                        - - - - - - - - - - - - - -
                                                                                                                                                        -
                                                                                                                                                        Returns:
                                                                                                                                                        - - - - - -Array - - - - - --

                                                                                                                                                        An array of mods matching the specified type.

                                                                                                                                                        - - - - - -
                                                                                                                                                        - - - - - -
                                                                                                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                        - - - - -
                                                                                                                                                        - - - - -
                                                                                                                                                        - -

                                                                                                                                                        - - inner getPortalRange(d) → {Object} - - - - -

                                                                                                                                                        - - - -
                                                                                                                                                        -
                                                                                                                                                        - - -
                                                                                                                                                        -

                                                                                                                                                        Calculates the range of a portal for creating links. The range depends on portal level and any installed Link Amps.

                                                                                                                                                        -
                                                                                                                                                        - - - - - - - - - -
                                                                                                                                                        -
                                                                                                                                                        Parameters:
                                                                                                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                        NameTypeDescription
                                                                                                                                                        d - - -Object - - - -

                                                                                                                                                        The portal detail object containing details about the team and resonators.

                                                                                                                                                        - -
                                                                                                                                                        - - - - - - - - - - - - - -
                                                                                                                                                        -
                                                                                                                                                        Returns:
                                                                                                                                                        - - - - - -Object - - - - - --

                                                                                                                                                        An object containing the base range (base), boost multiplier (boost), -total range after applying the boost (range), -and a boolean indicating if the portal is linkable (isLinkable).

                                                                                                                                                        - - - - - -
                                                                                                                                                        - - - - - -
                                                                                                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                        - - - - -
                                                                                                                                                        - - - - -
                                                                                                                                                        - -

                                                                                                                                                        - - inner getPortalRange(d) → {Object} - - - - -

                                                                                                                                                        - - - -
                                                                                                                                                        -
                                                                                                                                                        - - -
                                                                                                                                                        -

                                                                                                                                                        Calculates the range of a portal for creating links. The range depends on portal level and any installed Link Amps.

                                                                                                                                                        -
                                                                                                                                                        - - - - - - - - - -
                                                                                                                                                        -
                                                                                                                                                        Parameters:
                                                                                                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                        NameTypeDescription
                                                                                                                                                        d - - -Object - - - -

                                                                                                                                                        The portal detail object containing details about the team and resonators.

                                                                                                                                                        - -
                                                                                                                                                        - - - - - - - - - - - - - -
                                                                                                                                                        -
                                                                                                                                                        Returns:
                                                                                                                                                        - - - - - -Object - - - - - --

                                                                                                                                                        An object containing the base range (base), boost multiplier (boost), -total range after applying the boost (range), -and a boolean indicating if the portal is linkable (isLinkable).

                                                                                                                                                        - - - - - -
                                                                                                                                                        - - - - - -
                                                                                                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                        - - - - -
                                                                                                                                                        - - - - -
                                                                                                                                                        - -

                                                                                                                                                        - - inner getPortalShieldMitigation(d) → {number} - - - - -

                                                                                                                                                        - - - -
                                                                                                                                                        -
                                                                                                                                                        - - -
                                                                                                                                                        -

                                                                                                                                                        Calculates the total mitigation provided by shields installed on a portal.

                                                                                                                                                        -
                                                                                                                                                        - - - - - - - - - -
                                                                                                                                                        -
                                                                                                                                                        Parameters:
                                                                                                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                        NameTypeDescription
                                                                                                                                                        d - - -Object - - - -

                                                                                                                                                        The portal detail object containing mod information.

                                                                                                                                                        - -
                                                                                                                                                        - - - - - - - - - - - - - -
                                                                                                                                                        -
                                                                                                                                                        Returns:
                                                                                                                                                        - - - - - -number - - - - - --

                                                                                                                                                        The total mitigation value from all shields installed on the portal.

                                                                                                                                                        - - - - - -
                                                                                                                                                        - - - - - -
                                                                                                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                        - - - - -
                                                                                                                                                        - - - - -
                                                                                                                                                        - -

                                                                                                                                                        - - inner getPortalShieldMitigation(d) → {number} - - - - -

                                                                                                                                                        - - - -
                                                                                                                                                        -
                                                                                                                                                        - - -
                                                                                                                                                        -

                                                                                                                                                        Calculates the total mitigation provided by shields installed on a portal.

                                                                                                                                                        -
                                                                                                                                                        - - - - - - - - - -
                                                                                                                                                        -
                                                                                                                                                        Parameters:
                                                                                                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                        NameTypeDescription
                                                                                                                                                        d - - -Object - - - -

                                                                                                                                                        The portal detail object containing mod information.

                                                                                                                                                        - -
                                                                                                                                                        - - - - - - - - - - - - - -
                                                                                                                                                        -
                                                                                                                                                        Returns:
                                                                                                                                                        - - - - - -number - - - - - --

                                                                                                                                                        The total mitigation value from all shields installed on the portal.

                                                                                                                                                        - - - - - -
                                                                                                                                                        - - - - - -
                                                                                                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                        - - - - -
                                                                                                                                                        - - - - -
                                                                                                                                                        - -

                                                                                                                                                        - - inner getPortalSummaryData(d) → {Object} - - - - -

                                                                                                                                                        - - - -
                                                                                                                                                        -
                                                                                                                                                        - - -
                                                                                                                                                        -

                                                                                                                                                        Converts detailed portal information into a summary format similar to that seen in the map tile data.

                                                                                                                                                        -
                                                                                                                                                        - - - - - - - - - -
                                                                                                                                                        -
                                                                                                                                                        Parameters:
                                                                                                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                        NameTypeDescription
                                                                                                                                                        d - - -Object - - - -

                                                                                                                                                        The detailed portal data.

                                                                                                                                                        - -
                                                                                                                                                        - - - - - - - - - - - - - -
                                                                                                                                                        -
                                                                                                                                                        Returns:
                                                                                                                                                        - - - - - -Object - - - - - --

                                                                                                                                                        A summary of the portal data, including level, title, image, resonator count, health, and team.

                                                                                                                                                        - - - - - -
                                                                                                                                                        - - - - - -
                                                                                                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                        - - - - -
                                                                                                                                                        - - - - -
                                                                                                                                                        - -

                                                                                                                                                        - - inner getPortalSummaryData(d) → {Object} - - - - -

                                                                                                                                                        - - - -
                                                                                                                                                        -
                                                                                                                                                        - - -
                                                                                                                                                        -

                                                                                                                                                        Converts detailed portal information into a summary format similar to that seen in the map tile data.

                                                                                                                                                        -
                                                                                                                                                        - - - - - - - - - -
                                                                                                                                                        -
                                                                                                                                                        Parameters:
                                                                                                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                        NameTypeDescription
                                                                                                                                                        d - - -Object - - - -

                                                                                                                                                        The detailed portal data.

                                                                                                                                                        - -
                                                                                                                                                        - - - - - - - - - - - - - -
                                                                                                                                                        -
                                                                                                                                                        Returns:
                                                                                                                                                        - - - - - -Object - - - - - --

                                                                                                                                                        A summary of the portal data, including level, title, image, resonator count, health, and team.

                                                                                                                                                        - - - - - -
                                                                                                                                                        - - - - - -
                                                                                                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                        - - - - -
                                                                                                                                                        - - - - -
                                                                                                                                                        - -

                                                                                                                                                        - - inner getTotalPortalEnergy(d) → {number} - - - - -

                                                                                                                                                        - - - -
                                                                                                                                                        -
                                                                                                                                                        - - -
                                                                                                                                                        -

                                                                                                                                                        Calculates the total energy capacity of a portal based on its resonators.

                                                                                                                                                        -
                                                                                                                                                        - - - - - - - - - -
                                                                                                                                                        -
                                                                                                                                                        Parameters:
                                                                                                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                        NameTypeDescription
                                                                                                                                                        d - - -Object - - - -

                                                                                                                                                        The portal detail object containing resonator information.

                                                                                                                                                        - -
                                                                                                                                                        - - - - - - - - - - - - - -
                                                                                                                                                        -
                                                                                                                                                        Returns:
                                                                                                                                                        - - - - - -number - - - - - --

                                                                                                                                                        The total energy capacity of the portal.

                                                                                                                                                        - - - - - -
                                                                                                                                                        - - - - - -
                                                                                                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                        - - - - -
                                                                                                                                                        - - - - -
                                                                                                                                                        - -

                                                                                                                                                        - - inner getTotalPortalEnergy(d) → {number} - - - - -

                                                                                                                                                        - - - -
                                                                                                                                                        -
                                                                                                                                                        - - -
                                                                                                                                                        -

                                                                                                                                                        Calculates the total energy capacity of a portal based on its resonators.

                                                                                                                                                        -
                                                                                                                                                        - - - - - - - - - -
                                                                                                                                                        -
                                                                                                                                                        Parameters:
                                                                                                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                        NameTypeDescription
                                                                                                                                                        d - - -Object - - - -

                                                                                                                                                        The portal detail object containing resonator information.

                                                                                                                                                        - -
                                                                                                                                                        - - - - - - - - - - - - - -
                                                                                                                                                        -
                                                                                                                                                        Returns:
                                                                                                                                                        - - - - - -number - - - - - --

                                                                                                                                                        The total energy capacity of the portal.

                                                                                                                                                        - - - - - -
                                                                                                                                                        - - - - - -
                                                                                                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                        - - - - -
                                                                                                                                                        - -
                                                                                                                                                        - - - - - -
                                                                                                                                                        - -
                                                                                                                                                        - - - - - - - -
                                                                                                                                                        - -
                                                                                                                                                        - -

                                                                                                                                                        portal_info

                                                                                                                                                        - - - - - - -
                                                                                                                                                        - -
                                                                                                                                                        - -
                                                                                                                                                        - - -

                                                                                                                                                        This file contains functions that handle the extraction and computation of raw data -from portal details for various purposes.

                                                                                                                                                        - - - - - -
                                                                                                                                                        - -
                                                                                                                                                        -
                                                                                                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                        - - - - -
                                                                                                                                                        - - - - -
                                                                                                                                                        - -
                                                                                                                                                        -
                                                                                                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                        - - - - -
                                                                                                                                                        - - - -
                                                                                                                                                        - - - - - - - - - - - - - - - - - -

                                                                                                                                                        Methods

                                                                                                                                                        - -
                                                                                                                                                        - - -
                                                                                                                                                        - -

                                                                                                                                                        - - inner fixPortalImageUrl(url) → {string} - - - - -

                                                                                                                                                        - - - -
                                                                                                                                                        -
                                                                                                                                                        - - -
                                                                                                                                                        -

                                                                                                                                                        Corrects the portal image URL to match the current protocol (http/https).

                                                                                                                                                        -
                                                                                                                                                        - - - - - - - - - -
                                                                                                                                                        -
                                                                                                                                                        Parameters:
                                                                                                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                        NameTypeDescription
                                                                                                                                                        url - - -string - - - -

                                                                                                                                                        The original image URL.

                                                                                                                                                        - -
                                                                                                                                                        - - - - - - - - - - - - - -
                                                                                                                                                        -
                                                                                                                                                        Returns:
                                                                                                                                                        - - - - - -string - - - - - --

                                                                                                                                                        The corrected image URL.

                                                                                                                                                        - - - - - -
                                                                                                                                                        - - - - - -
                                                                                                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                        - - - - -
                                                                                                                                                        - - - - -
                                                                                                                                                        - -

                                                                                                                                                        - - inner fixPortalImageUrl(url) → {string} - - - - -

                                                                                                                                                        - - - -
                                                                                                                                                        -
                                                                                                                                                        - - -
                                                                                                                                                        -

                                                                                                                                                        Corrects the portal image URL to match the current protocol (http/https).

                                                                                                                                                        -
                                                                                                                                                        - - - - - - - - - -
                                                                                                                                                        -
                                                                                                                                                        Parameters:
                                                                                                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                        NameTypeDescription
                                                                                                                                                        url - - -string - - - -

                                                                                                                                                        The original image URL.

                                                                                                                                                        - -
                                                                                                                                                        - - - - - - - - - - - - - -
                                                                                                                                                        -
                                                                                                                                                        Returns:
                                                                                                                                                        - - - - - -string - - - - - --

                                                                                                                                                        The corrected image URL.

                                                                                                                                                        - - - - - -
                                                                                                                                                        - - - - - -
                                                                                                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                        - - - - -
                                                                                                                                                        - - - - -
                                                                                                                                                        - -

                                                                                                                                                        - - inner getAttackApGain(d, fieldCount, linkCount) → {Object} - - - - -

                                                                                                                                                        - - - -
                                                                                                                                                        -
                                                                                                                                                        - - -
                                                                                                                                                        -

                                                                                                                                                        Calculates the potential AP gain from attacking a portal.

                                                                                                                                                        -
                                                                                                                                                        - - - - - - - - - -
                                                                                                                                                        -
                                                                                                                                                        Parameters:
                                                                                                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                        NameTypeDescription
                                                                                                                                                        d - - -Object - - - -

                                                                                                                                                        The portal detail object containing resonator and ownership information.

                                                                                                                                                        fieldCount - - -number - - - -

                                                                                                                                                        The number of fields attached to the portal.

                                                                                                                                                        linkCount - - -number - - - -

                                                                                                                                                        The number of links attached to the portal.

                                                                                                                                                        - -
                                                                                                                                                        - - - - - - - - - - - - - -
                                                                                                                                                        -
                                                                                                                                                        Returns:
                                                                                                                                                        - - - - - -Object - - - - - --

                                                                                                                                                        An object detailing various components of AP gain, including totals for friendly and enemy factions.

                                                                                                                                                        - - - - - -
                                                                                                                                                        - - - - - -
                                                                                                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                        - - - - -
                                                                                                                                                        - - - - -
                                                                                                                                                        - -

                                                                                                                                                        - - inner getAttackApGain(d, fieldCount, linkCount) → {Object} - - - - -

                                                                                                                                                        - - - -
                                                                                                                                                        -
                                                                                                                                                        - - -
                                                                                                                                                        -

                                                                                                                                                        Calculates the potential AP gain from attacking a portal.

                                                                                                                                                        -
                                                                                                                                                        - - - - - - - - - -
                                                                                                                                                        -
                                                                                                                                                        Parameters:
                                                                                                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                        NameTypeDescription
                                                                                                                                                        d - - -Object - - - -

                                                                                                                                                        The portal detail object containing resonator and ownership information.

                                                                                                                                                        fieldCount - - -number - - - -

                                                                                                                                                        The number of fields attached to the portal.

                                                                                                                                                        linkCount - - -number - - - -

                                                                                                                                                        The number of links attached to the portal.

                                                                                                                                                        - -
                                                                                                                                                        - - - - - - - - - - - - - -
                                                                                                                                                        -
                                                                                                                                                        Returns:
                                                                                                                                                        - - - - - -Object - - - - - --

                                                                                                                                                        An object detailing various components of AP gain, including totals for friendly and enemy factions.

                                                                                                                                                        - - - - - -
                                                                                                                                                        - - - - - -
                                                                                                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                        - - - - -
                                                                                                                                                        - - - - -
                                                                                                                                                        - -

                                                                                                                                                        - - inner getCurrentPortalEnergy(d) → {number} - - - - -

                                                                                                                                                        - - - -
                                                                                                                                                        -
                                                                                                                                                        - - -
                                                                                                                                                        -

                                                                                                                                                        Calculates the current energy of a portal based on its resonators.

                                                                                                                                                        -
                                                                                                                                                        - - - - - - - - - -
                                                                                                                                                        -
                                                                                                                                                        Parameters:
                                                                                                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                        NameTypeDescription
                                                                                                                                                        d - - -Object - - - -

                                                                                                                                                        The portal detail object containing resonator information.

                                                                                                                                                        - -
                                                                                                                                                        - - - - - - - - - - - - - -
                                                                                                                                                        -
                                                                                                                                                        Returns:
                                                                                                                                                        - - - - - -number - - - - - --

                                                                                                                                                        The current energy of the portal.

                                                                                                                                                        - - - - - -
                                                                                                                                                        - - - - - -
                                                                                                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                        - - - - -
                                                                                                                                                        - - - - -
                                                                                                                                                        - -

                                                                                                                                                        - - inner getCurrentPortalEnergy(d) → {number} - - - - -

                                                                                                                                                        - - - -
                                                                                                                                                        -
                                                                                                                                                        - - -
                                                                                                                                                        -

                                                                                                                                                        Calculates the current energy of a portal based on its resonators.

                                                                                                                                                        -
                                                                                                                                                        - - - - - - - - - -
                                                                                                                                                        -
                                                                                                                                                        Parameters:
                                                                                                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                        NameTypeDescription
                                                                                                                                                        d - - -Object - - - -

                                                                                                                                                        The portal detail object containing resonator information.

                                                                                                                                                        - -
                                                                                                                                                        - - - - - - - - - - - - - -
                                                                                                                                                        -
                                                                                                                                                        Returns:
                                                                                                                                                        - - - - - -number - - - - - --

                                                                                                                                                        The current energy of the portal.

                                                                                                                                                        - - - - - -
                                                                                                                                                        - - - - - -
                                                                                                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                        - - - - -
                                                                                                                                                        - - - - -
                                                                                                                                                        - -

                                                                                                                                                        - - inner getLinkAmpRangeBoost(d) → {number} - - - - -

                                                                                                                                                        - - - -
                                                                                                                                                        -
                                                                                                                                                        - - -
                                                                                                                                                        -

                                                                                                                                                        Calculates the boost in link range provided by installed Link Amps.

                                                                                                                                                        -
                                                                                                                                                        - - - - - - - - - -
                                                                                                                                                        -
                                                                                                                                                        Parameters:
                                                                                                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                        NameTypeDescription
                                                                                                                                                        d - - -Object - - - -

                                                                                                                                                        The portal detail object containing mod information.

                                                                                                                                                        - -
                                                                                                                                                        - - - - - - - - - - - - - -
                                                                                                                                                        -
                                                                                                                                                        Returns:
                                                                                                                                                        - - - - - -number - - - - - --

                                                                                                                                                        The total boost factor for the link range.

                                                                                                                                                        - - - - - -
                                                                                                                                                        - - - - - -
                                                                                                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                        - - - - -
                                                                                                                                                        - - - - -
                                                                                                                                                        - -

                                                                                                                                                        - - inner getLinkAmpRangeBoost(d) → {number} - - - - -

                                                                                                                                                        - - - -
                                                                                                                                                        -
                                                                                                                                                        - - -
                                                                                                                                                        -

                                                                                                                                                        Calculates the boost in link range provided by installed Link Amps.

                                                                                                                                                        -
                                                                                                                                                        - - - - - - - - - -
                                                                                                                                                        -
                                                                                                                                                        Parameters:
                                                                                                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                        NameTypeDescription
                                                                                                                                                        d - - -Object - - - -

                                                                                                                                                        The portal detail object containing mod information.

                                                                                                                                                        - -
                                                                                                                                                        - - - - - - - - - - - - - -
                                                                                                                                                        -
                                                                                                                                                        Returns:
                                                                                                                                                        - - - - - -number - - - - - --

                                                                                                                                                        The total boost factor for the link range.

                                                                                                                                                        - - - - - -
                                                                                                                                                        - - - - - -
                                                                                                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                        - - - - -
                                                                                                                                                        - - - - -
                                                                                                                                                        - - - - - -
                                                                                                                                                        -
                                                                                                                                                        - - -
                                                                                                                                                        -

                                                                                                                                                        Calculates the maximum number of outgoing links that can be created from a portal.

                                                                                                                                                        -
                                                                                                                                                        - - - - - - - - - -
                                                                                                                                                        -
                                                                                                                                                        Parameters:
                                                                                                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                        NameTypeDescription
                                                                                                                                                        d - - -Object - - - -

                                                                                                                                                        The portal detail object containing mod information.

                                                                                                                                                        - -
                                                                                                                                                        - - - - - - - - - - - - - -
                                                                                                                                                        -
                                                                                                                                                        Returns:
                                                                                                                                                        - - - - - -number - - - - - --

                                                                                                                                                        The maximum number of outgoing links.

                                                                                                                                                        - - - - - -
                                                                                                                                                        - - - - - -
                                                                                                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                        - - - - -
                                                                                                                                                        - - - - -
                                                                                                                                                        - - - - - -
                                                                                                                                                        -
                                                                                                                                                        - - -
                                                                                                                                                        -

                                                                                                                                                        Calculates the maximum number of outgoing links that can be created from a portal.

                                                                                                                                                        -
                                                                                                                                                        - - - - - - - - - -
                                                                                                                                                        -
                                                                                                                                                        Parameters:
                                                                                                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                        NameTypeDescription
                                                                                                                                                        d - - -Object - - - -

                                                                                                                                                        The portal detail object containing mod information.

                                                                                                                                                        - -
                                                                                                                                                        - - - - - - - - - - - - - -
                                                                                                                                                        -
                                                                                                                                                        Returns:
                                                                                                                                                        - - - - - -number - - - - - --

                                                                                                                                                        The maximum number of outgoing links.

                                                                                                                                                        - - - - - -
                                                                                                                                                        - - - - - -
                                                                                                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                        - - - - -
                                                                                                                                                        - - - - -
                                                                                                                                                        - -

                                                                                                                                                        - - inner getPortalAttackValues(d) → {Object} - - - - -

                                                                                                                                                        - - - -
                                                                                                                                                        -
                                                                                                                                                        - - -
                                                                                                                                                        -

                                                                                                                                                        Calculates various attack values of a portal, including hit bonus, force amplifier, and attack frequency.

                                                                                                                                                        -
                                                                                                                                                        - - - - - - - - - -
                                                                                                                                                        -
                                                                                                                                                        Parameters:
                                                                                                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                        NameTypeDescription
                                                                                                                                                        d - - -Object - - - -

                                                                                                                                                        The portal detail object containing mod information.

                                                                                                                                                        - -
                                                                                                                                                        - - - - - - - - - - - - - -
                                                                                                                                                        -
                                                                                                                                                        Returns:
                                                                                                                                                        - - - - - -Object - - - - - --

                                                                                                                                                        An object containing attack values such as hit bonus, force amplifier, and attack frequency.

                                                                                                                                                        - - - - - -
                                                                                                                                                        - - - - - -
                                                                                                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                        - - - - -
                                                                                                                                                        - - - - -
                                                                                                                                                        - -

                                                                                                                                                        - - inner getPortalAttackValues(d) → {Object} - - - - -

                                                                                                                                                        - - - -
                                                                                                                                                        -
                                                                                                                                                        - - -
                                                                                                                                                        -

                                                                                                                                                        Calculates various attack values of a portal, including hit bonus, force amplifier, and attack frequency.

                                                                                                                                                        -
                                                                                                                                                        - - - - - - - - - -
                                                                                                                                                        -
                                                                                                                                                        Parameters:
                                                                                                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                        NameTypeDescription
                                                                                                                                                        d - - -Object - - - -

                                                                                                                                                        The portal detail object containing mod information.

                                                                                                                                                        - -
                                                                                                                                                        - - - - - - - - - - - - - -
                                                                                                                                                        -
                                                                                                                                                        Returns:
                                                                                                                                                        - - - - - -Object - - - - - --

                                                                                                                                                        An object containing attack values such as hit bonus, force amplifier, and attack frequency.

                                                                                                                                                        - - - - - -
                                                                                                                                                        - - - - - -
                                                                                                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                        - - - - -
                                                                                                                                                        - - - - -
                                                                                                                                                        - -

                                                                                                                                                        - - inner getPortalHackDetails(d) → {Object} - - - - -

                                                                                                                                                        - - - -
                                                                                                                                                        -
                                                                                                                                                        - - -
                                                                                                                                                        -

                                                                                                                                                        Calculates hack-related details of a portal, such as hack cooldown and burnout time.

                                                                                                                                                        -
                                                                                                                                                        - - - - - - - - - -
                                                                                                                                                        -
                                                                                                                                                        Parameters:
                                                                                                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                        NameTypeDescription
                                                                                                                                                        d - - -Object - - - -

                                                                                                                                                        The portal detail object containing mod information.

                                                                                                                                                        - -
                                                                                                                                                        - - - - - - - - - - - - - -
                                                                                                                                                        -
                                                                                                                                                        Returns:
                                                                                                                                                        - - - - - -Object - - - - - --

                                                                                                                                                        An object containing hack-related details like cooldown time, hack count, and burnout time.

                                                                                                                                                        - - - - - -
                                                                                                                                                        - - - - - -
                                                                                                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                        - - - - -
                                                                                                                                                        - - - - -
                                                                                                                                                        - -

                                                                                                                                                        - - inner getPortalHackDetails(d) → {Object} - - - - -

                                                                                                                                                        - - - -
                                                                                                                                                        -
                                                                                                                                                        - - -
                                                                                                                                                        -

                                                                                                                                                        Calculates hack-related details of a portal, such as hack cooldown and burnout time.

                                                                                                                                                        -
                                                                                                                                                        - - - - - - - - - -
                                                                                                                                                        -
                                                                                                                                                        Parameters:
                                                                                                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                        NameTypeDescription
                                                                                                                                                        d - - -Object - - - -

                                                                                                                                                        The portal detail object containing mod information.

                                                                                                                                                        - -
                                                                                                                                                        - - - - - - - - - - - - - -
                                                                                                                                                        -
                                                                                                                                                        Returns:
                                                                                                                                                        - - - - - -Object - - - - - --

                                                                                                                                                        An object containing hack-related details like cooldown time, hack count, and burnout time.

                                                                                                                                                        - - - - - -
                                                                                                                                                        - - - - - -
                                                                                                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                        - - - - -
                                                                                                                                                        - - - - -
                                                                                                                                                        - -

                                                                                                                                                        - - inner getPortalLevel(d) → {number} - - - - -

                                                                                                                                                        - - - -
                                                                                                                                                        -
                                                                                                                                                        - - -
                                                                                                                                                        -

                                                                                                                                                        Calculates the displayed level of a portal, which is always rounded down from the actual float value.

                                                                                                                                                        -
                                                                                                                                                        - - - - - - - - - -
                                                                                                                                                        -
                                                                                                                                                        Parameters:
                                                                                                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                        NameTypeDescription
                                                                                                                                                        d - - -Object - - - -

                                                                                                                                                        The portal detail object containing resonator information.

                                                                                                                                                        - -
                                                                                                                                                        - - - - - - - - - - - - - -
                                                                                                                                                        -
                                                                                                                                                        Returns:
                                                                                                                                                        - - - - - -number - - - - - --

                                                                                                                                                        The calculated portal level.

                                                                                                                                                        - - - - - -
                                                                                                                                                        - - - - - -
                                                                                                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                        - - + -
                                                                                                                                                        - - - - -
                                                                                                                                                        +
                                                                                                                                                        -

                                                                                                                                                        +
                                                                                                                                                        + - inner getPortalLevel(d) → {number} - +

                                                                                                                                                        This file contains functions that handle the extraction and computation of raw data +from portal details for various purposes.

                                                                                                                                                        - + -

                                                                                                                                                        + - +
                                                                                                                                                        -
                                                                                                                                                        -

                                                                                                                                                        Calculates the displayed level of a portal, which is always rounded down from the actual float value.

                                                                                                                                                        -
                                                                                                                                                        - @@ -8267,55 +81,26 @@

                                                                                                                                                        -
                                                                                                                                                        -
                                                                                                                                                        Parameters:
                                                                                                                                                        - - - - - - - - - - - - - - - - + - - - - - + - + - + - - - +
                                                                                                                                                        -
                                                                                                                                                        -
                                                                                                                                                        NameTypeDescription
                                                                                                                                                        d - - -Object + + - -

                                                                                                                                                        The portal detail object containing resonator information.

                                                                                                                                                        -
                                                                                                                                                        @@ -8329,33 +114,11 @@

                                                                                                                                                        Parameters:
                                                                                                                                                        -
                                                                                                                                                        -
                                                                                                                                                        Returns:
                                                                                                                                                        - - - - - -number - - - - --

                                                                                                                                                        The calculated portal level.

                                                                                                                                                        - - - - - -
                                                                                                                                                        - -
                                                                                                                                                        - @@ -8365,13 +128,16 @@
                                                                                                                                                        Returns:
                                                                                                                                                        +
                                                                                                                                                        - - +
                                                                                                                                                        + + + @@ -8385,26 +151,25 @@
                                                                                                                                                        Returns:
                                                                                                                                                        -
                                                                                                                                                        - - + +

                                                                                                                                                        Methods

                                                                                                                                                        - +
                                                                                                                                                        -

                                                                                                                                                        +

                                                                                                                                                        - inner getPortalLinkDefenseBoost(d) → {number} + inner fixPortalImageUrl(url) → {string}

                                                                                                                                                        @@ -8416,7 +181,7 @@

                                                                                                                                                        -

                                                                                                                                                        Calculates the link defense boost provided by installed Ultra Link Amps.

                                                                                                                                                        +

                                                                                                                                                        Corrects the portal image URL to match the current protocol (http/https).

                                                                                                                                                        @@ -8452,13 +217,13 @@

                                                                                                                                                        Parameters:
                                                                                                                                                        - d + url -Object +string @@ -8468,7 +233,7 @@
                                                                                                                                                        Parameters:
                                                                                                                                                        -

                                                                                                                                                        The portal detail object containing mod information.

                                                                                                                                                        +

                                                                                                                                                        The original image URL.

                                                                                                                                                        @@ -8496,13 +261,13 @@
                                                                                                                                                        Returns:
                                                                                                                                                        -number +string --

                                                                                                                                                        The total link defense boost factor.

                                                                                                                                                        +-

                                                                                                                                                        The corrected image URL.

                                                                                                                                                        @@ -8557,14 +322,14 @@
                                                                                                                                                        Returns:
                                                                                                                                                        -

                                                                                                                                                        +

                                                                                                                                                        - inner getPortalLinkDefenseBoost(d) → {number} + inner getAttackApGain(d, fieldCount, linkCount) → {Object}

                                                                                                                                                        @@ -8576,7 +341,7 @@

                                                                                                                                                        -

                                                                                                                                                        Calculates the link defense boost provided by installed Ultra Link Amps.

                                                                                                                                                        +

                                                                                                                                                        Calculates the potential AP gain from attacking a portal.

                                                                                                                                                        @@ -8628,7 +393,53 @@

                                                                                                                                                        Parameters:
                                                                                                                                                        -

                                                                                                                                                        The portal detail object containing mod information.

                                                                                                                                                        +

                                                                                                                                                        The portal detail object containing resonator and ownership information.

                                                                                                                                                        + + + + + + + fieldCount + + + + + +number + + + + + + + + + +

                                                                                                                                                        The number of fields attached to the portal.

                                                                                                                                                        + + + + + + + linkCount + + + + + +number + + + + + + + + + +

                                                                                                                                                        The number of links attached to the portal.

                                                                                                                                                        @@ -8656,13 +467,13 @@
                                                                                                                                                        Returns:
                                                                                                                                                        -number +Object --

                                                                                                                                                        The total link defense boost factor.

                                                                                                                                                        +-

                                                                                                                                                        An object detailing various components of AP gain, including totals for friendly and enemy factions.

                                                                                                                                                        @@ -8717,14 +528,14 @@
                                                                                                                                                        Returns:
                                                                                                                                                        -

                                                                                                                                                        +

                                                                                                                                                        - inner getPortalLinksMitigation(linkCount) → {number} + inner getCurrentPortalEnergy(d) → {number}

                                                                                                                                                        @@ -8736,7 +547,7 @@

                                                                                                                                                        -

                                                                                                                                                        Calculates the additional mitigation provided by links attached to a portal.

                                                                                                                                                        +

                                                                                                                                                        Calculates the current energy of a portal based on its resonators.

                                                                                                                                                        @@ -8772,13 +583,13 @@

                                                                                                                                                        Parameters:
                                                                                                                                                        - linkCount + d -number +Object @@ -8788,7 +599,7 @@
                                                                                                                                                        Parameters:
                                                                                                                                                        -

                                                                                                                                                        The number of links attached to the portal.

                                                                                                                                                        +

                                                                                                                                                        The portal detail object containing resonator information.

                                                                                                                                                        @@ -8822,7 +633,7 @@
                                                                                                                                                        Returns:
                                                                                                                                                        --

                                                                                                                                                        The additional mitigation value provided by the links.

                                                                                                                                                        +-

                                                                                                                                                        The current energy of the portal.

                                                                                                                                                        @@ -8877,14 +688,14 @@
                                                                                                                                                        Returns:
                                                                                                                                                        -

                                                                                                                                                        +

                                                                                                                                                        - inner getPortalLinksMitigation(linkCount) → {number} + inner getLinkAmpRangeBoost(d) → {number}

                                                                                                                                                        @@ -8896,7 +707,7 @@

                                                                                                                                                        -

                                                                                                                                                        Calculates the additional mitigation provided by links attached to a portal.

                                                                                                                                                        +

                                                                                                                                                        Calculates the boost in link range provided by installed Link Amps.

                                                                                                                                                        @@ -8932,13 +743,13 @@

                                                                                                                                                        Parameters:
                                                                                                                                                        - linkCount + d -number +Object @@ -8948,7 +759,7 @@
                                                                                                                                                        Parameters:
                                                                                                                                                        -

                                                                                                                                                        The number of links attached to the portal.

                                                                                                                                                        +

                                                                                                                                                        The portal detail object containing mod information.

                                                                                                                                                        @@ -8982,7 +793,7 @@
                                                                                                                                                        Returns:
                                                                                                                                                        --

                                                                                                                                                        The additional mitigation value provided by the links.

                                                                                                                                                        +-

                                                                                                                                                        The total boost factor for the link range.

                                                                                                                                                        @@ -9037,14 +848,14 @@
                                                                                                                                                        Returns:
                                                                                                                                                        -

                                                                                                                                                        +

                                                                                                                                                        @@ -9056,7 +867,7 @@

                                                                                                                                                        -

                                                                                                                                                        Calculates detailed mitigation information for a portal, including contributions from shields and links.

                                                                                                                                                        +

                                                                                                                                                        Calculates the maximum number of outgoing links that can be created from a portal.

                                                                                                                                                        @@ -9108,30 +919,7 @@

                                                                                                                                                        Parameters:
                                                                                                                                                        -

                                                                                                                                                        The portal detail object containing mod and resonator information.

                                                                                                                                                        - - - - - - - linkCount - - - - - -number - - - - - - - - - -

                                                                                                                                                        The number of links attached to the portal.

                                                                                                                                                        +

                                                                                                                                                        The portal detail object containing mod information.

                                                                                                                                                        @@ -9159,13 +947,13 @@
                                                                                                                                                        Returns:
                                                                                                                                                        -Object +number --

                                                                                                                                                        An object detailing various components of mitigation.

                                                                                                                                                        +-

                                                                                                                                                        The maximum number of outgoing links.

                                                                                                                                                        @@ -9220,14 +1008,14 @@
                                                                                                                                                        Returns:
                                                                                                                                                        -

                                                                                                                                                        +

                                                                                                                                                        - inner getPortalMitigationDetails(d, linkCount) → {Object} + inner getPortalAttackValues(d) → {Object}

                                                                                                                                                        @@ -9239,7 +1027,7 @@

                                                                                                                                                        -

                                                                                                                                                        Calculates detailed mitigation information for a portal, including contributions from shields and links.

                                                                                                                                                        +

                                                                                                                                                        Calculates various attack values of a portal, including hit bonus, force amplifier, and attack frequency.

                                                                                                                                                        @@ -9291,30 +1079,7 @@

                                                                                                                                                        Parameters:
                                                                                                                                                        -

                                                                                                                                                        The portal detail object containing mod and resonator information.

                                                                                                                                                        - - - - - - - linkCount - - - - - -number - - - - - - - - - -

                                                                                                                                                        The number of links attached to the portal.

                                                                                                                                                        +

                                                                                                                                                        The portal detail object containing mod information.

                                                                                                                                                        @@ -9348,7 +1113,7 @@
                                                                                                                                                        Returns:
                                                                                                                                                        --

                                                                                                                                                        An object detailing various components of mitigation.

                                                                                                                                                        +-

                                                                                                                                                        An object containing attack values such as hit bonus, force amplifier, and attack frequency.

                                                                                                                                                        @@ -9403,14 +1168,14 @@
                                                                                                                                                        Returns:
                                                                                                                                                        -

                                                                                                                                                        +

                                                                                                                                                        - inner getPortalModsByType(d, type) → {Array} + inner getPortalHackDetails(d) → {Object}

                                                                                                                                                        @@ -9422,7 +1187,7 @@

                                                                                                                                                        -

                                                                                                                                                        Returns a list of portal mods filtered by a specific type.

                                                                                                                                                        +

                                                                                                                                                        Calculates hack-related details of a portal, such as hack cooldown and burnout time.

                                                                                                                                                        @@ -9478,29 +1243,6 @@

                                                                                                                                                        Parameters:
                                                                                                                                                        - - - - type - - - - - -string - - - - - - - - - -

                                                                                                                                                        The type of mods to filter (e.g., 'RES_SHIELD', 'LINK_AMPLIFIER').

                                                                                                                                                        - - - @@ -9525,13 +1267,13 @@
                                                                                                                                                        Returns:
                                                                                                                                                        -Array +Object --

                                                                                                                                                        An array of mods matching the specified type.

                                                                                                                                                        +-

                                                                                                                                                        An object containing hack-related details like cooldown time, hack count, and burnout time.

                                                                                                                                                        @@ -9586,14 +1328,14 @@
                                                                                                                                                        Returns:
                                                                                                                                                        -

                                                                                                                                                        +

                                                                                                                                                        - inner getPortalModsByType(d, type) → {Array} + inner getPortalLevel(d) → {number}

                                                                                                                                                        @@ -9605,7 +1347,7 @@

                                                                                                                                                        -

                                                                                                                                                        Returns a list of portal mods filtered by a specific type.

                                                                                                                                                        +

                                                                                                                                                        Calculates the displayed level of a portal, which is always rounded down from the actual float value.

                                                                                                                                                        @@ -9657,30 +1399,7 @@

                                                                                                                                                        Parameters:
                                                                                                                                                        -

                                                                                                                                                        The portal detail object containing mod information.

                                                                                                                                                        - - - - - - - type - - - - - -string - - - - - - - - - -

                                                                                                                                                        The type of mods to filter (e.g., 'RES_SHIELD', 'LINK_AMPLIFIER').

                                                                                                                                                        +

                                                                                                                                                        The portal detail object containing resonator information.

                                                                                                                                                        @@ -9708,13 +1427,13 @@
                                                                                                                                                        Returns:
                                                                                                                                                        -Array +number --

                                                                                                                                                        An array of mods matching the specified type.

                                                                                                                                                        +-

                                                                                                                                                        The calculated portal level.

                                                                                                                                                        @@ -9769,14 +1488,14 @@
                                                                                                                                                        Returns:
                                                                                                                                                        -

                                                                                                                                                        +

                                                                                                                                                        - inner getPortalRange(d) → {Object} + inner getPortalLinkDefenseBoost(d) → {number}

                                                                                                                                                        @@ -9788,7 +1507,7 @@

                                                                                                                                                        -

                                                                                                                                                        Calculates the range of a portal for creating links. The range depends on portal level and any installed Link Amps.

                                                                                                                                                        +

                                                                                                                                                        Calculates the link defense boost provided by installed Ultra Link Amps.

                                                                                                                                                        @@ -9840,7 +1559,7 @@

                                                                                                                                                        Parameters:
                                                                                                                                                        -

                                                                                                                                                        The portal detail object containing details about the team and resonators.

                                                                                                                                                        +

                                                                                                                                                        The portal detail object containing mod information.

                                                                                                                                                        @@ -9868,15 +1587,13 @@
                                                                                                                                                        Returns:
                                                                                                                                                        -Object +number --

                                                                                                                                                        An object containing the base range (base), boost multiplier (boost), -total range after applying the boost (range), -and a boolean indicating if the portal is linkable (isLinkable).

                                                                                                                                                        +-

                                                                                                                                                        The total link defense boost factor.

                                                                                                                                                        @@ -9931,14 +1648,14 @@
                                                                                                                                                        Returns:
                                                                                                                                                        -

                                                                                                                                                        +

                                                                                                                                                        - inner getPortalRange(d) → {Object} + inner getPortalLinksMitigation(linkCount) → {number}

                                                                                                                                                        @@ -9950,7 +1667,7 @@

                                                                                                                                                        -

                                                                                                                                                        Calculates the range of a portal for creating links. The range depends on portal level and any installed Link Amps.

                                                                                                                                                        +

                                                                                                                                                        Calculates the additional mitigation provided by links attached to a portal.

                                                                                                                                                        @@ -9986,13 +1703,13 @@

                                                                                                                                                        Parameters:
                                                                                                                                                        - d + linkCount -Object +number @@ -10002,7 +1719,7 @@
                                                                                                                                                        Parameters:
                                                                                                                                                        -

                                                                                                                                                        The portal detail object containing details about the team and resonators.

                                                                                                                                                        +

                                                                                                                                                        The number of links attached to the portal.

                                                                                                                                                        @@ -10030,15 +1747,13 @@
                                                                                                                                                        Returns:
                                                                                                                                                        -Object +number --

                                                                                                                                                        An object containing the base range (base), boost multiplier (boost), -total range after applying the boost (range), -and a boolean indicating if the portal is linkable (isLinkable).

                                                                                                                                                        +-

                                                                                                                                                        The additional mitigation value provided by the links.

                                                                                                                                                        @@ -10093,14 +1808,14 @@
                                                                                                                                                        Returns:
                                                                                                                                                        -

                                                                                                                                                        +

                                                                                                                                                        - inner getPortalShieldMitigation(d) → {number} + inner getPortalMitigationDetails(d, linkCount) → {Object}

                                                                                                                                                        @@ -10112,7 +1827,7 @@

                                                                                                                                                        -

                                                                                                                                                        Calculates the total mitigation provided by shields installed on a portal.

                                                                                                                                                        +

                                                                                                                                                        Calculates detailed mitigation information for a portal, including contributions from shields and links.

                                                                                                                                                        @@ -10164,7 +1879,30 @@

                                                                                                                                                        Parameters:
                                                                                                                                                        -

                                                                                                                                                        The portal detail object containing mod information.

                                                                                                                                                        +

                                                                                                                                                        The portal detail object containing mod and resonator information.

                                                                                                                                                        + + + + + + + linkCount + + + + + +number + + + + + + + + + +

                                                                                                                                                        The number of links attached to the portal.

                                                                                                                                                        @@ -10192,13 +1930,13 @@
                                                                                                                                                        Returns:
                                                                                                                                                        -number +Object --

                                                                                                                                                        The total mitigation value from all shields installed on the portal.

                                                                                                                                                        +-

                                                                                                                                                        An object detailing various components of mitigation.

                                                                                                                                                        @@ -10253,14 +1991,14 @@
                                                                                                                                                        Returns:
                                                                                                                                                        -

                                                                                                                                                        +

                                                                                                                                                        - inner getPortalShieldMitigation(d) → {number} + inner getPortalModsByType(d, type) → {Array}

                                                                                                                                                        @@ -10272,7 +2010,7 @@

                                                                                                                                                        -

                                                                                                                                                        Calculates the total mitigation provided by shields installed on a portal.

                                                                                                                                                        +

                                                                                                                                                        Returns a list of portal mods filtered by a specific type.

                                                                                                                                                        @@ -10328,6 +2066,29 @@

                                                                                                                                                        Parameters:
                                                                                                                                                        + + + + type + + + + + +string + + + + + + + + + +

                                                                                                                                                        The type of mods to filter (e.g., 'RES_SHIELD', 'LINK_AMPLIFIER').

                                                                                                                                                        + + + @@ -10352,13 +2113,13 @@
                                                                                                                                                        Returns:
                                                                                                                                                        -number +Array --

                                                                                                                                                        The total mitigation value from all shields installed on the portal.

                                                                                                                                                        +-

                                                                                                                                                        An array of mods matching the specified type.

                                                                                                                                                        @@ -10413,14 +2174,14 @@
                                                                                                                                                        Returns:
                                                                                                                                                        -

                                                                                                                                                        +

                                                                                                                                                        - inner getPortalSummaryData(d) → {Object} + inner getPortalRange(d) → {Object}

                                                                                                                                                        @@ -10432,7 +2193,7 @@

                                                                                                                                                        -

                                                                                                                                                        Converts detailed portal information into a summary format similar to that seen in the map tile data.

                                                                                                                                                        +

                                                                                                                                                        Calculates the range of a portal for creating links. The range depends on portal level and any installed Link Amps.

                                                                                                                                                        @@ -10484,7 +2245,7 @@

                                                                                                                                                        Parameters:
                                                                                                                                                        -

                                                                                                                                                        The detailed portal data.

                                                                                                                                                        +

                                                                                                                                                        The portal detail object containing details about the team and resonators.

                                                                                                                                                        @@ -10518,7 +2279,9 @@
                                                                                                                                                        Returns:
                                                                                                                                                        --

                                                                                                                                                        A summary of the portal data, including level, title, image, resonator count, health, and team.

                                                                                                                                                        +-

                                                                                                                                                        An object containing the base range (base), boost multiplier (boost), +total range after applying the boost (range), +and a boolean indicating if the portal is linkable (isLinkable).

                                                                                                                                                        @@ -10573,14 +2336,14 @@
                                                                                                                                                        Returns:
                                                                                                                                                        -

                                                                                                                                                        +

                                                                                                                                                        - inner getPortalSummaryData(d) → {Object} + inner getPortalShieldMitigation(d) → {number}

                                                                                                                                                        @@ -10592,7 +2355,7 @@

                                                                                                                                                        -

                                                                                                                                                        Converts detailed portal information into a summary format similar to that seen in the map tile data.

                                                                                                                                                        +

                                                                                                                                                        Calculates the total mitigation provided by shields installed on a portal.

                                                                                                                                                        @@ -10644,7 +2407,7 @@

                                                                                                                                                        Parameters:
                                                                                                                                                        -

                                                                                                                                                        The detailed portal data.

                                                                                                                                                        +

                                                                                                                                                        The portal detail object containing mod information.

                                                                                                                                                        @@ -10672,13 +2435,13 @@
                                                                                                                                                        Returns:
                                                                                                                                                        -Object +number --

                                                                                                                                                        A summary of the portal data, including level, title, image, resonator count, health, and team.

                                                                                                                                                        +-

                                                                                                                                                        The total mitigation value from all shields installed on the portal.

                                                                                                                                                        @@ -10733,14 +2496,14 @@
                                                                                                                                                        Returns:
                                                                                                                                                        -

                                                                                                                                                        +

                                                                                                                                                        - inner getTotalPortalEnergy(d) → {number} + inner getPortalSummaryData(d) → {Object}

                                                                                                                                                        @@ -10752,7 +2515,7 @@

                                                                                                                                                        -

                                                                                                                                                        Calculates the total energy capacity of a portal based on its resonators.

                                                                                                                                                        +

                                                                                                                                                        Converts detailed portal information into a summary format similar to that seen in the map tile data.

                                                                                                                                                        @@ -10804,7 +2567,7 @@

                                                                                                                                                        Parameters:
                                                                                                                                                        -

                                                                                                                                                        The portal detail object containing resonator information.

                                                                                                                                                        +

                                                                                                                                                        The detailed portal data.

                                                                                                                                                        @@ -10832,13 +2595,13 @@
                                                                                                                                                        Returns:
                                                                                                                                                        -number +Object --

                                                                                                                                                        The total energy capacity of the portal.

                                                                                                                                                        +-

                                                                                                                                                        A summary of the portal data, including level, title, image, resonator count, health, and team.

                                                                                                                                                        diff --git a/module-portal_marker.html b/module-portal_marker.html index 01d831418..d6743fe4f 100644 --- a/module-portal_marker.html +++ b/module-portal_marker.html @@ -34,7 +34,7 @@

                                                                                                                                                        IITC-CE

                                                                                                                                                          - +
                                                                                                                                                          @@ -52,8 +52,6 @@

                                                                                                                                                          portal_marker

                                                                                                                                                          - - @@ -119,77 +117,6 @@

                                                                                                                                                          portal_marker

                                                                                                                                                          - - - - - - - - - - -
                                                                                                                                                          - - - - - - - - - -
                                                                                                                                                          - -
                                                                                                                                                          -
                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - @@ -417,14 +344,14 @@
                                                                                                                                                          Returns:
                                                                                                                                                          -

                                                                                                                                                          +

                                                                                                                                                          - inner createMarker(latlng, data) → {L.circleMarker} + inner getMarkerStyleOptions(details) → {Object}

                                                                                                                                                          @@ -436,7 +363,7 @@

                                                                                                                                                          -

                                                                                                                                                          Creates a new portal marker on the map.

                                                                                                                                                          +

                                                                                                                                                          Determines the style options for a portal marker based on its details.

                                                                                                                                                          @@ -472,30 +399,7 @@

                                                                                                                                                          Parameters:
                                                                                                                                                          - latlng - - - - - -L.LatLng - - - - - - - - - -

                                                                                                                                                          The latitude and longitude where the marker will be placed.

                                                                                                                                                          - - - - - - - data + details @@ -511,7 +415,7 @@
                                                                                                                                                          Parameters:
                                                                                                                                                          -

                                                                                                                                                          The IITC-specific entity data to be stored in the marker options.

                                                                                                                                                          +

                                                                                                                                                          Details of the portal, including team and level.

                                                                                                                                                          @@ -539,13 +443,13 @@
                                                                                                                                                          Returns:
                                                                                                                                                          -L.circleMarker +Object --

                                                                                                                                                          A Leaflet circle marker representing the portal.

                                                                                                                                                          +-

                                                                                                                                                          Style options for the portal marker.

                                                                                                                                                          @@ -600,14 +504,14 @@
                                                                                                                                                          Returns:
                                                                                                                                                          -

                                                                                                                                                          +

                                                                                                                                                          - inner getMarkerStyleOptions(details) → {Object} + inner portalMarkerScale() → {number}

                                                                                                                                                          @@ -619,7 +523,7 @@

                                                                                                                                                          -

                                                                                                                                                          Determines the style options for a portal marker based on its details.

                                                                                                                                                          +

                                                                                                                                                          Calculates the scale of portal markers based on the current zoom level of the map.

                                                                                                                                                          @@ -630,56 +534,6 @@

                                                                                                                                                          -
                                                                                                                                                          -
                                                                                                                                                          Parameters:
                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                          NameTypeDescription
                                                                                                                                                          details - - -Object - - - -

                                                                                                                                                          Details of the portal, including team and level.

                                                                                                                                                          - -
                                                                                                                                                          - @@ -699,1996 +553,23 @@

                                                                                                                                                          Returns:
                                                                                                                                                          -Object - - - - - --

                                                                                                                                                          Style options for the portal marker.

                                                                                                                                                          - - - - - - - - - - - -
                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - +number - - - - -
                                                                                                                                                          +-

                                                                                                                                                          The scale factor for portal markers.

                                                                                                                                                          - -
                                                                                                                                                          - - -
                                                                                                                                                          - -

                                                                                                                                                          - - inner getMarkerStyleOptions(details) → {Object} - - - -

                                                                                                                                                          - - - -
                                                                                                                                                          -
                                                                                                                                                          - - -
                                                                                                                                                          -

                                                                                                                                                          Determines the style options for a portal marker based on its details.

                                                                                                                                                          - - - - - -
                                                                                                                                                          -
                                                                                                                                                          Parameters:
                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                          NameTypeDescription
                                                                                                                                                          details - - -Object - - - -

                                                                                                                                                          Details of the portal, including team and level.

                                                                                                                                                          - -
                                                                                                                                                          - - - - - - - - - - - - - -
                                                                                                                                                          -
                                                                                                                                                          Returns:
                                                                                                                                                          - - - - - -Object - - - - - --

                                                                                                                                                          Style options for the portal marker.

                                                                                                                                                          - - - - - -
                                                                                                                                                          - - - - - -
                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                          - - - - -
                                                                                                                                                          - - - - -
                                                                                                                                                          - -

                                                                                                                                                          - - inner portalMarkerScale() → {number} - - - - -

                                                                                                                                                          - - - -
                                                                                                                                                          -
                                                                                                                                                          - - -
                                                                                                                                                          -

                                                                                                                                                          Calculates the scale of portal markers based on the current zoom level of the map.

                                                                                                                                                          -
                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                          -
                                                                                                                                                          Returns:
                                                                                                                                                          - - - - - -number - - - - - --

                                                                                                                                                          The scale factor for portal markers.

                                                                                                                                                          - - - - - -
                                                                                                                                                          - - - - - -
                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                          - - - - -
                                                                                                                                                          - - - - -
                                                                                                                                                          - -

                                                                                                                                                          - - inner portalMarkerScale() → {number} - - - - -

                                                                                                                                                          - - - -
                                                                                                                                                          -
                                                                                                                                                          - - -
                                                                                                                                                          -

                                                                                                                                                          Calculates the scale of portal markers based on the current zoom level of the map.

                                                                                                                                                          -
                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                          -
                                                                                                                                                          Returns:
                                                                                                                                                          - - - - - -number - - - - - --

                                                                                                                                                          The scale factor for portal markers.

                                                                                                                                                          - - - - - -
                                                                                                                                                          - - - - - -
                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                          - - - - -
                                                                                                                                                          - - - - -
                                                                                                                                                          - -

                                                                                                                                                          - - inner setMarkerStyle(marker, selected) - - - - -

                                                                                                                                                          - - - -
                                                                                                                                                          -
                                                                                                                                                          - - -
                                                                                                                                                          -

                                                                                                                                                          Sets the style of a portal marker, including options for when the portal is selected.

                                                                                                                                                          -
                                                                                                                                                          - - - - - - - - - -
                                                                                                                                                          -
                                                                                                                                                          Parameters:
                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                          NameTypeDescription
                                                                                                                                                          marker - - -L.circleMarker - - - -

                                                                                                                                                          The portal marker whose style will be set.

                                                                                                                                                          selected - - -boolean - - - -

                                                                                                                                                          Indicates if the portal is selected.

                                                                                                                                                          - -
                                                                                                                                                          - - - - - - - - - - - - - - - - - -
                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                          - - - - -
                                                                                                                                                          - - - - -
                                                                                                                                                          - -

                                                                                                                                                          - - inner setMarkerStyle(marker, selected) - - - - -

                                                                                                                                                          - - - -
                                                                                                                                                          -
                                                                                                                                                          - - -
                                                                                                                                                          -

                                                                                                                                                          Sets the style of a portal marker, including options for when the portal is selected.

                                                                                                                                                          -
                                                                                                                                                          - - - - - - - - - -
                                                                                                                                                          -
                                                                                                                                                          Parameters:
                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                          NameTypeDescription
                                                                                                                                                          marker - - -L.circleMarker - - - -

                                                                                                                                                          The portal marker whose style will be set.

                                                                                                                                                          selected - - -boolean - - - -

                                                                                                                                                          Indicates if the portal is selected.

                                                                                                                                                          - -
                                                                                                                                                          - - - - - - - - - - - - - - - - - -
                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                          - - - - -
                                                                                                                                                          - - - - - - - -
                                                                                                                                                          - -
                                                                                                                                                          - - - - - - - -
                                                                                                                                                          - -
                                                                                                                                                          - -

                                                                                                                                                          portal_marker

                                                                                                                                                          - - - - - - -
                                                                                                                                                          - -
                                                                                                                                                          - -
                                                                                                                                                          - - -

                                                                                                                                                          This file contains the code related to creating and updating portal markers on the map.

                                                                                                                                                          - - - - - -
                                                                                                                                                          - -
                                                                                                                                                          -
                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                          - - - - -
                                                                                                                                                          - - - - -
                                                                                                                                                          - -
                                                                                                                                                          -
                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                          - - - - -
                                                                                                                                                          - - - -
                                                                                                                                                          - - - - - - - - - - - - - - - - - -

                                                                                                                                                          Methods

                                                                                                                                                          - -
                                                                                                                                                          - - -
                                                                                                                                                          - -

                                                                                                                                                          - - inner createMarker(latlng, data) → {L.circleMarker} - - - - -

                                                                                                                                                          - - - -
                                                                                                                                                          -
                                                                                                                                                          - - -
                                                                                                                                                          -

                                                                                                                                                          Creates a new portal marker on the map.

                                                                                                                                                          -
                                                                                                                                                          - - - - - - - - - -
                                                                                                                                                          -
                                                                                                                                                          Parameters:
                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                          NameTypeDescription
                                                                                                                                                          latlng - - -L.LatLng - - - -

                                                                                                                                                          The latitude and longitude where the marker will be placed.

                                                                                                                                                          data - - -Object - - - -

                                                                                                                                                          The IITC-specific entity data to be stored in the marker options.

                                                                                                                                                          - -
                                                                                                                                                          - - - - - - - - - - - - - -
                                                                                                                                                          -
                                                                                                                                                          Returns:
                                                                                                                                                          - - - - - -L.circleMarker - - - - - --

                                                                                                                                                          A Leaflet circle marker representing the portal.

                                                                                                                                                          - - - - - -
                                                                                                                                                          - - - - - -
                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                          - - - - -
                                                                                                                                                          - - - - -
                                                                                                                                                          - -

                                                                                                                                                          - - inner createMarker(latlng, data) → {L.circleMarker} - - - - -

                                                                                                                                                          - - - -
                                                                                                                                                          -
                                                                                                                                                          - - -
                                                                                                                                                          -

                                                                                                                                                          Creates a new portal marker on the map.

                                                                                                                                                          -
                                                                                                                                                          - - - - - - - - - -
                                                                                                                                                          -
                                                                                                                                                          Parameters:
                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                          NameTypeDescription
                                                                                                                                                          latlng - - -L.LatLng - - - -

                                                                                                                                                          The latitude and longitude where the marker will be placed.

                                                                                                                                                          data - - -Object - - - -

                                                                                                                                                          The IITC-specific entity data to be stored in the marker options.

                                                                                                                                                          - -
                                                                                                                                                          - - - - - - - - - - - - - -
                                                                                                                                                          -
                                                                                                                                                          Returns:
                                                                                                                                                          - - - - - -L.circleMarker - - - - - --

                                                                                                                                                          A Leaflet circle marker representing the portal.

                                                                                                                                                          - - - - - -
                                                                                                                                                          - - - - - -
                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                          - - - - -
                                                                                                                                                          - - - - -
                                                                                                                                                          - -

                                                                                                                                                          - - inner getMarkerStyleOptions(details) → {Object} - - - - -

                                                                                                                                                          - - - -
                                                                                                                                                          -
                                                                                                                                                          - - -
                                                                                                                                                          -

                                                                                                                                                          Determines the style options for a portal marker based on its details.

                                                                                                                                                          -
                                                                                                                                                          - - - - - - - - - -
                                                                                                                                                          -
                                                                                                                                                          Parameters:
                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                          NameTypeDescription
                                                                                                                                                          details - - -Object - - - -

                                                                                                                                                          Details of the portal, including team and level.

                                                                                                                                                          - -
                                                                                                                                                          - - - - - - - - - - - - - -
                                                                                                                                                          -
                                                                                                                                                          Returns:
                                                                                                                                                          - - - - - -Object - - - - - --

                                                                                                                                                          Style options for the portal marker.

                                                                                                                                                          - - - - - -
                                                                                                                                                          - - - - - -
                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                          - - - - -
                                                                                                                                                          - - - - -
                                                                                                                                                          - -

                                                                                                                                                          - - inner getMarkerStyleOptions(details) → {Object} - - - - -

                                                                                                                                                          - - - -
                                                                                                                                                          -
                                                                                                                                                          - - -
                                                                                                                                                          -

                                                                                                                                                          Determines the style options for a portal marker based on its details.

                                                                                                                                                          -
                                                                                                                                                          - - - - - - - - - -
                                                                                                                                                          -
                                                                                                                                                          Parameters:
                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                          NameTypeDescription
                                                                                                                                                          details - - -Object - - - -

                                                                                                                                                          Details of the portal, including team and level.

                                                                                                                                                          - -
                                                                                                                                                          - - - - - - - - - - - - - -
                                                                                                                                                          -
                                                                                                                                                          Returns:
                                                                                                                                                          - - - - - -Object - - - - - --

                                                                                                                                                          Style options for the portal marker.

                                                                                                                                                          - - - - - -
                                                                                                                                                          - - - - - -
                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                          - - - - -
                                                                                                                                                          - - - - -
                                                                                                                                                          - -

                                                                                                                                                          - - inner portalMarkerScale() → {number} - - - - -

                                                                                                                                                          - - - -
                                                                                                                                                          -
                                                                                                                                                          - - -
                                                                                                                                                          -

                                                                                                                                                          Calculates the scale of portal markers based on the current zoom level of the map.

                                                                                                                                                          -
                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                          -
                                                                                                                                                          Returns:
                                                                                                                                                          - - - - - -number - - - - - --

                                                                                                                                                          The scale factor for portal markers.

                                                                                                                                                          - - - - - -
                                                                                                                                                          - - - - - -
                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                          - - - - -
                                                                                                                                                          - - - - -
                                                                                                                                                          - -

                                                                                                                                                          - - inner portalMarkerScale() → {number} - - - - -

                                                                                                                                                          - - - -
                                                                                                                                                          -
                                                                                                                                                          - - -
                                                                                                                                                          -

                                                                                                                                                          Calculates the scale of portal markers based on the current zoom level of the map.

                                                                                                                                                          -
                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                          -
                                                                                                                                                          Returns:
                                                                                                                                                          - - - - - -number - - - - - --

                                                                                                                                                          The scale factor for portal markers.

                                                                                                                                                          - - - - - -
                                                                                                                                                          - - - - - -
                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                          - - - - -
                                                                                                                                                          - - - - -
                                                                                                                                                          - -

                                                                                                                                                          - - inner setMarkerStyle(marker, selected) - - - - -

                                                                                                                                                          - - - -
                                                                                                                                                          -
                                                                                                                                                          - - -
                                                                                                                                                          -

                                                                                                                                                          Sets the style of a portal marker, including options for when the portal is selected.

                                                                                                                                                          -
                                                                                                                                                          - - - - - - - - - -
                                                                                                                                                          -
                                                                                                                                                          Parameters:
                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                          NameTypeDescription
                                                                                                                                                          marker - - -L.circleMarker - - - -

                                                                                                                                                          The portal marker whose style will be set.

                                                                                                                                                          selected - - -boolean - - - -

                                                                                                                                                          Indicates if the portal is selected.

                                                                                                                                                          - -
                                                                                                                                                          - - - - - - - - - - - - - - - -
                                                                                                                                                          diff --git a/module-redeeming.html b/module-redeeming.html index 74fb769c2..0f8679aa4 100644 --- a/module-redeeming.html +++ b/module-redeeming.html @@ -34,7 +34,7 @@

                                                                                                                                                          IITC-CE

                                                                                                                                                            - +
                                                                                                                                                            @@ -52,8 +52,6 @@

                                                                                                                                                            redeeming

                                                                                                                                                            - - @@ -119,77 +117,6 @@

                                                                                                                                                            redeeming

                                                                                                                                                            - - - - - - - - - - -
                                                                                                                                                            - - - - -
                                                                                                                                                            - - - - -
                                                                                                                                                            - -
                                                                                                                                                            -
                                                                                                                                                            - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                            - - - - - - - - - - - - - - - - - - - - @@ -288,164 +215,6 @@
                                                                                                                                                            Type:
                                                                                                                                                            - - - - - - - - - - -
                                                                                                                                                            - - - - - -
                                                                                                                                                            - - - - -
                                                                                                                                                            -

                                                                                                                                                            - inner, constant REDEEM_SHORT_NAMES :Object - - - -

                                                                                                                                                            - - -
                                                                                                                                                            -
                                                                                                                                                            - -
                                                                                                                                                            -

                                                                                                                                                            Provides a scale factor for short names of various Ingress items used in passcode rewards.

                                                                                                                                                            -
                                                                                                                                                            - - - - - - - -
                                                                                                                                                            - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                            - - - - - -
                                                                                                                                                            - - - - -
                                                                                                                                                            -

                                                                                                                                                            - inner, constant REDEEM_STATUSES :Object - - - -

                                                                                                                                                            - - -
                                                                                                                                                            -
                                                                                                                                                            - -
                                                                                                                                                            -

                                                                                                                                                            HTTP status codes and corresponding messages returned by the redemption API.

                                                                                                                                                            -
                                                                                                                                                            - - - - - - - -
                                                                                                                                                            - - - - - - - - - - - - - - - - - - - - @@ -714,14 +483,14 @@
                                                                                                                                                            Returns:
                                                                                                                                                            -

                                                                                                                                                            +

                                                                                                                                                            - inner formatPasscodeLong(data) → {string} + inner formatPasscodeShort(data) → {string}

                                                                                                                                                            @@ -733,7 +502,7 @@

                                                                                                                                                            -

                                                                                                                                                            Formats passcode reward data into a long, detailed html string.

                                                                                                                                                            +

                                                                                                                                                            Formats passcode reward data into a short, concise html string.

                                                                                                                                                            @@ -819,7 +588,7 @@

                                                                                                                                                            Returns:
                                                                                                                                                            --

                                                                                                                                                            Formatted string representing the detailed rewards.

                                                                                                                                                            +-

                                                                                                                                                            Formatted string representing the concise rewards.

                                                                                                                                                            @@ -874,14 +643,14 @@
                                                                                                                                                            Returns:
                                                                                                                                                            -

                                                                                                                                                            +

                                                                                                                                                            - inner formatPasscodeShort(data) → {string} + inner handleRedeemResponse(data, textStatus, jqXHR)

                                                                                                                                                            @@ -893,7 +662,7 @@

                                                                                                                                                            -

                                                                                                                                                            Formats passcode reward data into a short, concise html string.

                                                                                                                                                            +

                                                                                                                                                            Handles the response from the passcode redeeming API.

                                                                                                                                                            @@ -945,2221 +714,7 @@

                                                                                                                                                            Parameters:
                                                                                                                                                            -

                                                                                                                                                            The reward data.

                                                                                                                                                            - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                            -
                                                                                                                                                            Returns:
                                                                                                                                                            - - - - - -string - - - - - --

                                                                                                                                                            Formatted string representing the concise rewards.

                                                                                                                                                            - - - - - -
                                                                                                                                                            - - - - - -
                                                                                                                                                            - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                            - - - - -
                                                                                                                                                            - - - - -
                                                                                                                                                            - -

                                                                                                                                                            - - inner formatPasscodeShort(data) → {string} - - - - -

                                                                                                                                                            - - - -
                                                                                                                                                            -
                                                                                                                                                            - - -
                                                                                                                                                            -

                                                                                                                                                            Formats passcode reward data into a short, concise html string.

                                                                                                                                                            -
                                                                                                                                                            - - - - - - - - - -
                                                                                                                                                            -
                                                                                                                                                            Parameters:
                                                                                                                                                            - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                            NameTypeDescription
                                                                                                                                                            data - - -Object - - - -

                                                                                                                                                            The reward data.

                                                                                                                                                            - -
                                                                                                                                                            - - - - - - - - - - - - - -
                                                                                                                                                            -
                                                                                                                                                            Returns:
                                                                                                                                                            - - - - - -string - - - - - --

                                                                                                                                                            Formatted string representing the concise rewards.

                                                                                                                                                            - - - - - -
                                                                                                                                                            - - - - - -
                                                                                                                                                            - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                            - - - - -
                                                                                                                                                            - - - - -
                                                                                                                                                            - -

                                                                                                                                                            - - inner handleRedeemResponse(data, textStatus, jqXHR) - - - - -

                                                                                                                                                            - - - -
                                                                                                                                                            -
                                                                                                                                                            - - -
                                                                                                                                                            -

                                                                                                                                                            Handles the response from the passcode redeeming API.

                                                                                                                                                            -
                                                                                                                                                            - - - - - - - - - -
                                                                                                                                                            -
                                                                                                                                                            Parameters:
                                                                                                                                                            - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                            NameTypeDescription
                                                                                                                                                            data - - -Object - - - -

                                                                                                                                                            The data returned by the API.

                                                                                                                                                            textStatus - - -string - - - -

                                                                                                                                                            The status of the response.

                                                                                                                                                            jqXHR - - -jqXHR - - - -

                                                                                                                                                            The jQuery wrapped XMLHttpRequest object.

                                                                                                                                                            - -
                                                                                                                                                            - - - - - - - - - - - - - - - - - -
                                                                                                                                                            - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                            - - - - -
                                                                                                                                                            - - - - -
                                                                                                                                                            - -

                                                                                                                                                            - - inner handleRedeemResponse(data, textStatus, jqXHR) - - - - -

                                                                                                                                                            - - - -
                                                                                                                                                            -
                                                                                                                                                            - - -
                                                                                                                                                            -

                                                                                                                                                            Handles the response from the passcode redeeming API.

                                                                                                                                                            -
                                                                                                                                                            - - - - - - - - - -
                                                                                                                                                            -
                                                                                                                                                            Parameters:
                                                                                                                                                            - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                            NameTypeDescription
                                                                                                                                                            data - - -Object - - - -

                                                                                                                                                            The data returned by the API.

                                                                                                                                                            textStatus - - -string - - - -

                                                                                                                                                            The status of the response.

                                                                                                                                                            jqXHR - - -jqXHR - - - -

                                                                                                                                                            The jQuery wrapped XMLHttpRequest object.

                                                                                                                                                            - -
                                                                                                                                                            - - - - - - - - - - - - - - - - - -
                                                                                                                                                            - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                            - - - - -
                                                                                                                                                            - - - - -
                                                                                                                                                            - -

                                                                                                                                                            - - inner setupRedeem() - - - - -

                                                                                                                                                            - - - -
                                                                                                                                                            -
                                                                                                                                                            - - -
                                                                                                                                                            -

                                                                                                                                                            Sets up the redeem functionality, binding to UI elements.

                                                                                                                                                            -
                                                                                                                                                            - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                            - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                            - - - - -
                                                                                                                                                            - - - - -
                                                                                                                                                            - -

                                                                                                                                                            - - inner setupRedeem() - - - - -

                                                                                                                                                            - - - -
                                                                                                                                                            -
                                                                                                                                                            - - -
                                                                                                                                                            -

                                                                                                                                                            Sets up the redeem functionality, binding to UI elements.

                                                                                                                                                            -
                                                                                                                                                            - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                            - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                            - - - - -
                                                                                                                                                            - -
                                                                                                                                                            - - - - - -
                                                                                                                                                            - -
                                                                                                                                                            - - - - - - - -
                                                                                                                                                            - -
                                                                                                                                                            - -

                                                                                                                                                            redeeming

                                                                                                                                                            - - - - - - -
                                                                                                                                                            - -
                                                                                                                                                            - -
                                                                                                                                                            - - -

                                                                                                                                                            This file contains functions related to the handling of passcode redeeming in Ingress.

                                                                                                                                                            - - - - - -
                                                                                                                                                            - -
                                                                                                                                                            -
                                                                                                                                                            - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                            - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                            - - - - -
                                                                                                                                                            - - - - -
                                                                                                                                                            - -
                                                                                                                                                            -
                                                                                                                                                            - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                            - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                            - - - - -
                                                                                                                                                            - - - -
                                                                                                                                                            - - - - - - - - - - - - - - - -

                                                                                                                                                            Members

                                                                                                                                                            - -
                                                                                                                                                            - - -
                                                                                                                                                            -

                                                                                                                                                            - inner, constant REDEEM_SHORT_NAMES :Object - - - -

                                                                                                                                                            - - -
                                                                                                                                                            -
                                                                                                                                                            - -
                                                                                                                                                            -

                                                                                                                                                            Provides a scale factor for short names of various Ingress items used in passcode rewards.

                                                                                                                                                            -
                                                                                                                                                            - - - - - - - -
                                                                                                                                                            - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                            - - - - - -
                                                                                                                                                            - - - - -
                                                                                                                                                            -

                                                                                                                                                            - inner, constant REDEEM_SHORT_NAMES :Object - - - -

                                                                                                                                                            - - -
                                                                                                                                                            -
                                                                                                                                                            - -
                                                                                                                                                            -

                                                                                                                                                            Provides a scale factor for short names of various Ingress items used in passcode rewards.

                                                                                                                                                            -
                                                                                                                                                            - - - - - - - -
                                                                                                                                                            - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                            - - - - - -
                                                                                                                                                            - - - - -
                                                                                                                                                            -

                                                                                                                                                            - inner, constant REDEEM_STATUSES :Object - - - -

                                                                                                                                                            - - -
                                                                                                                                                            -
                                                                                                                                                            - -
                                                                                                                                                            -

                                                                                                                                                            HTTP status codes and corresponding messages returned by the redemption API.

                                                                                                                                                            -
                                                                                                                                                            - - - - - - - -
                                                                                                                                                            - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                            - - - - - -
                                                                                                                                                            - - - - -
                                                                                                                                                            -

                                                                                                                                                            - inner, constant REDEEM_STATUSES :Object - - - -

                                                                                                                                                            - - -
                                                                                                                                                            -
                                                                                                                                                            - -
                                                                                                                                                            -

                                                                                                                                                            HTTP status codes and corresponding messages returned by the redemption API.

                                                                                                                                                            -
                                                                                                                                                            - - - - - - - -
                                                                                                                                                            - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                            - - - - - -
                                                                                                                                                            - -
                                                                                                                                                            - - - -

                                                                                                                                                            Methods

                                                                                                                                                            - -
                                                                                                                                                            - - -
                                                                                                                                                            - -

                                                                                                                                                            - - inner formatPasscodeLong(data) → {string} - - - - -

                                                                                                                                                            - - - -
                                                                                                                                                            -
                                                                                                                                                            - - -
                                                                                                                                                            -

                                                                                                                                                            Formats passcode reward data into a long, detailed html string.

                                                                                                                                                            -
                                                                                                                                                            - - - - - - - - - -
                                                                                                                                                            -
                                                                                                                                                            Parameters:
                                                                                                                                                            - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                            NameTypeDescription
                                                                                                                                                            data - - -Object - - - -

                                                                                                                                                            The reward data.

                                                                                                                                                            - -
                                                                                                                                                            - - - - - - - - - - - - - -
                                                                                                                                                            -
                                                                                                                                                            Returns:
                                                                                                                                                            - - - - - -string - - - - - --

                                                                                                                                                            Formatted string representing the detailed rewards.

                                                                                                                                                            - - - - - -
                                                                                                                                                            - - - - - -
                                                                                                                                                            - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                            - - - - -
                                                                                                                                                            - - - - -
                                                                                                                                                            - -

                                                                                                                                                            - - inner formatPasscodeLong(data) → {string} - - - - -

                                                                                                                                                            - - - -
                                                                                                                                                            -
                                                                                                                                                            - - -
                                                                                                                                                            -

                                                                                                                                                            Formats passcode reward data into a long, detailed html string.

                                                                                                                                                            -
                                                                                                                                                            - - - - - - - - - -
                                                                                                                                                            -
                                                                                                                                                            Parameters:
                                                                                                                                                            - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                            NameTypeDescription
                                                                                                                                                            data - - -Object - - - -

                                                                                                                                                            The reward data.

                                                                                                                                                            - -
                                                                                                                                                            - - - - - - - - - - - - - -
                                                                                                                                                            -
                                                                                                                                                            Returns:
                                                                                                                                                            - - - - - -string - - - - - --

                                                                                                                                                            Formatted string representing the detailed rewards.

                                                                                                                                                            - - - - - -
                                                                                                                                                            - - - - - -
                                                                                                                                                            - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                            - - - - -
                                                                                                                                                            - - - - -
                                                                                                                                                            - -

                                                                                                                                                            - - inner formatPasscodeShort(data) → {string} - - - - -

                                                                                                                                                            - - - -
                                                                                                                                                            -
                                                                                                                                                            - - -
                                                                                                                                                            -

                                                                                                                                                            Formats passcode reward data into a short, concise html string.

                                                                                                                                                            -
                                                                                                                                                            - - - - - - - - - -
                                                                                                                                                            -
                                                                                                                                                            Parameters:
                                                                                                                                                            - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                            NameTypeDescription
                                                                                                                                                            data - - -Object - - - -

                                                                                                                                                            The reward data.

                                                                                                                                                            - -
                                                                                                                                                            - - - - - - - - - - - - - -
                                                                                                                                                            -
                                                                                                                                                            Returns:
                                                                                                                                                            - - - - - -string - - - - - --

                                                                                                                                                            Formatted string representing the concise rewards.

                                                                                                                                                            - - - - - -
                                                                                                                                                            - - - - - -
                                                                                                                                                            - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                            - - - - -
                                                                                                                                                            - - - - -
                                                                                                                                                            - -

                                                                                                                                                            - - inner formatPasscodeShort(data) → {string} - - - - -

                                                                                                                                                            - - - -
                                                                                                                                                            -
                                                                                                                                                            - - -
                                                                                                                                                            -

                                                                                                                                                            Formats passcode reward data into a short, concise html string.

                                                                                                                                                            -
                                                                                                                                                            - - - - - - - - - -
                                                                                                                                                            -
                                                                                                                                                            Parameters:
                                                                                                                                                            - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                            NameTypeDescription
                                                                                                                                                            data - - -Object - - - -

                                                                                                                                                            The reward data.

                                                                                                                                                            - -
                                                                                                                                                            - - - - - - - - - - - - - -
                                                                                                                                                            -
                                                                                                                                                            Returns:
                                                                                                                                                            - - - - - -string - - - - - --

                                                                                                                                                            Formatted string representing the concise rewards.

                                                                                                                                                            - - - - - -
                                                                                                                                                            - - - - - -
                                                                                                                                                            - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                            - - - - -
                                                                                                                                                            - - - - -
                                                                                                                                                            - -

                                                                                                                                                            - - inner handleRedeemResponse(data, textStatus, jqXHR) - - - - -

                                                                                                                                                            - - - -
                                                                                                                                                            -
                                                                                                                                                            - - -
                                                                                                                                                            -

                                                                                                                                                            Handles the response from the passcode redeeming API.

                                                                                                                                                            -
                                                                                                                                                            - - - - - - - - - -
                                                                                                                                                            -
                                                                                                                                                            Parameters:
                                                                                                                                                            - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                            NameTypeDescription
                                                                                                                                                            data - - -Object - - - -

                                                                                                                                                            The data returned by the API.

                                                                                                                                                            textStatus - - -string - - - -

                                                                                                                                                            The status of the response.

                                                                                                                                                            jqXHR - - -jqXHR - - - -

                                                                                                                                                            The jQuery wrapped XMLHttpRequest object.

                                                                                                                                                            - -
                                                                                                                                                            - - - - - - - - - - - - - - - - - -
                                                                                                                                                            - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                            - - - - -
                                                                                                                                                            - - - - -
                                                                                                                                                            - -

                                                                                                                                                            - - inner handleRedeemResponse(data, textStatus, jqXHR) - - - - -

                                                                                                                                                            - - - -
                                                                                                                                                            -
                                                                                                                                                            - - -
                                                                                                                                                            -

                                                                                                                                                            Handles the response from the passcode redeeming API.

                                                                                                                                                            -
                                                                                                                                                            - - - - - - - - - -
                                                                                                                                                            -
                                                                                                                                                            Parameters:
                                                                                                                                                            - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + @@ -3340,95 +895,6 @@

                                                                                                                                                            - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                            - -

                                                                                                                                                            - - inner setupRedeem() - - - - -

                                                                                                                                                            - - - -
                                                                                                                                                            -
                                                                                                                                                            - - -
                                                                                                                                                            -

                                                                                                                                                            Sets up the redeem functionality, binding to UI elements.

                                                                                                                                                            -
                                                                                                                                                            - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                            - - - - - - - - - - - - - - - - - - - - diff --git a/module-region_scoreboard-RegionScore.html b/module-region_scoreboard-RegionScore.html index 3035f7162..7bb27f1e5 100644 --- a/module-region_scoreboard-RegionScore.html +++ b/module-region_scoreboard-RegionScore.html @@ -34,7 +34,7 @@

                                                                                                                                                            IITC-CE

                                                                                                                                                              - +
                                                                                                                                                              @@ -179,191 +179,6 @@
                                                                                                                                                              Parameters:
                                                                                                                                                              - - - - - - - - - - -
                                                                                                                                                              - - - - -
                                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                              - -
                                                                                                                                                              - -

                                                                                                                                                              - region_scoreboard~RegionScore(serverResult)

                                                                                                                                                              - - -
                                                                                                                                                              - -
                                                                                                                                                              - -
                                                                                                                                                              - - - -
                                                                                                                                                              - -

                                                                                                                                                              - - new RegionScore(serverResult) - - - - -

                                                                                                                                                              - - - -
                                                                                                                                                              -
                                                                                                                                                              - - -
                                                                                                                                                              -

                                                                                                                                                              Constructs a RegionScore object from server results. Contains methods to process and retrieve score data.

                                                                                                                                                              -
                                                                                                                                                              - - - - - - - - - -
                                                                                                                                                              -
                                                                                                                                                              Parameters:
                                                                                                                                                              - -

                                                                                                                                                              NameTypeDescription
                                                                                                                                                              data - - -Object - - - -

                                                                                                                                                              The data returned by the API.

                                                                                                                                                              The data returned by the API.

                                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                              NameTypeDescription
                                                                                                                                                              serverResult - - -Object - - - -

                                                                                                                                                              The data returned from the server for regional scores.

                                                                                                                                                              - -
                                                                                                                                                              - - - - - - - - - - - - - - - - - -
                                                                                                                                                              - - - - - - - - - - - - - - - - - - - - diff --git a/module-region_scoreboard.html b/module-region_scoreboard.html index 9b13b958f..eedcd6307 100644 --- a/module-region_scoreboard.html +++ b/module-region_scoreboard.html @@ -34,7 +34,7 @@

                                                                                                                                                              IITC-CE

                                                                                                                                                                - +
                                                                                                                                                                @@ -52,8 +52,6 @@

                                                                                                                                                                region_scoreboard

                                                                                                                                                                - - @@ -119,77 +117,6 @@

                                                                                                                                                                region_scoreboard

                                                                                                                                                                - - - - - - - - - - -
                                                                                                                                                                - - - - -
                                                                                                                                                                - - - - -
                                                                                                                                                                - -
                                                                                                                                                                -
                                                                                                                                                                - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                - - - - - - - - - - - - - - - - - - - - @@ -232,16 +159,6 @@

                                                                                                                                                                -
                                                                                                                                                                -

                                                                                                                                                                - RegionScore - -

                                                                                                                                                                -
                                                                                                                                                                - -

                                                                                                                                                                @@ -423,1114 +340,6 @@
                                                                                                                                                                Returns:
                                                                                                                                                                - - - - - - - - - - -
                                                                                                                                                                - - - - - - - - - -
                                                                                                                                                                - -

                                                                                                                                                                - - inner HistoryChart(_regionScore, logscale) → {string} - - - - -

                                                                                                                                                                - - - -
                                                                                                                                                                -
                                                                                                                                                                - - -
                                                                                                                                                                -

                                                                                                                                                                Creates an SVG-based history chart for regional scores.

                                                                                                                                                                -
                                                                                                                                                                - - - - - - - - - -
                                                                                                                                                                -
                                                                                                                                                                Parameters:
                                                                                                                                                                - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                NameTypeDescription
                                                                                                                                                                _regionScore - - -RegionScore - - - -

                                                                                                                                                                The RegionScore object containing score data.

                                                                                                                                                                logscale - - -boolean - - - -

                                                                                                                                                                Whether to use logarithmic scale for the chart.

                                                                                                                                                                - -
                                                                                                                                                                - - - - - - - - - - - - - -
                                                                                                                                                                -
                                                                                                                                                                Returns:
                                                                                                                                                                - - - - - -string - - - - - --

                                                                                                                                                                An SVG string representing the history chart.

                                                                                                                                                                - - - - - -
                                                                                                                                                                - - - - - -
                                                                                                                                                                - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                - - - - -
                                                                                                                                                                - - - - -
                                                                                                                                                                - -

                                                                                                                                                                - - inner RegionScoreboardSetup() → {function} - - - - -

                                                                                                                                                                - - - -
                                                                                                                                                                -
                                                                                                                                                                - - -
                                                                                                                                                                -

                                                                                                                                                                Sets up and manages the main dialog for the regional scoreboard.

                                                                                                                                                                -
                                                                                                                                                                - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                -
                                                                                                                                                                Returns:
                                                                                                                                                                - - - - - -function - - - - - --

                                                                                                                                                                A setup function to initialize the scoreboard.

                                                                                                                                                                - - - - - -
                                                                                                                                                                - - - - - -
                                                                                                                                                                - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                - - - - -
                                                                                                                                                                - - - - -
                                                                                                                                                                - -

                                                                                                                                                                - - inner RegionScoreboardSetup() → {function} - - - - -

                                                                                                                                                                - - - -
                                                                                                                                                                -
                                                                                                                                                                - - -
                                                                                                                                                                -

                                                                                                                                                                Sets up and manages the main dialog for the regional scoreboard.

                                                                                                                                                                -
                                                                                                                                                                - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                -
                                                                                                                                                                Returns:
                                                                                                                                                                - - - - - -function - - - - - --

                                                                                                                                                                A setup function to initialize the scoreboard.

                                                                                                                                                                - - - - - -
                                                                                                                                                                - - - - - -
                                                                                                                                                                - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                - - - - -
                                                                                                                                                                - - - - - - - -
                                                                                                                                                                - -
                                                                                                                                                                - - - - - - - -
                                                                                                                                                                - -
                                                                                                                                                                - -

                                                                                                                                                                region_scoreboard

                                                                                                                                                                - - - - - - -
                                                                                                                                                                - -
                                                                                                                                                                - -
                                                                                                                                                                - - -

                                                                                                                                                                This file contains the code for displaying and handling the regional scoreboard.

                                                                                                                                                                - - - - - -
                                                                                                                                                                - -
                                                                                                                                                                -
                                                                                                                                                                - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                - - - - -
                                                                                                                                                                - - - - -
                                                                                                                                                                - -
                                                                                                                                                                -
                                                                                                                                                                - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                - - - - -
                                                                                                                                                                - - - -
                                                                                                                                                                - - - - - - - -

                                                                                                                                                                Classes

                                                                                                                                                                - - -
                                                                                                                                                                - -
                                                                                                                                                                -

                                                                                                                                                                - RegionScore - -

                                                                                                                                                                -
                                                                                                                                                                - - -
                                                                                                                                                                -

                                                                                                                                                                - RegionScore - -

                                                                                                                                                                -
                                                                                                                                                                - - -
                                                                                                                                                                - - - - - - - - - - - - -

                                                                                                                                                                Methods

                                                                                                                                                                - -
                                                                                                                                                                - - -
                                                                                                                                                                - -

                                                                                                                                                                - - inner HistoryChart(_regionScore, logscale) → {string} - - - - -

                                                                                                                                                                - - - -
                                                                                                                                                                -
                                                                                                                                                                - - -
                                                                                                                                                                -

                                                                                                                                                                Creates an SVG-based history chart for regional scores.

                                                                                                                                                                -
                                                                                                                                                                - - - - - - - - - -
                                                                                                                                                                -
                                                                                                                                                                Parameters:
                                                                                                                                                                - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                NameTypeDescription
                                                                                                                                                                _regionScore - - -RegionScore - - - -

                                                                                                                                                                The RegionScore object containing score data.

                                                                                                                                                                logscale - - -boolean - - - -

                                                                                                                                                                Whether to use logarithmic scale for the chart.

                                                                                                                                                                - -
                                                                                                                                                                - - - - - - - - - - - - - -
                                                                                                                                                                -
                                                                                                                                                                Returns:
                                                                                                                                                                - - - - - -string - - - - - --

                                                                                                                                                                An SVG string representing the history chart.

                                                                                                                                                                - - - - - -
                                                                                                                                                                - - - - - -
                                                                                                                                                                - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                - - - - -
                                                                                                                                                                - - - - -
                                                                                                                                                                - -

                                                                                                                                                                - - inner HistoryChart(_regionScore, logscale) → {string} - - - - -

                                                                                                                                                                - - - -
                                                                                                                                                                -
                                                                                                                                                                - - -
                                                                                                                                                                -

                                                                                                                                                                Creates an SVG-based history chart for regional scores.

                                                                                                                                                                -
                                                                                                                                                                - - - - - - - - - -
                                                                                                                                                                -
                                                                                                                                                                Parameters:
                                                                                                                                                                - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                NameTypeDescription
                                                                                                                                                                _regionScore - - -RegionScore - - - -

                                                                                                                                                                The RegionScore object containing score data.

                                                                                                                                                                logscale - - -boolean - - - -

                                                                                                                                                                Whether to use logarithmic scale for the chart.

                                                                                                                                                                - -
                                                                                                                                                                - - - - - - - - - - - - - -
                                                                                                                                                                -
                                                                                                                                                                Returns:
                                                                                                                                                                - - - - - -string - - - - - --

                                                                                                                                                                An SVG string representing the history chart.

                                                                                                                                                                - - - - - -
                                                                                                                                                                - - - - - -
                                                                                                                                                                - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                - - - - -
                                                                                                                                                                - - - - -
                                                                                                                                                                - -

                                                                                                                                                                - - inner RegionScoreboardSetup() → {function} - - - - -

                                                                                                                                                                - - - -
                                                                                                                                                                -
                                                                                                                                                                - - -
                                                                                                                                                                -

                                                                                                                                                                Sets up and manages the main dialog for the regional scoreboard.

                                                                                                                                                                -
                                                                                                                                                                - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                -
                                                                                                                                                                Returns:
                                                                                                                                                                - - - - - -function - - - - - --

                                                                                                                                                                A setup function to initialize the scoreboard.

                                                                                                                                                                - - - - - -
                                                                                                                                                                - - - - - -
                                                                                                                                                                - - - - - - - - - - - - - - - - - - - - diff --git a/module-request_handling.html b/module-request_handling.html index ba7813675..474a049fe 100644 --- a/module-request_handling.html +++ b/module-request_handling.html @@ -34,7 +34,7 @@

                                                                                                                                                                IITC-CE

                                                                                                                                                                  - +
                                                                                                                                                                  @@ -52,516 +52,6 @@

                                                                                                                                                                  request_handling

                                                                                                                                                                  - - - - - -
                                                                                                                                                                  - -
                                                                                                                                                                  - - -

                                                                                                                                                                  This file contains functions and variables related to request handling in IITC. -Note: only meant for portal/links/fields request, everything else does not count towards “loading”

                                                                                                                                                                  - - - - - -
                                                                                                                                                                  - -
                                                                                                                                                                  -
                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                  - - - - -
                                                                                                                                                                  - - - - -
                                                                                                                                                                  - -
                                                                                                                                                                  -
                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                  - - - - -
                                                                                                                                                                  - - - -
                                                                                                                                                                  - - - - - - - - - - - - - - - - - -

                                                                                                                                                                  Methods

                                                                                                                                                                  - -
                                                                                                                                                                  - - -
                                                                                                                                                                  - -

                                                                                                                                                                  - - inner startRefreshTimeout(overrideopt) - - - - -

                                                                                                                                                                  - - - -
                                                                                                                                                                  -
                                                                                                                                                                  - - -
                                                                                                                                                                  -

                                                                                                                                                                  Sets a timeout for the next automatic refresh of data. Ensures only one timeout is queued. -Can use an override time in milliseconds. -Especially useful if a little delay is required, for example when zooming.

                                                                                                                                                                  -
                                                                                                                                                                  - - - - - - - - - -
                                                                                                                                                                  -
                                                                                                                                                                  Parameters:
                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                  NameTypeAttributesDescription
                                                                                                                                                                  override - - -number - - - - - - <optional>
                                                                                                                                                                  - - - - - -

                                                                                                                                                                  Optional override time in milliseconds for the next refresh.

                                                                                                                                                                  - -
                                                                                                                                                                  - - - - - - - - - - - - - - - - - -
                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                  - - - - -
                                                                                                                                                                  - - - - -
                                                                                                                                                                  - -

                                                                                                                                                                  - - inner startRefreshTimeout(overrideopt) - - - - -

                                                                                                                                                                  - - - -
                                                                                                                                                                  -
                                                                                                                                                                  - - -
                                                                                                                                                                  -

                                                                                                                                                                  Sets a timeout for the next automatic refresh of data. Ensures only one timeout is queued. -Can use an override time in milliseconds. -Especially useful if a little delay is required, for example when zooming.

                                                                                                                                                                  -
                                                                                                                                                                  - - - - - - - - - -
                                                                                                                                                                  -
                                                                                                                                                                  Parameters:
                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                  NameTypeAttributesDescription
                                                                                                                                                                  override - - -number - - - - - - <optional>
                                                                                                                                                                  - - - - - -

                                                                                                                                                                  Optional override time in milliseconds for the next refresh.

                                                                                                                                                                  - -
                                                                                                                                                                  - - - - - - - - - - - - - - - - - -
                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                  - - - - -
                                                                                                                                                                  - -
                                                                                                                                                                  - - - - - -
                                                                                                                                                                  - -
                                                                                                                                                                  - - - - - - - -
                                                                                                                                                                  - -
                                                                                                                                                                  - -

                                                                                                                                                                  request_handling

                                                                                                                                                                  - - - - -
                                                                                                                                                                  @@ -628,77 +118,6 @@

                                                                                                                                                                  request_handling

                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                  - -
                                                                                                                                                                  -
                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - @@ -874,159 +293,6 @@
                                                                                                                                                                  Parameters:
                                                                                                                                                                  - - - - - - - - - - -
                                                                                                                                                                  - - - - -
                                                                                                                                                                  - - - - -
                                                                                                                                                                  - -

                                                                                                                                                                  - - inner startRefreshTimeout(overrideopt) - - - - -

                                                                                                                                                                  - - - -
                                                                                                                                                                  -
                                                                                                                                                                  - - -
                                                                                                                                                                  -

                                                                                                                                                                  Sets a timeout for the next automatic refresh of data. Ensures only one timeout is queued. -Can use an override time in milliseconds. -Especially useful if a little delay is required, for example when zooming.

                                                                                                                                                                  -
                                                                                                                                                                  - - - - - - - - - -
                                                                                                                                                                  -
                                                                                                                                                                  Parameters:
                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                  NameTypeAttributesDescription
                                                                                                                                                                  override - - -number - - - - - - <optional>
                                                                                                                                                                  - - - - - -

                                                                                                                                                                  Optional override time in milliseconds for the next refresh.

                                                                                                                                                                  - -
                                                                                                                                                                  - - - - - - - - - - - - - - - - - -
                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - diff --git a/module-send_request.html b/module-send_request.html index 6d08f446c..ccb2a8dca 100644 --- a/module-send_request.html +++ b/module-send_request.html @@ -34,7 +34,7 @@

                                                                                                                                                                  IITC-CE

                                                                                                                                                                    - +
                                                                                                                                                                    @@ -52,8 +52,6 @@

                                                                                                                                                                    send_request

                                                                                                                                                                    - - @@ -119,77 +117,6 @@

                                                                                                                                                                    send_request

                                                                                                                                                                    - - - - - - - - - - -
                                                                                                                                                                    - - - - -
                                                                                                                                                                    - - - - -
                                                                                                                                                                    - -
                                                                                                                                                                    -
                                                                                                                                                                    - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                    - - - - - - - - - - - - - - - - - - - - @@ -302,1167 +229,6 @@

                                                                                                                                                                    - - - - - - - - - - -

                                                                                                                                                                    - - - - -
                                                                                                                                                                    - - - - -
                                                                                                                                                                    - -

                                                                                                                                                                    - - inner outOfDateUserPrompt() - - - - -

                                                                                                                                                                    - - - -
                                                                                                                                                                    -
                                                                                                                                                                    - - -
                                                                                                                                                                    -

                                                                                                                                                                    Displays a dialog prompt to the user when the IITC version is out of date. -Blocks all requests while the dialog is open.

                                                                                                                                                                    -
                                                                                                                                                                    - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                    - - - - -
                                                                                                                                                                    - - - - -
                                                                                                                                                                    - -

                                                                                                                                                                    - - inner postAjax(action, data, successCallback, errorCallback) → {jqXHR} - - - - -

                                                                                                                                                                    - - - -
                                                                                                                                                                    -
                                                                                                                                                                    - - -
                                                                                                                                                                    -

                                                                                                                                                                    Sends an AJAX POST request to the Ingress API.

                                                                                                                                                                    -
                                                                                                                                                                    - - - - - - - - - -
                                                                                                                                                                    -
                                                                                                                                                                    Parameters:
                                                                                                                                                                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                    NameTypeDescription
                                                                                                                                                                    action - - -string - - - -

                                                                                                                                                                    The last part of the URL, automatically appended to the Ingress API endpoint.

                                                                                                                                                                    data - - -Object - - - -

                                                                                                                                                                    JSON data to post. The method is derived automatically from action but may be overridden. -Expects to be given a Hash. Strings are not supported.

                                                                                                                                                                    successCallback - - -function - - - -

                                                                                                                                                                    Function to call on success. See jQuery API docs for available arguments.

                                                                                                                                                                    errorCallback - - -function - - - -

                                                                                                                                                                    Function to call on error. Additionally, it is logged if the request failed.

                                                                                                                                                                    - -
                                                                                                                                                                    - - - - - - - - - - - - - -
                                                                                                                                                                    -
                                                                                                                                                                    Returns:
                                                                                                                                                                    - - - - - -jqXHR - - - - - --

                                                                                                                                                                    The jQuery wrapped XMLHttpRequest object.

                                                                                                                                                                    - - - - - -
                                                                                                                                                                    - - - - - -
                                                                                                                                                                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                    - - - - -
                                                                                                                                                                    - - - - -
                                                                                                                                                                    - -

                                                                                                                                                                    - - inner postAjax(action, data, successCallback, errorCallback) → {jqXHR} - - - - -

                                                                                                                                                                    - - - -
                                                                                                                                                                    -
                                                                                                                                                                    - - -
                                                                                                                                                                    -

                                                                                                                                                                    Sends an AJAX POST request to the Ingress API.

                                                                                                                                                                    -
                                                                                                                                                                    - - - - - - - - - -
                                                                                                                                                                    -
                                                                                                                                                                    Parameters:
                                                                                                                                                                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                    NameTypeDescription
                                                                                                                                                                    action - - -string - - - -

                                                                                                                                                                    The last part of the URL, automatically appended to the Ingress API endpoint.

                                                                                                                                                                    data - - -Object - - - -

                                                                                                                                                                    JSON data to post. The method is derived automatically from action but may be overridden. -Expects to be given a Hash. Strings are not supported.

                                                                                                                                                                    successCallback - - -function - - - -

                                                                                                                                                                    Function to call on success. See jQuery API docs for available arguments.

                                                                                                                                                                    errorCallback - - -function - - - -

                                                                                                                                                                    Function to call on error. Additionally, it is logged if the request failed.

                                                                                                                                                                    - -
                                                                                                                                                                    - - - - - - - - - - - - - -
                                                                                                                                                                    -
                                                                                                                                                                    Returns:
                                                                                                                                                                    - - - - - -jqXHR - - - - - --

                                                                                                                                                                    The jQuery wrapped XMLHttpRequest object.

                                                                                                                                                                    - - - - - -
                                                                                                                                                                    - - - - - -
                                                                                                                                                                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                    - - - - -
                                                                                                                                                                    - - - - - - - - - -
                                                                                                                                                                    - - - - - - - -
                                                                                                                                                                    - -
                                                                                                                                                                    - -

                                                                                                                                                                    send_request

                                                                                                                                                                    - - - - - - -
                                                                                                                                                                    - -
                                                                                                                                                                    - -
                                                                                                                                                                    - - -

                                                                                                                                                                    This file provides functions for sending AJAX requests to the Ingress API.

                                                                                                                                                                    - - - - - -
                                                                                                                                                                    - -
                                                                                                                                                                    -
                                                                                                                                                                    - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                    - - - - -
                                                                                                                                                                    - - - - -
                                                                                                                                                                    - -
                                                                                                                                                                    -
                                                                                                                                                                    - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                    - - - - -
                                                                                                                                                                    - - - -
                                                                                                                                                                    - - - - - - - - - - - - - - - - - -

                                                                                                                                                                    Methods

                                                                                                                                                                    - -
                                                                                                                                                                    - - -
                                                                                                                                                                    - -

                                                                                                                                                                    - - inner outOfDateUserPrompt() - - - - -

                                                                                                                                                                    - - - -
                                                                                                                                                                    -
                                                                                                                                                                    - - -
                                                                                                                                                                    -

                                                                                                                                                                    Displays a dialog prompt to the user when the IITC version is out of date. -Blocks all requests while the dialog is open.

                                                                                                                                                                    -
                                                                                                                                                                    - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                    - - - - -
                                                                                                                                                                    - - - - -
                                                                                                                                                                    - -

                                                                                                                                                                    - - inner outOfDateUserPrompt() - - - - -

                                                                                                                                                                    - - - -
                                                                                                                                                                    -
                                                                                                                                                                    - - -
                                                                                                                                                                    -

                                                                                                                                                                    Displays a dialog prompt to the user when the IITC version is out of date. -Blocks all requests while the dialog is open.

                                                                                                                                                                    -
                                                                                                                                                                    - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                    - - - - -
                                                                                                                                                                    - - - - -
                                                                                                                                                                    - -

                                                                                                                                                                    - - inner postAjax(action, data, successCallback, errorCallback) → {jqXHR} - - - - -

                                                                                                                                                                    - - - -
                                                                                                                                                                    -
                                                                                                                                                                    - - -
                                                                                                                                                                    -

                                                                                                                                                                    Sends an AJAX POST request to the Ingress API.

                                                                                                                                                                    -
                                                                                                                                                                    - - - - - - - - - -
                                                                                                                                                                    -
                                                                                                                                                                    Parameters:
                                                                                                                                                                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                    NameTypeDescription
                                                                                                                                                                    action - - -string - - - -

                                                                                                                                                                    The last part of the URL, automatically appended to the Ingress API endpoint.

                                                                                                                                                                    data - - -Object - - - -

                                                                                                                                                                    JSON data to post. The method is derived automatically from action but may be overridden. -Expects to be given a Hash. Strings are not supported.

                                                                                                                                                                    successCallback - - -function - - - -

                                                                                                                                                                    Function to call on success. See jQuery API docs for available arguments.

                                                                                                                                                                    errorCallback - - -function - - - -

                                                                                                                                                                    Function to call on error. Additionally, it is logged if the request failed.

                                                                                                                                                                    - -
                                                                                                                                                                    - - - - - - - - - - - - - -
                                                                                                                                                                    -
                                                                                                                                                                    Returns:
                                                                                                                                                                    - - - - - -jqXHR - - - - - --

                                                                                                                                                                    The jQuery wrapped XMLHttpRequest object.

                                                                                                                                                                    - - - - - -
                                                                                                                                                                    - - - - - -
                                                                                                                                                                    - - - - - - - - - - - - - - - - - - - - diff --git a/module-sidebar.html b/module-sidebar.html index 0c86fd8d6..fa92af8c1 100644 --- a/module-sidebar.html +++ b/module-sidebar.html @@ -34,7 +34,7 @@

                                                                                                                                                                    IITC-CE

                                                                                                                                                                      - +
                                                                                                                                                                      @@ -52,8 +52,6 @@

                                                                                                                                                                      sidebar

                                                                                                                                                                      - - @@ -119,77 +117,6 @@

                                                                                                                                                                      sidebar

                                                                                                                                                                      - - - - - - - - - - -
                                                                                                                                                                      - - - - -
                                                                                                                                                                      - - - - -
                                                                                                                                                                      - -
                                                                                                                                                                      -
                                                                                                                                                                      - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                      - - - - - - - - - - - - - - - - - - - - @@ -301,95 +228,6 @@
                                                                                                                                                                      - - - - -
                                                                                                                                                                      - - - - -
                                                                                                                                                                      - - - - - -
                                                                                                                                                                      -
                                                                                                                                                                      - - -
                                                                                                                                                                      -

                                                                                                                                                                      Updates the permalink href attribute on mouseover and click events.

                                                                                                                                                                      -
                                                                                                                                                                      - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                      - - - - - - - - - - - - - - - - - - - - @@ -501,14 +339,14 @@

                                                                                                                                                                      -

                                                                                                                                                                      +

                                                                                                                                                                      - inner setupAddons() + inner setupIcons()

                                                                                                                                                                      @@ -520,7 +358,7 @@

                                                                                                                                                                      -

                                                                                                                                                                      Sets up additional elements in the sidebar, such as permalink and about dialog.

                                                                                                                                                                      +

                                                                                                                                                                      Sets up custom icons by appending SVG definitions to the DOM.

                                                                                                                                                                      @@ -590,14 +428,14 @@

                                                                                                                                                                      -

                                                                                                                                                                      +

                                                                                                                                                                      - inner setupIcons() + inner setupLargeImagePreview()

                                                                                                                                                                      @@ -609,7 +447,9 @@

                                                                                                                                                                      -

                                                                                                                                                                      Sets up custom icons by appending SVG definitions to the DOM.

                                                                                                                                                                      +

                                                                                                                                                                      Sets up event listeners for the large portal image view. This dialog is displayed +when a user clicks on the portal photo in the sidebar. It creates a new image +preview inside a dialog box.

                                                                                                                                                                      @@ -679,14 +519,14 @@

                                                                                                                                                                      -

                                                                                                                                                                      +

                                                                                                                                                                      - inner setupIcons() + inner setupPlayerStat()

                                                                                                                                                                      @@ -698,7 +538,9 @@

                                                                                                                                                                      -

                                                                                                                                                                      Sets up custom icons by appending SVG definitions to the DOM.

                                                                                                                                                                      +

                                                                                                                                                                      Renders player details into the website. Since the player info is +included as inline script in the original site, the data is static +and cannot be updated.

                                                                                                                                                                      @@ -768,14 +610,14 @@

                                                                                                                                                                      -

                                                                                                                                                                      +

                                                                                                                                                                      - inner setupLargeImagePreview() + inner setupSidebar()

                                                                                                                                                                      @@ -787,9 +629,7 @@

                                                                                                                                                                      -

                                                                                                                                                                      Sets up event listeners for the large portal image view. This dialog is displayed -when a user clicks on the portal photo in the sidebar. It creates a new image -preview inside a dialog box.

                                                                                                                                                                      +

                                                                                                                                                                      Sets up the sidebar, including player stats, toggle button, large image preview, etc.

                                                                                                                                                                      @@ -859,2189 +699,14 @@

                                                                                                                                                                      -

                                                                                                                                                                      +

                                                                                                                                                                      - inner setupLargeImagePreview() + inner setupSidebarToggle() - -

                                                                                                                                                                      - - - -
                                                                                                                                                                      -
                                                                                                                                                                      - - -
                                                                                                                                                                      -

                                                                                                                                                                      Sets up event listeners for the large portal image view. This dialog is displayed -when a user clicks on the portal photo in the sidebar. It creates a new image -preview inside a dialog box.

                                                                                                                                                                      -
                                                                                                                                                                      - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                      - - - - -
                                                                                                                                                                      - - - - -
                                                                                                                                                                      - -

                                                                                                                                                                      - - inner setupPlayerStat() - - - - -

                                                                                                                                                                      - - - -
                                                                                                                                                                      -
                                                                                                                                                                      - - -
                                                                                                                                                                      -

                                                                                                                                                                      Renders player details into the website. Since the player info is -included as inline script in the original site, the data is static -and cannot be updated.

                                                                                                                                                                      -
                                                                                                                                                                      - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                      - - - - -
                                                                                                                                                                      - - - - -
                                                                                                                                                                      - -

                                                                                                                                                                      - - inner setupPlayerStat() - - - - -

                                                                                                                                                                      - - - -
                                                                                                                                                                      -
                                                                                                                                                                      - - -
                                                                                                                                                                      -

                                                                                                                                                                      Renders player details into the website. Since the player info is -included as inline script in the original site, the data is static -and cannot be updated.

                                                                                                                                                                      -
                                                                                                                                                                      - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                      - - - - -
                                                                                                                                                                      - - - - -
                                                                                                                                                                      - -

                                                                                                                                                                      - - inner setupSidebar() - - - - -

                                                                                                                                                                      - - - -
                                                                                                                                                                      -
                                                                                                                                                                      - - -
                                                                                                                                                                      -

                                                                                                                                                                      Sets up the sidebar, including player stats, toggle button, large image preview, etc.

                                                                                                                                                                      -
                                                                                                                                                                      - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                      - - - - -
                                                                                                                                                                      - - - - -
                                                                                                                                                                      - -

                                                                                                                                                                      - - inner setupSidebar() - - - - -

                                                                                                                                                                      - - - -
                                                                                                                                                                      -
                                                                                                                                                                      - - -
                                                                                                                                                                      -

                                                                                                                                                                      Sets up the sidebar, including player stats, toggle button, large image preview, etc.

                                                                                                                                                                      -
                                                                                                                                                                      - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                      - - - - -
                                                                                                                                                                      - - - - -
                                                                                                                                                                      - -

                                                                                                                                                                      - - inner setupSidebarToggle() - - - - -

                                                                                                                                                                      - - - -
                                                                                                                                                                      -
                                                                                                                                                                      - - -
                                                                                                                                                                      -

                                                                                                                                                                      Initializes the sidebar toggle functionality.

                                                                                                                                                                      -
                                                                                                                                                                      - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                      - - - - -
                                                                                                                                                                      - - - - -
                                                                                                                                                                      - -

                                                                                                                                                                      - - inner setupSidebarToggle() - - - - -

                                                                                                                                                                      - - - -
                                                                                                                                                                      -
                                                                                                                                                                      - - -
                                                                                                                                                                      -

                                                                                                                                                                      Initializes the sidebar toggle functionality.

                                                                                                                                                                      -
                                                                                                                                                                      - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                      - - - - -
                                                                                                                                                                      - - - - -
                                                                                                                                                                      - -

                                                                                                                                                                      - - inner setupStyles() - - - - -

                                                                                                                                                                      - - - -
                                                                                                                                                                      -
                                                                                                                                                                      - - -
                                                                                                                                                                      -

                                                                                                                                                                      Function to append IITC's custom CSS styles to the <head> element. -Overwritten in smartphone.js.

                                                                                                                                                                      -
                                                                                                                                                                      - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                      - - - - -
                                                                                                                                                                      - - - - -
                                                                                                                                                                      - -

                                                                                                                                                                      - - inner setupStyles() - - - - -

                                                                                                                                                                      - - - -
                                                                                                                                                                      -
                                                                                                                                                                      - - -
                                                                                                                                                                      -

                                                                                                                                                                      Function to append IITC's custom CSS styles to the <head> element. -Overwritten in smartphone.js.

                                                                                                                                                                      -
                                                                                                                                                                      - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                      - - - - -
                                                                                                                                                                      - -

                                                                                                                                                                      - - - - - -
                                                                                                                                                                      - -
                                                                                                                                                                      - - - - - - - -
                                                                                                                                                                      - -
                                                                                                                                                                      - -

                                                                                                                                                                      sidebar

                                                                                                                                                                      - - - - - - -
                                                                                                                                                                      - -
                                                                                                                                                                      - -
                                                                                                                                                                      - - -

                                                                                                                                                                      This file provides functions for working with the sidebar.

                                                                                                                                                                      - - - - - -
                                                                                                                                                                      - -
                                                                                                                                                                      -
                                                                                                                                                                      - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                      - - - - -
                                                                                                                                                                      - - - - -
                                                                                                                                                                      - -
                                                                                                                                                                      -
                                                                                                                                                                      - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                      - - - - -
                                                                                                                                                                      - - - -
                                                                                                                                                                      - - - - - - - - - - - - - - - - - -

                                                                                                                                                                      Methods

                                                                                                                                                                      - -
                                                                                                                                                                      - - -
                                                                                                                                                                      - - - - - -
                                                                                                                                                                      -
                                                                                                                                                                      - - -
                                                                                                                                                                      -

                                                                                                                                                                      Updates the permalink href attribute on mouseover and click events.

                                                                                                                                                                      -
                                                                                                                                                                      - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                      - - - - -
                                                                                                                                                                      - - - - -
                                                                                                                                                                      - - - - - -
                                                                                                                                                                      -
                                                                                                                                                                      - - -
                                                                                                                                                                      -

                                                                                                                                                                      Updates the permalink href attribute on mouseover and click events.

                                                                                                                                                                      -
                                                                                                                                                                      - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                      - - - - -
                                                                                                                                                                      - - - - -
                                                                                                                                                                      - -

                                                                                                                                                                      - - inner setupAddons() - - - - -

                                                                                                                                                                      - - - -
                                                                                                                                                                      -
                                                                                                                                                                      - - -
                                                                                                                                                                      -

                                                                                                                                                                      Sets up additional elements in the sidebar, such as permalink and about dialog.

                                                                                                                                                                      -
                                                                                                                                                                      - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                      - - - - -
                                                                                                                                                                      - - - - -
                                                                                                                                                                      - -

                                                                                                                                                                      - - inner setupAddons() - - - - -

                                                                                                                                                                      - - - -
                                                                                                                                                                      -
                                                                                                                                                                      - - -
                                                                                                                                                                      -

                                                                                                                                                                      Sets up additional elements in the sidebar, such as permalink and about dialog.

                                                                                                                                                                      -
                                                                                                                                                                      - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                      - - - - -
                                                                                                                                                                      - - - - -
                                                                                                                                                                      - -

                                                                                                                                                                      - - inner setupIcons() - - - - -

                                                                                                                                                                      - - - -
                                                                                                                                                                      -
                                                                                                                                                                      - - -
                                                                                                                                                                      -

                                                                                                                                                                      Sets up custom icons by appending SVG definitions to the DOM.

                                                                                                                                                                      -
                                                                                                                                                                      - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                      - - - - -
                                                                                                                                                                      - - - - -
                                                                                                                                                                      - -

                                                                                                                                                                      - - inner setupIcons() - - - - -

                                                                                                                                                                      - - - -
                                                                                                                                                                      -
                                                                                                                                                                      - - -
                                                                                                                                                                      -

                                                                                                                                                                      Sets up custom icons by appending SVG definitions to the DOM.

                                                                                                                                                                      -
                                                                                                                                                                      - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                      - - - - -
                                                                                                                                                                      - - - - -
                                                                                                                                                                      - -

                                                                                                                                                                      - - inner setupLargeImagePreview() - - - - -

                                                                                                                                                                      - - - -
                                                                                                                                                                      -
                                                                                                                                                                      - - -
                                                                                                                                                                      -

                                                                                                                                                                      Sets up event listeners for the large portal image view. This dialog is displayed -when a user clicks on the portal photo in the sidebar. It creates a new image -preview inside a dialog box.

                                                                                                                                                                      -
                                                                                                                                                                      - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                      - - - - -
                                                                                                                                                                      - - - - -
                                                                                                                                                                      - -

                                                                                                                                                                      - - inner setupLargeImagePreview() - - - - -

                                                                                                                                                                      - - - -
                                                                                                                                                                      -
                                                                                                                                                                      - - -
                                                                                                                                                                      -

                                                                                                                                                                      Sets up event listeners for the large portal image view. This dialog is displayed -when a user clicks on the portal photo in the sidebar. It creates a new image -preview inside a dialog box.

                                                                                                                                                                      -
                                                                                                                                                                      - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                      - - - - -
                                                                                                                                                                      - - - - -
                                                                                                                                                                      - -

                                                                                                                                                                      - - inner setupPlayerStat() - - - - -

                                                                                                                                                                      - - - -
                                                                                                                                                                      -
                                                                                                                                                                      - - -
                                                                                                                                                                      -

                                                                                                                                                                      Renders player details into the website. Since the player info is -included as inline script in the original site, the data is static -and cannot be updated.

                                                                                                                                                                      -
                                                                                                                                                                      - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                      - - - - -
                                                                                                                                                                      - - - - -
                                                                                                                                                                      - -

                                                                                                                                                                      - - inner setupPlayerStat() - - - - -

                                                                                                                                                                      - - - -
                                                                                                                                                                      -
                                                                                                                                                                      - - -
                                                                                                                                                                      -

                                                                                                                                                                      Renders player details into the website. Since the player info is -included as inline script in the original site, the data is static -and cannot be updated.

                                                                                                                                                                      -
                                                                                                                                                                      - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                      - - - - -
                                                                                                                                                                      - - - - -
                                                                                                                                                                      - -

                                                                                                                                                                      - - inner setupSidebar() - - - - -

                                                                                                                                                                      - - - -
                                                                                                                                                                      -
                                                                                                                                                                      - - -
                                                                                                                                                                      -

                                                                                                                                                                      Sets up the sidebar, including player stats, toggle button, large image preview, etc.

                                                                                                                                                                      -
                                                                                                                                                                      - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                      - - - - -
                                                                                                                                                                      - - - - -
                                                                                                                                                                      - -

                                                                                                                                                                      - - inner setupSidebar() - - - - -

                                                                                                                                                                      - - - -
                                                                                                                                                                      -
                                                                                                                                                                      - - -
                                                                                                                                                                      -

                                                                                                                                                                      Sets up the sidebar, including player stats, toggle button, large image preview, etc.

                                                                                                                                                                      -
                                                                                                                                                                      - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                      - - - - -
                                                                                                                                                                      - - - - -
                                                                                                                                                                      - -

                                                                                                                                                                      - - inner setupSidebarToggle() - - - - -

                                                                                                                                                                      - - - -
                                                                                                                                                                      -
                                                                                                                                                                      - - -
                                                                                                                                                                      -

                                                                                                                                                                      Initializes the sidebar toggle functionality.

                                                                                                                                                                      -
                                                                                                                                                                      - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                      - - - - -
                                                                                                                                                                      - - - - -
                                                                                                                                                                      - -

                                                                                                                                                                      - - inner setupSidebarToggle() - - -

                                                                                                                                                                      @@ -3191,96 +856,6 @@

                                                                                                                                                                      - - - - - - - - - - -

                                                                                                                                                                      - - - - - - - - - -
                                                                                                                                                                      - -

                                                                                                                                                                      - - inner setupStyles() - - - - -

                                                                                                                                                                      - - - -
                                                                                                                                                                      -
                                                                                                                                                                      - - -
                                                                                                                                                                      -

                                                                                                                                                                      Function to append IITC's custom CSS styles to the <head> element. -Overwritten in smartphone.js.

                                                                                                                                                                      -
                                                                                                                                                                      - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                      - - - - - - - - - - - - - - - - - - - - diff --git a/module-smartphone.html b/module-smartphone.html index 20a4ebcb1..766a57ff8 100644 --- a/module-smartphone.html +++ b/module-smartphone.html @@ -34,7 +34,7 @@

                                                                                                                                                                      IITC-CE

                                                                                                                                                                        - +
                                                                                                                                                                        @@ -52,8 +52,6 @@

                                                                                                                                                                        smartphone

                                                                                                                                                                        - - @@ -119,77 +117,6 @@

                                                                                                                                                                        smartphone

                                                                                                                                                                        - - - - - - - - - - -
                                                                                                                                                                        - - - - -
                                                                                                                                                                        - - - - -
                                                                                                                                                                        - -
                                                                                                                                                                        -
                                                                                                                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                        - - - - - - - - - - - - - - - - - - - - @@ -324,118 +251,6 @@
                                                                                                                                                                        Returns:
                                                                                                                                                                        - - - - - - - - - - -
                                                                                                                                                                        - - - - -
                                                                                                                                                                        - - - - -
                                                                                                                                                                        - -

                                                                                                                                                                        - - inner isSmartphone() → {boolean} - - - - -

                                                                                                                                                                        - - - -
                                                                                                                                                                        -
                                                                                                                                                                        - - -
                                                                                                                                                                        -

                                                                                                                                                                        Determines if the user's device is a smartphone. -Note it should not detect tablets because their display is large enough to use the desktop version. -The stock intel site allows forcing mobile/full sites with a vp=m or vp=f parameter. This function supports the same.

                                                                                                                                                                        -
                                                                                                                                                                        - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                        -
                                                                                                                                                                        Returns:
                                                                                                                                                                        - - - - - -boolean - - - - - --

                                                                                                                                                                        True if the user's device is a smartphone, false otherwise.

                                                                                                                                                                        - - - - - -
                                                                                                                                                                        - - - - - -
                                                                                                                                                                        - - - - - - - - - - - - - - - - - - - - @@ -549,14 +364,14 @@

                                                                                                                                                                        -

                                                                                                                                                                        +

                                                                                                                                                                        - inner runOnSmartphonesAfterBoot() + inner runOnSmartphonesBeforeBoot()

                                                                                                                                                                        @@ -568,9 +383,9 @@

                                                                                                                                                                        -

                                                                                                                                                                        Performs setup tasks for IITC on smartphones after the IITC boot process. -This includes initializing mobile info display, adjusting UI elements for mobile compatibility, -and setting event handlers for mobile-specific interactions.

                                                                                                                                                                        +

                                                                                                                                                                        Performs initial setup tasks for IITC on smartphones before the IITC boot process. +This includes adding smartphone-specific stylesheets +and modifying some of the setup functions for mobile compatibility.

                                                                                                                                                                        @@ -640,14 +455,14 @@

                                                                                                                                                                        -

                                                                                                                                                                        +

                                                                                                                                                                        - inner runOnSmartphonesBeforeBoot() + inner smartphone()

                                                                                                                                                                        @@ -659,9 +474,8 @@

                                                                                                                                                                        -

                                                                                                                                                                        Performs initial setup tasks for IITC on smartphones before the IITC boot process. -This includes adding smartphone-specific stylesheets -and modifying some of the setup functions for mobile compatibility.

                                                                                                                                                                        +

                                                                                                                                                                        Placeholder for smartphone specific manipulations. +This function does not implement any logic by itself.

                                                                                                                                                                        @@ -709,1666 +523,6 @@

                                                                                                                                                                        - - - - - - - - - - -

                                                                                                                                                                        - - - - -
                                                                                                                                                                        - - - - -
                                                                                                                                                                        - -

                                                                                                                                                                        - - inner runOnSmartphonesBeforeBoot() - - - - -

                                                                                                                                                                        - - - -
                                                                                                                                                                        -
                                                                                                                                                                        - - -
                                                                                                                                                                        -

                                                                                                                                                                        Performs initial setup tasks for IITC on smartphones before the IITC boot process. -This includes adding smartphone-specific stylesheets -and modifying some of the setup functions for mobile compatibility.

                                                                                                                                                                        -
                                                                                                                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                        - - - - -
                                                                                                                                                                        - - - - -
                                                                                                                                                                        - -

                                                                                                                                                                        - - inner smartphone() - - - - -

                                                                                                                                                                        - - - -
                                                                                                                                                                        -
                                                                                                                                                                        - - -
                                                                                                                                                                        -

                                                                                                                                                                        Placeholder for smartphone specific manipulations. -This function does not implement any logic by itself.

                                                                                                                                                                        -
                                                                                                                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                        - - - - -
                                                                                                                                                                        - - - - -
                                                                                                                                                                        - -

                                                                                                                                                                        - - inner smartphone() - - - - -

                                                                                                                                                                        - - - -
                                                                                                                                                                        -
                                                                                                                                                                        - - -
                                                                                                                                                                        -

                                                                                                                                                                        Placeholder for smartphone specific manipulations. -This function does not implement any logic by itself.

                                                                                                                                                                        -
                                                                                                                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                        - - - - -
                                                                                                                                                                        - - - - -
                                                                                                                                                                        - -

                                                                                                                                                                        - - inner smartphoneInfo(data) - - - - -

                                                                                                                                                                        - - - -
                                                                                                                                                                        -
                                                                                                                                                                        - - -
                                                                                                                                                                        -

                                                                                                                                                                        Updates the mobile information bar with portal details when a portal is selected. -This function is hooked to the 'portalSelected' event and is specific to the smartphone layout.

                                                                                                                                                                        -
                                                                                                                                                                        - - - - - - - - - -
                                                                                                                                                                        -
                                                                                                                                                                        Parameters:
                                                                                                                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                        NameTypeDescription
                                                                                                                                                                        data - - -Object - - - -

                                                                                                                                                                        The data object containing details about the selected portal.

                                                                                                                                                                        - -
                                                                                                                                                                        - - - - - - - - - - - - - - - - - -
                                                                                                                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                        - - - - -
                                                                                                                                                                        - - - - -
                                                                                                                                                                        - -

                                                                                                                                                                        - - inner smartphoneInfo(data) - - - - -

                                                                                                                                                                        - - - -
                                                                                                                                                                        -
                                                                                                                                                                        - - -
                                                                                                                                                                        -

                                                                                                                                                                        Updates the mobile information bar with portal details when a portal is selected. -This function is hooked to the 'portalSelected' event and is specific to the smartphone layout.

                                                                                                                                                                        -
                                                                                                                                                                        - - - - - - - - - -
                                                                                                                                                                        -
                                                                                                                                                                        Parameters:
                                                                                                                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                        NameTypeDescription
                                                                                                                                                                        data - - -Object - - - -

                                                                                                                                                                        The data object containing details about the selected portal.

                                                                                                                                                                        - -
                                                                                                                                                                        - - - - - - - - - - - - - - - - - -
                                                                                                                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                        - - - - -
                                                                                                                                                                        - - - - - - - -
                                                                                                                                                                        - -
                                                                                                                                                                        - - - - - - - -
                                                                                                                                                                        - -
                                                                                                                                                                        - -

                                                                                                                                                                        smartphone

                                                                                                                                                                        - - - - - - -
                                                                                                                                                                        - -
                                                                                                                                                                        - -
                                                                                                                                                                        - - -

                                                                                                                                                                        This file provides functions and utilities specifically for the smartphone layout of IITC.

                                                                                                                                                                        - - - - - -
                                                                                                                                                                        - -
                                                                                                                                                                        -
                                                                                                                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                        - - - - -
                                                                                                                                                                        - - - - -
                                                                                                                                                                        - -
                                                                                                                                                                        -
                                                                                                                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                        - - - - -
                                                                                                                                                                        - - - -
                                                                                                                                                                        - - - - - - - - - - - - - - - - - -

                                                                                                                                                                        Methods

                                                                                                                                                                        - -
                                                                                                                                                                        - - -
                                                                                                                                                                        - -

                                                                                                                                                                        - - inner isSmartphone() → {boolean} - - - - -

                                                                                                                                                                        - - - -
                                                                                                                                                                        -
                                                                                                                                                                        - - -
                                                                                                                                                                        -

                                                                                                                                                                        Determines if the user's device is a smartphone. -Note it should not detect tablets because their display is large enough to use the desktop version. -The stock intel site allows forcing mobile/full sites with a vp=m or vp=f parameter. This function supports the same.

                                                                                                                                                                        -
                                                                                                                                                                        - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                        -
                                                                                                                                                                        Returns:
                                                                                                                                                                        - - - - - -boolean - - - - - --

                                                                                                                                                                        True if the user's device is a smartphone, false otherwise.

                                                                                                                                                                        - - - - - -
                                                                                                                                                                        - - - - - -
                                                                                                                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                        - - - - -
                                                                                                                                                                        - - - - -
                                                                                                                                                                        - -

                                                                                                                                                                        - - inner isSmartphone() → {boolean} - - - - -

                                                                                                                                                                        - - - -
                                                                                                                                                                        -
                                                                                                                                                                        - - -
                                                                                                                                                                        -

                                                                                                                                                                        Determines if the user's device is a smartphone. -Note it should not detect tablets because their display is large enough to use the desktop version. -The stock intel site allows forcing mobile/full sites with a vp=m or vp=f parameter. This function supports the same.

                                                                                                                                                                        -
                                                                                                                                                                        - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                        -
                                                                                                                                                                        Returns:
                                                                                                                                                                        - - - - - -boolean - - - - - --

                                                                                                                                                                        True if the user's device is a smartphone, false otherwise.

                                                                                                                                                                        - - - - - -
                                                                                                                                                                        - - - - - -
                                                                                                                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                        - - - - -
                                                                                                                                                                        - - - - -
                                                                                                                                                                        - -

                                                                                                                                                                        - - inner runOnSmartphonesAfterBoot() - - - - -

                                                                                                                                                                        - - - -
                                                                                                                                                                        -
                                                                                                                                                                        - - -
                                                                                                                                                                        -

                                                                                                                                                                        Performs setup tasks for IITC on smartphones after the IITC boot process. -This includes initializing mobile info display, adjusting UI elements for mobile compatibility, -and setting event handlers for mobile-specific interactions.

                                                                                                                                                                        -
                                                                                                                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                        - - - - -
                                                                                                                                                                        - - - - -
                                                                                                                                                                        - -

                                                                                                                                                                        - - inner runOnSmartphonesAfterBoot() - - - - -

                                                                                                                                                                        - - - -
                                                                                                                                                                        -
                                                                                                                                                                        - - -
                                                                                                                                                                        -

                                                                                                                                                                        Performs setup tasks for IITC on smartphones after the IITC boot process. -This includes initializing mobile info display, adjusting UI elements for mobile compatibility, -and setting event handlers for mobile-specific interactions.

                                                                                                                                                                        -
                                                                                                                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                        - - - - -
                                                                                                                                                                        - - - - -
                                                                                                                                                                        - -

                                                                                                                                                                        - - inner runOnSmartphonesBeforeBoot() - - - - -

                                                                                                                                                                        - - - -
                                                                                                                                                                        -
                                                                                                                                                                        - - -
                                                                                                                                                                        -

                                                                                                                                                                        Performs initial setup tasks for IITC on smartphones before the IITC boot process. -This includes adding smartphone-specific stylesheets -and modifying some of the setup functions for mobile compatibility.

                                                                                                                                                                        -
                                                                                                                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                        - - - - -
                                                                                                                                                                        - - - - -
                                                                                                                                                                        - -

                                                                                                                                                                        - - inner runOnSmartphonesBeforeBoot() - - - - -

                                                                                                                                                                        - - - -
                                                                                                                                                                        -
                                                                                                                                                                        - - -
                                                                                                                                                                        -

                                                                                                                                                                        Performs initial setup tasks for IITC on smartphones before the IITC boot process. -This includes adding smartphone-specific stylesheets -and modifying some of the setup functions for mobile compatibility.

                                                                                                                                                                        -
                                                                                                                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                        - - - - -
                                                                                                                                                                        - - - - -
                                                                                                                                                                        - -

                                                                                                                                                                        - - inner smartphone() - - - - -

                                                                                                                                                                        - - - -
                                                                                                                                                                        -
                                                                                                                                                                        - - -
                                                                                                                                                                        -

                                                                                                                                                                        Placeholder for smartphone specific manipulations. -This function does not implement any logic by itself.

                                                                                                                                                                        -
                                                                                                                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                        - - - - -
                                                                                                                                                                        - - - - -
                                                                                                                                                                        - -

                                                                                                                                                                        - - inner smartphone() - - - - -

                                                                                                                                                                        - - - -
                                                                                                                                                                        -
                                                                                                                                                                        - - -
                                                                                                                                                                        -

                                                                                                                                                                        Placeholder for smartphone specific manipulations. -This function does not implement any logic by itself.

                                                                                                                                                                        -
                                                                                                                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                        - - - - -
                                                                                                                                                                        - - - - -
                                                                                                                                                                        - -

                                                                                                                                                                        - - inner smartphoneInfo(data) - - - - -

                                                                                                                                                                        - - - -
                                                                                                                                                                        -
                                                                                                                                                                        - - -
                                                                                                                                                                        -

                                                                                                                                                                        Updates the mobile information bar with portal details when a portal is selected. -This function is hooked to the 'portalSelected' event and is specific to the smartphone layout.

                                                                                                                                                                        -
                                                                                                                                                                        - - - - - - - - - -
                                                                                                                                                                        -
                                                                                                                                                                        Parameters:
                                                                                                                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                        NameTypeDescription
                                                                                                                                                                        data - - -Object - - - -

                                                                                                                                                                        The data object containing details about the selected portal.

                                                                                                                                                                        - -
                                                                                                                                                                        - - - - - - - - - - - - - - - - - -
                                                                                                                                                                        - - - - - - - - - - - - - - - - - - - - diff --git a/module-status_bar.html b/module-status_bar.html index fa43ad825..74ea32951 100644 --- a/module-status_bar.html +++ b/module-status_bar.html @@ -34,7 +34,7 @@

                                                                                                                                                                        IITC-CE

                                                                                                                                                                          - +
                                                                                                                                                                          @@ -52,391 +52,6 @@

                                                                                                                                                                          status_bar

                                                                                                                                                                          - - - - - -
                                                                                                                                                                          - -
                                                                                                                                                                          - - -

                                                                                                                                                                          This file handles the rendering and updating of the status bar in IITC.

                                                                                                                                                                          - - - - - -
                                                                                                                                                                          - -
                                                                                                                                                                          -
                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                          - - - - -
                                                                                                                                                                          - - - - -
                                                                                                                                                                          - -
                                                                                                                                                                          -
                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                          - - - - -
                                                                                                                                                                          - - - -
                                                                                                                                                                          - - - - - - - - - - - - - - - - - -

                                                                                                                                                                          Methods

                                                                                                                                                                          - -
                                                                                                                                                                          - - -
                                                                                                                                                                          - -

                                                                                                                                                                          - - inner renderUpdateStatus() - - - - -

                                                                                                                                                                          - - - -
                                                                                                                                                                          -
                                                                                                                                                                          - - -
                                                                                                                                                                          -

                                                                                                                                                                          Renders the status bar. This function updates the status bar with information about the current -zoom level (portal levels and link lengths), map data loading progress, and any pending requests or failed requests. -It schedules the update to the next event loop to improve performance and ensure smoother rendering.

                                                                                                                                                                          -
                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                          - - - - -
                                                                                                                                                                          - - - - -
                                                                                                                                                                          - -

                                                                                                                                                                          - - inner renderUpdateStatus() - - - - -

                                                                                                                                                                          - - - -
                                                                                                                                                                          -
                                                                                                                                                                          - - -
                                                                                                                                                                          -

                                                                                                                                                                          Renders the status bar. This function updates the status bar with information about the current -zoom level (portal levels and link lengths), map data loading progress, and any pending requests or failed requests. -It schedules the update to the next event loop to improve performance and ensure smoother rendering.

                                                                                                                                                                          -
                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                          - - - - -
                                                                                                                                                                          - -
                                                                                                                                                                          - - - - - -
                                                                                                                                                                          - -
                                                                                                                                                                          - - - - - - - -
                                                                                                                                                                          - -
                                                                                                                                                                          - -

                                                                                                                                                                          status_bar

                                                                                                                                                                          - - - - -
                                                                                                                                                                          @@ -502,77 +117,6 @@

                                                                                                                                                                          status_bar

                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                          - -
                                                                                                                                                                          -
                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - @@ -686,97 +230,6 @@

                                                                                                                                                                          - - - - - - - - - - -

                                                                                                                                                                          - - - - -
                                                                                                                                                                          - - - - -
                                                                                                                                                                          - -

                                                                                                                                                                          - - inner renderUpdateStatus() - - - - -

                                                                                                                                                                          - - - -
                                                                                                                                                                          -
                                                                                                                                                                          - - -
                                                                                                                                                                          -

                                                                                                                                                                          Renders the status bar. This function updates the status bar with information about the current -zoom level (portal levels and link lengths), map data loading progress, and any pending requests or failed requests. -It schedules the update to the next event loop to improve performance and ensure smoother rendering.

                                                                                                                                                                          -
                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - diff --git a/module-utils_file.html b/module-utils_file.html index 10297c495..9c6bb6ded 100644 --- a/module-utils_file.html +++ b/module-utils_file.html @@ -34,7 +34,7 @@

                                                                                                                                                                          IITC-CE

                                                                                                                                                                            - +
                                                                                                                                                                            @@ -52,8 +52,6 @@

                                                                                                                                                                            utils_file

                                                                                                                                                                            - - @@ -120,84 +118,6 @@

                                                                                                                                                                            utils_file

                                                                                                                                                                            - - - - - - - - -
                                                                                                                                                                            See:
                                                                                                                                                                            -
                                                                                                                                                                            - -
                                                                                                                                                                            - - - -
                                                                                                                                                                            - - - - -
                                                                                                                                                                            - - - - -
                                                                                                                                                                            - -
                                                                                                                                                                            -
                                                                                                                                                                            - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                            - - - - - - - - - - - - - - - - - - - - @@ -448,1554 +368,6 @@
                                                                                                                                                                            Parameters:
                                                                                                                                                                            - - - - - - - - - - -
                                                                                                                                                                            - - - - -
                                                                                                                                                                            - - - - -
                                                                                                                                                                            - -

                                                                                                                                                                            - - private, inner saveAs(data, filenameopt, dataTypeopt) - - - - -

                                                                                                                                                                            - - - -
                                                                                                                                                                            -
                                                                                                                                                                            - - -
                                                                                                                                                                            -

                                                                                                                                                                            Saves data as a file with a specified filename and data type.

                                                                                                                                                                            -
                                                                                                                                                                            - - - - - - - - - -
                                                                                                                                                                            -
                                                                                                                                                                            Parameters:
                                                                                                                                                                            - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                            NameTypeAttributesDescription
                                                                                                                                                                            data - - -string -| - -BlobPart -| - -Array.<BlobPart> - - - - - - - - - -

                                                                                                                                                                            The data to be saved.

                                                                                                                                                                            filename - - -string - - - - - - <optional>
                                                                                                                                                                            - - - - - -

                                                                                                                                                                            The name of the file to save.

                                                                                                                                                                            dataType - - -string - - - - - - <optional>
                                                                                                                                                                            - - - - - -

                                                                                                                                                                            The MIME type of the file, used to specify the file format.

                                                                                                                                                                            - -
                                                                                                                                                                            - - - - - - - - - - - - - - - - - -
                                                                                                                                                                            - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                            - - - - -
                                                                                                                                                                            - - - - -
                                                                                                                                                                            - -

                                                                                                                                                                            - - inner saveFile(data, filenameopt, dataTypeopt) - - - - -

                                                                                                                                                                            - - - -
                                                                                                                                                                            -
                                                                                                                                                                            - - -
                                                                                                                                                                            -

                                                                                                                                                                            Saves data to a file with the given filename. This function is an alias to the saveAs function. -or it can use the IITC Mobile file chooser (overwritten in app.js). The dataType parameter can be used to filter -file types in the IITCm file chooser.

                                                                                                                                                                            -
                                                                                                                                                                            - - - - - - - - - -
                                                                                                                                                                            -
                                                                                                                                                                            Parameters:
                                                                                                                                                                            - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                            NameTypeAttributesDescription
                                                                                                                                                                            data - - -string -| - -BlobPart -| - -Array.<BlobPart> - - - - - - - - - -

                                                                                                                                                                            The data to be saved.

                                                                                                                                                                            filename - - -string - - - - - - <optional>
                                                                                                                                                                            - - - - - -

                                                                                                                                                                            The name of the file to save.

                                                                                                                                                                            dataType - - -string - - - - - - <optional>
                                                                                                                                                                            - - - - - -

                                                                                                                                                                            The MIME type of the file, used to specify the file format.

                                                                                                                                                                            - -
                                                                                                                                                                            - - - - - - - - - - - - - - - - - -
                                                                                                                                                                            - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                            - - - - -
                                                                                                                                                                            - - - - -
                                                                                                                                                                            - -

                                                                                                                                                                            - - inner saveFile(data, filenameopt, dataTypeopt) - - - - -

                                                                                                                                                                            - - - -
                                                                                                                                                                            -
                                                                                                                                                                            - - -
                                                                                                                                                                            -

                                                                                                                                                                            Saves data to a file with the given filename. This function is an alias to the saveAs function. -or it can use the IITC Mobile file chooser (overwritten in app.js). The dataType parameter can be used to filter -file types in the IITCm file chooser.

                                                                                                                                                                            -
                                                                                                                                                                            - - - - - - - - - -
                                                                                                                                                                            -
                                                                                                                                                                            Parameters:
                                                                                                                                                                            - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                            NameTypeAttributesDescription
                                                                                                                                                                            data - - -string -| - -BlobPart -| - -Array.<BlobPart> - - - - - - - - - -

                                                                                                                                                                            The data to be saved.

                                                                                                                                                                            filename - - -string - - - - - - <optional>
                                                                                                                                                                            - - - - - -

                                                                                                                                                                            The name of the file to save.

                                                                                                                                                                            dataType - - -string - - - - - - <optional>
                                                                                                                                                                            - - - - - -

                                                                                                                                                                            The MIME type of the file, used to specify the file format.

                                                                                                                                                                            - -
                                                                                                                                                                            - - - - - - - - - - - - - - - - - -
                                                                                                                                                                            - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                            - - - - -
                                                                                                                                                                            - - - - - - - - - -
                                                                                                                                                                            - - - - - - - -
                                                                                                                                                                            - -
                                                                                                                                                                            - -

                                                                                                                                                                            utils_file

                                                                                                                                                                            - - - - - - -
                                                                                                                                                                            - -
                                                                                                                                                                            - -
                                                                                                                                                                            - - -

                                                                                                                                                                            This file provides utilities for handling files in an environment-independent way, including -functions to save files and wrappers around the FileReader API to integrate with Leaflet's event system.

                                                                                                                                                                            - - - - - -
                                                                                                                                                                            - -
                                                                                                                                                                            -
                                                                                                                                                                            - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                            - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                            See:
                                                                                                                                                                            -
                                                                                                                                                                            - -
                                                                                                                                                                            - - - -
                                                                                                                                                                            - - - - -
                                                                                                                                                                            - - - - -
                                                                                                                                                                            - -
                                                                                                                                                                            -
                                                                                                                                                                            - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                            - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                            See:
                                                                                                                                                                            -
                                                                                                                                                                            - -
                                                                                                                                                                            - - - -
                                                                                                                                                                            - - - - -
                                                                                                                                                                            - - - -
                                                                                                                                                                            - - - - - - - - - - - - - - - - - -

                                                                                                                                                                            Methods

                                                                                                                                                                            - -
                                                                                                                                                                            - - -
                                                                                                                                                                            - -

                                                                                                                                                                            - - private, inner saveAs(data, filenameopt, dataTypeopt) - - - - -

                                                                                                                                                                            - - - -
                                                                                                                                                                            -
                                                                                                                                                                            - - -
                                                                                                                                                                            -

                                                                                                                                                                            Saves data as a file with a specified filename and data type.

                                                                                                                                                                            -
                                                                                                                                                                            - - - - - - - - - -
                                                                                                                                                                            -
                                                                                                                                                                            Parameters:
                                                                                                                                                                            - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                            NameTypeAttributesDescription
                                                                                                                                                                            data - - -string -| - -BlobPart -| - -Array.<BlobPart> - - - - - - - - - -

                                                                                                                                                                            The data to be saved.

                                                                                                                                                                            filename - - -string - - - - - - <optional>
                                                                                                                                                                            - - - - - -

                                                                                                                                                                            The name of the file to save.

                                                                                                                                                                            dataType - - -string - - - - - - <optional>
                                                                                                                                                                            - - - - - -

                                                                                                                                                                            The MIME type of the file, used to specify the file format.

                                                                                                                                                                            - -
                                                                                                                                                                            - - - - - - - - - - - - - - - - - -
                                                                                                                                                                            - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                            - - - - -
                                                                                                                                                                            - - - - -
                                                                                                                                                                            - -

                                                                                                                                                                            - - private, inner saveAs(data, filenameopt, dataTypeopt) - - - - -

                                                                                                                                                                            - - - -
                                                                                                                                                                            -
                                                                                                                                                                            - - -
                                                                                                                                                                            -

                                                                                                                                                                            Saves data as a file with a specified filename and data type.

                                                                                                                                                                            -
                                                                                                                                                                            - - - - - - - - - -
                                                                                                                                                                            -
                                                                                                                                                                            Parameters:
                                                                                                                                                                            - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                            NameTypeAttributesDescription
                                                                                                                                                                            data - - -string -| - -BlobPart -| - -Array.<BlobPart> - - - - - - - - - -

                                                                                                                                                                            The data to be saved.

                                                                                                                                                                            filename - - -string - - - - - - <optional>
                                                                                                                                                                            - - - - - -

                                                                                                                                                                            The name of the file to save.

                                                                                                                                                                            dataType - - -string - - - - - - <optional>
                                                                                                                                                                            - - - - - -

                                                                                                                                                                            The MIME type of the file, used to specify the file format.

                                                                                                                                                                            - -
                                                                                                                                                                            - - - - - - - - - - - - - - - - - -
                                                                                                                                                                            - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                            - - - - -
                                                                                                                                                                            - - - - -
                                                                                                                                                                            - -

                                                                                                                                                                            - - inner saveFile(data, filenameopt, dataTypeopt) - - - - -

                                                                                                                                                                            - - - -
                                                                                                                                                                            -
                                                                                                                                                                            - - -
                                                                                                                                                                            -

                                                                                                                                                                            Saves data to a file with the given filename. This function is an alias to the saveAs function. -or it can use the IITC Mobile file chooser (overwritten in app.js). The dataType parameter can be used to filter -file types in the IITCm file chooser.

                                                                                                                                                                            -
                                                                                                                                                                            - - - - - - - - - -
                                                                                                                                                                            -
                                                                                                                                                                            Parameters:
                                                                                                                                                                            - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                            NameTypeAttributesDescription
                                                                                                                                                                            data - - -string -| - -BlobPart -| - -Array.<BlobPart> - - - - - - - - - -

                                                                                                                                                                            The data to be saved.

                                                                                                                                                                            filename - - -string - - - - - - <optional>
                                                                                                                                                                            - - - - - -

                                                                                                                                                                            The name of the file to save.

                                                                                                                                                                            dataType - - -string - - - - - - <optional>
                                                                                                                                                                            - - - - - -

                                                                                                                                                                            The MIME type of the file, used to specify the file format.

                                                                                                                                                                            - -
                                                                                                                                                                            - - - - - - - - - - - - - - - - - -
                                                                                                                                                                            - - - - - - - - - - - - - - - - - - - - diff --git a/module-utils_misc.html b/module-utils_misc.html index cf7e342ef..aad5297b5 100644 --- a/module-utils_misc.html +++ b/module-utils_misc.html @@ -34,7 +34,7 @@

                                                                                                                                                                            IITC-CE

                                                                                                                                                                              - +
                                                                                                                                                                              @@ -52,8 +52,6 @@

                                                                                                                                                                              utils_misc

                                                                                                                                                                              - - @@ -119,77 +117,6 @@

                                                                                                                                                                              utils_misc

                                                                                                                                                                              - - - - - - - - - - -
                                                                                                                                                                              - - - - -
                                                                                                                                                                              - - - - -
                                                                                                                                                                              - -
                                                                                                                                                                              -
                                                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                              - - - - - - - - - - - - - - - - - - - - @@ -440,14 +367,14 @@
                                                                                                                                                                              Returns:
                                                                                                                                                                              -

                                                                                                                                                                              +

                                                                                                                                                                              - private, inner clamp(n, max, min) → {number} + inner clampLatLng(latlng) → {Array.<number>}

                                                                                                                                                                              @@ -459,7 +386,7 @@

                                                                                                                                                                              -

                                                                                                                                                                              Clamps a given value between a minimum and maximum value.

                                                                                                                                                                              +

                                                                                                                                                                              Clamps a latitude and longitude to the maximum and minimum valid values.

                                                                                                                                                                              @@ -495,59 +422,13 @@

                                                                                                                                                                              Parameters:
                                                                                                                                                                              - n - - - - - -number - - - - - - - - - -

                                                                                                                                                                              The value to clamp.

                                                                                                                                                                              - - - - - - - max - - - - - -number - - - - - - - - - -

                                                                                                                                                                              The maximum allowed value.

                                                                                                                                                                              - - - - - - - min + latlng -number +L.LatLng @@ -557,7 +438,7 @@
                                                                                                                                                                              Parameters:
                                                                                                                                                                              -

                                                                                                                                                                              The minimum allowed value.

                                                                                                                                                                              +

                                                                                                                                                                              The latitude and longitude to clamp.

                                                                                                                                                                              @@ -585,13 +466,13 @@
                                                                                                                                                                              Returns:
                                                                                                                                                                              -number +Array.<number> --

                                                                                                                                                                              The clamped value.

                                                                                                                                                                              +-

                                                                                                                                                                              The clamped latitude and longitude.

                                                                                                                                                                              @@ -646,14 +527,14 @@
                                                                                                                                                                              Returns:
                                                                                                                                                                              -

                                                                                                                                                                              +

                                                                                                                                                                              - inner clampLatLng(latlng) → {Array.<number>} + inner clampLatLngBounds(bounds) → {L.LatLngBounds}

                                                                                                                                                                              @@ -665,7 +546,7 @@

                                                                                                                                                                              -

                                                                                                                                                                              Clamps a latitude and longitude to the maximum and minimum valid values.

                                                                                                                                                                              +

                                                                                                                                                                              Clamps a latitude and longitude bounds to the maximum and minimum valid values.

                                                                                                                                                                              @@ -701,13 +582,13 @@

                                                                                                                                                                              Parameters:
                                                                                                                                                                              - latlng + bounds -L.LatLng +L.LatLngBounds @@ -717,7 +598,7 @@
                                                                                                                                                                              Parameters:
                                                                                                                                                                              -

                                                                                                                                                                              The latitude and longitude to clamp.

                                                                                                                                                                              +

                                                                                                                                                                              The bounds to clamp.

                                                                                                                                                                              @@ -745,13 +626,13 @@
                                                                                                                                                                              Returns:
                                                                                                                                                                              -Array.<number> +L.LatLngBounds --

                                                                                                                                                                              The clamped latitude and longitude.

                                                                                                                                                                              +-

                                                                                                                                                                              The clamped bounds.

                                                                                                                                                                              @@ -806,14 +687,14 @@
                                                                                                                                                                              Returns:
                                                                                                                                                                              -

                                                                                                                                                                              +

                                                                                                                                                                              - inner clampLatLng(latlng) → {Array.<number>} + inner convertTextToTableMagic(text) → {string}

                                                                                                                                                                              @@ -825,7 +706,7 @@

                                                                                                                                                                              -

                                                                                                                                                                              Clamps a latitude and longitude to the maximum and minimum valid values.

                                                                                                                                                                              +

                                                                                                                                                                              Converts text with newlines (\n) and tabs (\t) into an HTML table.

                                                                                                                                                                              @@ -861,13 +742,13 @@

                                                                                                                                                                              Parameters:
                                                                                                                                                                              - latlng + text -L.LatLng +string @@ -877,7 +758,7 @@
                                                                                                                                                                              Parameters:
                                                                                                                                                                              -

                                                                                                                                                                              The latitude and longitude to clamp.

                                                                                                                                                                              +

                                                                                                                                                                              The text to convert.

                                                                                                                                                                              @@ -905,13 +786,13 @@
                                                                                                                                                                              Returns:
                                                                                                                                                                              -Array.<number> +string --

                                                                                                                                                                              The clamped latitude and longitude.

                                                                                                                                                                              +-

                                                                                                                                                                              The resulting HTML table.

                                                                                                                                                                              @@ -966,14 +847,14 @@
                                                                                                                                                                              Returns:
                                                                                                                                                                              -

                                                                                                                                                                              +

                                                                                                                                                                              - inner clampLatLngBounds(bounds) → {L.LatLngBounds} + inner digits(d) → {string}

                                                                                                                                                                              @@ -985,7 +866,7 @@

                                                                                                                                                                              -

                                                                                                                                                                              Clamps a latitude and longitude bounds to the maximum and minimum valid values.

                                                                                                                                                                              +

                                                                                                                                                                              Adds thousand separators to a given number.

                                                                                                                                                                              @@ -1021,13 +902,13 @@

                                                                                                                                                                              Parameters:
                                                                                                                                                                              - bounds + d -L.LatLngBounds +number @@ -1037,7 +918,7 @@
                                                                                                                                                                              Parameters:
                                                                                                                                                                              -

                                                                                                                                                                              The bounds to clamp.

                                                                                                                                                                              +

                                                                                                                                                                              The number to format.

                                                                                                                                                                              @@ -1065,13 +946,13 @@
                                                                                                                                                                              Returns:
                                                                                                                                                                              -L.LatLngBounds +string --

                                                                                                                                                                              The clamped bounds.

                                                                                                                                                                              +-

                                                                                                                                                                              The formatted number with thousand separators.

                                                                                                                                                                              @@ -1111,6 +992,13 @@
                                                                                                                                                                              Returns:
                                                                                                                                                                              + +
                                                                                                                                                                              See:
                                                                                                                                                                              +
                                                                                                                                                                              + +
                                                                                                                                                                              @@ -1126,14 +1014,14 @@
                                                                                                                                                                              Returns:
                                                                                                                                                                              -

                                                                                                                                                                              +

                                                                                                                                                                              - inner clampLatLngBounds(bounds) → {L.LatLngBounds} + inner eraseCookie(name)

                                                                                                                                                                              @@ -1145,7 +1033,7 @@

                                                                                                                                                                              -

                                                                                                                                                                              Clamps a latitude and longitude bounds to the maximum and minimum valid values.

                                                                                                                                                                              +

                                                                                                                                                                              Erases a cookie with a specified name.

                                                                                                                                                                              @@ -1181,13 +1069,13 @@

                                                                                                                                                                              Parameters:
                                                                                                                                                                              - bounds + name -L.LatLngBounds +string @@ -1197,7 +1085,7 @@
                                                                                                                                                                              Parameters:
                                                                                                                                                                              -

                                                                                                                                                                              The bounds to clamp.

                                                                                                                                                                              +

                                                                                                                                                                              The name of the cookie to erase.

                                                                                                                                                                              @@ -1218,27 +1106,6 @@
                                                                                                                                                                              Parameters:
                                                                                                                                                                              -
                                                                                                                                                                              -
                                                                                                                                                                              Returns:
                                                                                                                                                                              - - - - - -L.LatLngBounds - - - - - --

                                                                                                                                                                              The clamped bounds.

                                                                                                                                                                              - - - - - -
                                                                                                                                                                              - @@ -1286,14 +1153,14 @@
                                                                                                                                                                              Returns:
                                                                                                                                                                              -

                                                                                                                                                                              +

                                                                                                                                                                              - inner convertTextToTableMagic(text) → {string} + inner escapeHtmlSpecialChars(str) → {string}

                                                                                                                                                                              @@ -1305,7 +1172,7 @@

                                                                                                                                                                              -

                                                                                                                                                                              Converts text with newlines (\n) and tabs (\t) into an HTML table.

                                                                                                                                                                              +

                                                                                                                                                                              Escapes HTML special characters in a string.

                                                                                                                                                                              @@ -1341,7 +1208,7 @@

                                                                                                                                                                              Parameters:
                                                                                                                                                                              - text + str @@ -1357,7 +1224,7 @@
                                                                                                                                                                              Parameters:
                                                                                                                                                                              -

                                                                                                                                                                              The text to convert.

                                                                                                                                                                              +

                                                                                                                                                                              The string to escape.

                                                                                                                                                                              @@ -1391,7 +1258,7 @@
                                                                                                                                                                              Returns:
                                                                                                                                                                              --

                                                                                                                                                                              The resulting HTML table.

                                                                                                                                                                              +-

                                                                                                                                                                              The escaped string.

                                                                                                                                                                              @@ -1446,14 +1313,14 @@
                                                                                                                                                                              Returns:
                                                                                                                                                                              -

                                                                                                                                                                              +

                                                                                                                                                                              - inner convertTextToTableMagic(text) → {string} + inner escapeJavascriptString(str) → {string}

                                                                                                                                                                              @@ -1465,7 +1332,8 @@

                                                                                                                                                                              -

                                                                                                                                                                              Converts text with newlines (\n) and tabs (\t) into an HTML table.

                                                                                                                                                                              +

                                                                                                                                                                              Escapes special characters in a string for use in JavaScript. +(for strings passed as parameters to html onclick="..." for example)

                                                                                                                                                                              @@ -1501,7 +1369,7 @@

                                                                                                                                                                              Parameters:
                                                                                                                                                                              - text + str @@ -1517,7 +1385,7 @@
                                                                                                                                                                              Parameters:
                                                                                                                                                                              -

                                                                                                                                                                              The text to convert.

                                                                                                                                                                              +

                                                                                                                                                                              The string to escape.

                                                                                                                                                                              @@ -1551,7 +1419,7 @@
                                                                                                                                                                              Returns:
                                                                                                                                                                              --

                                                                                                                                                                              The resulting HTML table.

                                                                                                                                                                              +-

                                                                                                                                                                              The escaped string.

                                                                                                                                                                              @@ -1606,14 +1474,14 @@
                                                                                                                                                                              Returns:
                                                                                                                                                                              -

                                                                                                                                                                              +

                                                                                                                                                                              - inner digits(d) → {string} + inner formatDistance(distance) → {string}

                                                                                                                                                                              @@ -1625,7 +1493,7 @@

                                                                                                                                                                              -

                                                                                                                                                                              Adds thousand separators to a given number.

                                                                                                                                                                              +

                                                                                                                                                                              Formats a distance in meters, converting to kilometers if the distance is over 10,000 meters.

                                                                                                                                                                              @@ -1661,7 +1529,7 @@

                                                                                                                                                                              Parameters:
                                                                                                                                                                              - d + distance @@ -1677,7 +1545,7 @@
                                                                                                                                                                              Parameters:
                                                                                                                                                                              -

                                                                                                                                                                              The number to format.

                                                                                                                                                                              +

                                                                                                                                                                              The distance in meters.

                                                                                                                                                                              @@ -1711,7 +1579,7 @@
                                                                                                                                                                              Returns:
                                                                                                                                                                              --

                                                                                                                                                                              The formatted number with thousand separators.

                                                                                                                                                                              +-

                                                                                                                                                                              The formatted distance.

                                                                                                                                                                              @@ -1751,13 +1619,6 @@
                                                                                                                                                                              Returns:
                                                                                                                                                                              - -
                                                                                                                                                                              See:
                                                                                                                                                                              -
                                                                                                                                                                              - -
                                                                                                                                                                              @@ -1773,14 +1634,14 @@
                                                                                                                                                                              Returns:
                                                                                                                                                                              -

                                                                                                                                                                              +

                                                                                                                                                                              - inner digits(d) → {string} + inner formatInterval(seconds, maxTermsopt) → {string}

                                                                                                                                                                              @@ -1792,7 +1653,7 @@

                                                                                                                                                                              -

                                                                                                                                                                              Adds thousand separators to a given number.

                                                                                                                                                                              +

                                                                                                                                                                              Formats an interval of time given in seconds into a human-readable string.

                                                                                                                                                                              @@ -1816,6 +1677,8 @@

                                                                                                                                                                              Parameters:
                                                                                                                                                                              Type + Attributes + @@ -1828,7 +1691,7 @@
                                                                                                                                                                              Parameters:
                                                                                                                                                                              - d + seconds @@ -1841,10 +1704,51 @@
                                                                                                                                                                              Parameters:
                                                                                                                                                                              + + + + + + + + -

                                                                                                                                                                              The number to format.

                                                                                                                                                                              +

                                                                                                                                                                              The interval in seconds.

                                                                                                                                                                              + + + + + + + maxTerms + + + + + +number + + + + + + + + + <optional>
                                                                                                                                                                              + + + + + + + + + + +

                                                                                                                                                                              The maximum number of time units to include.

                                                                                                                                                                              @@ -1878,7 +1782,7 @@
                                                                                                                                                                              Returns:
                                                                                                                                                                              --

                                                                                                                                                                              The formatted number with thousand separators.

                                                                                                                                                                              +-

                                                                                                                                                                              The formatted time interval.

                                                                                                                                                                              @@ -1918,13 +1822,6 @@
                                                                                                                                                                              Returns:
                                                                                                                                                                              - -
                                                                                                                                                                              See:
                                                                                                                                                                              -
                                                                                                                                                                              - -
                                                                                                                                                                              @@ -1940,14 +1837,14 @@
                                                                                                                                                                              Returns:
                                                                                                                                                                              -

                                                                                                                                                                              +

                                                                                                                                                                              - inner eraseCookie(name) + inner getURLParam(param) → {string}

                                                                                                                                                                              @@ -1959,7 +1856,7 @@

                                                                                                                                                                              -

                                                                                                                                                                              Erases a cookie with a specified name.

                                                                                                                                                                              +

                                                                                                                                                                              Retrieves a parameter from the URL query string.

                                                                                                                                                                              @@ -1995,7 +1892,7 @@

                                                                                                                                                                              Parameters:
                                                                                                                                                                              - name + param @@ -2011,7 +1908,7 @@
                                                                                                                                                                              Parameters:
                                                                                                                                                                              -

                                                                                                                                                                              The name of the cookie to erase.

                                                                                                                                                                              +

                                                                                                                                                                              The name of the parameter to retrieve.

                                                                                                                                                                              @@ -2032,6 +1929,27 @@
                                                                                                                                                                              Parameters:
                                                                                                                                                                              +
                                                                                                                                                                              +
                                                                                                                                                                              Returns:
                                                                                                                                                                              + + + + + +string + + + + + +-

                                                                                                                                                                              The value of the parameter, or an empty string if not found.

                                                                                                                                                                              + + + + + +
                                                                                                                                                                              + @@ -2079,14 +1997,14 @@
                                                                                                                                                                              Parameters:
                                                                                                                                                                              -

                                                                                                                                                                              +

                                                                                                                                                                              - inner eraseCookie(name) + inner isTouchDevice() → {boolean}

                                                                                                                                                                              @@ -2098,7 +2016,7 @@

                                                                                                                                                                              -

                                                                                                                                                                              Erases a cookie with a specified name.

                                                                                                                                                                              +

                                                                                                                                                                              Checks if the device is a touch-enabled device.

                                                                                                                                                                              @@ -2109,67 +2027,38 @@

                                                                                                                                                                              -
                                                                                                                                                                              -
                                                                                                                                                                              Parameters:
                                                                                                                                                                              - - - - - - - - - - + - + - - - + - - - - - + - - - - +boolean - - - - -
                                                                                                                                                                              NameTypeDescription
                                                                                                                                                                              name - + +
                                                                                                                                                                              +
                                                                                                                                                                              Returns:
                                                                                                                                                                              + -string - -

                                                                                                                                                                              The name of the cookie to erase.

                                                                                                                                                                              -
                                                                                                                                                                              - - - +-

                                                                                                                                                                              True if the device is touch-enabled, otherwise false.

                                                                                                                                                                              - - - + + @@ -2218,14 +2107,14 @@

                                                                                                                                                                              Parameters:
                                                                                                                                                                              -

                                                                                                                                                                              +

                                                                                                                                                                              @@ -2237,7 +2126,7 @@

                                                                                                                                                                              -

                                                                                                                                                                              Escapes HTML special characters in a string.

                                                                                                                                                                              +

                                                                                                                                                                              Creates a link to open a specific portal in Ingress Prime.

                                                                                                                                                                              @@ -2273,7 +2162,7 @@

                                                                                                                                                                              Parameters:
                                                                                                                                                                              - str + guid @@ -2289,7 +2178,53 @@
                                                                                                                                                                              Parameters:
                                                                                                                                                                              -

                                                                                                                                                                              The string to escape.

                                                                                                                                                                              +

                                                                                                                                                                              The globally unique identifier of the portal.

                                                                                                                                                                              + + + + + + + lat + + + + + +number + + + + + + + + + +

                                                                                                                                                                              The latitude of the portal.

                                                                                                                                                                              + + + + + + + lng + + + + + +number + + + + + + + + + +

                                                                                                                                                                              The longitude of the portal.

                                                                                                                                                                              @@ -2323,7 +2258,7 @@
                                                                                                                                                                              Returns:
                                                                                                                                                                              --

                                                                                                                                                                              The escaped string.

                                                                                                                                                                              +-

                                                                                                                                                                              The Ingress Prime link for the portal

                                                                                                                                                                              @@ -2378,14 +2313,14 @@
                                                                                                                                                                              Returns:
                                                                                                                                                                              -

                                                                                                                                                                              +

                                                                                                                                                                              - inner escapeHtmlSpecialChars(str) → {string} + inner prettyEnergy(nrg) → {string}

                                                                                                                                                                              @@ -2397,7 +2332,7 @@

                                                                                                                                                                              -

                                                                                                                                                                              Escapes HTML special characters in a string.

                                                                                                                                                                              +

                                                                                                                                                                              Formats energy of portal.

                                                                                                                                                                              @@ -2433,13 +2368,13 @@

                                                                                                                                                                              Parameters:
                                                                                                                                                                              - str + nrg -string +number @@ -2449,7 +2384,7 @@
                                                                                                                                                                              Parameters:
                                                                                                                                                                              -

                                                                                                                                                                              The string to escape.

                                                                                                                                                                              +

                                                                                                                                                                              The energy value to format.

                                                                                                                                                                              @@ -2483,7 +2418,7 @@
                                                                                                                                                                              Returns:
                                                                                                                                                                              --

                                                                                                                                                                              The escaped string.

                                                                                                                                                                              +-

                                                                                                                                                                              The formatted energy value.

                                                                                                                                                                              @@ -2538,14 +2473,14 @@
                                                                                                                                                                              Returns:
                                                                                                                                                                              -

                                                                                                                                                                              +

                                                                                                                                                                              - inner escapeJavascriptString(str) → {string} + inner rangeLinkClick()

                                                                                                                                                                              @@ -2557,8 +2492,7 @@

                                                                                                                                                                              -

                                                                                                                                                                              Escapes special characters in a string for use in JavaScript. -(for strings passed as parameters to html onclick="..." for example)

                                                                                                                                                                              +

                                                                                                                                                                              Changes the coordinates and map scale to show the range for portal links.

                                                                                                                                                                              @@ -2569,58 +2503,6 @@

                                                                                                                                                                              -
                                                                                                                                                                              -
                                                                                                                                                                              Parameters:
                                                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                              NameTypeDescription
                                                                                                                                                                              str - - -string - - - -

                                                                                                                                                                              The string to escape.

                                                                                                                                                                              - -
                                                                                                                                                                              - - - @@ -2631,26 +2513,7 @@

                                                                                                                                                                              Parameters:
                                                                                                                                                                              -
                                                                                                                                                                              -
                                                                                                                                                                              Returns:
                                                                                                                                                                              - - - - - -string - - - - - --

                                                                                                                                                                              The escaped string.

                                                                                                                                                                              - - - - -
                                                                                                                                                                              @@ -2699,14 +2562,14 @@
                                                                                                                                                                              Returns:
                                                                                                                                                                              -

                                                                                                                                                                              +

                                                                                                                                                                              - inner escapeJavascriptString(str) → {string} + inner readCookie(name) → {string}

                                                                                                                                                                              @@ -2718,8 +2581,7 @@

                                                                                                                                                                              -

                                                                                                                                                                              Escapes special characters in a string for use in JavaScript. -(for strings passed as parameters to html onclick="..." for example)

                                                                                                                                                                              +

                                                                                                                                                                              Reads a cookie by name.

                                                                                                                                                                              @@ -2755,7 +2617,7 @@

                                                                                                                                                                              Parameters:
                                                                                                                                                                              - str + name @@ -2771,7 +2633,7 @@
                                                                                                                                                                              Parameters:
                                                                                                                                                                              -

                                                                                                                                                                              The string to escape.

                                                                                                                                                                              +

                                                                                                                                                                              The name of the cookie to read.

                                                                                                                                                                              @@ -2805,7 +2667,7 @@
                                                                                                                                                                              Returns:
                                                                                                                                                                              --

                                                                                                                                                                              The escaped string.

                                                                                                                                                                              +-

                                                                                                                                                                              The value of the cookie, or undefined if not found.

                                                                                                                                                                              @@ -2845,6 +2707,13 @@
                                                                                                                                                                              Returns:
                                                                                                                                                                              + +
                                                                                                                                                                              See:
                                                                                                                                                                              +
                                                                                                                                                                              + +
                                                                                                                                                                              @@ -2860,14 +2729,14 @@
                                                                                                                                                                              Returns:
                                                                                                                                                                              -

                                                                                                                                                                              +

                                                                                                                                                                              - inner formatDistance(distance) → {string} + inner scrollBottom(elm) → {number}

                                                                                                                                                                              @@ -2879,7 +2748,7 @@

                                                                                                                                                                              -

                                                                                                                                                                              Formats a distance in meters, converting to kilometers if the distance is over 10,000 meters.

                                                                                                                                                                              +

                                                                                                                                                                              Calculates the number of pixels left to scroll down before reaching the bottom of an element.

                                                                                                                                                                              @@ -2915,13 +2784,16 @@

                                                                                                                                                                              Parameters:
                                                                                                                                                                              - distance + elm -number +string +| + +jQuery @@ -2931,7 +2803,7 @@
                                                                                                                                                                              Parameters:
                                                                                                                                                                              -

                                                                                                                                                                              The distance in meters.

                                                                                                                                                                              +

                                                                                                                                                                              The element to calculate the scroll bottom for.

                                                                                                                                                                              @@ -2959,13 +2831,13 @@
                                                                                                                                                                              Returns:
                                                                                                                                                                              -string +number --

                                                                                                                                                                              The formatted distance.

                                                                                                                                                                              +-

                                                                                                                                                                              The number of pixels from the bottom.

                                                                                                                                                                              @@ -3020,14 +2892,14 @@
                                                                                                                                                                              Returns:
                                                                                                                                                                              -

                                                                                                                                                                              +

                                                                                                                                                                              - inner formatDistance(distance) → {string} + inner selectPortalByLatLng(lat, lngopt)

                                                                                                                                                                              @@ -3039,7 +2911,7 @@

                                                                                                                                                                              -

                                                                                                                                                                              Formats a distance in meters, converting to kilometers if the distance is over 10,000 meters.

                                                                                                                                                                              +

                                                                                                                                                                              Selects a portal by its latitude and longitude.

                                                                                                                                                                              @@ -3063,6 +2935,8 @@

                                                                                                                                                                              Parameters:
                                                                                                                                                                              Type + Attributes + @@ -3075,63 +2949,90 @@
                                                                                                                                                                              Parameters:
                                                                                                                                                                              - distance + lat number +| + +Array +| + +L.LatLng + + - + -

                                                                                                                                                                              The distance in meters.

                                                                                                                                                                              - + + + - - - + - - +

                                                                                                                                                                              The latitude of the portal +or an array or L.LatLng object containing both latitude and longitude.

                                                                                                                                                                              + - + + + lng + - + + + +number - - + + - -
                                                                                                                                                                              -
                                                                                                                                                                              Returns:
                                                                                                                                                                              - + + + + <optional>
                                                                                                                                                                              + + + + -string + +

                                                                                                                                                                              The longitude of the portal.

                                                                                                                                                                              + + + + +
                                                                                                                                                                              + + --

                                                                                                                                                                              The formatted distance.

                                                                                                                                                                              + + + + - - @@ -3180,14 +3081,14 @@
                                                                                                                                                                              Returns:
                                                                                                                                                                              -

                                                                                                                                                                              +

                                                                                                                                                                              @@ -3199,7 +3100,7 @@

                                                                                                                                                                              -

                                                                                                                                                                              Formats an interval of time given in seconds into a human-readable string.

                                                                                                                                                                              +

                                                                                                                                                                              Displays a dialog with links to show the specified location on various map services.

                                                                                                                                                                              @@ -3223,8 +3124,6 @@

                                                                                                                                                                              Parameters:
                                                                                                                                                                              Type - Attributes - @@ -3237,7 +3136,7 @@
                                                                                                                                                                              Parameters:
                                                                                                                                                                              - seconds + lat @@ -3250,25 +3149,17 @@
                                                                                                                                                                              Parameters:
                                                                                                                                                                              - - - - - - - - -

                                                                                                                                                                              The interval in seconds.

                                                                                                                                                                              +

                                                                                                                                                                              Latitude of the location.

                                                                                                                                                                              - maxTerms + lng @@ -3281,13256 +3172,33 @@
                                                                                                                                                                              Parameters:
                                                                                                                                                                              - - - <optional>
                                                                                                                                                                              - - - - - - - -

                                                                                                                                                                              The maximum number of time units to include.

                                                                                                                                                                              +

                                                                                                                                                                              Longitude of the location.

                                                                                                                                                                              - - - - + + + name + - - - - - - - - - - - -
                                                                                                                                                                              -
                                                                                                                                                                              Returns:
                                                                                                                                                                              - - - - - -string - - - - - --

                                                                                                                                                                              The formatted time interval.

                                                                                                                                                                              - - - - - -
                                                                                                                                                                              - - - - - -
                                                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                              - - - - -
                                                                                                                                                                              - - - - -
                                                                                                                                                                              - -

                                                                                                                                                                              - - inner formatInterval(seconds, maxTermsopt) → {string} - - - - -

                                                                                                                                                                              - - - -
                                                                                                                                                                              -
                                                                                                                                                                              - - -
                                                                                                                                                                              -

                                                                                                                                                                              Formats an interval of time given in seconds into a human-readable string.

                                                                                                                                                                              -
                                                                                                                                                                              - - - - - - - - - -
                                                                                                                                                                              -
                                                                                                                                                                              Parameters:
                                                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                              NameTypeAttributesDescription
                                                                                                                                                                              seconds - - -number - - - - - - - - - -

                                                                                                                                                                              The interval in seconds.

                                                                                                                                                                              maxTerms - - -number - - - - - - <optional>
                                                                                                                                                                              - - - - - -

                                                                                                                                                                              The maximum number of time units to include.

                                                                                                                                                                              - -
                                                                                                                                                                              - - - - - - - - - - - - - -
                                                                                                                                                                              -
                                                                                                                                                                              Returns:
                                                                                                                                                                              - - - - - -string - - - - - --

                                                                                                                                                                              The formatted time interval.

                                                                                                                                                                              - - - - - -
                                                                                                                                                                              - - - - - -
                                                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                              - - - - -
                                                                                                                                                                              - - - - -
                                                                                                                                                                              - -

                                                                                                                                                                              - - inner getURLParam(param) → {string} - - - - -

                                                                                                                                                                              - - - -
                                                                                                                                                                              -
                                                                                                                                                                              - - -
                                                                                                                                                                              -

                                                                                                                                                                              Retrieves a parameter from the URL query string.

                                                                                                                                                                              -
                                                                                                                                                                              - - - - - - - - - -
                                                                                                                                                                              -
                                                                                                                                                                              Parameters:
                                                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                              NameTypeDescription
                                                                                                                                                                              param - - -string - - - -

                                                                                                                                                                              The name of the parameter to retrieve.

                                                                                                                                                                              - -
                                                                                                                                                                              - - - - - - - - - - - - - -
                                                                                                                                                                              -
                                                                                                                                                                              Returns:
                                                                                                                                                                              - - - - - -string - - - - - --

                                                                                                                                                                              The value of the parameter, or an empty string if not found.

                                                                                                                                                                              - - - - - -
                                                                                                                                                                              - - - - - -
                                                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                              - - - - -
                                                                                                                                                                              - - - - -
                                                                                                                                                                              - -

                                                                                                                                                                              - - inner getURLParam(param) → {string} - - - - -

                                                                                                                                                                              - - - -
                                                                                                                                                                              -
                                                                                                                                                                              - - -
                                                                                                                                                                              -

                                                                                                                                                                              Retrieves a parameter from the URL query string.

                                                                                                                                                                              -
                                                                                                                                                                              - - - - - - - - - -
                                                                                                                                                                              -
                                                                                                                                                                              Parameters:
                                                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                              NameTypeDescription
                                                                                                                                                                              param - - -string - - - -

                                                                                                                                                                              The name of the parameter to retrieve.

                                                                                                                                                                              - -
                                                                                                                                                                              - - - - - - - - - - - - - -
                                                                                                                                                                              -
                                                                                                                                                                              Returns:
                                                                                                                                                                              - - - - - -string - - - - - --

                                                                                                                                                                              The value of the parameter, or an empty string if not found.

                                                                                                                                                                              - - - - - -
                                                                                                                                                                              - - - - - -
                                                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                              - - - - -
                                                                                                                                                                              - - - - -
                                                                                                                                                                              - -

                                                                                                                                                                              - - inner isTouchDevice() → {boolean} - - - - -

                                                                                                                                                                              - - - -
                                                                                                                                                                              -
                                                                                                                                                                              - - -
                                                                                                                                                                              -

                                                                                                                                                                              Checks if the device is a touch-enabled device.

                                                                                                                                                                              -
                                                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                              -
                                                                                                                                                                              Returns:
                                                                                                                                                                              - - - - - -boolean - - - - - --

                                                                                                                                                                              True if the device is touch-enabled, otherwise false.

                                                                                                                                                                              - - - - - -
                                                                                                                                                                              - - - - - -
                                                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                              - - - - -
                                                                                                                                                                              - - - - -
                                                                                                                                                                              - -

                                                                                                                                                                              - - inner isTouchDevice() → {boolean} - - - - -

                                                                                                                                                                              - - - -
                                                                                                                                                                              -
                                                                                                                                                                              - - -
                                                                                                                                                                              -

                                                                                                                                                                              Checks if the device is a touch-enabled device.

                                                                                                                                                                              -
                                                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                              -
                                                                                                                                                                              Returns:
                                                                                                                                                                              - - - - - -boolean - - - - - --

                                                                                                                                                                              True if the device is touch-enabled, otherwise false.

                                                                                                                                                                              - - - - - -
                                                                                                                                                                              - - - - - -
                                                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                              - - - - -
                                                                                                                                                                              - - - - -
                                                                                                                                                                              - - - - - -
                                                                                                                                                                              -
                                                                                                                                                                              - - -
                                                                                                                                                                              -

                                                                                                                                                                              Creates a link to open a specific portal in Ingress Prime.

                                                                                                                                                                              -
                                                                                                                                                                              - - - - - - - - - -
                                                                                                                                                                              -
                                                                                                                                                                              Parameters:
                                                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                              NameTypeDescription
                                                                                                                                                                              guid - - -string - - - -

                                                                                                                                                                              The globally unique identifier of the portal.

                                                                                                                                                                              lat - - -number - - - -

                                                                                                                                                                              The latitude of the portal.

                                                                                                                                                                              lng - - -number - - - -

                                                                                                                                                                              The longitude of the portal.

                                                                                                                                                                              - -
                                                                                                                                                                              - - - - - - - - - - - - - -
                                                                                                                                                                              -
                                                                                                                                                                              Returns:
                                                                                                                                                                              - - - - - -string - - - - - --

                                                                                                                                                                              The Ingress Prime link for the portal

                                                                                                                                                                              - - - - - -
                                                                                                                                                                              - - - - - -
                                                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                              - - - - -
                                                                                                                                                                              - - - - -
                                                                                                                                                                              - - - - - -
                                                                                                                                                                              -
                                                                                                                                                                              - - -
                                                                                                                                                                              -

                                                                                                                                                                              Creates a link to open a specific portal in Ingress Prime.

                                                                                                                                                                              -
                                                                                                                                                                              - - - - - - - - - -
                                                                                                                                                                              -
                                                                                                                                                                              Parameters:
                                                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                              NameTypeDescription
                                                                                                                                                                              guid - - -string - - - -

                                                                                                                                                                              The globally unique identifier of the portal.

                                                                                                                                                                              lat - - -number - - - -

                                                                                                                                                                              The latitude of the portal.

                                                                                                                                                                              lng - - -number - - - -

                                                                                                                                                                              The longitude of the portal.

                                                                                                                                                                              - -
                                                                                                                                                                              - - - - - - - - - - - - - -
                                                                                                                                                                              -
                                                                                                                                                                              Returns:
                                                                                                                                                                              - - - - - -string - - - - - --

                                                                                                                                                                              The Ingress Prime link for the portal

                                                                                                                                                                              - - - - - -
                                                                                                                                                                              - - - - - -
                                                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                              - - - - -
                                                                                                                                                                              - - - - -
                                                                                                                                                                              - -

                                                                                                                                                                              - - inner prettyEnergy(nrg) → {string} - - - - -

                                                                                                                                                                              - - - -
                                                                                                                                                                              -
                                                                                                                                                                              - - -
                                                                                                                                                                              -

                                                                                                                                                                              Formats energy of portal.

                                                                                                                                                                              -
                                                                                                                                                                              - - - - - - - - - -
                                                                                                                                                                              -
                                                                                                                                                                              Parameters:
                                                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                              NameTypeDescription
                                                                                                                                                                              nrg - - -number - - - -

                                                                                                                                                                              The energy value to format.

                                                                                                                                                                              - -
                                                                                                                                                                              - - - - - - - - - - - - - -
                                                                                                                                                                              -
                                                                                                                                                                              Returns:
                                                                                                                                                                              - - - - - -string - - - - - --

                                                                                                                                                                              The formatted energy value.

                                                                                                                                                                              - - - - - -
                                                                                                                                                                              - - - - - -
                                                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                              - - - - -
                                                                                                                                                                              - - - - -
                                                                                                                                                                              - -

                                                                                                                                                                              - - inner prettyEnergy(nrg) → {string} - - - - -

                                                                                                                                                                              - - - -
                                                                                                                                                                              -
                                                                                                                                                                              - - -
                                                                                                                                                                              -

                                                                                                                                                                              Formats energy of portal.

                                                                                                                                                                              -
                                                                                                                                                                              - - - - - - - - - -
                                                                                                                                                                              -
                                                                                                                                                                              Parameters:
                                                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                              NameTypeDescription
                                                                                                                                                                              nrg - - -number - - - -

                                                                                                                                                                              The energy value to format.

                                                                                                                                                                              - -
                                                                                                                                                                              - - - - - - - - - - - - - -
                                                                                                                                                                              -
                                                                                                                                                                              Returns:
                                                                                                                                                                              - - - - - -string - - - - - --

                                                                                                                                                                              The formatted energy value.

                                                                                                                                                                              - - - - - -
                                                                                                                                                                              - - - - - -
                                                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                              - - - - -
                                                                                                                                                                              - - - - -
                                                                                                                                                                              - -

                                                                                                                                                                              - - inner rangeLinkClick() - - - - -

                                                                                                                                                                              - - - -
                                                                                                                                                                              -
                                                                                                                                                                              - - -
                                                                                                                                                                              -

                                                                                                                                                                              Changes the coordinates and map scale to show the range for portal links.

                                                                                                                                                                              -
                                                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                              - - - - -
                                                                                                                                                                              - - - - -
                                                                                                                                                                              - -

                                                                                                                                                                              - - inner rangeLinkClick() - - - - -

                                                                                                                                                                              - - - -
                                                                                                                                                                              -
                                                                                                                                                                              - - -
                                                                                                                                                                              -

                                                                                                                                                                              Changes the coordinates and map scale to show the range for portal links.

                                                                                                                                                                              -
                                                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                              - - - - -
                                                                                                                                                                              - - - - -
                                                                                                                                                                              - -

                                                                                                                                                                              - - inner readCookie(name) → {string} - - - - -

                                                                                                                                                                              - - - -
                                                                                                                                                                              -
                                                                                                                                                                              - - -
                                                                                                                                                                              -

                                                                                                                                                                              Reads a cookie by name.

                                                                                                                                                                              -
                                                                                                                                                                              - - - - - - - - - -
                                                                                                                                                                              -
                                                                                                                                                                              Parameters:
                                                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                              NameTypeDescription
                                                                                                                                                                              name - - -string - - - -

                                                                                                                                                                              The name of the cookie to read.

                                                                                                                                                                              - -
                                                                                                                                                                              - - - - - - - - - - - - - -
                                                                                                                                                                              -
                                                                                                                                                                              Returns:
                                                                                                                                                                              - - - - - -string - - - - - --

                                                                                                                                                                              The value of the cookie, or undefined if not found.

                                                                                                                                                                              - - - - - -
                                                                                                                                                                              - - - - - -
                                                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                              See:
                                                                                                                                                                              -
                                                                                                                                                                              - -
                                                                                                                                                                              - - - -
                                                                                                                                                                              - - - - -
                                                                                                                                                                              - - - - -
                                                                                                                                                                              - -

                                                                                                                                                                              - - inner readCookie(name) → {string} - - - - -

                                                                                                                                                                              - - - -
                                                                                                                                                                              -
                                                                                                                                                                              - - -
                                                                                                                                                                              -

                                                                                                                                                                              Reads a cookie by name.

                                                                                                                                                                              -
                                                                                                                                                                              - - - - - - - - - -
                                                                                                                                                                              -
                                                                                                                                                                              Parameters:
                                                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                              NameTypeDescription
                                                                                                                                                                              name - - -string - - - -

                                                                                                                                                                              The name of the cookie to read.

                                                                                                                                                                              - -
                                                                                                                                                                              - - - - - - - - - - - - - -
                                                                                                                                                                              -
                                                                                                                                                                              Returns:
                                                                                                                                                                              - - - - - -string - - - - - --

                                                                                                                                                                              The value of the cookie, or undefined if not found.

                                                                                                                                                                              - - - - - -
                                                                                                                                                                              - - - - - -
                                                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                              See:
                                                                                                                                                                              -
                                                                                                                                                                              - -
                                                                                                                                                                              - - - -
                                                                                                                                                                              - - - - -
                                                                                                                                                                              - - - - -
                                                                                                                                                                              - -

                                                                                                                                                                              - - inner scrollBottom(elm) → {number} - - - - -

                                                                                                                                                                              - - - -
                                                                                                                                                                              -
                                                                                                                                                                              - - -
                                                                                                                                                                              -

                                                                                                                                                                              Calculates the number of pixels left to scroll down before reaching the bottom of an element.

                                                                                                                                                                              -
                                                                                                                                                                              - - - - - - - - - -
                                                                                                                                                                              -
                                                                                                                                                                              Parameters:
                                                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                              NameTypeDescription
                                                                                                                                                                              elm - - -string -| - -jQuery - - - -

                                                                                                                                                                              The element to calculate the scroll bottom for.

                                                                                                                                                                              - -
                                                                                                                                                                              - - - - - - - - - - - - - -
                                                                                                                                                                              -
                                                                                                                                                                              Returns:
                                                                                                                                                                              - - - - - -number - - - - - --

                                                                                                                                                                              The number of pixels from the bottom.

                                                                                                                                                                              - - - - - -
                                                                                                                                                                              - - - - - -
                                                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                              - - - - -
                                                                                                                                                                              - - - - -
                                                                                                                                                                              - -

                                                                                                                                                                              - - inner scrollBottom(elm) → {number} - - - - -

                                                                                                                                                                              - - - -
                                                                                                                                                                              -
                                                                                                                                                                              - - -
                                                                                                                                                                              -

                                                                                                                                                                              Calculates the number of pixels left to scroll down before reaching the bottom of an element.

                                                                                                                                                                              -
                                                                                                                                                                              - - - - - - - - - -
                                                                                                                                                                              -
                                                                                                                                                                              Parameters:
                                                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                              NameTypeDescription
                                                                                                                                                                              elm - - -string -| - -jQuery - - - -

                                                                                                                                                                              The element to calculate the scroll bottom for.

                                                                                                                                                                              - -
                                                                                                                                                                              - - - - - - - - - - - - - -
                                                                                                                                                                              -
                                                                                                                                                                              Returns:
                                                                                                                                                                              - - - - - -number - - - - - --

                                                                                                                                                                              The number of pixels from the bottom.

                                                                                                                                                                              - - - - - -
                                                                                                                                                                              - - - - - -
                                                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                              - - - - -
                                                                                                                                                                              - - - - -
                                                                                                                                                                              - -

                                                                                                                                                                              - - inner selectPortalByLatLng(lat, lngopt) - - - - -

                                                                                                                                                                              - - - -
                                                                                                                                                                              -
                                                                                                                                                                              - - -
                                                                                                                                                                              -

                                                                                                                                                                              Selects a portal by its latitude and longitude.

                                                                                                                                                                              -
                                                                                                                                                                              - - - - - - - - - -
                                                                                                                                                                              -
                                                                                                                                                                              Parameters:
                                                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                              NameTypeAttributesDescription
                                                                                                                                                                              lat - - -number -| - -Array -| - -L.LatLng - - - - - - - - - -

                                                                                                                                                                              The latitude of the portal -or an array or L.LatLng object containing both latitude and longitude.

                                                                                                                                                                              lng - - -number - - - - - - <optional>
                                                                                                                                                                              - - - - - -

                                                                                                                                                                              The longitude of the portal.

                                                                                                                                                                              - -
                                                                                                                                                                              - - - - - - - - - - - - - - - - - -
                                                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                              - - - - -
                                                                                                                                                                              - - - - -
                                                                                                                                                                              - -

                                                                                                                                                                              - - inner selectPortalByLatLng(lat, lngopt) - - - - -

                                                                                                                                                                              - - - -
                                                                                                                                                                              -
                                                                                                                                                                              - - -
                                                                                                                                                                              -

                                                                                                                                                                              Selects a portal by its latitude and longitude.

                                                                                                                                                                              -
                                                                                                                                                                              - - - - - - - - - -
                                                                                                                                                                              -
                                                                                                                                                                              Parameters:
                                                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                              NameTypeAttributesDescription
                                                                                                                                                                              lat - - -number -| - -Array -| - -L.LatLng - - - - - - - - - -

                                                                                                                                                                              The latitude of the portal -or an array or L.LatLng object containing both latitude and longitude.

                                                                                                                                                                              lng - - -number - - - - - - <optional>
                                                                                                                                                                              - - - - - -

                                                                                                                                                                              The longitude of the portal.

                                                                                                                                                                              - -
                                                                                                                                                                              - - - - - - - - - - - - - - - - - -
                                                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                              - - - - -
                                                                                                                                                                              - - - - -
                                                                                                                                                                              - - - - - -
                                                                                                                                                                              -
                                                                                                                                                                              - - -
                                                                                                                                                                              -

                                                                                                                                                                              Displays a dialog with links to show the specified location on various map services.

                                                                                                                                                                              -
                                                                                                                                                                              - - - - - - - - - -
                                                                                                                                                                              -
                                                                                                                                                                              Parameters:
                                                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                              NameTypeDescription
                                                                                                                                                                              lat - - -number - - - -

                                                                                                                                                                              Latitude of the location.

                                                                                                                                                                              lng - - -number - - - -

                                                                                                                                                                              Longitude of the location.

                                                                                                                                                                              name - - -string - - - -

                                                                                                                                                                              Name of the location.

                                                                                                                                                                              - -
                                                                                                                                                                              - - - - - - - - - - - - - - - - - -
                                                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                              - - - - -
                                                                                                                                                                              - - - - -
                                                                                                                                                                              - - - - - -
                                                                                                                                                                              -
                                                                                                                                                                              - - -
                                                                                                                                                                              -

                                                                                                                                                                              Displays a dialog with links to show the specified location on various map services.

                                                                                                                                                                              -
                                                                                                                                                                              - - - - - - - - - -
                                                                                                                                                                              -
                                                                                                                                                                              Parameters:
                                                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                              NameTypeDescription
                                                                                                                                                                              lat - - -number - - - -

                                                                                                                                                                              Latitude of the location.

                                                                                                                                                                              lng - - -number - - - -

                                                                                                                                                                              Longitude of the location.

                                                                                                                                                                              name - - -string - - - -

                                                                                                                                                                              Name of the location.

                                                                                                                                                                              - -
                                                                                                                                                                              - - - - - - - - - - - - - - - - - -
                                                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                              - - - - -
                                                                                                                                                                              - - - - -
                                                                                                                                                                              - -

                                                                                                                                                                              - - inner uniqueArray(arr) → {Array} - - - - -

                                                                                                                                                                              - - - -
                                                                                                                                                                              -
                                                                                                                                                                              - - -
                                                                                                                                                                              -

                                                                                                                                                                              Converts a list of items into a unique array, removing duplicates.

                                                                                                                                                                              -
                                                                                                                                                                              - - - - - - - - - -
                                                                                                                                                                              -
                                                                                                                                                                              Parameters:
                                                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                              NameTypeDescription
                                                                                                                                                                              arr - - -Array - - - -

                                                                                                                                                                              The array to process.

                                                                                                                                                                              - -
                                                                                                                                                                              - - - - - - - - - - - - - -
                                                                                                                                                                              -
                                                                                                                                                                              Returns:
                                                                                                                                                                              - - - - - -Array - - - - - --

                                                                                                                                                                              A new array containing only unique elements.

                                                                                                                                                                              - - - - - -
                                                                                                                                                                              - - - - - -
                                                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                              - - - - -
                                                                                                                                                                              - - - - -
                                                                                                                                                                              - -

                                                                                                                                                                              - - inner uniqueArray(arr) → {Array} - - - - -

                                                                                                                                                                              - - - -
                                                                                                                                                                              -
                                                                                                                                                                              - - -
                                                                                                                                                                              -

                                                                                                                                                                              Converts a list of items into a unique array, removing duplicates.

                                                                                                                                                                              -
                                                                                                                                                                              - - - - - - - - - -
                                                                                                                                                                              -
                                                                                                                                                                              Parameters:
                                                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                              NameTypeDescription
                                                                                                                                                                              arr - - -Array - - - -

                                                                                                                                                                              The array to process.

                                                                                                                                                                              - -
                                                                                                                                                                              - - - - - - - - - - - - - -
                                                                                                                                                                              -
                                                                                                                                                                              Returns:
                                                                                                                                                                              - - - - - -Array - - - - - --

                                                                                                                                                                              A new array containing only unique elements.

                                                                                                                                                                              - - - - - -
                                                                                                                                                                              - - - - - -
                                                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                              - - - - -
                                                                                                                                                                              - - - - -
                                                                                                                                                                              - -

                                                                                                                                                                              - - inner unixTimeToDateTimeString(time, millisecondopt) → {string|null} - - - - -

                                                                                                                                                                              - - - -
                                                                                                                                                                              -
                                                                                                                                                                              - - -
                                                                                                                                                                              -

                                                                                                                                                                              Converts a UNIX timestamp to a precise date and time string in the local timezone. -Formatted in ISO-style YYYY-MM-DD hh:mm:ss.mmm - but using local timezone

                                                                                                                                                                              -
                                                                                                                                                                              - - - - - - - - - -
                                                                                                                                                                              -
                                                                                                                                                                              Parameters:
                                                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                              NameTypeAttributesDescription
                                                                                                                                                                              time - - -number - - - - - - - - - -

                                                                                                                                                                              The UNIX timestamp to convert.

                                                                                                                                                                              millisecond - - -boolean - - - - - - <optional>
                                                                                                                                                                              - - - - - -

                                                                                                                                                                              Whether to include millisecond precision.

                                                                                                                                                                              - -
                                                                                                                                                                              - - - - - - - - - - - - - -
                                                                                                                                                                              -
                                                                                                                                                                              Returns:
                                                                                                                                                                              - - - - - -string -| - -null - - - - - --

                                                                                                                                                                              The formatted date and time string.

                                                                                                                                                                              - - - - - -
                                                                                                                                                                              - - - - - -
                                                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                              - - - - -
                                                                                                                                                                              - - - - -
                                                                                                                                                                              - -

                                                                                                                                                                              - - inner unixTimeToDateTimeString(time, millisecondopt) → {string|null} - - - - -

                                                                                                                                                                              - - - -
                                                                                                                                                                              -
                                                                                                                                                                              - - -
                                                                                                                                                                              -

                                                                                                                                                                              Converts a UNIX timestamp to a precise date and time string in the local timezone. -Formatted in ISO-style YYYY-MM-DD hh:mm:ss.mmm - but using local timezone

                                                                                                                                                                              -
                                                                                                                                                                              - - - - - - - - - -
                                                                                                                                                                              -
                                                                                                                                                                              Parameters:
                                                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                              NameTypeAttributesDescription
                                                                                                                                                                              time - - -number - - - - - - - - - -

                                                                                                                                                                              The UNIX timestamp to convert.

                                                                                                                                                                              millisecond - - -boolean - - - - - - <optional>
                                                                                                                                                                              - - - - - -

                                                                                                                                                                              Whether to include millisecond precision.

                                                                                                                                                                              - -
                                                                                                                                                                              - - - - - - - - - - - - - -
                                                                                                                                                                              -
                                                                                                                                                                              Returns:
                                                                                                                                                                              - - - - - -string -| - -null - - - - - --

                                                                                                                                                                              The formatted date and time string.

                                                                                                                                                                              - - - - - -
                                                                                                                                                                              - - - - - -
                                                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                              - - - - -
                                                                                                                                                                              - - - - -
                                                                                                                                                                              - -

                                                                                                                                                                              - - inner unixTimeToHHmm(time) → {string|null} - - - - -

                                                                                                                                                                              - - - -
                                                                                                                                                                              -
                                                                                                                                                                              - - -
                                                                                                                                                                              -

                                                                                                                                                                              Converts a UNIX timestamp to a time string formatted as HH:mm.

                                                                                                                                                                              -
                                                                                                                                                                              - - - - - - - - - -
                                                                                                                                                                              -
                                                                                                                                                                              Parameters:
                                                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                              NameTypeDescription
                                                                                                                                                                              time - - -number -| - -string - - - -

                                                                                                                                                                              The UNIX timestamp to convert.

                                                                                                                                                                              - -
                                                                                                                                                                              - - - - - - - - - - - - - -
                                                                                                                                                                              -
                                                                                                                                                                              Returns:
                                                                                                                                                                              - - - - - -string -| - -null - - - - - --

                                                                                                                                                                              Formatted time as HH:mm.

                                                                                                                                                                              - - - - - -
                                                                                                                                                                              - - - - - -
                                                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                              - - - - -
                                                                                                                                                                              - - - - -
                                                                                                                                                                              - -

                                                                                                                                                                              - - inner unixTimeToHHmm(time) → {string|null} - - - - -

                                                                                                                                                                              - - - -
                                                                                                                                                                              -
                                                                                                                                                                              - - -
                                                                                                                                                                              -

                                                                                                                                                                              Converts a UNIX timestamp to a time string formatted as HH:mm.

                                                                                                                                                                              -
                                                                                                                                                                              - - - - - - - - - -
                                                                                                                                                                              -
                                                                                                                                                                              Parameters:
                                                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                              NameTypeDescription
                                                                                                                                                                              time - - -number -| - -string - - - -

                                                                                                                                                                              The UNIX timestamp to convert.

                                                                                                                                                                              - -
                                                                                                                                                                              - - - - - - - - - - - - - -
                                                                                                                                                                              -
                                                                                                                                                                              Returns:
                                                                                                                                                                              - - - - - -string -| - -null - - - - - --

                                                                                                                                                                              Formatted time as HH:mm.

                                                                                                                                                                              - - - - - -
                                                                                                                                                                              - - - - - -
                                                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                              - - - - -
                                                                                                                                                                              - - - - -
                                                                                                                                                                              - -

                                                                                                                                                                              - - inner unixTimeToString(time, fullopt) → {string|null} - - - - -

                                                                                                                                                                              - - - -
                                                                                                                                                                              -
                                                                                                                                                                              - - -
                                                                                                                                                                              -

                                                                                                                                                                              Converts a UNIX timestamp to a human-readable string. -If the timestamp is from today, returns the time (HH:mm:ss format); otherwise, returns the date (YYYY-MM-DD).

                                                                                                                                                                              -
                                                                                                                                                                              - - - - - - - - - -
                                                                                                                                                                              -
                                                                                                                                                                              Parameters:
                                                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                              NameTypeAttributesDescription
                                                                                                                                                                              time - - -number - - - - - - - - - -

                                                                                                                                                                              The UNIX timestamp to convert.

                                                                                                                                                                              full - - -boolean - - - - - - <optional>
                                                                                                                                                                              - - - - - -

                                                                                                                                                                              If true, returns both date and time.

                                                                                                                                                                              - -
                                                                                                                                                                              - - - - - - - - - - - - - -
                                                                                                                                                                              -
                                                                                                                                                                              Returns:
                                                                                                                                                                              - - - - - -string -| - -null - - - - - --

                                                                                                                                                                              The formatted date and/or time.

                                                                                                                                                                              - - - - - -
                                                                                                                                                                              - - - - - -
                                                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                              - - - - -
                                                                                                                                                                              - - - - -
                                                                                                                                                                              - -

                                                                                                                                                                              - - inner unixTimeToString(time, fullopt) → {string|null} - - - - -

                                                                                                                                                                              - - - -
                                                                                                                                                                              -
                                                                                                                                                                              - - -
                                                                                                                                                                              -

                                                                                                                                                                              Converts a UNIX timestamp to a human-readable string. -If the timestamp is from today, returns the time (HH:mm:ss format); otherwise, returns the date (YYYY-MM-DD).

                                                                                                                                                                              -
                                                                                                                                                                              - - - - - - - - - -
                                                                                                                                                                              -
                                                                                                                                                                              Parameters:
                                                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                              NameTypeAttributesDescription
                                                                                                                                                                              time - - -number - - - - - - - - - -

                                                                                                                                                                              The UNIX timestamp to convert.

                                                                                                                                                                              full - - -boolean - - - - - - <optional>
                                                                                                                                                                              - - - - - -

                                                                                                                                                                              If true, returns both date and time.

                                                                                                                                                                              - -
                                                                                                                                                                              - - - - - - - - - - - - - -
                                                                                                                                                                              -
                                                                                                                                                                              Returns:
                                                                                                                                                                              - - - - - -string -| - -null - - - - - --

                                                                                                                                                                              The formatted date and/or time.

                                                                                                                                                                              - - - - - -
                                                                                                                                                                              - - - - - -
                                                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                              - - - - -
                                                                                                                                                                              - - - - -
                                                                                                                                                                              - -

                                                                                                                                                                              - - inner writeCookie(name, val) - - - - -

                                                                                                                                                                              - - - -
                                                                                                                                                                              -
                                                                                                                                                                              - - -
                                                                                                                                                                              -

                                                                                                                                                                              Writes a cookie with a specified name and value.

                                                                                                                                                                              -
                                                                                                                                                                              - - - - - - - - - -
                                                                                                                                                                              -
                                                                                                                                                                              Parameters:
                                                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                              NameTypeDescription
                                                                                                                                                                              name - - -string - - - -

                                                                                                                                                                              The name of the cookie.

                                                                                                                                                                              val - - -string - - - -

                                                                                                                                                                              The value of the cookie.

                                                                                                                                                                              - -
                                                                                                                                                                              - - - - - - - - - - - - - - - - - -
                                                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                              - - - - -
                                                                                                                                                                              - - - - -
                                                                                                                                                                              - -

                                                                                                                                                                              - - inner writeCookie(name, val) - - - - -

                                                                                                                                                                              - - - -
                                                                                                                                                                              -
                                                                                                                                                                              - - -
                                                                                                                                                                              -

                                                                                                                                                                              Writes a cookie with a specified name and value.

                                                                                                                                                                              -
                                                                                                                                                                              - - - - - - - - - -
                                                                                                                                                                              -
                                                                                                                                                                              Parameters:
                                                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                              NameTypeDescription
                                                                                                                                                                              name - - -string - - - -

                                                                                                                                                                              The name of the cookie.

                                                                                                                                                                              val - - -string - - - -

                                                                                                                                                                              The value of the cookie.

                                                                                                                                                                              - -
                                                                                                                                                                              - - - - - - - - - - - - - - - - - -
                                                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                              - - - - -
                                                                                                                                                                              - - - - -
                                                                                                                                                                              - -

                                                                                                                                                                              - - inner zeroPad(number, pad) → {string} - - - - -

                                                                                                                                                                              - - - -
                                                                                                                                                                              -
                                                                                                                                                                              - - -
                                                                                                                                                                              -

                                                                                                                                                                              Pads a number with zeros up to a specified length.

                                                                                                                                                                              -
                                                                                                                                                                              - - - - - - - - - -
                                                                                                                                                                              -
                                                                                                                                                                              Parameters:
                                                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                              NameTypeDescription
                                                                                                                                                                              number - - -number - - - -

                                                                                                                                                                              The number to pad.

                                                                                                                                                                              pad - - -number - - - -

                                                                                                                                                                              The desired length of the output string.

                                                                                                                                                                              - -
                                                                                                                                                                              - - - - - - - - - - - - - -
                                                                                                                                                                              -
                                                                                                                                                                              Returns:
                                                                                                                                                                              - - - - - -string - - - - - --

                                                                                                                                                                              The padded number as a string.

                                                                                                                                                                              - - - - - -
                                                                                                                                                                              - - - - - -
                                                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                              - - - - -
                                                                                                                                                                              - - - - -
                                                                                                                                                                              - -

                                                                                                                                                                              - - inner zeroPad(number, pad) → {string} - - - - -

                                                                                                                                                                              - - - -
                                                                                                                                                                              -
                                                                                                                                                                              - - -
                                                                                                                                                                              -

                                                                                                                                                                              Pads a number with zeros up to a specified length.

                                                                                                                                                                              -
                                                                                                                                                                              - - - - - - - - - -
                                                                                                                                                                              -
                                                                                                                                                                              Parameters:
                                                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                              NameTypeDescription
                                                                                                                                                                              number - - -number - - - -

                                                                                                                                                                              The number to pad.

                                                                                                                                                                              pad - - -number - - - -

                                                                                                                                                                              The desired length of the output string.

                                                                                                                                                                              - -
                                                                                                                                                                              - - - - - - - - - - - - - -
                                                                                                                                                                              -
                                                                                                                                                                              Returns:
                                                                                                                                                                              - - - - - -string - - - - - --

                                                                                                                                                                              The padded number as a string.

                                                                                                                                                                              - - - - - -
                                                                                                                                                                              - - - - - -
                                                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                              - - - - -
                                                                                                                                                                              - - - - -
                                                                                                                                                                              - -

                                                                                                                                                                              - - inner zoomToAndShowPortal(guid, latlng) - - - - -

                                                                                                                                                                              - - - -
                                                                                                                                                                              -
                                                                                                                                                                              - - -
                                                                                                                                                                              -

                                                                                                                                                                              Zooms the map to a specific portal and shows its details if available.

                                                                                                                                                                              -
                                                                                                                                                                              - - - - - - - - - -
                                                                                                                                                                              -
                                                                                                                                                                              Parameters:
                                                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                              NameTypeDescription
                                                                                                                                                                              guid - - -string - - - -

                                                                                                                                                                              The globally unique identifier of the portal.

                                                                                                                                                                              latlng - - -L.LatLng - - - -

                                                                                                                                                                              The latitude and longitude of the portal.

                                                                                                                                                                              - -
                                                                                                                                                                              - - - - - - - - - - - - - - - - - -
                                                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                              - - - - -
                                                                                                                                                                              - - - - -
                                                                                                                                                                              - -

                                                                                                                                                                              - - inner zoomToAndShowPortal(guid, latlng) - - - - -

                                                                                                                                                                              - - - -
                                                                                                                                                                              -
                                                                                                                                                                              - - -
                                                                                                                                                                              -

                                                                                                                                                                              Zooms the map to a specific portal and shows its details if available.

                                                                                                                                                                              -
                                                                                                                                                                              - - - - - - - - - -
                                                                                                                                                                              -
                                                                                                                                                                              Parameters:
                                                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                              NameTypeDescription
                                                                                                                                                                              guid - - -string - - - -

                                                                                                                                                                              The globally unique identifier of the portal.

                                                                                                                                                                              latlng - - -L.LatLng - - - -

                                                                                                                                                                              The latitude and longitude of the portal.

                                                                                                                                                                              - -
                                                                                                                                                                              - - - - - - - - - - - - - - - - - -
                                                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                              - - - - -
                                                                                                                                                                              - -
                                                                                                                                                                              - - - - - -
                                                                                                                                                                              - -
                                                                                                                                                                              - - - - - - - -
                                                                                                                                                                              - -
                                                                                                                                                                              - -

                                                                                                                                                                              utils_misc

                                                                                                                                                                              - - - - - - -
                                                                                                                                                                              - -
                                                                                                                                                                              - -
                                                                                                                                                                              - - -

                                                                                                                                                                              Misc utils

                                                                                                                                                                              - - - - - -
                                                                                                                                                                              - -
                                                                                                                                                                              -
                                                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                              - - - - -
                                                                                                                                                                              - - - - -
                                                                                                                                                                              - -
                                                                                                                                                                              -
                                                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                              - - - - -
                                                                                                                                                                              - - - -
                                                                                                                                                                              - - - - - - - - - - - - - - - - - -

                                                                                                                                                                              Methods

                                                                                                                                                                              - -
                                                                                                                                                                              - - -
                                                                                                                                                                              - -

                                                                                                                                                                              - - private, inner clamp(n, max, min) → {number} - - - - -

                                                                                                                                                                              - - - -
                                                                                                                                                                              -
                                                                                                                                                                              - - -
                                                                                                                                                                              -

                                                                                                                                                                              Clamps a given value between a minimum and maximum value.

                                                                                                                                                                              -
                                                                                                                                                                              - - - - - - - - - -
                                                                                                                                                                              -
                                                                                                                                                                              Parameters:
                                                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                              NameTypeDescription
                                                                                                                                                                              n - - -number - - - -

                                                                                                                                                                              The value to clamp.

                                                                                                                                                                              max - - -number - - - -

                                                                                                                                                                              The maximum allowed value.

                                                                                                                                                                              min - - -number - - - -

                                                                                                                                                                              The minimum allowed value.

                                                                                                                                                                              - -
                                                                                                                                                                              - - - - - - - - - - - - - -
                                                                                                                                                                              -
                                                                                                                                                                              Returns:
                                                                                                                                                                              - - - - - -number - - - - - --

                                                                                                                                                                              The clamped value.

                                                                                                                                                                              - - - - - -
                                                                                                                                                                              - - - - - -
                                                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                              - - - - -
                                                                                                                                                                              - - - - -
                                                                                                                                                                              - -

                                                                                                                                                                              - - private, inner clamp(n, max, min) → {number} - - - - -

                                                                                                                                                                              - - - -
                                                                                                                                                                              -
                                                                                                                                                                              - - -
                                                                                                                                                                              -

                                                                                                                                                                              Clamps a given value between a minimum and maximum value.

                                                                                                                                                                              -
                                                                                                                                                                              - - - - - - - - - -
                                                                                                                                                                              -
                                                                                                                                                                              Parameters:
                                                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                              NameTypeDescription
                                                                                                                                                                              n - - -number - - - -

                                                                                                                                                                              The value to clamp.

                                                                                                                                                                              max - - -number - - - -

                                                                                                                                                                              The maximum allowed value.

                                                                                                                                                                              min - - -number - - - -

                                                                                                                                                                              The minimum allowed value.

                                                                                                                                                                              - -
                                                                                                                                                                              - - - - - - - - - - - - - -
                                                                                                                                                                              -
                                                                                                                                                                              Returns:
                                                                                                                                                                              - - - - - -number - - - - - --

                                                                                                                                                                              The clamped value.

                                                                                                                                                                              - - - - - -
                                                                                                                                                                              - - - - - -
                                                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                              - - - - -
                                                                                                                                                                              - - - - -
                                                                                                                                                                              - -

                                                                                                                                                                              - - inner clampLatLng(latlng) → {Array.<number>} - - - - -

                                                                                                                                                                              - - - -
                                                                                                                                                                              -
                                                                                                                                                                              - - -
                                                                                                                                                                              -

                                                                                                                                                                              Clamps a latitude and longitude to the maximum and minimum valid values.

                                                                                                                                                                              -
                                                                                                                                                                              - - - - - - - - - -
                                                                                                                                                                              -
                                                                                                                                                                              Parameters:
                                                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                              NameTypeDescription
                                                                                                                                                                              latlng - - -L.LatLng - - - -

                                                                                                                                                                              The latitude and longitude to clamp.

                                                                                                                                                                              - -
                                                                                                                                                                              - - - - - - - - - - - - - -
                                                                                                                                                                              -
                                                                                                                                                                              Returns:
                                                                                                                                                                              - - - - - -Array.<number> - - - - - --

                                                                                                                                                                              The clamped latitude and longitude.

                                                                                                                                                                              - - - - - -
                                                                                                                                                                              - - - - - -
                                                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                              - - - - -
                                                                                                                                                                              - - - - -
                                                                                                                                                                              - -

                                                                                                                                                                              - - inner clampLatLng(latlng) → {Array.<number>} - - - - -

                                                                                                                                                                              - - - -
                                                                                                                                                                              -
                                                                                                                                                                              - - -
                                                                                                                                                                              -

                                                                                                                                                                              Clamps a latitude and longitude to the maximum and minimum valid values.

                                                                                                                                                                              -
                                                                                                                                                                              - - - - - - - - - -
                                                                                                                                                                              -
                                                                                                                                                                              Parameters:
                                                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                              NameTypeDescription
                                                                                                                                                                              latlng - - -L.LatLng - - - -

                                                                                                                                                                              The latitude and longitude to clamp.

                                                                                                                                                                              - -
                                                                                                                                                                              - - - - - - - - - - - - - -
                                                                                                                                                                              -
                                                                                                                                                                              Returns:
                                                                                                                                                                              - - - - - -Array.<number> - - - - - --

                                                                                                                                                                              The clamped latitude and longitude.

                                                                                                                                                                              - - - - - -
                                                                                                                                                                              - - - - - -
                                                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                              - - - - -
                                                                                                                                                                              - - - - -
                                                                                                                                                                              - -

                                                                                                                                                                              - - inner clampLatLngBounds(bounds) → {L.LatLngBounds} - - - - -

                                                                                                                                                                              - - - -
                                                                                                                                                                              -
                                                                                                                                                                              - - -
                                                                                                                                                                              -

                                                                                                                                                                              Clamps a latitude and longitude bounds to the maximum and minimum valid values.

                                                                                                                                                                              -
                                                                                                                                                                              - - - - - - - - - -
                                                                                                                                                                              -
                                                                                                                                                                              Parameters:
                                                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                              NameTypeDescription
                                                                                                                                                                              bounds - - -L.LatLngBounds - - - -

                                                                                                                                                                              The bounds to clamp.

                                                                                                                                                                              - -
                                                                                                                                                                              - - - - - - - - - - - - - -
                                                                                                                                                                              -
                                                                                                                                                                              Returns:
                                                                                                                                                                              - - - - - -L.LatLngBounds - - - - - --

                                                                                                                                                                              The clamped bounds.

                                                                                                                                                                              - - - - - -
                                                                                                                                                                              - - - - - -
                                                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                              - - - - -
                                                                                                                                                                              - - - - -
                                                                                                                                                                              - -

                                                                                                                                                                              - - inner clampLatLngBounds(bounds) → {L.LatLngBounds} - - - - -

                                                                                                                                                                              - - - -
                                                                                                                                                                              -
                                                                                                                                                                              - - -
                                                                                                                                                                              -

                                                                                                                                                                              Clamps a latitude and longitude bounds to the maximum and minimum valid values.

                                                                                                                                                                              -
                                                                                                                                                                              - - - - - - - - - -
                                                                                                                                                                              -
                                                                                                                                                                              Parameters:
                                                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                              NameTypeDescription
                                                                                                                                                                              bounds - - -L.LatLngBounds - - - -

                                                                                                                                                                              The bounds to clamp.

                                                                                                                                                                              - -
                                                                                                                                                                              - - - - - - - - - - - - - -
                                                                                                                                                                              -
                                                                                                                                                                              Returns:
                                                                                                                                                                              - - - - - -L.LatLngBounds - - - - - --

                                                                                                                                                                              The clamped bounds.

                                                                                                                                                                              - - - - - -
                                                                                                                                                                              - - - - - -
                                                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                              - - - - -
                                                                                                                                                                              - - - - -
                                                                                                                                                                              - -

                                                                                                                                                                              - - inner convertTextToTableMagic(text) → {string} - - - - -

                                                                                                                                                                              - - - -
                                                                                                                                                                              -
                                                                                                                                                                              - - -
                                                                                                                                                                              -

                                                                                                                                                                              Converts text with newlines (\n) and tabs (\t) into an HTML table.

                                                                                                                                                                              -
                                                                                                                                                                              - - - - - - - - - -
                                                                                                                                                                              -
                                                                                                                                                                              Parameters:
                                                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                              NameTypeDescription
                                                                                                                                                                              text - - -string - - - -

                                                                                                                                                                              The text to convert.

                                                                                                                                                                              - -
                                                                                                                                                                              - - - - - - - - - - - - - -
                                                                                                                                                                              -
                                                                                                                                                                              Returns:
                                                                                                                                                                              - - - - - -string - - - - - --

                                                                                                                                                                              The resulting HTML table.

                                                                                                                                                                              - - - - - -
                                                                                                                                                                              - - - - - -
                                                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                              - - - - -
                                                                                                                                                                              - - - - -
                                                                                                                                                                              - -

                                                                                                                                                                              - - inner convertTextToTableMagic(text) → {string} - - - - -

                                                                                                                                                                              - - - -
                                                                                                                                                                              -
                                                                                                                                                                              - - -
                                                                                                                                                                              -

                                                                                                                                                                              Converts text with newlines (\n) and tabs (\t) into an HTML table.

                                                                                                                                                                              -
                                                                                                                                                                              - - - - - - - - - -
                                                                                                                                                                              -
                                                                                                                                                                              Parameters:
                                                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                              NameTypeDescription
                                                                                                                                                                              text - - -string - - - -

                                                                                                                                                                              The text to convert.

                                                                                                                                                                              - -
                                                                                                                                                                              - - - - - - - - - - - - - -
                                                                                                                                                                              -
                                                                                                                                                                              Returns:
                                                                                                                                                                              - - - - - -string - - - - - --

                                                                                                                                                                              The resulting HTML table.

                                                                                                                                                                              - - - - - -
                                                                                                                                                                              - - - - - -
                                                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                              - - - - -
                                                                                                                                                                              - - - - -
                                                                                                                                                                              - -

                                                                                                                                                                              - - inner digits(d) → {string} - - - - -

                                                                                                                                                                              - - - -
                                                                                                                                                                              -
                                                                                                                                                                              - - -
                                                                                                                                                                              -

                                                                                                                                                                              Adds thousand separators to a given number.

                                                                                                                                                                              -
                                                                                                                                                                              - - - - - - - - - -
                                                                                                                                                                              -
                                                                                                                                                                              Parameters:
                                                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                              NameTypeDescription
                                                                                                                                                                              d - - -number - - - -

                                                                                                                                                                              The number to format.

                                                                                                                                                                              - -
                                                                                                                                                                              - - - - - - - - - - - - - -
                                                                                                                                                                              -
                                                                                                                                                                              Returns:
                                                                                                                                                                              - - - - - -string - - - - - --

                                                                                                                                                                              The formatted number with thousand separators.

                                                                                                                                                                              - - - - - -
                                                                                                                                                                              - - - - - -
                                                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                              See:
                                                                                                                                                                              -
                                                                                                                                                                              - -
                                                                                                                                                                              - - - -
                                                                                                                                                                              - - - - -
                                                                                                                                                                              - - - - -
                                                                                                                                                                              - -

                                                                                                                                                                              - - inner digits(d) → {string} - - - - -

                                                                                                                                                                              - - - -
                                                                                                                                                                              -
                                                                                                                                                                              - - -
                                                                                                                                                                              -

                                                                                                                                                                              Adds thousand separators to a given number.

                                                                                                                                                                              -
                                                                                                                                                                              - - - - - - - - - -
                                                                                                                                                                              -
                                                                                                                                                                              Parameters:
                                                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                              NameTypeDescription
                                                                                                                                                                              d - - -number - - - -

                                                                                                                                                                              The number to format.

                                                                                                                                                                              - -
                                                                                                                                                                              - - - - - - - - - - - - - -
                                                                                                                                                                              -
                                                                                                                                                                              Returns:
                                                                                                                                                                              - - - - - -string - - - - - --

                                                                                                                                                                              The formatted number with thousand separators.

                                                                                                                                                                              - - - - - -
                                                                                                                                                                              - - - - - -
                                                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                              See:
                                                                                                                                                                              -
                                                                                                                                                                              - -
                                                                                                                                                                              - - - -
                                                                                                                                                                              - - - - -
                                                                                                                                                                              - - - - -
                                                                                                                                                                              - -

                                                                                                                                                                              - - inner eraseCookie(name) - - - - -

                                                                                                                                                                              - - - -
                                                                                                                                                                              -
                                                                                                                                                                              - - -
                                                                                                                                                                              -

                                                                                                                                                                              Erases a cookie with a specified name.

                                                                                                                                                                              -
                                                                                                                                                                              - - - - - - - - - -
                                                                                                                                                                              -
                                                                                                                                                                              Parameters:
                                                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                              NameTypeDescription
                                                                                                                                                                              name - - -string - - - -

                                                                                                                                                                              The name of the cookie to erase.

                                                                                                                                                                              - -
                                                                                                                                                                              - - - - - - - - - - - - - - - - - -
                                                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                              - - - - -
                                                                                                                                                                              - - - - -
                                                                                                                                                                              - -

                                                                                                                                                                              - - inner eraseCookie(name) - - - - -

                                                                                                                                                                              - - - -
                                                                                                                                                                              -
                                                                                                                                                                              - - -
                                                                                                                                                                              -

                                                                                                                                                                              Erases a cookie with a specified name.

                                                                                                                                                                              -
                                                                                                                                                                              - - - - - - - - - -
                                                                                                                                                                              -
                                                                                                                                                                              Parameters:
                                                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                              NameTypeDescription
                                                                                                                                                                              name - - -string - - - -

                                                                                                                                                                              The name of the cookie to erase.

                                                                                                                                                                              - -
                                                                                                                                                                              - - - - - - - - - - - - - - - - - -
                                                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                              - - - - -
                                                                                                                                                                              - - - - -
                                                                                                                                                                              - -

                                                                                                                                                                              - - inner escapeHtmlSpecialChars(str) → {string} - - - - -

                                                                                                                                                                              - - - -
                                                                                                                                                                              -
                                                                                                                                                                              - - -
                                                                                                                                                                              -

                                                                                                                                                                              Escapes HTML special characters in a string.

                                                                                                                                                                              -
                                                                                                                                                                              - - - - - - - - - -
                                                                                                                                                                              -
                                                                                                                                                                              Parameters:
                                                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                              NameTypeDescription
                                                                                                                                                                              str - - -string - - - -

                                                                                                                                                                              The string to escape.

                                                                                                                                                                              - -
                                                                                                                                                                              - - - - - - - - - - - - - -
                                                                                                                                                                              -
                                                                                                                                                                              Returns:
                                                                                                                                                                              - - - - - -string - - - - - --

                                                                                                                                                                              The escaped string.

                                                                                                                                                                              - - - - - -
                                                                                                                                                                              - - - - - -
                                                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                              - - - - -
                                                                                                                                                                              - - - - -
                                                                                                                                                                              - -

                                                                                                                                                                              - - inner escapeHtmlSpecialChars(str) → {string} - - - - -

                                                                                                                                                                              - - - -
                                                                                                                                                                              -
                                                                                                                                                                              - - -
                                                                                                                                                                              -

                                                                                                                                                                              Escapes HTML special characters in a string.

                                                                                                                                                                              -
                                                                                                                                                                              - - - - - - - - - -
                                                                                                                                                                              -
                                                                                                                                                                              Parameters:
                                                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                              NameTypeDescription
                                                                                                                                                                              str - - -string - - - -

                                                                                                                                                                              The string to escape.

                                                                                                                                                                              - -
                                                                                                                                                                              - - - - - - - - - - - - - -
                                                                                                                                                                              -
                                                                                                                                                                              Returns:
                                                                                                                                                                              - - - - - -string - - - - - --

                                                                                                                                                                              The escaped string.

                                                                                                                                                                              - - - - - -
                                                                                                                                                                              - - - - - -
                                                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                              - - - - -
                                                                                                                                                                              - - - - -
                                                                                                                                                                              - -

                                                                                                                                                                              - - inner escapeJavascriptString(str) → {string} - - - - -

                                                                                                                                                                              - - - -
                                                                                                                                                                              -
                                                                                                                                                                              - - -
                                                                                                                                                                              -

                                                                                                                                                                              Escapes special characters in a string for use in JavaScript. -(for strings passed as parameters to html onclick="..." for example)

                                                                                                                                                                              -
                                                                                                                                                                              - - - - - - - - - -
                                                                                                                                                                              -
                                                                                                                                                                              Parameters:
                                                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                              NameTypeDescription
                                                                                                                                                                              str - - -string - - - -

                                                                                                                                                                              The string to escape.

                                                                                                                                                                              - -
                                                                                                                                                                              - - - - - - - - - - - - - -
                                                                                                                                                                              -
                                                                                                                                                                              Returns:
                                                                                                                                                                              - - - - - -string - - - - - --

                                                                                                                                                                              The escaped string.

                                                                                                                                                                              - - - - - -
                                                                                                                                                                              - - - - - -
                                                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                              - - - - -
                                                                                                                                                                              - - - - -
                                                                                                                                                                              - -

                                                                                                                                                                              - - inner escapeJavascriptString(str) → {string} - - - - -

                                                                                                                                                                              - - - -
                                                                                                                                                                              -
                                                                                                                                                                              - - -
                                                                                                                                                                              -

                                                                                                                                                                              Escapes special characters in a string for use in JavaScript. -(for strings passed as parameters to html onclick="..." for example)

                                                                                                                                                                              -
                                                                                                                                                                              - - - - - - - - - -
                                                                                                                                                                              -
                                                                                                                                                                              Parameters:
                                                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                              NameTypeDescription
                                                                                                                                                                              str - - -string - - - -

                                                                                                                                                                              The string to escape.

                                                                                                                                                                              - -
                                                                                                                                                                              - - - - - - - - - - - - - -
                                                                                                                                                                              -
                                                                                                                                                                              Returns:
                                                                                                                                                                              - - - - - -string - - - - - --

                                                                                                                                                                              The escaped string.

                                                                                                                                                                              - - - - - -
                                                                                                                                                                              - - - - - -
                                                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                              - - - - -
                                                                                                                                                                              - - - - -
                                                                                                                                                                              - -

                                                                                                                                                                              - - inner formatDistance(distance) → {string} - - - - -

                                                                                                                                                                              - - - -
                                                                                                                                                                              -
                                                                                                                                                                              - - -
                                                                                                                                                                              -

                                                                                                                                                                              Formats a distance in meters, converting to kilometers if the distance is over 10,000 meters.

                                                                                                                                                                              -
                                                                                                                                                                              - - - - - - - - - -
                                                                                                                                                                              -
                                                                                                                                                                              Parameters:
                                                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                              NameTypeDescription
                                                                                                                                                                              distance - - -number - - - -

                                                                                                                                                                              The distance in meters.

                                                                                                                                                                              - -
                                                                                                                                                                              - - - - - - - - - - - - - -
                                                                                                                                                                              -
                                                                                                                                                                              Returns:
                                                                                                                                                                              - - - - - -string - - - - - --

                                                                                                                                                                              The formatted distance.

                                                                                                                                                                              - - - - - -
                                                                                                                                                                              - - - - - -
                                                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                              - - - - -
                                                                                                                                                                              - - - - -
                                                                                                                                                                              - -

                                                                                                                                                                              - - inner formatDistance(distance) → {string} - - - - -

                                                                                                                                                                              - - - -
                                                                                                                                                                              -
                                                                                                                                                                              - - -
                                                                                                                                                                              -

                                                                                                                                                                              Formats a distance in meters, converting to kilometers if the distance is over 10,000 meters.

                                                                                                                                                                              -
                                                                                                                                                                              - - - - - - - - - -
                                                                                                                                                                              -
                                                                                                                                                                              Parameters:
                                                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                              NameTypeDescription
                                                                                                                                                                              distance - - -number - - - -

                                                                                                                                                                              The distance in meters.

                                                                                                                                                                              - -
                                                                                                                                                                              - - - - - - - - - - - - - -
                                                                                                                                                                              -
                                                                                                                                                                              Returns:
                                                                                                                                                                              - - - - - -string - - - - - --

                                                                                                                                                                              The formatted distance.

                                                                                                                                                                              - - - - - -
                                                                                                                                                                              - - - - - -
                                                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                              - - - - -
                                                                                                                                                                              - - - - -
                                                                                                                                                                              - -

                                                                                                                                                                              - - inner formatInterval(seconds, maxTermsopt) → {string} - - - - -

                                                                                                                                                                              - - - -
                                                                                                                                                                              -
                                                                                                                                                                              - - -
                                                                                                                                                                              -

                                                                                                                                                                              Formats an interval of time given in seconds into a human-readable string.

                                                                                                                                                                              -
                                                                                                                                                                              - - - - - - - - - -
                                                                                                                                                                              -
                                                                                                                                                                              Parameters:
                                                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                              NameTypeAttributesDescription
                                                                                                                                                                              seconds - - -number - - - - - - - - - -

                                                                                                                                                                              The interval in seconds.

                                                                                                                                                                              maxTerms - - -number - - - - - - <optional>
                                                                                                                                                                              - - - - - -

                                                                                                                                                                              The maximum number of time units to include.

                                                                                                                                                                              - -
                                                                                                                                                                              - - - - - - - - - - - - - -
                                                                                                                                                                              -
                                                                                                                                                                              Returns:
                                                                                                                                                                              - - - - - -string - - - - - --

                                                                                                                                                                              The formatted time interval.

                                                                                                                                                                              - - - - - -
                                                                                                                                                                              - - - - - -
                                                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                              - - - - -
                                                                                                                                                                              - - - - -
                                                                                                                                                                              - -

                                                                                                                                                                              - - inner formatInterval(seconds, maxTermsopt) → {string} - - - - -

                                                                                                                                                                              - - - -
                                                                                                                                                                              -
                                                                                                                                                                              - - -
                                                                                                                                                                              -

                                                                                                                                                                              Formats an interval of time given in seconds into a human-readable string.

                                                                                                                                                                              -
                                                                                                                                                                              - - - - - - - - - -
                                                                                                                                                                              -
                                                                                                                                                                              Parameters:
                                                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                              NameTypeAttributesDescription
                                                                                                                                                                              seconds - - -number - - - - - - - - - -

                                                                                                                                                                              The interval in seconds.

                                                                                                                                                                              maxTerms - - -number - - - - - - <optional>
                                                                                                                                                                              - - - - - -

                                                                                                                                                                              The maximum number of time units to include.

                                                                                                                                                                              - -
                                                                                                                                                                              - - - - - - - - - - - - - -
                                                                                                                                                                              -
                                                                                                                                                                              Returns:
                                                                                                                                                                              - - - - - -string - - - - - --

                                                                                                                                                                              The formatted time interval.

                                                                                                                                                                              - - - - - -
                                                                                                                                                                              - - - - - -
                                                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                              - - - - -
                                                                                                                                                                              - - - - -
                                                                                                                                                                              - -

                                                                                                                                                                              - - inner getURLParam(param) → {string} - - - - -

                                                                                                                                                                              - - - -
                                                                                                                                                                              -
                                                                                                                                                                              - - -
                                                                                                                                                                              -

                                                                                                                                                                              Retrieves a parameter from the URL query string.

                                                                                                                                                                              -
                                                                                                                                                                              - - - - - - - - - -
                                                                                                                                                                              -
                                                                                                                                                                              Parameters:
                                                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                              NameTypeDescription
                                                                                                                                                                              param - - -string - - - -

                                                                                                                                                                              The name of the parameter to retrieve.

                                                                                                                                                                              - -
                                                                                                                                                                              - - - - - - - - - - - - - -
                                                                                                                                                                              -
                                                                                                                                                                              Returns:
                                                                                                                                                                              - - - - - -string - - - - - --

                                                                                                                                                                              The value of the parameter, or an empty string if not found.

                                                                                                                                                                              - - - - - -
                                                                                                                                                                              - - - - - -
                                                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                              - - - - -
                                                                                                                                                                              - - - - -
                                                                                                                                                                              - -

                                                                                                                                                                              - - inner getURLParam(param) → {string} - - - - -

                                                                                                                                                                              - - - -
                                                                                                                                                                              -
                                                                                                                                                                              - - -
                                                                                                                                                                              -

                                                                                                                                                                              Retrieves a parameter from the URL query string.

                                                                                                                                                                              -
                                                                                                                                                                              - - - - - - - - - -
                                                                                                                                                                              -
                                                                                                                                                                              Parameters:
                                                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                              NameTypeDescription
                                                                                                                                                                              param - - -string - - - -

                                                                                                                                                                              The name of the parameter to retrieve.

                                                                                                                                                                              - -
                                                                                                                                                                              - - - - - - - - - - - - - -
                                                                                                                                                                              -
                                                                                                                                                                              Returns:
                                                                                                                                                                              - - - - - -string - - - - - --

                                                                                                                                                                              The value of the parameter, or an empty string if not found.

                                                                                                                                                                              - - - - - -
                                                                                                                                                                              - - - - - -
                                                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                              - - - - -
                                                                                                                                                                              - - - - -
                                                                                                                                                                              - -

                                                                                                                                                                              - - inner isTouchDevice() → {boolean} - - - - -

                                                                                                                                                                              - - - -
                                                                                                                                                                              -
                                                                                                                                                                              - - -
                                                                                                                                                                              -

                                                                                                                                                                              Checks if the device is a touch-enabled device.

                                                                                                                                                                              -
                                                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                              -
                                                                                                                                                                              Returns:
                                                                                                                                                                              - - - - - -boolean - - - - - --

                                                                                                                                                                              True if the device is touch-enabled, otherwise false.

                                                                                                                                                                              - - - - - -
                                                                                                                                                                              - - - - - -
                                                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                              - - - - -
                                                                                                                                                                              - - - - -
                                                                                                                                                                              - -

                                                                                                                                                                              - - inner isTouchDevice() → {boolean} - - - - -

                                                                                                                                                                              - - - -
                                                                                                                                                                              -
                                                                                                                                                                              - - -
                                                                                                                                                                              -

                                                                                                                                                                              Checks if the device is a touch-enabled device.

                                                                                                                                                                              -
                                                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                              -
                                                                                                                                                                              Returns:
                                                                                                                                                                              - - - - - -boolean - - - - - --

                                                                                                                                                                              True if the device is touch-enabled, otherwise false.

                                                                                                                                                                              - - - - - -
                                                                                                                                                                              - - - - - -
                                                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                              - - - - -
                                                                                                                                                                              - - - - -
                                                                                                                                                                              - - - - - -
                                                                                                                                                                              -
                                                                                                                                                                              - - -
                                                                                                                                                                              -

                                                                                                                                                                              Creates a link to open a specific portal in Ingress Prime.

                                                                                                                                                                              -
                                                                                                                                                                              - - - - - - - - - -
                                                                                                                                                                              -
                                                                                                                                                                              Parameters:
                                                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                              NameTypeDescription
                                                                                                                                                                              guid - - -string - - - -

                                                                                                                                                                              The globally unique identifier of the portal.

                                                                                                                                                                              lat - - -number - - - -

                                                                                                                                                                              The latitude of the portal.

                                                                                                                                                                              lng - - -number - - - -

                                                                                                                                                                              The longitude of the portal.

                                                                                                                                                                              - -
                                                                                                                                                                              - - - - - - - - - - - - - -
                                                                                                                                                                              -
                                                                                                                                                                              Returns:
                                                                                                                                                                              - - - - - -string - - - - - --

                                                                                                                                                                              The Ingress Prime link for the portal

                                                                                                                                                                              - - - - - -
                                                                                                                                                                              - - - - - -
                                                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                              - - - - -
                                                                                                                                                                              - - - - -
                                                                                                                                                                              - - - - - -
                                                                                                                                                                              -
                                                                                                                                                                              - - -
                                                                                                                                                                              -

                                                                                                                                                                              Creates a link to open a specific portal in Ingress Prime.

                                                                                                                                                                              -
                                                                                                                                                                              - - - - - - - - - -
                                                                                                                                                                              -
                                                                                                                                                                              Parameters:
                                                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                              NameTypeDescription
                                                                                                                                                                              guid - - -string - - - -

                                                                                                                                                                              The globally unique identifier of the portal.

                                                                                                                                                                              lat - - -number - - - -

                                                                                                                                                                              The latitude of the portal.

                                                                                                                                                                              lng - - -number - - - -

                                                                                                                                                                              The longitude of the portal.

                                                                                                                                                                              - -
                                                                                                                                                                              - - - - - - - - - - - - - -
                                                                                                                                                                              -
                                                                                                                                                                              Returns:
                                                                                                                                                                              - - - - - -string - - - - - --

                                                                                                                                                                              The Ingress Prime link for the portal

                                                                                                                                                                              - - - - - -
                                                                                                                                                                              - - - - - -
                                                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                              - - - - -
                                                                                                                                                                              - - - - -
                                                                                                                                                                              - -

                                                                                                                                                                              - - inner prettyEnergy(nrg) → {string} - - - - -

                                                                                                                                                                              - - - -
                                                                                                                                                                              -
                                                                                                                                                                              - - -
                                                                                                                                                                              -

                                                                                                                                                                              Formats energy of portal.

                                                                                                                                                                              -
                                                                                                                                                                              - - - - - - - - - -
                                                                                                                                                                              -
                                                                                                                                                                              Parameters:
                                                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                              NameTypeDescription
                                                                                                                                                                              nrg - - -number - - - -

                                                                                                                                                                              The energy value to format.

                                                                                                                                                                              - -
                                                                                                                                                                              - - - - - - - - - - - - - -
                                                                                                                                                                              -
                                                                                                                                                                              Returns:
                                                                                                                                                                              - - - - - -string - - - - - --

                                                                                                                                                                              The formatted energy value.

                                                                                                                                                                              - - - - - -
                                                                                                                                                                              - - - - - -
                                                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                              - - - - -
                                                                                                                                                                              - - - - -
                                                                                                                                                                              - -

                                                                                                                                                                              - - inner prettyEnergy(nrg) → {string} - - - - -

                                                                                                                                                                              - - - -
                                                                                                                                                                              -
                                                                                                                                                                              - - -
                                                                                                                                                                              -

                                                                                                                                                                              Formats energy of portal.

                                                                                                                                                                              -
                                                                                                                                                                              - - - - - - - - - -
                                                                                                                                                                              -
                                                                                                                                                                              Parameters:
                                                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                              NameTypeDescription
                                                                                                                                                                              nrg - - -number - - - -

                                                                                                                                                                              The energy value to format.

                                                                                                                                                                              - -
                                                                                                                                                                              - - - - - - - - - - - - - -
                                                                                                                                                                              -
                                                                                                                                                                              Returns:
                                                                                                                                                                              - - - - - -string - - - - - --

                                                                                                                                                                              The formatted energy value.

                                                                                                                                                                              - - - - - -
                                                                                                                                                                              - - - - - -
                                                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                              - - - - -
                                                                                                                                                                              - - - - -
                                                                                                                                                                              - -

                                                                                                                                                                              - - inner rangeLinkClick() - - - - -

                                                                                                                                                                              - - - -
                                                                                                                                                                              -
                                                                                                                                                                              - - -
                                                                                                                                                                              -

                                                                                                                                                                              Changes the coordinates and map scale to show the range for portal links.

                                                                                                                                                                              -
                                                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                              - - - - -
                                                                                                                                                                              - - - - -
                                                                                                                                                                              - -

                                                                                                                                                                              - - inner rangeLinkClick() - - - - -

                                                                                                                                                                              - - - -
                                                                                                                                                                              -
                                                                                                                                                                              - - -
                                                                                                                                                                              -

                                                                                                                                                                              Changes the coordinates and map scale to show the range for portal links.

                                                                                                                                                                              -
                                                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                              - - - - -
                                                                                                                                                                              - - - - -
                                                                                                                                                                              - -

                                                                                                                                                                              - - inner readCookie(name) → {string} - - - - -

                                                                                                                                                                              - - - -
                                                                                                                                                                              -
                                                                                                                                                                              - - -
                                                                                                                                                                              -

                                                                                                                                                                              Reads a cookie by name.

                                                                                                                                                                              -
                                                                                                                                                                              - - - - - - - - - -
                                                                                                                                                                              -
                                                                                                                                                                              Parameters:
                                                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                              NameTypeDescription
                                                                                                                                                                              name - - -string - - - -

                                                                                                                                                                              The name of the cookie to read.

                                                                                                                                                                              - -
                                                                                                                                                                              - - - - - - - - - - - - - -
                                                                                                                                                                              -
                                                                                                                                                                              Returns:
                                                                                                                                                                              - - - - - -string - - - - - --

                                                                                                                                                                              The value of the cookie, or undefined if not found.

                                                                                                                                                                              - - - - - -
                                                                                                                                                                              - - - - - -
                                                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                              See:
                                                                                                                                                                              -
                                                                                                                                                                              - -
                                                                                                                                                                              - - - -
                                                                                                                                                                              - - - - -
                                                                                                                                                                              - - - - -
                                                                                                                                                                              - -

                                                                                                                                                                              - - inner readCookie(name) → {string} - - - - -

                                                                                                                                                                              - - - -
                                                                                                                                                                              -
                                                                                                                                                                              - - -
                                                                                                                                                                              -

                                                                                                                                                                              Reads a cookie by name.

                                                                                                                                                                              -
                                                                                                                                                                              - - - - - - - - - -
                                                                                                                                                                              -
                                                                                                                                                                              Parameters:
                                                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                              NameTypeDescription
                                                                                                                                                                              name - - -string - - - -

                                                                                                                                                                              The name of the cookie to read.

                                                                                                                                                                              - -
                                                                                                                                                                              - - - - - - - - - - - - - -
                                                                                                                                                                              -
                                                                                                                                                                              Returns:
                                                                                                                                                                              - - - - - -string - - - - - --

                                                                                                                                                                              The value of the cookie, or undefined if not found.

                                                                                                                                                                              - - - - - -
                                                                                                                                                                              - - - - - -
                                                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                              See:
                                                                                                                                                                              -
                                                                                                                                                                              - -
                                                                                                                                                                              - - - -
                                                                                                                                                                              - - - - -
                                                                                                                                                                              - - - - -
                                                                                                                                                                              - -

                                                                                                                                                                              - - inner scrollBottom(elm) → {number} - - - - -

                                                                                                                                                                              - - - -
                                                                                                                                                                              -
                                                                                                                                                                              - - -
                                                                                                                                                                              -

                                                                                                                                                                              Calculates the number of pixels left to scroll down before reaching the bottom of an element.

                                                                                                                                                                              -
                                                                                                                                                                              - - - - - - - - - -
                                                                                                                                                                              -
                                                                                                                                                                              Parameters:
                                                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                              NameTypeDescription
                                                                                                                                                                              elm - - -string -| - -jQuery - - - -

                                                                                                                                                                              The element to calculate the scroll bottom for.

                                                                                                                                                                              - -
                                                                                                                                                                              - - - - - - - - - - - - - -
                                                                                                                                                                              -
                                                                                                                                                                              Returns:
                                                                                                                                                                              - - - - - -number - - - - - --

                                                                                                                                                                              The number of pixels from the bottom.

                                                                                                                                                                              - - - - - -
                                                                                                                                                                              - - - - - -
                                                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                              - - - - -
                                                                                                                                                                              - - - - -
                                                                                                                                                                              - -

                                                                                                                                                                              - - inner scrollBottom(elm) → {number} - - - - -

                                                                                                                                                                              - - - -
                                                                                                                                                                              -
                                                                                                                                                                              - - -
                                                                                                                                                                              -

                                                                                                                                                                              Calculates the number of pixels left to scroll down before reaching the bottom of an element.

                                                                                                                                                                              -
                                                                                                                                                                              - - - - - - - - - -
                                                                                                                                                                              -
                                                                                                                                                                              Parameters:
                                                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                              NameTypeDescription
                                                                                                                                                                              elm - - -string -| - -jQuery - - - -

                                                                                                                                                                              The element to calculate the scroll bottom for.

                                                                                                                                                                              - -
                                                                                                                                                                              - - - - - - - - - - - - - -
                                                                                                                                                                              -
                                                                                                                                                                              Returns:
                                                                                                                                                                              - - - - - -number - - - - - --

                                                                                                                                                                              The number of pixels from the bottom.

                                                                                                                                                                              - - - - - -
                                                                                                                                                                              - - - - - -
                                                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                              - - - - -
                                                                                                                                                                              - - - - -
                                                                                                                                                                              - -

                                                                                                                                                                              - - inner selectPortalByLatLng(lat, lngopt) - - - - -

                                                                                                                                                                              - - - -
                                                                                                                                                                              -
                                                                                                                                                                              - - -
                                                                                                                                                                              -

                                                                                                                                                                              Selects a portal by its latitude and longitude.

                                                                                                                                                                              -
                                                                                                                                                                              - - - - - - - - - -
                                                                                                                                                                              -
                                                                                                                                                                              Parameters:
                                                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                              NameTypeAttributesDescription
                                                                                                                                                                              lat - - -number -| - -Array -| - -L.LatLng - - - - - - - - - -

                                                                                                                                                                              The latitude of the portal -or an array or L.LatLng object containing both latitude and longitude.

                                                                                                                                                                              lng - - -number - - - - - - <optional>
                                                                                                                                                                              - - - - - -

                                                                                                                                                                              The longitude of the portal.

                                                                                                                                                                              - -
                                                                                                                                                                              - - - - - - - - - - - - - - - - - -
                                                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                              - - - - -
                                                                                                                                                                              - - - - -
                                                                                                                                                                              - -

                                                                                                                                                                              - - inner selectPortalByLatLng(lat, lngopt) - - - - -

                                                                                                                                                                              - - - -
                                                                                                                                                                              -
                                                                                                                                                                              - - -
                                                                                                                                                                              -

                                                                                                                                                                              Selects a portal by its latitude and longitude.

                                                                                                                                                                              -
                                                                                                                                                                              - - - - - - - - - -
                                                                                                                                                                              -
                                                                                                                                                                              Parameters:
                                                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                              NameTypeAttributesDescription
                                                                                                                                                                              lat - - -number -| - -Array -| - -L.LatLng - - - - - - - - - -

                                                                                                                                                                              The latitude of the portal -or an array or L.LatLng object containing both latitude and longitude.

                                                                                                                                                                              lng - - -number - - - - - - <optional>
                                                                                                                                                                              - - - - - -

                                                                                                                                                                              The longitude of the portal.

                                                                                                                                                                              - -
                                                                                                                                                                              - - - - - - - - - - - - - - - - - -
                                                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                              - - - - -
                                                                                                                                                                              - - - - -
                                                                                                                                                                              - - - - - -
                                                                                                                                                                              -
                                                                                                                                                                              - - -
                                                                                                                                                                              -

                                                                                                                                                                              Displays a dialog with links to show the specified location on various map services.

                                                                                                                                                                              -
                                                                                                                                                                              - - - - - - - - - -
                                                                                                                                                                              -
                                                                                                                                                                              Parameters:
                                                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                              NameTypeDescription
                                                                                                                                                                              lat - - -number - - - -

                                                                                                                                                                              Latitude of the location.

                                                                                                                                                                              lng - - -number - - - -

                                                                                                                                                                              Longitude of the location.

                                                                                                                                                                              name - - -string - - - -

                                                                                                                                                                              Name of the location.

                                                                                                                                                                              - -
                                                                                                                                                                              - - - - - - - - - - - - - - - - - -
                                                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                              - - - - -
                                                                                                                                                                              - - - - -
                                                                                                                                                                              - - - - - -
                                                                                                                                                                              -
                                                                                                                                                                              - - -
                                                                                                                                                                              -

                                                                                                                                                                              Displays a dialog with links to show the specified location on various map services.

                                                                                                                                                                              -
                                                                                                                                                                              - - - - - - - - - -
                                                                                                                                                                              -
                                                                                                                                                                              Parameters:
                                                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                              NameTypeDescription
                                                                                                                                                                              lat - - -number - - - -

                                                                                                                                                                              Latitude of the location.

                                                                                                                                                                              lng - - -number - - - -

                                                                                                                                                                              Longitude of the location.

                                                                                                                                                                              name - - -string - - - -

                                                                                                                                                                              Name of the location.

                                                                                                                                                                              - -
                                                                                                                                                                              - - - - - - - - - - - - - - - - - -
                                                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                              - - - - -
                                                                                                                                                                              - - - - -
                                                                                                                                                                              - -

                                                                                                                                                                              - - inner uniqueArray(arr) → {Array} - - - - -

                                                                                                                                                                              - - - -
                                                                                                                                                                              -
                                                                                                                                                                              - - -
                                                                                                                                                                              -

                                                                                                                                                                              Converts a list of items into a unique array, removing duplicates.

                                                                                                                                                                              -
                                                                                                                                                                              - - - - - - - - - -
                                                                                                                                                                              -
                                                                                                                                                                              Parameters:
                                                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                              NameTypeDescription
                                                                                                                                                                              arr - - -Array - - - -

                                                                                                                                                                              The array to process.

                                                                                                                                                                              - -
                                                                                                                                                                              - - - - - - - - - - - - - -
                                                                                                                                                                              -
                                                                                                                                                                              Returns:
                                                                                                                                                                              - - - - - -Array - - - - - --

                                                                                                                                                                              A new array containing only unique elements.

                                                                                                                                                                              - - - - - -
                                                                                                                                                                              - - - - - -
                                                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                              - - - - -
                                                                                                                                                                              - - - - -
                                                                                                                                                                              - -

                                                                                                                                                                              - - inner uniqueArray(arr) → {Array} - - - - -

                                                                                                                                                                              - - - -
                                                                                                                                                                              -
                                                                                                                                                                              - - -
                                                                                                                                                                              -

                                                                                                                                                                              Converts a list of items into a unique array, removing duplicates.

                                                                                                                                                                              -
                                                                                                                                                                              - - - - - - - - - -
                                                                                                                                                                              -
                                                                                                                                                                              Parameters:
                                                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                              NameTypeDescription
                                                                                                                                                                              arr - - -Array - - - -

                                                                                                                                                                              The array to process.

                                                                                                                                                                              - -
                                                                                                                                                                              - - - - - - - - - - - - - -
                                                                                                                                                                              -
                                                                                                                                                                              Returns:
                                                                                                                                                                              - - - - - -Array - - - - - --

                                                                                                                                                                              A new array containing only unique elements.

                                                                                                                                                                              - - - - - -
                                                                                                                                                                              - - - - - -
                                                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                              - - - - -
                                                                                                                                                                              - - - - -
                                                                                                                                                                              - -

                                                                                                                                                                              - - inner unixTimeToDateTimeString(time, millisecondopt) → {string|null} - - - - -

                                                                                                                                                                              - - - -
                                                                                                                                                                              -
                                                                                                                                                                              - - -
                                                                                                                                                                              -

                                                                                                                                                                              Converts a UNIX timestamp to a precise date and time string in the local timezone. -Formatted in ISO-style YYYY-MM-DD hh:mm:ss.mmm - but using local timezone

                                                                                                                                                                              -
                                                                                                                                                                              - - - - - - - - - -
                                                                                                                                                                              -
                                                                                                                                                                              Parameters:
                                                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                              NameTypeAttributesDescription
                                                                                                                                                                              time - - -number - - - - - - - - - -

                                                                                                                                                                              The UNIX timestamp to convert.

                                                                                                                                                                              millisecond - - -boolean - - - - - - <optional>
                                                                                                                                                                              - - - - - -

                                                                                                                                                                              Whether to include millisecond precision.

                                                                                                                                                                              - -
                                                                                                                                                                              - - - - - - - - - - - - - -
                                                                                                                                                                              -
                                                                                                                                                                              Returns:
                                                                                                                                                                              - - - - - -string -| - -null - - - - - --

                                                                                                                                                                              The formatted date and time string.

                                                                                                                                                                              - - - - - -
                                                                                                                                                                              - - - - - -
                                                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                              - - - - -
                                                                                                                                                                              - - - - -
                                                                                                                                                                              - -

                                                                                                                                                                              - - inner unixTimeToDateTimeString(time, millisecondopt) → {string|null} - - - - -

                                                                                                                                                                              - - - -
                                                                                                                                                                              -
                                                                                                                                                                              - - -
                                                                                                                                                                              -

                                                                                                                                                                              Converts a UNIX timestamp to a precise date and time string in the local timezone. -Formatted in ISO-style YYYY-MM-DD hh:mm:ss.mmm - but using local timezone

                                                                                                                                                                              -
                                                                                                                                                                              - - - - - - - - - -
                                                                                                                                                                              -
                                                                                                                                                                              Parameters:
                                                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                              NameTypeAttributesDescription
                                                                                                                                                                              time - - -number - - - - - - - - - -

                                                                                                                                                                              The UNIX timestamp to convert.

                                                                                                                                                                              millisecond - - -boolean - - - - - - <optional>
                                                                                                                                                                              - - - - - -

                                                                                                                                                                              Whether to include millisecond precision.

                                                                                                                                                                              - -
                                                                                                                                                                              - - - - - - - - - - - - - -
                                                                                                                                                                              -
                                                                                                                                                                              Returns:
                                                                                                                                                                              - - - - - -string -| - -null - - - - - --

                                                                                                                                                                              The formatted date and time string.

                                                                                                                                                                              - - - - - -
                                                                                                                                                                              - - - - - -
                                                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                              - - - - -
                                                                                                                                                                              - - - - -
                                                                                                                                                                              - -

                                                                                                                                                                              - - inner unixTimeToHHmm(time) → {string|null} - - - - -

                                                                                                                                                                              - - - -
                                                                                                                                                                              -
                                                                                                                                                                              - - -
                                                                                                                                                                              -

                                                                                                                                                                              Converts a UNIX timestamp to a time string formatted as HH:mm.

                                                                                                                                                                              -
                                                                                                                                                                              - - - - - - - - - -
                                                                                                                                                                              -
                                                                                                                                                                              Parameters:
                                                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                              NameTypeDescription
                                                                                                                                                                              time - - -number -| - -string - - - -

                                                                                                                                                                              The UNIX timestamp to convert.

                                                                                                                                                                              - -
                                                                                                                                                                              - - - - - - - - - - - - - -
                                                                                                                                                                              -
                                                                                                                                                                              Returns:
                                                                                                                                                                              - - - - - -string -| - -null - - - - - --

                                                                                                                                                                              Formatted time as HH:mm.

                                                                                                                                                                              - - - - - -
                                                                                                                                                                              - - - - - -
                                                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                              - - - - -
                                                                                                                                                                              - - - - -
                                                                                                                                                                              - -

                                                                                                                                                                              - - inner unixTimeToHHmm(time) → {string|null} - - - - -

                                                                                                                                                                              - - - -
                                                                                                                                                                              -
                                                                                                                                                                              - - -
                                                                                                                                                                              -

                                                                                                                                                                              Converts a UNIX timestamp to a time string formatted as HH:mm.

                                                                                                                                                                              -
                                                                                                                                                                              - - - - - - - - - -
                                                                                                                                                                              -
                                                                                                                                                                              Parameters:
                                                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                              NameTypeDescription
                                                                                                                                                                              time - - -number -| - -string - - - -

                                                                                                                                                                              The UNIX timestamp to convert.

                                                                                                                                                                              - -
                                                                                                                                                                              - - - - - - - - - - - - - -
                                                                                                                                                                              -
                                                                                                                                                                              Returns:
                                                                                                                                                                              - - - - - -string -| - -null - - - - - --

                                                                                                                                                                              Formatted time as HH:mm.

                                                                                                                                                                              - - - - - -
                                                                                                                                                                              - - - - - -
                                                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                              - - - - -
                                                                                                                                                                              - - - - -
                                                                                                                                                                              - -

                                                                                                                                                                              - - inner unixTimeToString(time, fullopt) → {string|null} - - - - -

                                                                                                                                                                              - - - -
                                                                                                                                                                              -
                                                                                                                                                                              - - -
                                                                                                                                                                              -

                                                                                                                                                                              Converts a UNIX timestamp to a human-readable string. -If the timestamp is from today, returns the time (HH:mm:ss format); otherwise, returns the date (YYYY-MM-DD).

                                                                                                                                                                              -
                                                                                                                                                                              - - - - - - - - - -
                                                                                                                                                                              -
                                                                                                                                                                              Parameters:
                                                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + @@ -16551,30 +3219,6 @@
                                                                                                                                                                              Parameters:
                                                                                                                                                                              -
                                                                                                                                                                              -
                                                                                                                                                                              Returns:
                                                                                                                                                                              - - - - - -string -| - -null - - - - - --

                                                                                                                                                                              The formatted date and/or time.

                                                                                                                                                                              - - - - - -
                                                                                                                                                                              - @@ -16622,14 +3266,14 @@
                                                                                                                                                                              Returns:
                                                                                                                                                                              -

                                                                                                                                                                              +

                                                                                                                                                                              - inner unixTimeToString(time, fullopt) → {string|null} + inner uniqueArray(arr) → {Array}

                                                                                                                                                                              @@ -16641,8 +3285,7 @@

                                                                                                                                                                              -

                                                                                                                                                                              Converts a UNIX timestamp to a human-readable string. -If the timestamp is from today, returns the time (HH:mm:ss format); otherwise, returns the date (YYYY-MM-DD).

                                                                                                                                                                              +

                                                                                                                                                                              Converts a list of items into a unique array, removing duplicates.

                                                                                                                                                                              @@ -16666,8 +3309,6 @@

                                                                                                                                                                              Parameters:
                                                                                                                                                                              - - @@ -16680,64 +3321,23 @@
                                                                                                                                                                              Parameters:
                                                                                                                                                                              - - - - - - - - - - - - - - - - - - - + - - - + @@ -16764,17 +3364,14 @@
                                                                                                                                                                              Returns:
                                                                                                                                                                              - -string -| - -null + +Array --

                                                                                                                                                                              The formatted date and/or time.

                                                                                                                                                                              +-

                                                                                                                                                                              A new array containing only unique elements.

                                                                                                                                                                              @@ -16829,14 +3426,14 @@
                                                                                                                                                                              Returns:
                                                                                                                                                                              -

                                                                                                                                                                              +

                                                                                                                                                                              - inner writeCookie(name, val) + inner unixTimeToDateTimeString(time, millisecondopt) → {string|null}

                                                                                                                                                                              @@ -16848,7 +3445,8 @@

                                                                                                                                                                              -

                                                                                                                                                                              Writes a cookie with a specified name and value.

                                                                                                                                                                              +

                                                                                                                                                                              Converts a UNIX timestamp to a precise date and time string in the local timezone. +Formatted in ISO-style YYYY-MM-DD hh:mm:ss.mmm - but using local timezone

                                                                                                                                                                              @@ -16872,6 +3470,8 @@

                                                                                                                                                                              Parameters:
                                                                                                                                                                              + + @@ -16884,46 +3484,64 @@
                                                                                                                                                                              Parameters:
                                                                                                                                                                              - + + + - + - + + + - + @@ -16944,6 +3562,30 @@
                                                                                                                                                                              Parameters:
                                                                                                                                                                              +
                                                                                                                                                                              +
                                                                                                                                                                              Returns:
                                                                                                                                                                              + + + + + +string +| + +null + + + + + +-

                                                                                                                                                                              The formatted date and time string.

                                                                                                                                                                              + + + + + +
                                                                                                                                                                              + @@ -16991,14 +3633,14 @@
                                                                                                                                                                              Parameters:
                                                                                                                                                                              -

                                                                                                                                                                              +

                                                                                                                                                                              - inner writeCookie(name, val) + inner unixTimeToHHmm(time) → {string|null}

                                                                                                                                                                              @@ -17010,7 +3652,7 @@

                                                                                                                                                                              -

                                                                                                                                                                              Writes a cookie with a specified name and value.

                                                                                                                                                                              +

                                                                                                                                                                              Converts a UNIX timestamp to a time string formatted as HH:mm.

                                                                                                                                                                              @@ -17046,35 +3688,15 @@

                                                                                                                                                                              Parameters:
                                                                                                                                                                              - + - - - - - - - - - - - - - - +number +| - + @@ -17106,6 +3728,30 @@
                                                                                                                                                                              Parameters:
                                                                                                                                                                              +
                                                                                                                                                                              +
                                                                                                                                                                              Returns:
                                                                                                                                                                              + + + + + +string +| + +null + + + + + +-

                                                                                                                                                                              Formatted time as HH:mm.

                                                                                                                                                                              + + + + + +
                                                                                                                                                                              + @@ -17153,14 +3799,14 @@
                                                                                                                                                                              Parameters:
                                                                                                                                                                              -

                                                                                                                                                                              +

                                                                                                                                                                              - inner zeroPad(number, pad) → {string} + inner unixTimeToString(time, fullopt) → {string|null}

                                                                                                                                                                              @@ -17172,7 +3818,8 @@

                                                                                                                                                                              -

                                                                                                                                                                              Pads a number with zeros up to a specified length.

                                                                                                                                                                              +

                                                                                                                                                                              Converts a UNIX timestamp to a human-readable string. +If the timestamp is from today, returns the time (HH:mm:ss format); otherwise, returns the date (YYYY-MM-DD).

                                                                                                                                                                              @@ -17196,6 +3843,8 @@

                                                                                                                                                                              Parameters:
                                                                                                                                                                              + + @@ -17208,7 +3857,7 @@
                                                                                                                                                                              Parameters:
                                                                                                                                                                              - + + + - + - + + + - + @@ -17276,12 +3943,15 @@
                                                                                                                                                                              Returns:
                                                                                                                                                                              string +| +null --

                                                                                                                                                                              The padded number as a string.

                                                                                                                                                                              + +-

                                                                                                                                                                              The formatted date and/or time.

                                                                                                                                                                              @@ -17336,14 +4006,14 @@
                                                                                                                                                                              Returns:
                                                                                                                                                                              -

                                                                                                                                                                              +

                                                                                                                                                                              - inner zeroPad(number, pad) → {string} + inner writeCookie(name, val)

                                                                                                                                                                              @@ -17355,7 +4025,7 @@

                                                                                                                                                                              -

                                                                                                                                                                              Pads a number with zeros up to a specified length.

                                                                                                                                                                              +

                                                                                                                                                                              Writes a cookie with a specified name and value.

                                                                                                                                                                              @@ -17391,13 +4061,13 @@

                                                                                                                                                                              Parameters:
                                                                                                                                                                              - + + - + + @@ -17451,27 +4121,6 @@
                                                                                                                                                                              Parameters:
                                                                                                                                                                              -
                                                                                                                                                                              -
                                                                                                                                                                              Returns:
                                                                                                                                                                              - - - - - -string - - - - - --

                                                                                                                                                                              The padded number as a string.

                                                                                                                                                                              - - - - - -
                                                                                                                                                                              - @@ -17519,14 +4168,14 @@
                                                                                                                                                                              Returns:
                                                                                                                                                                              -

                                                                                                                                                                              +

                                                                                                                                                                              - inner zoomToAndShowPortal(guid, latlng) + inner zeroPad(number, pad) → {string}

                                                                                                                                                                              @@ -17538,7 +4187,7 @@

                                                                                                                                                                              -

                                                                                                                                                                              Zooms the map to a specific portal and shows its details if available.

                                                                                                                                                                              +

                                                                                                                                                                              Pads a number with zeros up to a specified length.

                                                                                                                                                                              @@ -17574,13 +4223,13 @@

                                                                                                                                                                              Parameters:
                                                                                                                                                                              - + + - + + @@ -17634,6 +4283,27 @@
                                                                                                                                                                              Parameters:
                                                                                                                                                                              +
                                                                                                                                                                              +
                                                                                                                                                                              Returns:
                                                                                                                                                                              + + + + + +string + + + + + +-

                                                                                                                                                                              The padded number as a string.

                                                                                                                                                                              + + + + + +
                                                                                                                                                                              + diff --git a/other_constants.html b/other_constants.html index e914b4039..c8579e281 100644 --- a/other_constants.html +++ b/other_constants.html @@ -34,7 +34,7 @@

                                                                                                                                                                              IITC-CE

                                                                                                                                                                                - +
                                                                                                                                                                                @@ -197,3554 +197,12 @@
                                                                                                                                                                                Type:
                                                                                                                                                                                -

                                                                                                                                                                                - static, constant window.TEAM_CODE_ENL :string - - - -

                                                                                                                                                                                - - -
                                                                                                                                                                                -
                                                                                                                                                                                - - - - - - - -
                                                                                                                                                                                - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                - - - - - -
                                                                                                                                                                                - - - - -
                                                                                                                                                                                -

                                                                                                                                                                                - static, constant window.TEAM_CODE_MAC :string - - - -

                                                                                                                                                                                - - -
                                                                                                                                                                                -
                                                                                                                                                                                - - - - - - - -
                                                                                                                                                                                - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                - - - - - -
                                                                                                                                                                                - - - - -
                                                                                                                                                                                -

                                                                                                                                                                                - static, constant window.TEAM_CODE_MAC :string - - - -

                                                                                                                                                                                - - -
                                                                                                                                                                                -
                                                                                                                                                                                - - - - - - - -
                                                                                                                                                                                - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                - - - - - -
                                                                                                                                                                                - - - - -
                                                                                                                                                                                -

                                                                                                                                                                                - static, constant window.TEAM_CODE_NONE :string - - - -

                                                                                                                                                                                - - -
                                                                                                                                                                                -
                                                                                                                                                                                - - - - - - - -
                                                                                                                                                                                - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                - - - - - -
                                                                                                                                                                                - - - - -
                                                                                                                                                                                -

                                                                                                                                                                                - static, constant window.TEAM_CODE_NONE :string - - - -

                                                                                                                                                                                - - -
                                                                                                                                                                                -
                                                                                                                                                                                - - - - - - - -
                                                                                                                                                                                - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                - - - - - -
                                                                                                                                                                                - - - - -
                                                                                                                                                                                -

                                                                                                                                                                                - static, constant window.TEAM_CODE_RES :string - - - -

                                                                                                                                                                                - - -
                                                                                                                                                                                -
                                                                                                                                                                                - - - - - - - -
                                                                                                                                                                                - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                - - - - - -
                                                                                                                                                                                - - - - -
                                                                                                                                                                                -

                                                                                                                                                                                - static, constant window.TEAM_CODE_RES :string - - - -

                                                                                                                                                                                - - -
                                                                                                                                                                                -
                                                                                                                                                                                - - - - - - - -
                                                                                                                                                                                - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                - - - - - -
                                                                                                                                                                                - - - - -
                                                                                                                                                                                -

                                                                                                                                                                                - static, constant window.TEAM_CODENAMES :Array.<string> - - - -

                                                                                                                                                                                - - -
                                                                                                                                                                                -
                                                                                                                                                                                - - - - - - - -
                                                                                                                                                                                - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                - - - - - -
                                                                                                                                                                                - - - - -
                                                                                                                                                                                -

                                                                                                                                                                                - static, constant window.TEAM_CODENAMES :Array.<string> - - - -

                                                                                                                                                                                - - -
                                                                                                                                                                                -
                                                                                                                                                                                - - - - - - - -
                                                                                                                                                                                - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                - - - - - -
                                                                                                                                                                                - - - - -
                                                                                                                                                                                -

                                                                                                                                                                                - static, constant window.TEAM_CODES :Array.<string> - - - -

                                                                                                                                                                                - - -
                                                                                                                                                                                -
                                                                                                                                                                                - - - - - - - -
                                                                                                                                                                                - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                - - - - - -
                                                                                                                                                                                - - - - -
                                                                                                                                                                                -

                                                                                                                                                                                - static, constant window.TEAM_CODES :Array.<string> - - - -

                                                                                                                                                                                - - -
                                                                                                                                                                                -
                                                                                                                                                                                - - - - - - - -
                                                                                                                                                                                - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                - - - - - -
                                                                                                                                                                                - - - - -
                                                                                                                                                                                -

                                                                                                                                                                                - static, constant window.TEAM_ENL :number - - - -

                                                                                                                                                                                - - -
                                                                                                                                                                                -
                                                                                                                                                                                - - - - - - - -
                                                                                                                                                                                - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                - - - - - -
                                                                                                                                                                                - - - - -
                                                                                                                                                                                -

                                                                                                                                                                                - static, constant window.TEAM_ENL :number - - - -

                                                                                                                                                                                - - -
                                                                                                                                                                                -
                                                                                                                                                                                - - - - - - - -
                                                                                                                                                                                - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                - - - - - -
                                                                                                                                                                                - - - - -
                                                                                                                                                                                -

                                                                                                                                                                                - static, constant window.TEAM_MAC :number - - - -

                                                                                                                                                                                - - -
                                                                                                                                                                                -
                                                                                                                                                                                - - - - - - - -
                                                                                                                                                                                - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                - - - - - -
                                                                                                                                                                                - - - - -
                                                                                                                                                                                -

                                                                                                                                                                                - static, constant window.TEAM_MAC :number - - - -

                                                                                                                                                                                - - -
                                                                                                                                                                                -
                                                                                                                                                                                - - - - - - - -
                                                                                                                                                                                - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                - - - - - -
                                                                                                                                                                                - - - - -
                                                                                                                                                                                -

                                                                                                                                                                                - static, constant window.TEAM_NAME_ENL :string - - - -

                                                                                                                                                                                - - -
                                                                                                                                                                                -
                                                                                                                                                                                - - - - - - - -
                                                                                                                                                                                - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                - - - - - -
                                                                                                                                                                                - - - - -
                                                                                                                                                                                -

                                                                                                                                                                                - static, constant window.TEAM_NAME_ENL :string - - - -

                                                                                                                                                                                - - -
                                                                                                                                                                                -
                                                                                                                                                                                - - - - - - - -
                                                                                                                                                                                - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                - - - - - -
                                                                                                                                                                                - - - - -
                                                                                                                                                                                -

                                                                                                                                                                                - static, constant window.TEAM_NAME_MAC :string - - - -

                                                                                                                                                                                - - -
                                                                                                                                                                                -
                                                                                                                                                                                - - - - - - - -
                                                                                                                                                                                - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                - - - - - -
                                                                                                                                                                                - - - - -
                                                                                                                                                                                -

                                                                                                                                                                                - static, constant window.TEAM_NAME_MAC :string - - - -

                                                                                                                                                                                - - -
                                                                                                                                                                                -
                                                                                                                                                                                - - - - - - - -
                                                                                                                                                                                - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                - - - - - -
                                                                                                                                                                                - - - - -
                                                                                                                                                                                -

                                                                                                                                                                                - static, constant window.TEAM_NAME_NONE :string - - - -

                                                                                                                                                                                - - -
                                                                                                                                                                                -
                                                                                                                                                                                - - - - - - - -
                                                                                                                                                                                - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                - - - - - -
                                                                                                                                                                                - - - - -
                                                                                                                                                                                -

                                                                                                                                                                                - static, constant window.TEAM_NAME_NONE :string - - - -

                                                                                                                                                                                - - -
                                                                                                                                                                                -
                                                                                                                                                                                - - - - - - - -
                                                                                                                                                                                - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                - - - - - -
                                                                                                                                                                                - - - - -
                                                                                                                                                                                -

                                                                                                                                                                                - static, constant window.TEAM_NAME_RES :string - - - -

                                                                                                                                                                                - - -
                                                                                                                                                                                -
                                                                                                                                                                                - - - - - - - -
                                                                                                                                                                                - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                - - - - - -
                                                                                                                                                                                - - - - -
                                                                                                                                                                                -

                                                                                                                                                                                - static, constant window.TEAM_NAME_RES :string - - - -

                                                                                                                                                                                - - -
                                                                                                                                                                                -
                                                                                                                                                                                - - - - - - - -
                                                                                                                                                                                - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                - - - - - -
                                                                                                                                                                                - - - - -
                                                                                                                                                                                -

                                                                                                                                                                                - static, constant window.TEAM_NAMES :Array.<string> - - - -

                                                                                                                                                                                - - -
                                                                                                                                                                                -
                                                                                                                                                                                - - - - - - - -
                                                                                                                                                                                - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                - - - - - -
                                                                                                                                                                                - - - - -
                                                                                                                                                                                -

                                                                                                                                                                                - static, constant window.TEAM_NAMES :Array.<string> - - - -

                                                                                                                                                                                - - -
                                                                                                                                                                                -
                                                                                                                                                                                - - - - - - - -
                                                                                                                                                                                - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                - - - - - -
                                                                                                                                                                                - - - - -
                                                                                                                                                                                -

                                                                                                                                                                                - static, constant window.TEAM_NONE :number - - - -

                                                                                                                                                                                - - -
                                                                                                                                                                                -
                                                                                                                                                                                - - - - - - - -
                                                                                                                                                                                - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                - - - - - -
                                                                                                                                                                                - - - - -
                                                                                                                                                                                -

                                                                                                                                                                                - static, constant window.TEAM_NONE :number - - - -

                                                                                                                                                                                - - -
                                                                                                                                                                                -
                                                                                                                                                                                - - - - - - - -
                                                                                                                                                                                - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                - - - - - -
                                                                                                                                                                                - - - - -
                                                                                                                                                                                -

                                                                                                                                                                                - static, constant window.TEAM_RES :number - - - -

                                                                                                                                                                                - - -
                                                                                                                                                                                -
                                                                                                                                                                                - - - - - - - -
                                                                                                                                                                                - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                - - - - - -
                                                                                                                                                                                - - - - -
                                                                                                                                                                                -

                                                                                                                                                                                - static, constant window.TEAM_RES :number - - - -

                                                                                                                                                                                - - -
                                                                                                                                                                                -
                                                                                                                                                                                - - - - - - - -
                                                                                                                                                                                - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                - - - - - -
                                                                                                                                                                                - - - - -
                                                                                                                                                                                -

                                                                                                                                                                                - static, constant window.TEAM_TO_CSS :Array.<string> - - - -

                                                                                                                                                                                - - -
                                                                                                                                                                                -
                                                                                                                                                                                - - - - - - - -
                                                                                                                                                                                - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                - - - - - -
                                                                                                                                                                                - - - - -
                                                                                                                                                                                -

                                                                                                                                                                                - static, constant window.TEAM_TO_CSS :Array.<string> - - - -

                                                                                                                                                                                - - -
                                                                                                                                                                                -
                                                                                                                                                                                - - - - - - - -
                                                                                                                                                                                - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                - - - - - -
                                                                                                                                                                                - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                - -
                                                                                                                                                                                - -

                                                                                                                                                                                other_constants

                                                                                                                                                                                - - -
                                                                                                                                                                                - -
                                                                                                                                                                                - -
                                                                                                                                                                                - - -

                                                                                                                                                                                OTHER MORE-OR-LESS CONSTANTS

                                                                                                                                                                                - - - - - -
                                                                                                                                                                                - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                - - - - -
                                                                                                                                                                                - - - - - - - - - - - - - - - -

                                                                                                                                                                                Members

                                                                                                                                                                                - -
                                                                                                                                                                                - - -
                                                                                                                                                                                -

                                                                                                                                                                                - static, constant window.TEAM_CODE_ENL :string - - - -

                                                                                                                                                                                - - -
                                                                                                                                                                                -
                                                                                                                                                                                - - - - - - - -
                                                                                                                                                                                - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                - - - - - -
                                                                                                                                                                                - - - - -
                                                                                                                                                                                -

                                                                                                                                                                                - static, constant window.TEAM_CODE_ENL :string - - - -

                                                                                                                                                                                - - -
                                                                                                                                                                                -
                                                                                                                                                                                - - - - - - - -
                                                                                                                                                                                - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                - - - - - -
                                                                                                                                                                                - - - - -
                                                                                                                                                                                -

                                                                                                                                                                                - static, constant window.TEAM_CODE_MAC :string - - - -

                                                                                                                                                                                - - -
                                                                                                                                                                                -
                                                                                                                                                                                - - - - - - - -
                                                                                                                                                                                - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                - - - - - -
                                                                                                                                                                                - - - - -
                                                                                                                                                                                -

                                                                                                                                                                                - static, constant window.TEAM_CODE_MAC :string - - - -

                                                                                                                                                                                - - -
                                                                                                                                                                                -
                                                                                                                                                                                - - - - - - - -
                                                                                                                                                                                - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                - - - - - -
                                                                                                                                                                                - - - - -
                                                                                                                                                                                -

                                                                                                                                                                                - static, constant window.TEAM_CODE_NONE :string - - - -

                                                                                                                                                                                - - -
                                                                                                                                                                                -
                                                                                                                                                                                - - - - - - - -
                                                                                                                                                                                - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                - - - - - -
                                                                                                                                                                                - - - - -
                                                                                                                                                                                -

                                                                                                                                                                                - static, constant window.TEAM_CODE_NONE :string - - - -

                                                                                                                                                                                - - -
                                                                                                                                                                                -
                                                                                                                                                                                - - - - - - - -
                                                                                                                                                                                - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                - - - - - -
                                                                                                                                                                                - - - - -
                                                                                                                                                                                -

                                                                                                                                                                                - static, constant window.TEAM_CODE_RES :string - - - -

                                                                                                                                                                                - - -
                                                                                                                                                                                -
                                                                                                                                                                                - - - - - - - -
                                                                                                                                                                                - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                - - - - - -
                                                                                                                                                                                - - - - -
                                                                                                                                                                                -

                                                                                                                                                                                - static, constant window.TEAM_CODE_RES :string - - - -

                                                                                                                                                                                - - -
                                                                                                                                                                                -
                                                                                                                                                                                - - - - - - - -
                                                                                                                                                                                - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                - - - - - -
                                                                                                                                                                                - - - - -
                                                                                                                                                                                -

                                                                                                                                                                                - static, constant window.TEAM_CODENAMES :Array.<string> - - - -

                                                                                                                                                                                - - -
                                                                                                                                                                                -
                                                                                                                                                                                - - - - - - - -
                                                                                                                                                                                - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                - - - - - -
                                                                                                                                                                                - - - - -
                                                                                                                                                                                -

                                                                                                                                                                                - static, constant window.TEAM_CODENAMES :Array.<string> - - - -

                                                                                                                                                                                - - -
                                                                                                                                                                                -
                                                                                                                                                                                - - - - - - - -
                                                                                                                                                                                - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                - - - - - -
                                                                                                                                                                                - - - - -
                                                                                                                                                                                -

                                                                                                                                                                                - static, constant window.TEAM_CODES :Array.<string> - - - -

                                                                                                                                                                                - - -
                                                                                                                                                                                -
                                                                                                                                                                                - - - - - - - -
                                                                                                                                                                                - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                - - - - - -
                                                                                                                                                                                - - - - -
                                                                                                                                                                                -

                                                                                                                                                                                - static, constant window.TEAM_CODES :Array.<string> - - - -

                                                                                                                                                                                - - -
                                                                                                                                                                                -
                                                                                                                                                                                - - - - - - - -
                                                                                                                                                                                - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                - - - - - -
                                                                                                                                                                                - - - - -
                                                                                                                                                                                -

                                                                                                                                                                                - static, constant window.TEAM_ENL :number - - - -

                                                                                                                                                                                - - -
                                                                                                                                                                                -
                                                                                                                                                                                - - - - - - - -
                                                                                                                                                                                - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                - - - - - -
                                                                                                                                                                                - - - - -
                                                                                                                                                                                -

                                                                                                                                                                                - static, constant window.TEAM_ENL :number - - - -

                                                                                                                                                                                - - -
                                                                                                                                                                                -
                                                                                                                                                                                - - - - - - - -
                                                                                                                                                                                - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                - - - - - -
                                                                                                                                                                                - - - - -
                                                                                                                                                                                -

                                                                                                                                                                                - static, constant window.TEAM_MAC :number - - - -

                                                                                                                                                                                - - -
                                                                                                                                                                                -
                                                                                                                                                                                - - - - - - - -
                                                                                                                                                                                - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                - - - - - -
                                                                                                                                                                                - - - - -
                                                                                                                                                                                -

                                                                                                                                                                                - static, constant window.TEAM_MAC :number +

                                                                                                                                                                                + static, constant window.TEAM_CODE_MAC :string

                                                                                                                                                                                @@ -3760,7 +218,7 @@
                                                                                                                                                                                Type:
                                                                                                                                                                                • -number +string
                                                                                                                                                                                • @@ -3814,12 +272,12 @@
                                                                                                                                                                                  Type:
                                                                                                                                                                                  -

                                                                                                                                                                                  - static, constant window.TEAM_NAME_ENL :string +

                                                                                                                                                                                  + static, constant window.TEAM_CODE_NONE :string

                                                                                                                                                                                  @@ -3889,12 +347,12 @@
                                                                                                                                                                                  Type:
                                                                                                                                                                                  -

                                                                                                                                                                                  - static, constant window.TEAM_NAME_ENL :string +

                                                                                                                                                                                  + static, constant window.TEAM_CODE_RES :string

                                                                                                                                                                                  @@ -3964,12 +422,12 @@
                                                                                                                                                                                  Type:
                                                                                                                                                                                  -

                                                                                                                                                                                  - static, constant window.TEAM_NAME_MAC :string +

                                                                                                                                                                                  + static, constant window.TEAM_CODENAMES :Array.<string>

                                                                                                                                                                                  @@ -3985,7 +443,7 @@
                                                                                                                                                                                  Type:
                                                                                                                                                                                  • -string +Array.<string>
                                                                                                                                                                                  • @@ -4039,12 +497,12 @@
                                                                                                                                                                                    Type:
                                                                                                                                                                                    -

                                                                                                                                                                                    - static, constant window.TEAM_NAME_MAC :string +

                                                                                                                                                                                    + static, constant window.TEAM_CODES :Array.<string>

                                                                                                                                                                                    @@ -4060,7 +518,7 @@
                                                                                                                                                                                    Type:
                                                                                                                                                                                    • -string +Array.<string>
                                                                                                                                                                                    • @@ -4114,12 +572,12 @@
                                                                                                                                                                                      Type:
                                                                                                                                                                                      -

                                                                                                                                                                                      - static, constant window.TEAM_NAME_NONE :string +

                                                                                                                                                                                      + static, constant window.TEAM_ENL :number

                                                                                                                                                                                      @@ -4135,7 +593,7 @@
                                                                                                                                                                                      Type:
                                                                                                                                                                                      • -string +number
                                                                                                                                                                                      • @@ -4189,12 +647,12 @@
                                                                                                                                                                                        Type:
                                                                                                                                                                                        -

                                                                                                                                                                                        - static, constant window.TEAM_NAME_NONE :string +

                                                                                                                                                                                        + static, constant window.TEAM_MAC :number

                                                                                                                                                                                        @@ -4210,7 +668,7 @@
                                                                                                                                                                                        Type:
                                                                                                                                                                                        • -string +number
                                                                                                                                                                                        • @@ -4264,12 +722,12 @@
                                                                                                                                                                                          Type:
                                                                                                                                                                                          -

                                                                                                                                                                                          - static, constant window.TEAM_NAME_RES :string +

                                                                                                                                                                                          + static, constant window.TEAM_NAME_ENL :string

                                                                                                                                                                                          @@ -4339,12 +797,12 @@
                                                                                                                                                                                          Type:
                                                                                                                                                                                          -

                                                                                                                                                                                          - static, constant window.TEAM_NAME_RES :string +

                                                                                                                                                                                          + static, constant window.TEAM_NAME_MAC :string

                                                                                                                                                                                          @@ -4414,12 +872,12 @@
                                                                                                                                                                                          Type:
                                                                                                                                                                                          -

                                                                                                                                                                                          - static, constant window.TEAM_NAMES :Array.<string> +

                                                                                                                                                                                          + static, constant window.TEAM_NAME_NONE :string

                                                                                                                                                                                          @@ -4435,7 +893,7 @@
                                                                                                                                                                                          Type:
                                                                                                                                                                                          • -Array.<string> +string
                                                                                                                                                                                          • @@ -4489,12 +947,12 @@
                                                                                                                                                                                            Type:
                                                                                                                                                                                            -

                                                                                                                                                                                            - static, constant window.TEAM_NAMES :Array.<string> +

                                                                                                                                                                                            + static, constant window.TEAM_NAME_RES :string

                                                                                                                                                                                            @@ -4510,7 +968,7 @@
                                                                                                                                                                                            Type:
                                                                                                                                                                                            • -Array.<string> +string
                                                                                                                                                                                            • @@ -4564,12 +1022,12 @@
                                                                                                                                                                                              Type:
                                                                                                                                                                                              -

                                                                                                                                                                                              - static, constant window.TEAM_NONE :number +

                                                                                                                                                                                              + static, constant window.TEAM_NAMES :Array.<string>

                                                                                                                                                                                              @@ -4585,7 +1043,7 @@
                                                                                                                                                                                              Type:
                                                                                                                                                                                              • -number +Array.<string>
                                                                                                                                                                                              • @@ -4767,156 +1225,6 @@
                                                                                                                                                                                                Type:
                                                                                                                                                                                                - - - - - - - - - - -
                                                                                                                                                                                - - - - - - - - - - -
                                                                                                                                                                                -

                                                                                                                                                                                - static, constant window.TEAM_RES :number - - - -

                                                                                                                                                                                - - -
                                                                                                                                                                                -
                                                                                                                                                                                - - - - - - - -
                                                                                                                                                                                - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                - - - - - -
                                                                                                                                                                                - - - - -
                                                                                                                                                                                -

                                                                                                                                                                                - static, constant window.TEAM_TO_CSS :Array.<string> - - - -

                                                                                                                                                                                - - -
                                                                                                                                                                                -
                                                                                                                                                                                - - - - - - - -
                                                                                                                                                                                - - - - - - - - - - - - - - - - - - - - diff --git a/player.html b/player.html index 6710aaa98..1443fcd2c 100644 --- a/player.html +++ b/player.html @@ -34,7 +34,7 @@

                                                                                                                                                                                IITC-CE

                                                                                                                                                                                  - +
                                                                                                                                                                                  @@ -447,1127 +447,6 @@
                                                                                                                                                                                  Properties:
                                                                                                                                                                                  - - - - - - - - - - -
                                                                                                                                                                                  - - - - - -
                                                                                                                                                                                  - - - - -
                                                                                                                                                                                  -

                                                                                                                                                                                  - PLAYER - - - -

                                                                                                                                                                                  - - -
                                                                                                                                                                                  -
                                                                                                                                                                                  - -
                                                                                                                                                                                  -

                                                                                                                                                                                  window.PLAYER -Represents the current player's status in the game. This object is defined by stock and is static, -meaning it requires a page reload to update. The PLAYER object stores various pieces of information -about the player, which are detailed below.

                                                                                                                                                                                  -

                                                                                                                                                                                  Additional properties (nickMatcher and level) added by IITC in sidebar.setupPlayerStat

                                                                                                                                                                                  -
                                                                                                                                                                                  - - - - - - - -
                                                                                                                                                                                  Properties:
                                                                                                                                                                                  - - - -
                                                                                                                                                                                  NameTypeAttributesDescription
                                                                                                                                                                                  time - - -number - - - - - - - - - -

                                                                                                                                                                                  The UNIX timestamp to convert.

                                                                                                                                                                                  full - - -boolean + + + +string - - <optional>
                                                                                                                                                                                  - - - - - -

                                                                                                                                                                                  If true, returns both date and time.

                                                                                                                                                                                  Name of the location.

                                                                                                                                                                                  TypeAttributes
                                                                                                                                                                                  time - - -number - - - - - - - - - -

                                                                                                                                                                                  The UNIX timestamp to convert.

                                                                                                                                                                                  fullarr -boolean +Array - - <optional>
                                                                                                                                                                                  - - - - - -

                                                                                                                                                                                  If true, returns both date and time.

                                                                                                                                                                                  The array to process.

                                                                                                                                                                                  TypeAttributes
                                                                                                                                                                                  nametime -string +number + + + + + +

                                                                                                                                                                                  The name of the cookie.

                                                                                                                                                                                  The UNIX timestamp to convert.

                                                                                                                                                                                  valmillisecond -string +boolean + + <optional>
                                                                                                                                                                                  + + + + + +

                                                                                                                                                                                  The value of the cookie.

                                                                                                                                                                                  Whether to include millisecond precision.

                                                                                                                                                                                  nametime -string - - - -

                                                                                                                                                                                  The name of the cookie.

                                                                                                                                                                                  val - - string @@ -17085,7 +3707,7 @@
                                                                                                                                                                                  Parameters:
                                                                                                                                                                                  -

                                                                                                                                                                                  The value of the cookie.

                                                                                                                                                                                  The UNIX timestamp to convert.

                                                                                                                                                                                  TypeAttributes
                                                                                                                                                                                  numbertime @@ -17221,33 +3870,51 @@
                                                                                                                                                                                  Parameters:
                                                                                                                                                                                  + + + + + +

                                                                                                                                                                                  The number to pad.

                                                                                                                                                                                  The UNIX timestamp to convert.

                                                                                                                                                                                  padfull -number +boolean + + <optional>
                                                                                                                                                                                  + + + + + +

                                                                                                                                                                                  The desired length of the output string.

                                                                                                                                                                                  If true, returns both date and time.

                                                                                                                                                                                  numbername -number +string @@ -17407,20 +4077,20 @@
                                                                                                                                                                                  Parameters:
                                                                                                                                                                                  -

                                                                                                                                                                                  The number to pad.

                                                                                                                                                                                  The name of the cookie.

                                                                                                                                                                                  padval -number +string @@ -17430,7 +4100,7 @@
                                                                                                                                                                                  Parameters:
                                                                                                                                                                                  -

                                                                                                                                                                                  The desired length of the output string.

                                                                                                                                                                                  The value of the cookie.

                                                                                                                                                                                  guidnumber -string +number @@ -17590,20 +4239,20 @@
                                                                                                                                                                                  Parameters:
                                                                                                                                                                                  -

                                                                                                                                                                                  The globally unique identifier of the portal.

                                                                                                                                                                                  The number to pad.

                                                                                                                                                                                  latlngpad -L.LatLng +number @@ -17613,7 +4262,7 @@
                                                                                                                                                                                  Parameters:
                                                                                                                                                                                  -

                                                                                                                                                                                  The latitude and longitude of the portal.

                                                                                                                                                                                  The desired length of the output string.

                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                  NameTypeDescription
                                                                                                                                                                                  ap - - -string - - - -

                                                                                                                                                                                  The amount of AP (Access Points) the player currently has.

                                                                                                                                                                                  available_invites - - -number - - - -

                                                                                                                                                                                  The number of invitations the player can send.

                                                                                                                                                                                  energy - - -number - - - -

                                                                                                                                                                                  The amount of XM (Exotic Matter) the player currently holds.

                                                                                                                                                                                  min_ap_for_current_level - - -number - - - -

                                                                                                                                                                                  The AP required for the player's current level, used for tracking level progress.

                                                                                                                                                                                  min_ap_for_next_level - - -number - - - -

                                                                                                                                                                                  The AP required for the next level, used for tracking level progress.

                                                                                                                                                                                  nickname - - -string - - - -

                                                                                                                                                                                  The agent name of the player.

                                                                                                                                                                                  team - - -string - - - -

                                                                                                                                                                                  The faction of the player, which can be either "ENLIGHTENED" or "RESISTANCE".

                                                                                                                                                                                  verified_level - - -number - - - -

                                                                                                                                                                                  Current player level.

                                                                                                                                                                                  -

                                                                                                                                                                                  Additional properties

                                                                                                                                                                                  nickMatcher - - -RegExp - - - -

                                                                                                                                                                                  A regular expression used to match the player's agent name in chat. Added by IITC.

                                                                                                                                                                                  level - - -number - - - -

                                                                                                                                                                                  Backwards compatibility property, equivalent to verified_level. Added by IITC.

                                                                                                                                                                                  - - - - -
                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                  - - - - - -
                                                                                                                                                                                  - -
                                                                                                                                                                                  - - - -
                                                                                                                                                                                  - -
                                                                                                                                                                                  - - - - - - - -
                                                                                                                                                                                  - -
                                                                                                                                                                                  - -

                                                                                                                                                                                  player

                                                                                                                                                                                  - - -
                                                                                                                                                                                  - -
                                                                                                                                                                                  - -
                                                                                                                                                                                  - - -

                                                                                                                                                                                  PLAYER

                                                                                                                                                                                  - - - - - -
                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                  - - - - -
                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - -

                                                                                                                                                                                  Type Definitions

                                                                                                                                                                                  - -
                                                                                                                                                                                  - - -
                                                                                                                                                                                  -

                                                                                                                                                                                  - PLAYER - - - -

                                                                                                                                                                                  - - -
                                                                                                                                                                                  -
                                                                                                                                                                                  - -
                                                                                                                                                                                  -

                                                                                                                                                                                  window.PLAYER -Represents the current player's status in the game. This object is defined by stock and is static, -meaning it requires a page reload to update. The PLAYER object stores various pieces of information -about the player, which are detailed below.

                                                                                                                                                                                  -

                                                                                                                                                                                  Additional properties (nickMatcher and level) added by IITC in sidebar.setupPlayerStat

                                                                                                                                                                                  -
                                                                                                                                                                                  - - - - - - - -
                                                                                                                                                                                  Properties:
                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                  NameTypeDescription
                                                                                                                                                                                  ap - - -string - - - -

                                                                                                                                                                                  The amount of AP (Access Points) the player currently has.

                                                                                                                                                                                  available_invites - - -number - - - -

                                                                                                                                                                                  The number of invitations the player can send.

                                                                                                                                                                                  energy - - -number - - - -

                                                                                                                                                                                  The amount of XM (Exotic Matter) the player currently holds.

                                                                                                                                                                                  min_ap_for_current_level - - -number - - - -

                                                                                                                                                                                  The AP required for the player's current level, used for tracking level progress.

                                                                                                                                                                                  min_ap_for_next_level - - -number - - - -

                                                                                                                                                                                  The AP required for the next level, used for tracking level progress.

                                                                                                                                                                                  nickname - - -string - - - -

                                                                                                                                                                                  The agent name of the player.

                                                                                                                                                                                  team - - -string - - - -

                                                                                                                                                                                  The faction of the player, which can be either "ENLIGHTENED" or "RESISTANCE".

                                                                                                                                                                                  verified_level - - -number - - - -

                                                                                                                                                                                  Current player level.

                                                                                                                                                                                  -

                                                                                                                                                                                  Additional properties

                                                                                                                                                                                  nickMatcher - - -RegExp - - - -

                                                                                                                                                                                  A regular expression used to match the player's agent name in chat. Added by IITC.

                                                                                                                                                                                  level - - -number - - - -

                                                                                                                                                                                  Backwards compatibility property, equivalent to verified_level. Added by IITC.

                                                                                                                                                                                  - - - - -
                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                  - - - - - -
                                                                                                                                                                                  - - - - -
                                                                                                                                                                                  -

                                                                                                                                                                                  - PLAYER - - - -

                                                                                                                                                                                  - - -
                                                                                                                                                                                  -
                                                                                                                                                                                  - -
                                                                                                                                                                                  -

                                                                                                                                                                                  window.PLAYER -Represents the current player's status in the game. This object is defined by stock and is static, -meaning it requires a page reload to update. The PLAYER object stores various pieces of information -about the player, which are detailed below.

                                                                                                                                                                                  -

                                                                                                                                                                                  Additional properties (nickMatcher and level) added by IITC in sidebar.setupPlayerStat

                                                                                                                                                                                  -
                                                                                                                                                                                  - - - - - - - -
                                                                                                                                                                                  Properties:
                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                  NameTypeDescription
                                                                                                                                                                                  ap - - -string - - - -

                                                                                                                                                                                  The amount of AP (Access Points) the player currently has.

                                                                                                                                                                                  available_invites - - -number - - - -

                                                                                                                                                                                  The number of invitations the player can send.

                                                                                                                                                                                  energy - - -number - - - -

                                                                                                                                                                                  The amount of XM (Exotic Matter) the player currently holds.

                                                                                                                                                                                  min_ap_for_current_level - - -number - - - -

                                                                                                                                                                                  The AP required for the player's current level, used for tracking level progress.

                                                                                                                                                                                  min_ap_for_next_level - - -number - - - -

                                                                                                                                                                                  The AP required for the next level, used for tracking level progress.

                                                                                                                                                                                  nickname - - -string - - - -

                                                                                                                                                                                  The agent name of the player.

                                                                                                                                                                                  team - - -string - - - -

                                                                                                                                                                                  The faction of the player, which can be either "ENLIGHTENED" or "RESISTANCE".

                                                                                                                                                                                  verified_level - - -number - - - -

                                                                                                                                                                                  Current player level.

                                                                                                                                                                                  -

                                                                                                                                                                                  Additional properties

                                                                                                                                                                                  nickMatcher - - -RegExp - - - -

                                                                                                                                                                                  A regular expression used to match the player's agent name in chat. Added by IITC.

                                                                                                                                                                                  level - - -number - - - -

                                                                                                                                                                                  Backwards compatibility property, equivalent to verified_level. Added by IITC.

                                                                                                                                                                                  - - - - -
                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - diff --git a/storage_variables.html b/storage_variables.html index 4029f593a..c11bd9343 100644 --- a/storage_variables.html +++ b/storage_variables.html @@ -34,7 +34,7 @@

                                                                                                                                                                                  IITC-CE

                                                                                                                                                                                    - +
                                                                                                                                                                                    @@ -182,168 +182,6 @@
                                                                                                                                                                                    Type:
                                                                                                                                                                                    - - - - - - - - - - -
                                                                                                                                                                                    - - - - - -
                                                                                                                                                                                    - - - - -
                                                                                                                                                                                    -

                                                                                                                                                                                    - static window.fields :Object.<string, object> - - - -

                                                                                                                                                                                    - - -
                                                                                                                                                                                    -
                                                                                                                                                                                    - -
                                                                                                                                                                                    -

                                                                                                                                                                                    References to Leaflet objects representing fields, indexed by entity ID. -This object stores the mapping in the format { id1: feature1, ... }. -Note: While these are Leaflet objects, not all may be added to the map due to render limits.

                                                                                                                                                                                    -
                                                                                                                                                                                    - - - - - - - -
                                                                                                                                                                                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                    - - - - - -
                                                                                                                                                                                    - - - - -
                                                                                                                                                                                    - - - -
                                                                                                                                                                                    -
                                                                                                                                                                                    - -
                                                                                                                                                                                    -

                                                                                                                                                                                    References to Leaflet objects representing links, indexed by entity ID. -This object stores the mapping in the format { id1: feature1, ... }. -Note: While these are Leaflet objects, not all may be added to the map due to render limits.

                                                                                                                                                                                    -
                                                                                                                                                                                    - - - - - - - -
                                                                                                                                                                                    - - - - - - - - - - - - - - - - - - - - @@ -529,12 +367,12 @@
                                                                                                                                                                                    Type:
                                                                                                                                                                                    -

                                                                                                                                                                                    - static window.portalAccessIndicator :object|null +

                                                                                                                                                                                    + static window.portalRangeIndicator :object|null

                                                                                                                                                                                    @@ -544,7 +382,7 @@

                                                                                                                                                                                    -

                                                                                                                                                                                    Reference to the hacking range indicator of the selected portal. This is a Leaflet layer.

                                                                                                                                                                                    +

                                                                                                                                                                                    Reference to the linking range indicator of the selected portal. This is a Leaflet layer.

                                                                                                                                                                                    @@ -611,12 +449,12 @@
                                                                                                                                                                                    Type:
                                                                                                                                                                                    -

                                                                                                                                                                                    - static window.portalRangeIndicator :object|null +

                                                                                                                                                                                    + static window.portals :Object.<string, object>

                                                                                                                                                                                    @@ -626,7 +464,9 @@

                                                                                                                                                                                    -

                                                                                                                                                                                    Reference to the linking range indicator of the selected portal. This is a Leaflet layer.

                                                                                                                                                                                    +

                                                                                                                                                                                    References to Leaflet objects representing portals, indexed by entity ID. +This object stores the mapping in the format { id1: feature1, ... }. +Note: While these are Leaflet objects, not all may be added to the map due to render limits.

                                                                                                                                                                                    @@ -636,10 +476,7 @@
                                                                                                                                                                                    Type:
                                                                                                                                                                                    • -object -| - -null +Object.<string, object>
                                                                                                                                                                                    • @@ -693,12 +530,12 @@
                                                                                                                                                                                      Type:
                                                                                                                                                                                      -

                                                                                                                                                                                      - static window.portalRangeIndicator :object|null +

                                                                                                                                                                                      + static window.refreshTimeout :number|undefined

                                                                                                                                                                                      @@ -708,7 +545,7 @@

                                                                                                                                                                                      -

                                                                                                                                                                                      Reference to the linking range indicator of the selected portal. This is a Leaflet layer.

                                                                                                                                                                                      +

                                                                                                                                                                                      Stores the id of the timeout that kicks off the next refresh (ie value returned by setTimeout())

                                                                                                                                                                                      @@ -718,10 +555,10 @@
                                                                                                                                                                                      Type:
                                                                                                                                                                                      • -object +number | -null +undefined
                                                                                                                                                                                      • @@ -775,12 +612,12 @@
                                                                                                                                                                                        Type:
                                                                                                                                                                                        -

                                                                                                                                                                                        - static window.portals :Object.<string, object> +

                                                                                                                                                                                        + static window.selectedPortal :string|null

                                                                                                                                                                                        @@ -790,9 +627,7 @@

                                                                                                                                                                                        -

                                                                                                                                                                                        References to Leaflet objects representing portals, indexed by entity ID. -This object stores the mapping in the format { id1: feature1, ... }. -Note: While these are Leaflet objects, not all may be added to the map due to render limits.

                                                                                                                                                                                        +

                                                                                                                                                                                        Stores the GUID of the selected portal, or is null if there is none.

                                                                                                                                                                                        @@ -802,7 +637,10 @@
                                                                                                                                                                                        Type:
                                                                                                                                                                                        • -Object.<string, object> +string +| + +null
                                                                                                                                                                                        • @@ -856,12 +694,12 @@
                                                                                                                                                                                          Type:
                                                                                                                                                                                          -

                                                                                                                                                                                          - static window.portals :Object.<string, object> +

                                                                                                                                                                                          + static window.urlPortal :string|null

                                                                                                                                                                                          @@ -871,2061 +709,7 @@

                                                                                                                                                                                          -

                                                                                                                                                                                          References to Leaflet objects representing portals, indexed by entity ID. -This object stores the mapping in the format { id1: feature1, ... }. -Note: While these are Leaflet objects, not all may be added to the map due to render limits.

                                                                                                                                                                                          -
                                                                                                                                                                                          - - - - - - - -
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          - - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          -

                                                                                                                                                                                          - static window.refreshTimeout :number|undefined - - - -

                                                                                                                                                                                          - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          - -
                                                                                                                                                                                          -

                                                                                                                                                                                          Stores the id of the timeout that kicks off the next refresh (ie value returned by setTimeout())

                                                                                                                                                                                          -
                                                                                                                                                                                          - - - - - - - -
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          - - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          -

                                                                                                                                                                                          - static window.refreshTimeout :number|undefined - - - -

                                                                                                                                                                                          - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          - -
                                                                                                                                                                                          -

                                                                                                                                                                                          Stores the id of the timeout that kicks off the next refresh (ie value returned by setTimeout())

                                                                                                                                                                                          -
                                                                                                                                                                                          - - - - - - - -
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          - - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          -

                                                                                                                                                                                          - static window.selectedPortal :string|null - - - -

                                                                                                                                                                                          - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          - -
                                                                                                                                                                                          -

                                                                                                                                                                                          Stores the GUID of the selected portal, or is null if there is none.

                                                                                                                                                                                          -
                                                                                                                                                                                          - - - - - - - -
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          - - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          -

                                                                                                                                                                                          - static window.selectedPortal :string|null - - - -

                                                                                                                                                                                          - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          - -
                                                                                                                                                                                          -

                                                                                                                                                                                          Stores the GUID of the selected portal, or is null if there is none.

                                                                                                                                                                                          -
                                                                                                                                                                                          - - - - - - - -
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          - - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          -

                                                                                                                                                                                          - static window.urlPortal :string|null - - - -

                                                                                                                                                                                          - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          - -
                                                                                                                                                                                          -

                                                                                                                                                                                          Portal GUID if the original URL had it.

                                                                                                                                                                                          -
                                                                                                                                                                                          - - - - - - - -
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          - - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          -

                                                                                                                                                                                          - static window.urlPortal :string|null - - - -

                                                                                                                                                                                          - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          - -
                                                                                                                                                                                          -

                                                                                                                                                                                          Portal GUID if the original URL had it.

                                                                                                                                                                                          -
                                                                                                                                                                                          - - - - - - - -
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          - - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          -

                                                                                                                                                                                          - static window.urlPortalLL :object|null - - - -

                                                                                                                                                                                          - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          - -
                                                                                                                                                                                          -

                                                                                                                                                                                          Portal lng/lat if the orignial URL had it.

                                                                                                                                                                                          -
                                                                                                                                                                                          - - - - - - - -
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          - - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          -

                                                                                                                                                                                          - static window.urlPortalLL :object|null - - - -

                                                                                                                                                                                          - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          - -
                                                                                                                                                                                          -

                                                                                                                                                                                          Portal lng/lat if the orignial URL had it.

                                                                                                                                                                                          -
                                                                                                                                                                                          - - - - - - - -
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          - - - - - -
                                                                                                                                                                                          - -

                                                                                                                                                                                    - - - - - - - -
                                                                                                                                                                                    - -
                                                                                                                                                                                    - - - - - - - -
                                                                                                                                                                                    - -
                                                                                                                                                                                    - -

                                                                                                                                                                                    storage_variables

                                                                                                                                                                                    - - -
                                                                                                                                                                                    - -
                                                                                                                                                                                    - -
                                                                                                                                                                                    - - -

                                                                                                                                                                                    Global variables used for storage. Most likely READ ONLY. Proper ay would be to encapsulate them in an anonymous -function and write getters/setters, but if you are careful enough, this works.

                                                                                                                                                                                    - - - - - -
                                                                                                                                                                                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                    - - - - -
                                                                                                                                                                                    - - - - - - - - - - - - - - - -

                                                                                                                                                                                    Members

                                                                                                                                                                                    - -
                                                                                                                                                                                    - - -
                                                                                                                                                                                    -

                                                                                                                                                                                    - static window.fields :Object.<string, object> - - - -

                                                                                                                                                                                    - - -
                                                                                                                                                                                    -
                                                                                                                                                                                    - -
                                                                                                                                                                                    -

                                                                                                                                                                                    References to Leaflet objects representing fields, indexed by entity ID. -This object stores the mapping in the format { id1: feature1, ... }. -Note: While these are Leaflet objects, not all may be added to the map due to render limits.

                                                                                                                                                                                    -
                                                                                                                                                                                    - - - - - - - -
                                                                                                                                                                                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                    - - - - - -
                                                                                                                                                                                    - - - - -
                                                                                                                                                                                    -

                                                                                                                                                                                    - static window.fields :Object.<string, object> - - - -

                                                                                                                                                                                    - - -
                                                                                                                                                                                    -
                                                                                                                                                                                    - -
                                                                                                                                                                                    -

                                                                                                                                                                                    References to Leaflet objects representing fields, indexed by entity ID. -This object stores the mapping in the format { id1: feature1, ... }. -Note: While these are Leaflet objects, not all may be added to the map due to render limits.

                                                                                                                                                                                    -
                                                                                                                                                                                    - - - - - - - -
                                                                                                                                                                                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                    - - - - - -
                                                                                                                                                                                    - - - - -
                                                                                                                                                                                    - - - -
                                                                                                                                                                                    -
                                                                                                                                                                                    - -
                                                                                                                                                                                    -

                                                                                                                                                                                    References to Leaflet objects representing links, indexed by entity ID. -This object stores the mapping in the format { id1: feature1, ... }. -Note: While these are Leaflet objects, not all may be added to the map due to render limits.

                                                                                                                                                                                    -
                                                                                                                                                                                    - - - - - - - -
                                                                                                                                                                                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                    - - - - - -
                                                                                                                                                                                    - - - - -
                                                                                                                                                                                    - - - -
                                                                                                                                                                                    -
                                                                                                                                                                                    - -
                                                                                                                                                                                    -

                                                                                                                                                                                    References to Leaflet objects representing links, indexed by entity ID. -This object stores the mapping in the format { id1: feature1, ... }. -Note: While these are Leaflet objects, not all may be added to the map due to render limits.

                                                                                                                                                                                    -
                                                                                                                                                                                    - - - - - - - -
                                                                                                                                                                                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                    - - - - - -
                                                                                                                                                                                    - - - - -
                                                                                                                                                                                    -

                                                                                                                                                                                    - static window.portalAccessIndicator :object|null - - - -

                                                                                                                                                                                    - - -
                                                                                                                                                                                    -
                                                                                                                                                                                    - -
                                                                                                                                                                                    -

                                                                                                                                                                                    Reference to the hacking range indicator of the selected portal. This is a Leaflet layer.

                                                                                                                                                                                    -
                                                                                                                                                                                    - - - - - - - -
                                                                                                                                                                                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                    - - - - - -
                                                                                                                                                                                    - - - - -
                                                                                                                                                                                    -

                                                                                                                                                                                    - static window.portalAccessIndicator :object|null - - - -

                                                                                                                                                                                    - - -
                                                                                                                                                                                    -
                                                                                                                                                                                    - -
                                                                                                                                                                                    -

                                                                                                                                                                                    Reference to the hacking range indicator of the selected portal. This is a Leaflet layer.

                                                                                                                                                                                    -
                                                                                                                                                                                    - - - - - - - -
                                                                                                                                                                                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                    - - - - - -
                                                                                                                                                                                    - - - - -
                                                                                                                                                                                    -

                                                                                                                                                                                    - static window.portalRangeIndicator :object|null - - - -

                                                                                                                                                                                    - - -
                                                                                                                                                                                    -
                                                                                                                                                                                    - -
                                                                                                                                                                                    -

                                                                                                                                                                                    Reference to the linking range indicator of the selected portal. This is a Leaflet layer.

                                                                                                                                                                                    -
                                                                                                                                                                                    - - - - - - - -
                                                                                                                                                                                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                    - - - - - -
                                                                                                                                                                                    - - - - -
                                                                                                                                                                                    -

                                                                                                                                                                                    - static window.portalRangeIndicator :object|null - - - -

                                                                                                                                                                                    - - -
                                                                                                                                                                                    -
                                                                                                                                                                                    - -
                                                                                                                                                                                    -

                                                                                                                                                                                    Reference to the linking range indicator of the selected portal. This is a Leaflet layer.

                                                                                                                                                                                    -
                                                                                                                                                                                    - - - - - - - -
                                                                                                                                                                                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                    - - - - - -
                                                                                                                                                                                    - - - - -
                                                                                                                                                                                    -

                                                                                                                                                                                    - static window.portals :Object.<string, object> - - - -

                                                                                                                                                                                    - - -
                                                                                                                                                                                    -
                                                                                                                                                                                    - -
                                                                                                                                                                                    -

                                                                                                                                                                                    References to Leaflet objects representing portals, indexed by entity ID. -This object stores the mapping in the format { id1: feature1, ... }. -Note: While these are Leaflet objects, not all may be added to the map due to render limits.

                                                                                                                                                                                    -
                                                                                                                                                                                    - - - - - - - -
                                                                                                                                                                                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                    - - - - - -
                                                                                                                                                                                    - - - - -
                                                                                                                                                                                    -

                                                                                                                                                                                    - static window.portals :Object.<string, object> - - - -

                                                                                                                                                                                    - - -
                                                                                                                                                                                    -
                                                                                                                                                                                    - -
                                                                                                                                                                                    -

                                                                                                                                                                                    References to Leaflet objects representing portals, indexed by entity ID. -This object stores the mapping in the format { id1: feature1, ... }. -Note: While these are Leaflet objects, not all may be added to the map due to render limits.

                                                                                                                                                                                    -
                                                                                                                                                                                    - - - - - - - -
                                                                                                                                                                                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                    - - - - - -
                                                                                                                                                                                    - - - - -
                                                                                                                                                                                    -

                                                                                                                                                                                    - static window.refreshTimeout :number|undefined - - - -

                                                                                                                                                                                    - - -
                                                                                                                                                                                    -
                                                                                                                                                                                    - -
                                                                                                                                                                                    -

                                                                                                                                                                                    Stores the id of the timeout that kicks off the next refresh (ie value returned by setTimeout())

                                                                                                                                                                                    -
                                                                                                                                                                                    - - - - - - - -
                                                                                                                                                                                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                    - - - - - -
                                                                                                                                                                                    - - - - -
                                                                                                                                                                                    -

                                                                                                                                                                                    - static window.refreshTimeout :number|undefined - - - -

                                                                                                                                                                                    - - -
                                                                                                                                                                                    -
                                                                                                                                                                                    - -
                                                                                                                                                                                    -

                                                                                                                                                                                    Stores the id of the timeout that kicks off the next refresh (ie value returned by setTimeout())

                                                                                                                                                                                    -
                                                                                                                                                                                    - - - - - - - -
                                                                                                                                                                                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                    - - - - - -
                                                                                                                                                                                    - - - - -
                                                                                                                                                                                    -

                                                                                                                                                                                    - static window.selectedPortal :string|null - - - -

                                                                                                                                                                                    - - -
                                                                                                                                                                                    -
                                                                                                                                                                                    - -
                                                                                                                                                                                    -

                                                                                                                                                                                    Stores the GUID of the selected portal, or is null if there is none.

                                                                                                                                                                                    -
                                                                                                                                                                                    - - - - - - - -
                                                                                                                                                                                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                    - - - - - -
                                                                                                                                                                                    - - - - -
                                                                                                                                                                                    -

                                                                                                                                                                                    - static window.selectedPortal :string|null - - - -

                                                                                                                                                                                    - - -
                                                                                                                                                                                    -
                                                                                                                                                                                    - -
                                                                                                                                                                                    -

                                                                                                                                                                                    Stores the GUID of the selected portal, or is null if there is none.

                                                                                                                                                                                    -
                                                                                                                                                                                    - - - - - - - -
                                                                                                                                                                                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                    - - - - - -
                                                                                                                                                                                    - - - - -
                                                                                                                                                                                    -

                                                                                                                                                                                    - static window.urlPortal :string|null - - - -

                                                                                                                                                                                    - - -
                                                                                                                                                                                    -
                                                                                                                                                                                    - -
                                                                                                                                                                                    -

                                                                                                                                                                                    Portal GUID if the original URL had it.

                                                                                                                                                                                    -
                                                                                                                                                                                    - - - - - - - -
                                                                                                                                                                                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                    - - - - - -
                                                                                                                                                                                    - - - - -
                                                                                                                                                                                    -

                                                                                                                                                                                    - static window.urlPortal :string|null - - - -

                                                                                                                                                                                    - - -
                                                                                                                                                                                    -
                                                                                                                                                                                    - -
                                                                                                                                                                                    -

                                                                                                                                                                                    Portal GUID if the original URL had it.

                                                                                                                                                                                    +

                                                                                                                                                                                    Portal GUID if the original URL had it.

                                                                                                                                                                                    @@ -3052,88 +836,6 @@
                                                                                                                                                                                    Type:
                                                                                                                                                                                    - - - - - - - - - - -
                                                                                                                                                                                    - - - - - - - - - - -
                                                                                                                                                                                    -

                                                                                                                                                                                    - static window.urlPortalLL :object|null - - - -

                                                                                                                                                                                    - - -
                                                                                                                                                                                    -
                                                                                                                                                                                    - -
                                                                                                                                                                                    -

                                                                                                                                                                                    Portal lng/lat if the orignial URL had it.

                                                                                                                                                                                    -
                                                                                                                                                                                    - - - - - - - -
                                                                                                                                                                                    - - - - - - - - - - - - - - - - - - - - diff --git a/total-conversion-build.js.html b/total-conversion-build.js.html index 7728b5705..42344d8ed 100644 --- a/total-conversion-build.js.html +++ b/total-conversion-build.js.html @@ -36,7 +36,7 @@

                                                                                                                                                                                    IITC-CE

                                                                                                                                                                                      - +
                                                                                                                                                                                      diff --git a/window.artifact.html b/window.artifact.html index a81f392d5..1028bb2fe 100644 --- a/window.artifact.html +++ b/window.artifact.html @@ -34,7 +34,7 @@

                                                                                                                                                                                      IITC-CE

                                                                                                                                                                                        - +
                                                                                                                                                                                        @@ -223,14 +223,14 @@

                                                                                                                                                                                        -

                                                                                                                                                                                        +

                                                                                                                                                                                        - static clearData() + static getArtifactEntities() → {Array}

                                                                                                                                                                                        @@ -242,7 +242,7 @@

                                                                                                                                                                                        -

                                                                                                                                                                                        Clears all stored artifact data.

                                                                                                                                                                                        +

                                                                                                                                                                                        Used to render portals that would otherwise be below the visible level.

                                                                                                                                                                                        @@ -264,6 +264,27 @@

                                                                                                                                                                                        + +
                                                                                                                                                                                        +
                                                                                                                                                                                        Returns:
                                                                                                                                                                                        + + + + + +Array + + + + + +-

                                                                                                                                                                                        An array of artifact entities.

                                                                                                                                                                                        + + + + + +
                                                                                                                                                                                        @@ -312,14 +333,14 @@

                                                                                                                                                                                        -

                                                                                                                                                                                        +

                                                                                                                                                                                        - static getArtifactEntities() → {Array} + static getArtifactTypes() → {Array}

                                                                                                                                                                                        @@ -331,7 +352,7 @@

                                                                                                                                                                                        -

                                                                                                                                                                                        Used to render portals that would otherwise be below the visible level.

                                                                                                                                                                                        +

                                                                                                                                                                                        Returns the types of artifacts currently known.

                                                                                                                                                                                        @@ -367,7 +388,7 @@

                                                                                                                                                                                        Returns:
                                                                                                                                                                                        --

                                                                                                                                                                                        An array of artifact entities.

                                                                                                                                                                                        +-

                                                                                                                                                                                        An array of artifact type strings.

                                                                                                                                                                                        @@ -422,14 +443,14 @@
                                                                                                                                                                                        Returns:
                                                                                                                                                                                        -

                                                                                                                                                                                        +

                                                                                                                                                                                        - static getArtifactEntities() → {Array} + static getInterestingPortals() → {Array}

                                                                                                                                                                                        @@ -441,7 +462,7 @@

                                                                                                                                                                                        -

                                                                                                                                                                                        Used to render portals that would otherwise be below the visible level.

                                                                                                                                                                                        +

                                                                                                                                                                                        Gets the portals that are relevant to the artifacts.

                                                                                                                                                                                        @@ -477,7 +498,7 @@

                                                                                                                                                                                        Returns:
                                                                                                                                                                                        --

                                                                                                                                                                                        An array of artifact entities.

                                                                                                                                                                                        +-

                                                                                                                                                                                        An array of portal GUIDs.

                                                                                                                                                                                        @@ -532,14 +553,14 @@
                                                                                                                                                                                        Returns:
                                                                                                                                                                                        -

                                                                                                                                                                                        +

                                                                                                                                                                                        - static getArtifactTypes() → {Array} + static getPortalData(guid, artifactId) → {Object|false}

                                                                                                                                                                                        @@ -551,7 +572,7 @@

                                                                                                                                                                                        -

                                                                                                                                                                                        Returns the types of artifacts currently known.

                                                                                                                                                                                        +

                                                                                                                                                                                        Retrieves the artifact data for a specified artifact id (e.g. 'jarvis'), if available.

                                                                                                                                                                                        @@ -562,6 +583,79 @@

                                                                                                                                                                                        +
                                                                                                                                                                                        +
                                                                                                                                                                                        Parameters:
                                                                                                                                                                                        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                                        NameTypeDescription
                                                                                                                                                                                        guid + + +string + + + +

                                                                                                                                                                                        The GUID of the portal.

                                                                                                                                                                                        artifactId + + +string + + + +

                                                                                                                                                                                        The ID of the artifact type.

                                                                                                                                                                                        + +
                                                                                                                                                                                        + @@ -581,13 +675,16 @@

                                                                                                                                                                                        Returns:
                                                                                                                                                                                        -Array +Object +| + +false --

                                                                                                                                                                                        An array of artifact type strings.

                                                                                                                                                                                        +-

                                                                                                                                                                                        Artifact data for the specified portal and type, or undefined if not available.

                                                                                                                                                                                        @@ -642,14 +739,14 @@
                                                                                                                                                                                        Returns:
                                                                                                                                                                                        -

                                                                                                                                                                                        +

                                                                                                                                                                                        - static getArtifactTypes() → {Array} + static handleFailure(data)

                                                                                                                                                                                        @@ -661,7 +758,7 @@

                                                                                                                                                                                        -

                                                                                                                                                                                        Returns the types of artifacts currently known.

                                                                                                                                                                                        +

                                                                                                                                                                                        Handles failure in artifact data request. Schedules a new request after a short delay.

                                                                                                                                                                                        @@ -672,38 +769,67 @@

                                                                                                                                                                                        +
                                                                                                                                                                                        +
                                                                                                                                                                                        Parameters:
                                                                                                                                                                                        + + + + + + + - + - + - + - + + + + - -
                                                                                                                                                                                        -
                                                                                                                                                                                        Returns:
                                                                                                                                                                                        - +
                                                                                                                                                                                        + + + + + -Array + + + + + + + +
                                                                                                                                                                                        NameTypeDescription
                                                                                                                                                                                        data + +Object + +

                                                                                                                                                                                        Response data from the failed request.

                                                                                                                                                                                        +
                                                                                                                                                                                        + + --

                                                                                                                                                                                        An array of artifact type strings.

                                                                                                                                                                                        + + + + - - @@ -752,14 +878,14 @@

                                                                                                                                                                                        Returns:
                                                                                                                                                                                        -

                                                                                                                                                                                        +

                                                                                                                                                                                        - static getInterestingPortals() → {Array} + static handleSuccess(data)

                                                                                                                                                                                        @@ -771,7 +897,7 @@

                                                                                                                                                                                        -

                                                                                                                                                                                        Gets the portals that are relevant to the artifacts.

                                                                                                                                                                                        +

                                                                                                                                                                                        Handles successful artifact data response from the server.

                                                                                                                                                                                        @@ -782,42 +908,71 @@

                                                                                                                                                                                        +
                                                                                                                                                                                        +
                                                                                                                                                                                        Parameters:
                                                                                                                                                                                        + + + + + + + - - - - - - - - - + - -
                                                                                                                                                                                        -
                                                                                                                                                                                        Returns:
                                                                                                                                                                                        - + +
                                                                                                                                                                                        + + -Array + + + + + + + --

                                                                                                                                                                                        An array of portal GUIDs.

                                                                                                                                                                                        + + + + + + +
                                                                                                                                                                                        NameTypeDescription
                                                                                                                                                                                        data + + +Object + +

                                                                                                                                                                                        Artifact data received from the server.

                                                                                                                                                                                        -
                                                                                                                                                                                        + + + + + + + + + + + +
                                                                                                                                                                                        @@ -862,14 +1017,14 @@
                                                                                                                                                                                        Returns:
                                                                                                                                                                                        -

                                                                                                                                                                                        +

                                                                                                                                                                                        - static getInterestingPortals() → {Array} + static idleResume()

                                                                                                                                                                                        @@ -881,7 +1036,7 @@

                                                                                                                                                                                        -

                                                                                                                                                                                        Gets the portals that are relevant to the artifacts.

                                                                                                                                                                                        +

                                                                                                                                                                                        Resumes artifact data requests when coming out of idle mode.

                                                                                                                                                                                        @@ -903,27 +1058,6 @@

                                                                                                                                                                                        - -
                                                                                                                                                                                        -
                                                                                                                                                                                        Returns:
                                                                                                                                                                                        - - - - - -Array - - - - - --

                                                                                                                                                                                        An array of portal GUIDs.

                                                                                                                                                                                        - - - - - -
                                                                                                                                                                                        @@ -972,14 +1106,14 @@

                                                                                                                                                                                        Returns:
                                                                                                                                                                                        -

                                                                                                                                                                                        +

                                                                                                                                                                                        - static getPortalData(guid, artifactId) → {Object|false} + static isArtifact(type) → {boolean}

                                                                                                                                                                                        @@ -991,7 +1125,7 @@

                                                                                                                                                                                        -

                                                                                                                                                                                        Retrieves the artifact data for a specified artifact id (e.g. 'jarvis'), if available.

                                                                                                                                                                                        +

                                                                                                                                                                                        Determines if a given type is a knowable artifact.

                                                                                                                                                                                        @@ -1027,30 +1161,7 @@

                                                                                                                                                                                        Parameters:
                                                                                                                                                                                        - guid - - - - - -string - - - - - - - - - -

                                                                                                                                                                                        The GUID of the portal.

                                                                                                                                                                                        - - - - - - - artifactId + type @@ -1066,7 +1177,7 @@
                                                                                                                                                                                        Parameters:
                                                                                                                                                                                        -

                                                                                                                                                                                        The ID of the artifact type.

                                                                                                                                                                                        +

                                                                                                                                                                                        The type to check.

                                                                                                                                                                                        @@ -1094,16 +1205,13 @@
                                                                                                                                                                                        Returns:
                                                                                                                                                                                        -Object -| - -false +boolean --

                                                                                                                                                                                        Artifact data for the specified portal and type, or undefined if not available.

                                                                                                                                                                                        +-

                                                                                                                                                                                        True if the type is an artifact, false otherwise.

                                                                                                                                                                                        @@ -1158,14 +1266,14 @@
                                                                                                                                                                                        Returns:
                                                                                                                                                                                        -

                                                                                                                                                                                        +

                                                                                                                                                                                        - static getPortalData(guid, artifactId) → {Object|false} + static isInterestingPortal(guid) → {boolean}

                                                                                                                                                                                        @@ -1177,7 +1285,7 @@

                                                                                                                                                                                        -

                                                                                                                                                                                        Retrieves the artifact data for a specified artifact id (e.g. 'jarvis'), if available.

                                                                                                                                                                                        +

                                                                                                                                                                                        Quickly checks if a portal is relevant to any type of artifacts.

                                                                                                                                                                                        @@ -1229,30 +1337,7 @@

                                                                                                                                                                                        Parameters:
                                                                                                                                                                                        -

                                                                                                                                                                                        The GUID of the portal.

                                                                                                                                                                                        - - - - - - - artifactId - - - - - -string - - - - - - - - - -

                                                                                                                                                                                        The ID of the artifact type.

                                                                                                                                                                                        +

                                                                                                                                                                                        The GUID of the portal to check.

                                                                                                                                                                                        @@ -1280,16 +1365,13 @@
                                                                                                                                                                                        Returns:
                                                                                                                                                                                        -Object -| - -false +boolean --

                                                                                                                                                                                        Artifact data for the specified portal and type, or undefined if not available.

                                                                                                                                                                                        +-

                                                                                                                                                                                        True if the portal is involved in artifacts, false otherwise.

                                                                                                                                                                                        @@ -1344,14 +1426,14 @@
                                                                                                                                                                                        Returns:
                                                                                                                                                                                        -

                                                                                                                                                                                        +

                                                                                                                                                                                        - static handleFailure(data) + static processData(data)

                                                                                                                                                                                        @@ -1363,7 +1445,7 @@

                                                                                                                                                                                        -

                                                                                                                                                                                        Handles failure in artifact data request. Schedules a new request after a short delay.

                                                                                                                                                                                        +

                                                                                                                                                                                        Processes artifact data. Clears previous data, processes new results, runs hooks, and updates the artifact layer.

                                                                                                                                                                                        @@ -1415,7 +1497,7 @@

                                                                                                                                                                                        Parameters:
                                                                                                                                                                                        -

                                                                                                                                                                                        Response data from the failed request.

                                                                                                                                                                                        +

                                                                                                                                                                                        Artifact data to process.

                                                                                                                                                                                        @@ -1483,14 +1565,14 @@
                                                                                                                                                                                        Parameters:
                                                                                                                                                                                        -

                                                                                                                                                                                        +

                                                                                                                                                                                        - static handleFailure(data) + static processResult(portals)

                                                                                                                                                                                        @@ -1502,7 +1584,7 @@

                                                                                                                                                                                        -

                                                                                                                                                                                        Handles failure in artifact data request. Schedules a new request after a short delay.

                                                                                                                                                                                        +

                                                                                                                                                                                        Processes the results from artifact portal data. Extracts and stores portal data for each artifact type.

                                                                                                                                                                                        @@ -1538,7 +1620,7 @@

                                                                                                                                                                                        Parameters:
                                                                                                                                                                                        - data + portals @@ -1554,7 +1636,7 @@
                                                                                                                                                                                        Parameters:
                                                                                                                                                                                        -

                                                                                                                                                                                        Response data from the failed request.

                                                                                                                                                                                        +

                                                                                                                                                                                        The artifact portal data.

                                                                                                                                                                                        @@ -1622,14 +1704,14 @@
                                                                                                                                                                                        Parameters:
                                                                                                                                                                                        -

                                                                                                                                                                                        +

                                                                                                                                                                                        - static handleSuccess(data) + static requestData()

                                                                                                                                                                                        @@ -1641,7 +1723,7 @@

                                                                                                                                                                                        -

                                                                                                                                                                                        Handles successful artifact data response from the server.

                                                                                                                                                                                        +

                                                                                                                                                                                        Requests artifact data from the server. If the map is in idle mode, sets a flag instead of sending a request.

                                                                                                                                                                                        @@ -1652,56 +1734,6 @@

                                                                                                                                                                                        -
                                                                                                                                                                                        -
                                                                                                                                                                                        Parameters:
                                                                                                                                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                        NameTypeDescription
                                                                                                                                                                                        data - - -Object - - - -

                                                                                                                                                                                        Artifact data received from the server.

                                                                                                                                                                                        - -
                                                                                                                                                                                        - @@ -1761,14 +1793,14 @@

                                                                                                                                                                                        Parameters:
                                                                                                                                                                                        -

                                                                                                                                                                                        +

                                                                                                                                                                                        - static handleSuccess(data) + static setup()

                                                                                                                                                                                        @@ -1780,7 +1812,7 @@

                                                                                                                                                                                        -

                                                                                                                                                                                        Handles successful artifact data response from the server.

                                                                                                                                                                                        +

                                                                                                                                                                                        Sets up artifact data fetching, layer creation, and UI elements.

                                                                                                                                                                                        @@ -1791,5845 +1823,23 @@

                                                                                                                                                                                        -
                                                                                                                                                                                        -
                                                                                                                                                                                        Parameters:
                                                                                                                                                                                        - - - - - - - - - - - - - - - - + - - - - - + - + - + - - - - - - -
                                                                                                                                                                                        NameTypeDescription
                                                                                                                                                                                        data - - -Object + + - -

                                                                                                                                                                                        Artifact data received from the server.

                                                                                                                                                                                        - -
                                                                                                                                                                                        - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                        - - - - -

                                                                                                                                                                                        - - - - -
                                                                                                                                                                                        - -

                                                                                                                                                                                        - - static idleResume() - - - - -

                                                                                                                                                                                        - - - -
                                                                                                                                                                                        -
                                                                                                                                                                                        - - -
                                                                                                                                                                                        -

                                                                                                                                                                                        Resumes artifact data requests when coming out of idle mode.

                                                                                                                                                                                        -
                                                                                                                                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                        - - - - -
                                                                                                                                                                                        - - - - -
                                                                                                                                                                                        - -

                                                                                                                                                                                        - - static idleResume() - - - - -

                                                                                                                                                                                        - - - -
                                                                                                                                                                                        -
                                                                                                                                                                                        - - -
                                                                                                                                                                                        -

                                                                                                                                                                                        Resumes artifact data requests when coming out of idle mode.

                                                                                                                                                                                        -
                                                                                                                                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                        - - - - -
                                                                                                                                                                                        - - - - -
                                                                                                                                                                                        - -

                                                                                                                                                                                        - - static isArtifact(type) → {boolean} - - - - -

                                                                                                                                                                                        - - - -
                                                                                                                                                                                        -
                                                                                                                                                                                        - - -
                                                                                                                                                                                        -

                                                                                                                                                                                        Determines if a given type is a knowable artifact.

                                                                                                                                                                                        -
                                                                                                                                                                                        - - - - - - - - - -
                                                                                                                                                                                        -
                                                                                                                                                                                        Parameters:
                                                                                                                                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                        NameTypeDescription
                                                                                                                                                                                        type - - -string - - - -

                                                                                                                                                                                        The type to check.

                                                                                                                                                                                        - -
                                                                                                                                                                                        - - - - - - - - - - - - - -
                                                                                                                                                                                        -
                                                                                                                                                                                        Returns:
                                                                                                                                                                                        - - - - - -boolean - - - - - --

                                                                                                                                                                                        True if the type is an artifact, false otherwise.

                                                                                                                                                                                        - - - - - -
                                                                                                                                                                                        - - - - - -
                                                                                                                                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                        - - - - -
                                                                                                                                                                                        - - - - -
                                                                                                                                                                                        - -

                                                                                                                                                                                        - - static isArtifact(type) → {boolean} - - - - -

                                                                                                                                                                                        - - - -
                                                                                                                                                                                        -
                                                                                                                                                                                        - - -
                                                                                                                                                                                        -

                                                                                                                                                                                        Determines if a given type is a knowable artifact.

                                                                                                                                                                                        -
                                                                                                                                                                                        - - - - - - - - - -
                                                                                                                                                                                        -
                                                                                                                                                                                        Parameters:
                                                                                                                                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                        NameTypeDescription
                                                                                                                                                                                        type - - -string - - - -

                                                                                                                                                                                        The type to check.

                                                                                                                                                                                        - -
                                                                                                                                                                                        - - - - - - - - - - - - - -
                                                                                                                                                                                        -
                                                                                                                                                                                        Returns:
                                                                                                                                                                                        - - - - - -boolean - - - - - --

                                                                                                                                                                                        True if the type is an artifact, false otherwise.

                                                                                                                                                                                        - - - - - -
                                                                                                                                                                                        - - - - - -
                                                                                                                                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                        - - - - -
                                                                                                                                                                                        - - - - -
                                                                                                                                                                                        - -

                                                                                                                                                                                        - - static isInterestingPortal(guid) → {boolean} - - - - -

                                                                                                                                                                                        - - - -
                                                                                                                                                                                        -
                                                                                                                                                                                        - - -
                                                                                                                                                                                        -

                                                                                                                                                                                        Quickly checks if a portal is relevant to any type of artifacts.

                                                                                                                                                                                        -
                                                                                                                                                                                        - - - - - - - - - -
                                                                                                                                                                                        -
                                                                                                                                                                                        Parameters:
                                                                                                                                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                        NameTypeDescription
                                                                                                                                                                                        guid - - -string - - - -

                                                                                                                                                                                        The GUID of the portal to check.

                                                                                                                                                                                        - -
                                                                                                                                                                                        - - - - - - - - - - - - - -
                                                                                                                                                                                        -
                                                                                                                                                                                        Returns:
                                                                                                                                                                                        - - - - - -boolean - - - - - --

                                                                                                                                                                                        True if the portal is involved in artifacts, false otherwise.

                                                                                                                                                                                        - - - - - -
                                                                                                                                                                                        - - - - - -
                                                                                                                                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                        - - - - -
                                                                                                                                                                                        - - - - -
                                                                                                                                                                                        - -

                                                                                                                                                                                        - - static isInterestingPortal(guid) → {boolean} - - - - -

                                                                                                                                                                                        - - - -
                                                                                                                                                                                        -
                                                                                                                                                                                        - - -
                                                                                                                                                                                        -

                                                                                                                                                                                        Quickly checks if a portal is relevant to any type of artifacts.

                                                                                                                                                                                        -
                                                                                                                                                                                        - - - - - - - - - -
                                                                                                                                                                                        -
                                                                                                                                                                                        Parameters:
                                                                                                                                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                        NameTypeDescription
                                                                                                                                                                                        guid - - -string - - - -

                                                                                                                                                                                        The GUID of the portal to check.

                                                                                                                                                                                        - -
                                                                                                                                                                                        - - - - - - - - - - - - - -
                                                                                                                                                                                        -
                                                                                                                                                                                        Returns:
                                                                                                                                                                                        - - - - - -boolean - - - - - --

                                                                                                                                                                                        True if the portal is involved in artifacts, false otherwise.

                                                                                                                                                                                        - - - - - -
                                                                                                                                                                                        - - - - - -
                                                                                                                                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                        - - - - -
                                                                                                                                                                                        - - - - -
                                                                                                                                                                                        - -

                                                                                                                                                                                        - - static processData(data) - - - - -

                                                                                                                                                                                        - - - -
                                                                                                                                                                                        -
                                                                                                                                                                                        - - -
                                                                                                                                                                                        -

                                                                                                                                                                                        Processes artifact data. Clears previous data, processes new results, runs hooks, and updates the artifact layer.

                                                                                                                                                                                        -
                                                                                                                                                                                        - - - - - - - - - -
                                                                                                                                                                                        -
                                                                                                                                                                                        Parameters:
                                                                                                                                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                        NameTypeDescription
                                                                                                                                                                                        data - - -Object - - - -

                                                                                                                                                                                        Artifact data to process.

                                                                                                                                                                                        - -
                                                                                                                                                                                        - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                        - - - - -
                                                                                                                                                                                        - - - - -
                                                                                                                                                                                        - -

                                                                                                                                                                                        - - static processData(data) - - - - -

                                                                                                                                                                                        - - - -
                                                                                                                                                                                        -
                                                                                                                                                                                        - - -
                                                                                                                                                                                        -

                                                                                                                                                                                        Processes artifact data. Clears previous data, processes new results, runs hooks, and updates the artifact layer.

                                                                                                                                                                                        -
                                                                                                                                                                                        - - - - - - - - - -
                                                                                                                                                                                        -
                                                                                                                                                                                        Parameters:
                                                                                                                                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                        NameTypeDescription
                                                                                                                                                                                        data - - -Object - - - -

                                                                                                                                                                                        Artifact data to process.

                                                                                                                                                                                        - -
                                                                                                                                                                                        - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                        - - - - -
                                                                                                                                                                                        - - - - -
                                                                                                                                                                                        - -

                                                                                                                                                                                        - - static processResult(portals) - - - - -

                                                                                                                                                                                        - - - -
                                                                                                                                                                                        -
                                                                                                                                                                                        - - -
                                                                                                                                                                                        -

                                                                                                                                                                                        Processes the results from artifact portal data. Extracts and stores portal data for each artifact type.

                                                                                                                                                                                        -
                                                                                                                                                                                        - - - - - - - - - -
                                                                                                                                                                                        -
                                                                                                                                                                                        Parameters:
                                                                                                                                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                        NameTypeDescription
                                                                                                                                                                                        portals - - -Object - - - -

                                                                                                                                                                                        The artifact portal data.

                                                                                                                                                                                        - -
                                                                                                                                                                                        - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                        - - - - -
                                                                                                                                                                                        - - - - -
                                                                                                                                                                                        - -

                                                                                                                                                                                        - - static processResult(portals) - - - - -

                                                                                                                                                                                        - - - -
                                                                                                                                                                                        -
                                                                                                                                                                                        - - -
                                                                                                                                                                                        -

                                                                                                                                                                                        Processes the results from artifact portal data. Extracts and stores portal data for each artifact type.

                                                                                                                                                                                        -
                                                                                                                                                                                        - - - - - - - - - -
                                                                                                                                                                                        -
                                                                                                                                                                                        Parameters:
                                                                                                                                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                        NameTypeDescription
                                                                                                                                                                                        portals - - -Object - - - -

                                                                                                                                                                                        The artifact portal data.

                                                                                                                                                                                        - -
                                                                                                                                                                                        - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                        - - - - -
                                                                                                                                                                                        - - - - -
                                                                                                                                                                                        - -

                                                                                                                                                                                        - - static requestData() - - - - -

                                                                                                                                                                                        - - - -
                                                                                                                                                                                        -
                                                                                                                                                                                        - - -
                                                                                                                                                                                        -

                                                                                                                                                                                        Requests artifact data from the server. If the map is in idle mode, sets a flag instead of sending a request.

                                                                                                                                                                                        -
                                                                                                                                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                        - - - - -
                                                                                                                                                                                        - - - - -
                                                                                                                                                                                        - -

                                                                                                                                                                                        - - static requestData() - - - - -

                                                                                                                                                                                        - - - -
                                                                                                                                                                                        -
                                                                                                                                                                                        - - -
                                                                                                                                                                                        -

                                                                                                                                                                                        Requests artifact data from the server. If the map is in idle mode, sets a flag instead of sending a request.

                                                                                                                                                                                        -
                                                                                                                                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                        - - - - -
                                                                                                                                                                                        - - - - -
                                                                                                                                                                                        - -

                                                                                                                                                                                        - - static setup() - - - - -

                                                                                                                                                                                        - - - -
                                                                                                                                                                                        -
                                                                                                                                                                                        - - -
                                                                                                                                                                                        -

                                                                                                                                                                                        Sets up artifact data fetching, layer creation, and UI elements.

                                                                                                                                                                                        -
                                                                                                                                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                        - - - - -
                                                                                                                                                                                        - - - - -
                                                                                                                                                                                        - -

                                                                                                                                                                                        - - static setup() - - - - -

                                                                                                                                                                                        - - - -
                                                                                                                                                                                        -
                                                                                                                                                                                        - - -
                                                                                                                                                                                        -

                                                                                                                                                                                        Sets up artifact data fetching, layer creation, and UI elements.

                                                                                                                                                                                        -
                                                                                                                                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                        - - - - -
                                                                                                                                                                                        - - - - -
                                                                                                                                                                                        - -

                                                                                                                                                                                        - - static showArtifactList() - - - - -

                                                                                                                                                                                        - - - -
                                                                                                                                                                                        -
                                                                                                                                                                                        - - -
                                                                                                                                                                                        -

                                                                                                                                                                                        Displays a dialog listing all portals involved with artifacts, organized by artifact types.

                                                                                                                                                                                        -
                                                                                                                                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                        - - - - -
                                                                                                                                                                                        - - - - -
                                                                                                                                                                                        - -

                                                                                                                                                                                        - - static showArtifactList() - - - - -

                                                                                                                                                                                        - - - -
                                                                                                                                                                                        -
                                                                                                                                                                                        - - -
                                                                                                                                                                                        -

                                                                                                                                                                                        Displays a dialog listing all portals involved with artifacts, organized by artifact types.

                                                                                                                                                                                        -
                                                                                                                                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                        - - - - -
                                                                                                                                                                                        - - - - -
                                                                                                                                                                                        - -

                                                                                                                                                                                        - - static updateLayer() - - - - -

                                                                                                                                                                                        - - - -
                                                                                                                                                                                        -
                                                                                                                                                                                        - - -
                                                                                                                                                                                        -

                                                                                                                                                                                        Updates the artifact layer on the map based on the current artifact data.

                                                                                                                                                                                        -
                                                                                                                                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                        - - - - -
                                                                                                                                                                                        - - - - -
                                                                                                                                                                                        - -

                                                                                                                                                                                        - - static updateLayer() - - - - -

                                                                                                                                                                                        - - - -
                                                                                                                                                                                        -
                                                                                                                                                                                        - - -
                                                                                                                                                                                        -

                                                                                                                                                                                        Updates the artifact layer on the map based on the current artifact data.

                                                                                                                                                                                        -
                                                                                                                                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                        - - - - -
                                                                                                                                                                                        - - - - - - - -
                                                                                                                                                                                        - -
                                                                                                                                                                                        - - - - - - - -
                                                                                                                                                                                        - -
                                                                                                                                                                                        - -

                                                                                                                                                                                        window.artifact

                                                                                                                                                                                        - - -
                                                                                                                                                                                        - -
                                                                                                                                                                                        - -
                                                                                                                                                                                        - - -

                                                                                                                                                                                        Provides functions related to Ingress artifacts, including setup, data request, and processing functions. -Added as part of the ingress #13magnus in november 2013, artifacts -are additional game elements overlayed on the intel map

                                                                                                                                                                                        -

                                                                                                                                                                                        currently there are only jarvis-related entities

                                                                                                                                                                                        -
                                                                                                                                                                                          -
                                                                                                                                                                                        • shards: move between portals (along links) each hour. more than one can be at a portal.
                                                                                                                                                                                        • -
                                                                                                                                                                                        • targets: specific portals - one per team.
                                                                                                                                                                                        • -
                                                                                                                                                                                        -

                                                                                                                                                                                        The artifact data includes details for the specific portals, so can be useful. -2014-02-06: intel site updates hint at new 'amar artifacts', likely following the same system as above

                                                                                                                                                                                        - - - - - -
                                                                                                                                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                        - - - - -
                                                                                                                                                                                        - - - - - - - - - - - - - - - - - -

                                                                                                                                                                                        Methods

                                                                                                                                                                                        - -
                                                                                                                                                                                        - - -
                                                                                                                                                                                        - -

                                                                                                                                                                                        - - static clearData() - - - - -

                                                                                                                                                                                        - - - -
                                                                                                                                                                                        -
                                                                                                                                                                                        - - -
                                                                                                                                                                                        -

                                                                                                                                                                                        Clears all stored artifact data.

                                                                                                                                                                                        -
                                                                                                                                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                        - - - - -
                                                                                                                                                                                        - - - - -
                                                                                                                                                                                        - -

                                                                                                                                                                                        - - static clearData() - - - - -

                                                                                                                                                                                        - - - -
                                                                                                                                                                                        -
                                                                                                                                                                                        - - -
                                                                                                                                                                                        -

                                                                                                                                                                                        Clears all stored artifact data.

                                                                                                                                                                                        -
                                                                                                                                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                        - - - - -
                                                                                                                                                                                        - - - - -
                                                                                                                                                                                        - -

                                                                                                                                                                                        - - static getArtifactEntities() → {Array} - - - - -

                                                                                                                                                                                        - - - -
                                                                                                                                                                                        -
                                                                                                                                                                                        - - -
                                                                                                                                                                                        -

                                                                                                                                                                                        Used to render portals that would otherwise be below the visible level.

                                                                                                                                                                                        -
                                                                                                                                                                                        - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                        -
                                                                                                                                                                                        Returns:
                                                                                                                                                                                        - - - - - -Array - - - - - --

                                                                                                                                                                                        An array of artifact entities.

                                                                                                                                                                                        - - - - - -
                                                                                                                                                                                        - - - - - -
                                                                                                                                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                        - - - - -
                                                                                                                                                                                        - - - - -
                                                                                                                                                                                        - -

                                                                                                                                                                                        - - static getArtifactEntities() → {Array} - - - - -

                                                                                                                                                                                        - - - -
                                                                                                                                                                                        -
                                                                                                                                                                                        - - -
                                                                                                                                                                                        -

                                                                                                                                                                                        Used to render portals that would otherwise be below the visible level.

                                                                                                                                                                                        -
                                                                                                                                                                                        - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                        -
                                                                                                                                                                                        Returns:
                                                                                                                                                                                        - - - - - -Array - - - - - --

                                                                                                                                                                                        An array of artifact entities.

                                                                                                                                                                                        - - - - - -
                                                                                                                                                                                        - - - - - -
                                                                                                                                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                        - - - - -
                                                                                                                                                                                        - - - - -
                                                                                                                                                                                        - -

                                                                                                                                                                                        - - static getArtifactTypes() → {Array} - - - - -

                                                                                                                                                                                        - - - -
                                                                                                                                                                                        -
                                                                                                                                                                                        - - -
                                                                                                                                                                                        -

                                                                                                                                                                                        Returns the types of artifacts currently known.

                                                                                                                                                                                        -
                                                                                                                                                                                        - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                        -
                                                                                                                                                                                        Returns:
                                                                                                                                                                                        - - - - - -Array - - - - - --

                                                                                                                                                                                        An array of artifact type strings.

                                                                                                                                                                                        - - - - - -
                                                                                                                                                                                        - - - - - -
                                                                                                                                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                        - - - - -
                                                                                                                                                                                        - - - - -
                                                                                                                                                                                        - -

                                                                                                                                                                                        - - static getArtifactTypes() → {Array} - - - - -

                                                                                                                                                                                        - - - -
                                                                                                                                                                                        -
                                                                                                                                                                                        - - -
                                                                                                                                                                                        -

                                                                                                                                                                                        Returns the types of artifacts currently known.

                                                                                                                                                                                        -
                                                                                                                                                                                        - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                        -
                                                                                                                                                                                        Returns:
                                                                                                                                                                                        - - - - - -Array - - - - - --

                                                                                                                                                                                        An array of artifact type strings.

                                                                                                                                                                                        - - - - - -
                                                                                                                                                                                        - - - - - -
                                                                                                                                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                        - - - - -
                                                                                                                                                                                        - - - - -
                                                                                                                                                                                        - -

                                                                                                                                                                                        - - static getInterestingPortals() → {Array} - - - - -

                                                                                                                                                                                        - - - -
                                                                                                                                                                                        -
                                                                                                                                                                                        - - -
                                                                                                                                                                                        -

                                                                                                                                                                                        Gets the portals that are relevant to the artifacts.

                                                                                                                                                                                        -
                                                                                                                                                                                        - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                        -
                                                                                                                                                                                        Returns:
                                                                                                                                                                                        - - - - - -Array - - - - - --

                                                                                                                                                                                        An array of portal GUIDs.

                                                                                                                                                                                        - - - - - -
                                                                                                                                                                                        - - - - - -
                                                                                                                                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                        - - - - -
                                                                                                                                                                                        - - - - -
                                                                                                                                                                                        - -

                                                                                                                                                                                        - - static getInterestingPortals() → {Array} - - - - -

                                                                                                                                                                                        - - - -
                                                                                                                                                                                        -
                                                                                                                                                                                        - - -
                                                                                                                                                                                        -

                                                                                                                                                                                        Gets the portals that are relevant to the artifacts.

                                                                                                                                                                                        -
                                                                                                                                                                                        - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                        -
                                                                                                                                                                                        Returns:
                                                                                                                                                                                        - - - - - -Array - - - - - --

                                                                                                                                                                                        An array of portal GUIDs.

                                                                                                                                                                                        - - - - - -
                                                                                                                                                                                        - - - - - -
                                                                                                                                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                        - - - - -
                                                                                                                                                                                        - - - - -
                                                                                                                                                                                        - -

                                                                                                                                                                                        - - static getPortalData(guid, artifactId) → {Object|false} - - - - -

                                                                                                                                                                                        - - - -
                                                                                                                                                                                        -
                                                                                                                                                                                        - - -
                                                                                                                                                                                        -

                                                                                                                                                                                        Retrieves the artifact data for a specified artifact id (e.g. 'jarvis'), if available.

                                                                                                                                                                                        -
                                                                                                                                                                                        - - - - - - - - - -
                                                                                                                                                                                        -
                                                                                                                                                                                        Parameters:
                                                                                                                                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                        NameTypeDescription
                                                                                                                                                                                        guid - - -string - - - -

                                                                                                                                                                                        The GUID of the portal.

                                                                                                                                                                                        artifactId - - -string - - - -

                                                                                                                                                                                        The ID of the artifact type.

                                                                                                                                                                                        - -
                                                                                                                                                                                        - - - - - - - - - - - - - -
                                                                                                                                                                                        -
                                                                                                                                                                                        Returns:
                                                                                                                                                                                        - - - - - -Object -| - -false - - - - - --

                                                                                                                                                                                        Artifact data for the specified portal and type, or undefined if not available.

                                                                                                                                                                                        - - - - - -
                                                                                                                                                                                        - - - - - -
                                                                                                                                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                        - - - - -
                                                                                                                                                                                        - - - - -
                                                                                                                                                                                        - -

                                                                                                                                                                                        - - static getPortalData(guid, artifactId) → {Object|false} - - - - -

                                                                                                                                                                                        - - - -
                                                                                                                                                                                        -
                                                                                                                                                                                        - - -
                                                                                                                                                                                        -

                                                                                                                                                                                        Retrieves the artifact data for a specified artifact id (e.g. 'jarvis'), if available.

                                                                                                                                                                                        -
                                                                                                                                                                                        - - - - - - - - - -
                                                                                                                                                                                        -
                                                                                                                                                                                        Parameters:
                                                                                                                                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                        NameTypeDescription
                                                                                                                                                                                        guid - - -string - - - -

                                                                                                                                                                                        The GUID of the portal.

                                                                                                                                                                                        artifactId - - -string - - - -

                                                                                                                                                                                        The ID of the artifact type.

                                                                                                                                                                                        - -
                                                                                                                                                                                        - - - - - - - - - - - - - -
                                                                                                                                                                                        -
                                                                                                                                                                                        Returns:
                                                                                                                                                                                        - - - - - -Object -| - -false - - - - - --

                                                                                                                                                                                        Artifact data for the specified portal and type, or undefined if not available.

                                                                                                                                                                                        - - - - - -
                                                                                                                                                                                        - - - - - -
                                                                                                                                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                        - - - - -
                                                                                                                                                                                        - - - - -
                                                                                                                                                                                        - -

                                                                                                                                                                                        - - static handleFailure(data) - - - - -

                                                                                                                                                                                        - - - -
                                                                                                                                                                                        -
                                                                                                                                                                                        - - -
                                                                                                                                                                                        -

                                                                                                                                                                                        Handles failure in artifact data request. Schedules a new request after a short delay.

                                                                                                                                                                                        -
                                                                                                                                                                                        - - - - - - - - - -
                                                                                                                                                                                        -
                                                                                                                                                                                        Parameters:
                                                                                                                                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                        NameTypeDescription
                                                                                                                                                                                        data - - -Object - - - -

                                                                                                                                                                                        Response data from the failed request.

                                                                                                                                                                                        - -
                                                                                                                                                                                        - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                        - - - - -
                                                                                                                                                                                        - - - - -
                                                                                                                                                                                        - -

                                                                                                                                                                                        - - static handleFailure(data) - - - - -

                                                                                                                                                                                        - - - -
                                                                                                                                                                                        -
                                                                                                                                                                                        - - -
                                                                                                                                                                                        -

                                                                                                                                                                                        Handles failure in artifact data request. Schedules a new request after a short delay.

                                                                                                                                                                                        -
                                                                                                                                                                                        - - - - - - - - - -
                                                                                                                                                                                        -
                                                                                                                                                                                        Parameters:
                                                                                                                                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                        NameTypeDescription
                                                                                                                                                                                        data - - -Object - - - -

                                                                                                                                                                                        Response data from the failed request.

                                                                                                                                                                                        - -
                                                                                                                                                                                        - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                        - - - - -
                                                                                                                                                                                        - - - - -
                                                                                                                                                                                        - -

                                                                                                                                                                                        - - static handleSuccess(data) - - - - -

                                                                                                                                                                                        - - - -
                                                                                                                                                                                        -
                                                                                                                                                                                        - - -
                                                                                                                                                                                        -

                                                                                                                                                                                        Handles successful artifact data response from the server.

                                                                                                                                                                                        -
                                                                                                                                                                                        - - - - - - - - - -
                                                                                                                                                                                        -
                                                                                                                                                                                        Parameters:
                                                                                                                                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                        NameTypeDescription
                                                                                                                                                                                        data - - -Object - - - -

                                                                                                                                                                                        Artifact data received from the server.

                                                                                                                                                                                        - -
                                                                                                                                                                                        - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                        - - - - -
                                                                                                                                                                                        - - - - -
                                                                                                                                                                                        - -

                                                                                                                                                                                        - - static handleSuccess(data) - - - - -

                                                                                                                                                                                        - - - -
                                                                                                                                                                                        -
                                                                                                                                                                                        - - -
                                                                                                                                                                                        -

                                                                                                                                                                                        Handles successful artifact data response from the server.

                                                                                                                                                                                        -
                                                                                                                                                                                        - - - - - - - - - -
                                                                                                                                                                                        -
                                                                                                                                                                                        Parameters:
                                                                                                                                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                        NameTypeDescription
                                                                                                                                                                                        data - - -Object - - - -

                                                                                                                                                                                        Artifact data received from the server.

                                                                                                                                                                                        - -
                                                                                                                                                                                        - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                        - - - - -
                                                                                                                                                                                        - - - - -
                                                                                                                                                                                        - -

                                                                                                                                                                                        - - static idleResume() - - - - -

                                                                                                                                                                                        - - - -
                                                                                                                                                                                        -
                                                                                                                                                                                        - - -
                                                                                                                                                                                        -

                                                                                                                                                                                        Resumes artifact data requests when coming out of idle mode.

                                                                                                                                                                                        -
                                                                                                                                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                        - - - - -
                                                                                                                                                                                        - - - - -
                                                                                                                                                                                        - -

                                                                                                                                                                                        - - static idleResume() - - - - -

                                                                                                                                                                                        - - - -
                                                                                                                                                                                        -
                                                                                                                                                                                        - - -
                                                                                                                                                                                        -

                                                                                                                                                                                        Resumes artifact data requests when coming out of idle mode.

                                                                                                                                                                                        -
                                                                                                                                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                        - - - - -
                                                                                                                                                                                        - - - - -
                                                                                                                                                                                        - -

                                                                                                                                                                                        - - static isArtifact(type) → {boolean} - - - - -

                                                                                                                                                                                        - - - -
                                                                                                                                                                                        -
                                                                                                                                                                                        - - -
                                                                                                                                                                                        -

                                                                                                                                                                                        Determines if a given type is a knowable artifact.

                                                                                                                                                                                        -
                                                                                                                                                                                        - - - - - - - - - -
                                                                                                                                                                                        -
                                                                                                                                                                                        Parameters:
                                                                                                                                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                        NameTypeDescription
                                                                                                                                                                                        type - - -string - - - -

                                                                                                                                                                                        The type to check.

                                                                                                                                                                                        - -
                                                                                                                                                                                        - - - - - - - - - - - - - -
                                                                                                                                                                                        -
                                                                                                                                                                                        Returns:
                                                                                                                                                                                        - - - - - -boolean - - - - - --

                                                                                                                                                                                        True if the type is an artifact, false otherwise.

                                                                                                                                                                                        - - - - - -
                                                                                                                                                                                        - - - - - -
                                                                                                                                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                        - - - - -
                                                                                                                                                                                        - - - - -
                                                                                                                                                                                        - -

                                                                                                                                                                                        - - static isArtifact(type) → {boolean} - - - - -

                                                                                                                                                                                        - - - -
                                                                                                                                                                                        -
                                                                                                                                                                                        - - -
                                                                                                                                                                                        -

                                                                                                                                                                                        Determines if a given type is a knowable artifact.

                                                                                                                                                                                        -
                                                                                                                                                                                        - - - - - - - - - -
                                                                                                                                                                                        -
                                                                                                                                                                                        Parameters:
                                                                                                                                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                        NameTypeDescription
                                                                                                                                                                                        type - - -string - - - -

                                                                                                                                                                                        The type to check.

                                                                                                                                                                                        - -
                                                                                                                                                                                        - - - - - - - - - - - - - -
                                                                                                                                                                                        -
                                                                                                                                                                                        Returns:
                                                                                                                                                                                        - - - - - -boolean - - - - - --

                                                                                                                                                                                        True if the type is an artifact, false otherwise.

                                                                                                                                                                                        - - - - - -
                                                                                                                                                                                        - - - - - -
                                                                                                                                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                        - - - - -
                                                                                                                                                                                        - - - - -
                                                                                                                                                                                        - -

                                                                                                                                                                                        - - static isInterestingPortal(guid) → {boolean} - - - - -

                                                                                                                                                                                        - - - -
                                                                                                                                                                                        -
                                                                                                                                                                                        - - -
                                                                                                                                                                                        -

                                                                                                                                                                                        Quickly checks if a portal is relevant to any type of artifacts.

                                                                                                                                                                                        -
                                                                                                                                                                                        - - - - - - - - - -
                                                                                                                                                                                        -
                                                                                                                                                                                        Parameters:
                                                                                                                                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                        NameTypeDescription
                                                                                                                                                                                        guid - - -string - - - -

                                                                                                                                                                                        The GUID of the portal to check.

                                                                                                                                                                                        - -
                                                                                                                                                                                        - - - - - - - - - - - - - -
                                                                                                                                                                                        -
                                                                                                                                                                                        Returns:
                                                                                                                                                                                        - - - - - -boolean - - - - - --

                                                                                                                                                                                        True if the portal is involved in artifacts, false otherwise.

                                                                                                                                                                                        - - - - - -
                                                                                                                                                                                        - - - - - -
                                                                                                                                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                        - - - - -
                                                                                                                                                                                        - - - - -
                                                                                                                                                                                        - -

                                                                                                                                                                                        - - static isInterestingPortal(guid) → {boolean} - - - - -

                                                                                                                                                                                        - - - -
                                                                                                                                                                                        -
                                                                                                                                                                                        - - -
                                                                                                                                                                                        -

                                                                                                                                                                                        Quickly checks if a portal is relevant to any type of artifacts.

                                                                                                                                                                                        -
                                                                                                                                                                                        - - - - - - - - - -
                                                                                                                                                                                        -
                                                                                                                                                                                        Parameters:
                                                                                                                                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                        NameTypeDescription
                                                                                                                                                                                        guid - - -string - - - -

                                                                                                                                                                                        The GUID of the portal to check.

                                                                                                                                                                                        - -
                                                                                                                                                                                        - - - - - - - - - - - - - -
                                                                                                                                                                                        -
                                                                                                                                                                                        Returns:
                                                                                                                                                                                        - - - - - -boolean - - - - - --

                                                                                                                                                                                        True if the portal is involved in artifacts, false otherwise.

                                                                                                                                                                                        - - - - - -
                                                                                                                                                                                        - - - - - -
                                                                                                                                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                        - - - - -
                                                                                                                                                                                        - - - - -
                                                                                                                                                                                        - -

                                                                                                                                                                                        - - static processData(data) - - - - -

                                                                                                                                                                                        - - - -
                                                                                                                                                                                        -
                                                                                                                                                                                        - - -
                                                                                                                                                                                        -

                                                                                                                                                                                        Processes artifact data. Clears previous data, processes new results, runs hooks, and updates the artifact layer.

                                                                                                                                                                                        -
                                                                                                                                                                                        - - - - - - - - - -
                                                                                                                                                                                        -
                                                                                                                                                                                        Parameters:
                                                                                                                                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                        NameTypeDescription
                                                                                                                                                                                        data - - -Object - - - -

                                                                                                                                                                                        Artifact data to process.

                                                                                                                                                                                        - -
                                                                                                                                                                                        - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                        - - - - -
                                                                                                                                                                                        - - - - -
                                                                                                                                                                                        - -

                                                                                                                                                                                        - - static processData(data) - - - - -

                                                                                                                                                                                        - - - -
                                                                                                                                                                                        -
                                                                                                                                                                                        - - -
                                                                                                                                                                                        -

                                                                                                                                                                                        Processes artifact data. Clears previous data, processes new results, runs hooks, and updates the artifact layer.

                                                                                                                                                                                        -
                                                                                                                                                                                        - - - - - - - - - -
                                                                                                                                                                                        -
                                                                                                                                                                                        Parameters:
                                                                                                                                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                        NameTypeDescription
                                                                                                                                                                                        data - - -Object - - - -

                                                                                                                                                                                        Artifact data to process.

                                                                                                                                                                                        - -
                                                                                                                                                                                        - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                        - - - - -
                                                                                                                                                                                        - - - - -
                                                                                                                                                                                        - -

                                                                                                                                                                                        - - static processResult(portals) - - - - -

                                                                                                                                                                                        - - - -
                                                                                                                                                                                        -
                                                                                                                                                                                        - - -
                                                                                                                                                                                        -

                                                                                                                                                                                        Processes the results from artifact portal data. Extracts and stores portal data for each artifact type.

                                                                                                                                                                                        -
                                                                                                                                                                                        - - - - - - - - - -
                                                                                                                                                                                        -
                                                                                                                                                                                        Parameters:
                                                                                                                                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                        NameTypeDescription
                                                                                                                                                                                        portals - - -Object - - - -

                                                                                                                                                                                        The artifact portal data.

                                                                                                                                                                                        - -
                                                                                                                                                                                        - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                        - - - - -
                                                                                                                                                                                        - - - - -
                                                                                                                                                                                        - -

                                                                                                                                                                                        - - static processResult(portals) - - - - -

                                                                                                                                                                                        - - - -
                                                                                                                                                                                        -
                                                                                                                                                                                        - - -
                                                                                                                                                                                        -

                                                                                                                                                                                        Processes the results from artifact portal data. Extracts and stores portal data for each artifact type.

                                                                                                                                                                                        -
                                                                                                                                                                                        - - - - - - - - - -
                                                                                                                                                                                        -
                                                                                                                                                                                        Parameters:
                                                                                                                                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                        NameTypeDescription
                                                                                                                                                                                        portals - - -Object - - - -

                                                                                                                                                                                        The artifact portal data.

                                                                                                                                                                                        - -
                                                                                                                                                                                        - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                        - - - - -
                                                                                                                                                                                        - - - - -
                                                                                                                                                                                        - -

                                                                                                                                                                                        - - static requestData() - - - - -

                                                                                                                                                                                        - - - -
                                                                                                                                                                                        -
                                                                                                                                                                                        - - -
                                                                                                                                                                                        -

                                                                                                                                                                                        Requests artifact data from the server. If the map is in idle mode, sets a flag instead of sending a request.

                                                                                                                                                                                        -
                                                                                                                                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                        - - - - -
                                                                                                                                                                                        - - - - -
                                                                                                                                                                                        - -

                                                                                                                                                                                        - - static requestData() - - - - -

                                                                                                                                                                                        - - - -
                                                                                                                                                                                        -
                                                                                                                                                                                        - - -
                                                                                                                                                                                        -

                                                                                                                                                                                        Requests artifact data from the server. If the map is in idle mode, sets a flag instead of sending a request.

                                                                                                                                                                                        -
                                                                                                                                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                        - - - - -
                                                                                                                                                                                        - - - - -
                                                                                                                                                                                        - -

                                                                                                                                                                                        - - static setup() - - - - -

                                                                                                                                                                                        - - - -
                                                                                                                                                                                        -
                                                                                                                                                                                        - - -
                                                                                                                                                                                        -

                                                                                                                                                                                        Sets up artifact data fetching, layer creation, and UI elements.

                                                                                                                                                                                        -
                                                                                                                                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                        - - - - -
                                                                                                                                                                                        - - - - -
                                                                                                                                                                                        - -

                                                                                                                                                                                        - - static setup() - - - - -

                                                                                                                                                                                        - - - -
                                                                                                                                                                                        -
                                                                                                                                                                                        - - -
                                                                                                                                                                                        -

                                                                                                                                                                                        Sets up artifact data fetching, layer creation, and UI elements.

                                                                                                                                                                                        -
                                                                                                                                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                        - - - - -
                                                                                                                                                                                        - - - - -
                                                                                                                                                                                        - -

                                                                                                                                                                                        - - static showArtifactList() - - - - -

                                                                                                                                                                                        - - - -
                                                                                                                                                                                        -
                                                                                                                                                                                        - - -
                                                                                                                                                                                        -

                                                                                                                                                                                        Displays a dialog listing all portals involved with artifacts, organized by artifact types.

                                                                                                                                                                                        -
                                                                                                                                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                        +
                                                                                                                                                                                        @@ -7828,95 +2038,6 @@

                                                                                                                                                                                        - - - - - - - - - - -

                                                                                                                                                                                        - - - - -
                                                                                                                                                                                        - - - - -
                                                                                                                                                                                        - -

                                                                                                                                                                                        - - static updateLayer() - - - - -

                                                                                                                                                                                        - - - -
                                                                                                                                                                                        -
                                                                                                                                                                                        - - -
                                                                                                                                                                                        -

                                                                                                                                                                                        Updates the artifact layer on the map based on the current artifact data.

                                                                                                                                                                                        -
                                                                                                                                                                                        - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                        - - - - - - - - - - - - - - - - - - - - diff --git a/window.chat.html b/window.chat.html index 738cd7408..e440f08da 100644 --- a/window.chat.html +++ b/window.chat.html @@ -34,7 +34,7 @@

                                                                                                                                                                                        IITC-CE

                                                                                                                                                                                          - +
                                                                                                                                                                                          @@ -179,164 +179,6 @@
                                                                                                                                                                                          Type:
                                                                                                                                                                                          - - - - - - - - - - -
                                                                                                                                                                                          - - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          -

                                                                                                                                                                                          - static _alerts :Object - - - -

                                                                                                                                                                                          - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          - -
                                                                                                                                                                                          -

                                                                                                                                                                                          Holds data related to alerts chat.

                                                                                                                                                                                          -
                                                                                                                                                                                          - - - - - - - -
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          - - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          -

                                                                                                                                                                                          - static _faction :Object - - - -

                                                                                                                                                                                          - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          - -
                                                                                                                                                                                          -

                                                                                                                                                                                          Holds data related to faction chat.

                                                                                                                                                                                          -
                                                                                                                                                                                          - - - - - - - -
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - @@ -495,85 +337,6 @@
                                                                                                                                                                                          Type:
                                                                                                                                                                                          - - - - - - - - - - -
                                                                                                                                                                                          - - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          -

                                                                                                                                                                                          - static _public :Object - - - -

                                                                                                                                                                                          - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          - -
                                                                                                                                                                                          -

                                                                                                                                                                                          Holds data related to public chat.

                                                                                                                                                                                          -
                                                                                                                                                                                          - - - - - - - -
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - @@ -742,14 +505,14 @@
                                                                                                                                                                                          Parameters:
                                                                                                                                                                                          -

                                                                                                                                                                                          +

                                                                                                                                                                                          - static addNickname(nick) + static backgroundChannelData(instance, channel, flag)

                                                                                                                                                                                          @@ -761,7 +524,9 @@

                                                                                                                                                                                          -

                                                                                                                                                                                          Adds a nickname to the chat input.

                                                                                                                                                                                          +

                                                                                                                                                                                          Allows plugins to request and monitor COMM data streams in the background. This is useful for plugins +that need to process COMM data even when the user is not actively viewing the COMM channels. +It tracks the requested channels for each plugin instance and updates the global state accordingly.

                                                                                                                                                                                          @@ -797,7 +562,7 @@

                                                                                                                                                                                          Parameters:
                                                                                                                                                                                          - nick + instance @@ -813,148 +578,7 @@
                                                                                                                                                                                          Parameters:
                                                                                                                                                                                          -

                                                                                                                                                                                          The nickname to add.

                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          - -

                                                                                                                                                                                          - - static backgroundChannelData(instance, channel, flag) - - - - -

                                                                                                                                                                                          - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          - - -
                                                                                                                                                                                          -

                                                                                                                                                                                          Allows plugins to request and monitor COMM data streams in the background. This is useful for plugins -that need to process COMM data even when the user is not actively viewing the COMM channels. -It tracks the requested channels for each plugin instance and updates the global state accordingly.

                                                                                                                                                                                          -
                                                                                                                                                                                          - - - - - - - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          Parameters:
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + @@ -1068,14 +692,14 @@
                                                                                                                                                                                          Parameters:
                                                                                                                                                                                          -

                                                                                                                                                                                          +

                                                                                                                                                                                          - static backgroundChannelData(instance, channel, flag) + static chooser(event)

                                                                                                                                                                                          @@ -1087,9 +711,9 @@

                                                                                                                                                                                          -

                                                                                                                                                                                          Allows plugins to request and monitor COMM data streams in the background. This is useful for plugins -that need to process COMM data even when the user is not actively viewing the COMM channels. -It tracks the requested channels for each plugin instance and updates the global state accordingly.

                                                                                                                                                                                          +

                                                                                                                                                                                          Chat tab chooser handler. +This function is triggered by a click event on the chat tab. It reads the tab name from the event target +and activates the corresponding chat tab.

                                                                                                                                                                                          @@ -1125,59 +749,13 @@

                                                                                                                                                                                          Parameters:
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + @@ -1255,14 +833,14 @@
                                                                                                                                                                                          Parameters:
                                                                                                                                                                                          -

                                                                                                                                                                                          +

                                                                                                                                                                                          - static chooser(event) + static chooseTab(tab)

                                                                                                                                                                                          @@ -1274,9 +852,8 @@

                                                                                                                                                                                          -

                                                                                                                                                                                          Chat tab chooser handler. -This function is triggered by a click event on the chat tab. It reads the tab name from the event target -and activates the corresponding chat tab.

                                                                                                                                                                                          +

                                                                                                                                                                                          Chooses and activates a specified chat tab. +Also triggers an early refresh of the chat data when switching tabs.

                                                                                                                                                                                          @@ -1312,13 +889,13 @@

                                                                                                                                                                                          Parameters:
                                                                                                                                                                                          - + + @@ -1396,14 +973,14 @@
                                                                                                                                                                                          Parameters:
                                                                                                                                                                                          -

                                                                                                                                                                                          +

                                                                                                                                                                                          - static chooser(event) + static genPostData(channel, storageHash, getOlderMsgs) → {Object}

                                                                                                                                                                                          @@ -1415,9 +992,7 @@

                                                                                                                                                                                          -

                                                                                                                                                                                          Chat tab chooser handler. -This function is triggered by a click event on the chat tab. It reads the tab name from the event target -and activates the corresponding chat tab.

                                                                                                                                                                                          +

                                                                                                                                                                                          Generates post data for chat requests.

                                                                                                                                                                                          @@ -1453,13 +1028,13 @@

                                                                                                                                                                                          Parameters:
                                                                                                                                                                                          - + + - -
                                                                                                                                                                                          NameTypeDescription
                                                                                                                                                                                          instance - - -string - - - -

                                                                                                                                                                                          A unique identifier for the plugin or instance requesting background COMM data.

                                                                                                                                                                                          A unique identifier for the plugin or instance requesting background COMM data.

                                                                                                                                                                                          instance - - -string - - - -

                                                                                                                                                                                          A unique identifier for the plugin or instance requesting background COMM data.

                                                                                                                                                                                          channel - - -string - - - -

                                                                                                                                                                                          The name of the COMM channel ('all', 'faction', or 'alerts').

                                                                                                                                                                                          flagevent -boolean +Event @@ -1187,7 +765,7 @@
                                                                                                                                                                                          Parameters:
                                                                                                                                                                                          -

                                                                                                                                                                                          Set to true to request data for the specified channel, false to stop requesting.

                                                                                                                                                                                          The event triggered by clicking a chat tab.

                                                                                                                                                                                          eventtab -Event +string @@ -1328,7 +905,7 @@
                                                                                                                                                                                          Parameters:
                                                                                                                                                                                          -

                                                                                                                                                                                          The event triggered by clicking a chat tab.

                                                                                                                                                                                          The name of the chat tab to activate ('all', 'faction', or 'alerts').

                                                                                                                                                                                          eventchannel -Event +string @@ -1469,27 +1044,94 @@
                                                                                                                                                                                          Parameters:
                                                                                                                                                                                          -

                                                                                                                                                                                          The event triggered by clicking a chat tab.

                                                                                                                                                                                          The chat channel.

                                                                                                                                                                                          - -
                                                                                                                                                                                          - - + + + storageHash + - + + + +Object - - + + - + - + + +

                                                                                                                                                                                          Storage hash for the chat.

                                                                                                                                                                                          + + + + + + + getOlderMsgs + + + + + +boolean + + + + + + + + + +

                                                                                                                                                                                          Flag to determine if older messages are being requested.

                                                                                                                                                                                          + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                                          +
                                                                                                                                                                                          Returns:
                                                                                                                                                                                          + + + + + +Object + + + + + +-

                                                                                                                                                                                          The generated post data.

                                                                                                                                                                                          + + + + + +
                                                                                                                                                                                          + @@ -1537,14 +1179,14 @@
                                                                                                                                                                                          Parameters:
                                                                                                                                                                                          -

                                                                                                                                                                                          +

                                                                                                                                                                                          - static chooseTab(tab) + static getActive() → {string}

                                                                                                                                                                                          @@ -1556,8 +1198,7 @@

                                                                                                                                                                                          -

                                                                                                                                                                                          Chooses and activates a specified chat tab. -Also triggers an early refresh of the chat data when switching tabs.

                                                                                                                                                                                          +

                                                                                                                                                                                          Gets the name of the active chat tab.

                                                                                                                                                                                          @@ -1568,67 +1209,38 @@

                                                                                                                                                                                          -
                                                                                                                                                                                          -
                                                                                                                                                                                          Parameters:
                                                                                                                                                                                          - - - - - - - - - - + - + - - - + - - - - - + - - - +string - - - - -
                                                                                                                                                                                          NameTypeDescription
                                                                                                                                                                                          tab - + +
                                                                                                                                                                                          +
                                                                                                                                                                                          Returns:
                                                                                                                                                                                          + -string - - -

                                                                                                                                                                                          The name of the chat tab to activate ('all', 'faction', or 'alerts').

                                                                                                                                                                                          -
                                                                                                                                                                                          - - - +-

                                                                                                                                                                                          The name of the active chat tab.

                                                                                                                                                                                          - - - + + @@ -1677,14 +1289,14 @@

                                                                                                                                                                                          Parameters:
                                                                                                                                                                                          -

                                                                                                                                                                                          +

                                                                                                                                                                                          - static chooseTab(tab) + static getChatPortalName(markup) → {string}

                                                                                                                                                                                          @@ -1696,8 +1308,7 @@

                                                                                                                                                                                          -

                                                                                                                                                                                          Chooses and activates a specified chat tab. -Also triggers an early refresh of the chat data when switching tabs.

                                                                                                                                                                                          +

                                                                                                                                                                                          Overrides portal names used repeatedly in chat, such as 'US Post Office', with more specific names.

                                                                                                                                                                                          @@ -1733,13 +1344,13 @@

                                                                                                                                                                                          Parameters:
                                                                                                                                                                                          - tab + markup -string +Object @@ -1749,7 +1360,7 @@
                                                                                                                                                                                          Parameters:
                                                                                                                                                                                          -

                                                                                                                                                                                          The name of the chat tab to activate ('all', 'faction', or 'alerts').

                                                                                                                                                                                          +

                                                                                                                                                                                          An object containing portal markup, including the name and address.

                                                                                                                                                                                          @@ -1770,6 +1381,27 @@
                                                                                                                                                                                          Parameters:
                                                                                                                                                                                          +
                                                                                                                                                                                          +
                                                                                                                                                                                          Returns:
                                                                                                                                                                                          + + + + + +string + + + + + +-

                                                                                                                                                                                          The processed portal name.

                                                                                                                                                                                          + + + + + +
                                                                                                                                                                                          + @@ -1817,14 +1449,14 @@
                                                                                                                                                                                          Parameters:
                                                                                                                                                                                          -

                                                                                                                                                                                          +

                                                                                                                                                                                          - static genPostData(channel, storageHash, getOlderMsgs) → {Object} + static handleAlerts(data, olderMsgs, ascendingTimestampOrder)

                                                                                                                                                                                          @@ -1836,7 +1468,7 @@

                                                                                                                                                                                          -

                                                                                                                                                                                          Generates post data for chat requests.

                                                                                                                                                                                          +

                                                                                                                                                                                          Handles the alerts chat data received from the server.

                                                                                                                                                                                          @@ -1872,13 +1504,13 @@

                                                                                                                                                                                          Parameters:
                                                                                                                                                                                          - channel + data -string +Object @@ -1888,20 +1520,20 @@
                                                                                                                                                                                          Parameters:
                                                                                                                                                                                          -

                                                                                                                                                                                          The chat channel.

                                                                                                                                                                                          +

                                                                                                                                                                                          The alerts chat data.

                                                                                                                                                                                          - storageHash + olderMsgs -Object +boolean @@ -1911,14 +1543,14 @@
                                                                                                                                                                                          Parameters:
                                                                                                                                                                                          -

                                                                                                                                                                                          Storage hash for the chat.

                                                                                                                                                                                          +

                                                                                                                                                                                          Whether the received messages are older.

                                                                                                                                                                                          - getOlderMsgs + ascendingTimestampOrder @@ -1934,7 +1566,7 @@
                                                                                                                                                                                          Parameters:
                                                                                                                                                                                          -

                                                                                                                                                                                          Flag to determine if older messages are being requested.

                                                                                                                                                                                          +

                                                                                                                                                                                          Whether messages are in ascending timestamp order.

                                                                                                                                                                                          @@ -1955,27 +1587,6 @@
                                                                                                                                                                                          Parameters:
                                                                                                                                                                                          -
                                                                                                                                                                                          -
                                                                                                                                                                                          Returns:
                                                                                                                                                                                          - - - - - -Object - - - - - --

                                                                                                                                                                                          The generated post data.

                                                                                                                                                                                          - - - - - -
                                                                                                                                                                                          - @@ -2023,14 +1634,14 @@
                                                                                                                                                                                          Returns:
                                                                                                                                                                                          -

                                                                                                                                                                                          +

                                                                                                                                                                                          - static genPostData(channel, storageHash, getOlderMsgs) → {Object} + static handleFaction(data, olderMsgs, ascendingTimestampOrder)

                                                                                                                                                                                          @@ -2042,7 +1653,7 @@

                                                                                                                                                                                          -

                                                                                                                                                                                          Generates post data for chat requests.

                                                                                                                                                                                          +

                                                                                                                                                                                          Handles faction chat response.

                                                                                                                                                                                          @@ -2078,13 +1689,13 @@

                                                                                                                                                                                          Parameters:
                                                                                                                                                                                          - channel + data -string +Object @@ -2094,20 +1705,20 @@
                                                                                                                                                                                          Parameters:
                                                                                                                                                                                          -

                                                                                                                                                                                          The chat channel.

                                                                                                                                                                                          +

                                                                                                                                                                                          Response data from server.

                                                                                                                                                                                          - storageHash + olderMsgs -Object +boolean @@ -2117,14 +1728,14 @@
                                                                                                                                                                                          Parameters:
                                                                                                                                                                                          -

                                                                                                                                                                                          Storage hash for the chat.

                                                                                                                                                                                          +

                                                                                                                                                                                          Indicates if older messages were requested.

                                                                                                                                                                                          - getOlderMsgs + ascendingTimestampOrder @@ -2140,7 +1751,7 @@
                                                                                                                                                                                          Parameters:
                                                                                                                                                                                          -

                                                                                                                                                                                          Flag to determine if older messages are being requested.

                                                                                                                                                                                          +

                                                                                                                                                                                          Indicates if messages are in ascending timestamp order.

                                                                                                                                                                                          @@ -2161,27 +1772,6 @@
                                                                                                                                                                                          Parameters:
                                                                                                                                                                                          -
                                                                                                                                                                                          -
                                                                                                                                                                                          Returns:
                                                                                                                                                                                          - - - - - -Object - - - - - --

                                                                                                                                                                                          The generated post data.

                                                                                                                                                                                          - - - - - -
                                                                                                                                                                                          - @@ -2229,14 +1819,14 @@
                                                                                                                                                                                          Returns:
                                                                                                                                                                                          -

                                                                                                                                                                                          +

                                                                                                                                                                                          - static getActive() → {string} + static handlePublic(data, olderMsgs, ascendingTimestampOrder)

                                                                                                                                                                                          @@ -2248,7 +1838,7 @@

                                                                                                                                                                                          -

                                                                                                                                                                                          Gets the name of the active chat tab.

                                                                                                                                                                                          +

                                                                                                                                                                                          Handles the public chat data received from the server.

                                                                                                                                                                                          @@ -2259,42 +1849,117 @@

                                                                                                                                                                                          +
                                                                                                                                                                                          +
                                                                                                                                                                                          Parameters:
                                                                                                                                                                                          + + + + + + + - + - + - + - + + + + + + + + + + + + + + + + + + -
                                                                                                                                                                                          -
                                                                                                                                                                                          Returns:
                                                                                                                                                                                          - + +
                                                                                                                                                                                          + + + + + -string + + + + + + + + + --

                                                                                                                                                                                          The name of the active chat tab.

                                                                                                                                                                                          + + + + + + + + +
                                                                                                                                                                                          NameTypeDescription
                                                                                                                                                                                          data + + +Object + + + +

                                                                                                                                                                                          The public chat data.

                                                                                                                                                                                          olderMsgs + +boolean + +

                                                                                                                                                                                          Whether the received messages are older.

                                                                                                                                                                                          ascendingTimestampOrder + + +boolean + +

                                                                                                                                                                                          Whether messages are in ascending timestamp order.

                                                                                                                                                                                          +
                                                                                                                                                                                          + + + + + + + + + + + +
                                                                                                                                                                                          @@ -2339,14 +2004,14 @@
                                                                                                                                                                                          Returns:
                                                                                                                                                                                          -

                                                                                                                                                                                          +

                                                                                                                                                                                          - static getActive() → {string} + static handleTabCompletion()

                                                                                                                                                                                          @@ -2358,7 +2023,7 @@

                                                                                                                                                                                          -

                                                                                                                                                                                          Gets the name of the active chat tab.

                                                                                                                                                                                          +

                                                                                                                                                                                          Handles tab completion in chat input.

                                                                                                                                                                                          @@ -2380,27 +2045,6 @@

                                                                                                                                                                                          - -
                                                                                                                                                                                          -
                                                                                                                                                                                          Returns:
                                                                                                                                                                                          - - - - - -string - - - - - --

                                                                                                                                                                                          The name of the active chat tab.

                                                                                                                                                                                          - - - - - -
                                                                                                                                                                                          @@ -2449,14 +2093,14 @@

                                                                                                                                                                                          Returns:
                                                                                                                                                                                          -

                                                                                                                                                                                          +

                                                                                                                                                                                          - static getChatPortalName(markup) → {string} + static keepScrollPosition(box, scrollBefore, isOldMsgs)

                                                                                                                                                                                          @@ -2468,7 +2112,9 @@

                                                                                                                                                                                          -

                                                                                                                                                                                          Overrides portal names used repeatedly in chat, such as 'US Post Office', with more specific names.

                                                                                                                                                                                          +

                                                                                                                                                                                          Maintains the scroll position of a chat box when new messages are added. +This function is designed to keep the scroll position fixed when old messages are loaded, and to automatically scroll +to the bottom when new messages are added if the user is already at the bottom of the chat.

                                                                                                                                                                                          @@ -2504,13 +2150,13 @@

                                                                                                                                                                                          Parameters:
                                                                                                                                                                                          - markup + box -Object +jQuery @@ -2520,47 +2166,72 @@
                                                                                                                                                                                          Parameters:
                                                                                                                                                                                          -

                                                                                                                                                                                          An object containing portal markup, including the name and address.

                                                                                                                                                                                          +

                                                                                                                                                                                          The jQuery object of the chat box.

                                                                                                                                                                                          - - - - + + + scrollBefore + - + + + +number - - + + - + - + + +

                                                                                                                                                                                          The scroll position before new messages were added.

                                                                                                                                                                                          + -
                                                                                                                                                                                          -
                                                                                                                                                                                          Returns:
                                                                                                                                                                                          - + + + + isOldMsgs + + + + +boolean + + -string + + + +

                                                                                                                                                                                          Indicates if the added messages are older messages.

                                                                                                                                                                                          + + + + +
                                                                                                                                                                                          + + --

                                                                                                                                                                                          The processed portal name.

                                                                                                                                                                                          + + + + - - @@ -2609,14 +2280,14 @@
                                                                                                                                                                                          Returns:
                                                                                                                                                                                          -

                                                                                                                                                                                          +

                                                                                                                                                                                          - static getChatPortalName(markup) → {string} + static needMoreMessages()

                                                                                                                                                                                          @@ -2628,7 +2299,8 @@

                                                                                                                                                                                          -

                                                                                                                                                                                          Overrides portal names used repeatedly in chat, such as 'US Post Office', with more specific names.

                                                                                                                                                                                          +

                                                                                                                                                                                          Checks if the currently selected chat tab needs more messages. +This function is triggered by scroll events and loads older messages when the user scrolls to the top.

                                                                                                                                                                                          @@ -2639,100 +2311,29 @@

                                                                                                                                                                                          -
                                                                                                                                                                                          -
                                                                                                                                                                                          Parameters:
                                                                                                                                                                                          - - - - - - - - + - + - + - - - + - - - - - + - +
                                                                                                                                                                                          - + - + -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          NameTypeDescription
                                                                                                                                                                                          markup - - -Object + - -

                                                                                                                                                                                          An object containing portal markup, including the name and address.

                                                                                                                                                                                          - -
                                                                                                                                                                                          - - - - - - - - - - - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          Returns:
                                                                                                                                                                                          - - - - - -string - - - - - --

                                                                                                                                                                                          The processed portal name.

                                                                                                                                                                                          - - - - - -
                                                                                                                                                                                          - - - - - -
                                                                                                                                                                                          - - - - - - + @@ -2769,14 +2370,14 @@
                                                                                                                                                                                          Returns:
                                                                                                                                                                                          -

                                                                                                                                                                                          +

                                                                                                                                                                                          - static handleAlerts(data, olderMsgs, ascendingTimestampOrder) + static nicknameClicked(event, nickname) → {boolean}

                                                                                                                                                                                          @@ -2788,7 +2389,7 @@

                                                                                                                                                                                          -

                                                                                                                                                                                          Handles the alerts chat data received from the server.

                                                                                                                                                                                          +

                                                                                                                                                                                          Handles click events on nicknames in the chat.

                                                                                                                                                                                          @@ -2824,36 +2425,13 @@

                                                                                                                                                                                          Parameters:
                                                                                                                                                                                          - data - - - - - -Object - - - - - - - - - -

                                                                                                                                                                                          The alerts chat data.

                                                                                                                                                                                          - - - - - - - olderMsgs + event -boolean +Event @@ -2863,20 +2441,20 @@
                                                                                                                                                                                          Parameters:
                                                                                                                                                                                          -

                                                                                                                                                                                          Whether the received messages are older.

                                                                                                                                                                                          +

                                                                                                                                                                                          The click event.

                                                                                                                                                                                          - ascendingTimestampOrder + nickname -boolean +string @@ -2886,7 +2464,7 @@
                                                                                                                                                                                          Parameters:
                                                                                                                                                                                          -

                                                                                                                                                                                          Whether messages are in ascending timestamp order.

                                                                                                                                                                                          +

                                                                                                                                                                                          The clicked nickname.

                                                                                                                                                                                          @@ -2907,6 +2485,27 @@
                                                                                                                                                                                          Parameters:
                                                                                                                                                                                          +
                                                                                                                                                                                          +
                                                                                                                                                                                          Returns:
                                                                                                                                                                                          + + + + + +boolean + + + + + +-

                                                                                                                                                                                          Always returns false.

                                                                                                                                                                                          + + + + + +
                                                                                                                                                                                          + @@ -2954,14 +2553,14 @@
                                                                                                                                                                                          Parameters:
                                                                                                                                                                                          -

                                                                                                                                                                                          +

                                                                                                                                                                                          - static handleAlerts(data, olderMsgs, ascendingTimestampOrder) + static parseMsgData(data) → {Object}

                                                                                                                                                                                          @@ -2973,7 +2572,7 @@

                                                                                                                                                                                          -

                                                                                                                                                                                          Handles the alerts chat data received from the server.

                                                                                                                                                                                          +

                                                                                                                                                                                          Parses chat message data into a more convenient format.

                                                                                                                                                                                          @@ -3025,59 +2624,115 @@

                                                                                                                                                                                          Parameters:
                                                                                                                                                                                          -

                                                                                                                                                                                          The alerts chat data.

                                                                                                                                                                                          +

                                                                                                                                                                                          The raw chat message data.

                                                                                                                                                                                          + + - - - olderMsgs - + + - - + + + + + + + + + + + +
                                                                                                                                                                                          +
                                                                                                                                                                                          Returns:
                                                                                                                                                                                          + -boolean - - - +Object + + + + + +-

                                                                                                                                                                                          The parsed chat message data.

                                                                                                                                                                                          + + + +
                                                                                                                                                                                          + -

                                                                                                                                                                                          Whether the received messages are older.

                                                                                                                                                                                          - + + + +
                                                                                                                                                                                          - - - ascendingTimestampOrder - + - - - -boolean + + + + - - + - + + + + + + + + + + + + + + + + + +
                                                                                                                                                                                          + + + + + + -

                                                                                                                                                                                          Whether messages are in ascending timestamp order.

                                                                                                                                                                                          - +
                                                                                                                                                                                          + +

                                                                                                                                                                                          + + static postMsg() + + + + +

                                                                                                                                                                                          + - - +
                                                                                                                                                                                          +
                                                                                                                                                                                          + +
                                                                                                                                                                                          +

                                                                                                                                                                                          Posts a chat message to the currently active chat tab.

                                                                                                                                                                                          @@ -3091,6 +2746,14 @@
                                                                                                                                                                                          Parameters:
                                                                                                                                                                                          + + + + + + + + @@ -3139,14 +2802,14 @@
                                                                                                                                                                                          Parameters:
                                                                                                                                                                                          -

                                                                                                                                                                                          +

                                                                                                                                                                                          - static handleFaction(data, olderMsgs, ascendingTimestampOrder) + static renderAlerts(oldMsgsWereAdded)

                                                                                                                                                                                          @@ -3158,7 +2821,7 @@

                                                                                                                                                                                          -

                                                                                                                                                                                          Handles faction chat response.

                                                                                                                                                                                          +

                                                                                                                                                                                          Renders alerts chat in the UI.

                                                                                                                                                                                          @@ -3194,13 +2857,13 @@

                                                                                                                                                                                          Parameters:
                                                                                                                                                                                          - data + oldMsgsWereAdded -Object +boolean @@ -3210,58 +2873,12 @@
                                                                                                                                                                                          Parameters:
                                                                                                                                                                                          -

                                                                                                                                                                                          Response data from server.

                                                                                                                                                                                          +

                                                                                                                                                                                          Indicates if older messages were added to the chat.

                                                                                                                                                                                          - - - - olderMsgs - - - - - -boolean - - - - - - - - - -

                                                                                                                                                                                          Indicates if older messages were requested.

                                                                                                                                                                                          - - - - - - - ascendingTimestampOrder - - - - - -boolean - - - - - - - - - -

                                                                                                                                                                                          Indicates if messages are in ascending timestamp order.

                                                                                                                                                                                          - - - - - + + @@ -3324,14 +2941,14 @@
                                                                                                                                                                                          Parameters:
                                                                                                                                                                                          -

                                                                                                                                                                                          +

                                                                                                                                                                                          - static handleFaction(data, olderMsgs, ascendingTimestampOrder) + static renderData(data, element, likelyWereOldMsgs, sortedGuids)

                                                                                                                                                                                          @@ -3343,7 +2960,7 @@

                                                                                                                                                                                          -

                                                                                                                                                                                          Handles faction chat response.

                                                                                                                                                                                          +

                                                                                                                                                                                          Renders data from the data-hash to the element defined by the given ID.

                                                                                                                                                                                          @@ -3395,20 +3012,20 @@

                                                                                                                                                                                          Parameters:
                                                                                                                                                                                          -

                                                                                                                                                                                          Response data from server.

                                                                                                                                                                                          +

                                                                                                                                                                                          Chat data to be rendered.

                                                                                                                                                                                          - olderMsgs + element -boolean +string @@ -3418,14 +3035,14 @@
                                                                                                                                                                                          Parameters:
                                                                                                                                                                                          -

                                                                                                                                                                                          Indicates if older messages were requested.

                                                                                                                                                                                          +

                                                                                                                                                                                          ID of the DOM element to render the chat into.

                                                                                                                                                                                          - ascendingTimestampOrder + likelyWereOldMsgs @@ -3441,7 +3058,30 @@
                                                                                                                                                                                          Parameters:
                                                                                                                                                                                          -

                                                                                                                                                                                          Indicates if messages are in ascending timestamp order.

                                                                                                                                                                                          +

                                                                                                                                                                                          Flag indicating if older messages are likely to have been added.

                                                                                                                                                                                          + + + + + + + sortedGuids + + + + + +Array + + + + + + + + + +

                                                                                                                                                                                          Sorted array of GUIDs representing the order of messages.

                                                                                                                                                                                          @@ -3509,14 +3149,14 @@
                                                                                                                                                                                          Parameters:
                                                                                                                                                                                          -

                                                                                                                                                                                          +

                                                                                                                                                                                          - static handlePublic(data, olderMsgs, ascendingTimestampOrder) + static renderDivider(text) → {string}

                                                                                                                                                                                          @@ -3528,7 +3168,7 @@

                                                                                                                                                                                          -

                                                                                                                                                                                          Handles the public chat data received from the server.

                                                                                                                                                                                          +

                                                                                                                                                                                          Renders a divider row in the chat table.

                                                                                                                                                                                          @@ -3564,13 +3204,13 @@

                                                                                                                                                                                          Parameters:
                                                                                                                                                                                          - data + text -Object +string @@ -3580,72 +3220,47 @@
                                                                                                                                                                                          Parameters:
                                                                                                                                                                                          -

                                                                                                                                                                                          The public chat data.

                                                                                                                                                                                          +

                                                                                                                                                                                          Text to display within the divider row.

                                                                                                                                                                                          + + - - - olderMsgs - - - - - -boolean - - - - + + - + - + -

                                                                                                                                                                                          Whether the received messages are older.

                                                                                                                                                                                          - + - - - ascendingTimestampOrder - + - - + +
                                                                                                                                                                                          +
                                                                                                                                                                                          Returns:
                                                                                                                                                                                          + -boolean - - - - - +string -

                                                                                                                                                                                          Whether messages are in ascending timestamp order.

                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          - - - +-

                                                                                                                                                                                          The HTML string representing a divider row in the chat table.

                                                                                                                                                                                          - - - + + @@ -3694,14 +3309,14 @@
                                                                                                                                                                                          Parameters:
                                                                                                                                                                                          -

                                                                                                                                                                                          +

                                                                                                                                                                                          - static handlePublic(data, olderMsgs, ascendingTimestampOrder) + static renderFaction(oldMsgsWereAdded)

                                                                                                                                                                                          @@ -3713,7 +3328,7 @@

                                                                                                                                                                                          -

                                                                                                                                                                                          Handles the public chat data received from the server.

                                                                                                                                                                                          +

                                                                                                                                                                                          Renders faction chat.

                                                                                                                                                                                          @@ -3749,53 +3364,7 @@

                                                                                                                                                                                          Parameters:
                                                                                                                                                                                          - data - - - - - -Object - - - - - - - - - -

                                                                                                                                                                                          The public chat data.

                                                                                                                                                                                          - - - - - - - olderMsgs - - - - - -boolean - - - - - - - - - -

                                                                                                                                                                                          Whether the received messages are older.

                                                                                                                                                                                          - - - - - - - ascendingTimestampOrder + oldMsgsWereAdded @@ -3811,7 +3380,7 @@
                                                                                                                                                                                          Parameters:
                                                                                                                                                                                          -

                                                                                                                                                                                          Whether messages are in ascending timestamp order.

                                                                                                                                                                                          +

                                                                                                                                                                                          Indicates if old messages were added in the current rendering.

                                                                                                                                                                                          @@ -3879,14 +3448,14 @@
                                                                                                                                                                                          Parameters:
                                                                                                                                                                                          -

                                                                                                                                                                                          +

                                                                                                                                                                                          - static handleTabCompletion() + static renderFactionEnt(faction) → {string}

                                                                                                                                                                                          @@ -3898,7 +3467,7 @@

                                                                                                                                                                                          -

                                                                                                                                                                                          Handles tab completion in chat input.

                                                                                                                                                                                          +

                                                                                                                                                                                          Renders a faction entity for use in the chat.

                                                                                                                                                                                          @@ -3909,44 +3478,55 @@

                                                                                                                                                                                          +
                                                                                                                                                                                          +
                                                                                                                                                                                          Parameters:
                                                                                                                                                                                          + + + + + + + - + - + - + - + + + + - + + + + - + - + - + - + + + +
                                                                                                                                                                                          NameTypeDescription
                                                                                                                                                                                          faction + + +Object -
                                                                                                                                                                                          - - - - - - - - - - - - + +

                                                                                                                                                                                          The faction data.

                                                                                                                                                                                          +
                                                                                                                                                                                          @@ -3956,59 +3536,30 @@

                                                                                                                                                                                          -

                                                                                                                                                                                          - - - - - - -
                                                                                                                                                                                          -

                                                                                                                                                                                          - - static handleTabCompletion() +
                                                                                                                                                                                          +
                                                                                                                                                                                          Returns:
                                                                                                                                                                                          + - - - -

                                                                                                                                                                                          - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          - -
                                                                                                                                                                                          -

                                                                                                                                                                                          Handles tab completion in chat input.

                                                                                                                                                                                          -
                                                                                                                                                                                          - - +string - - - - - +-

                                                                                                                                                                                          HTML string representing the faction.

                                                                                                                                                                                          - - - + + @@ -4057,14 +3608,14 @@

                                                                                                                                                                                          -

                                                                                                                                                                                          +

                                                                                                                                                                                          - static keepScrollPosition(box, scrollBefore, isOldMsgs) + static renderMarkup(markup) → {string}

                                                                                                                                                                                          @@ -4076,9 +3627,7 @@

                                                                                                                                                                                          -

                                                                                                                                                                                          Maintains the scroll position of a chat box when new messages are added. -This function is designed to keep the scroll position fixed when old messages are loaded, and to automatically scroll -to the bottom when new messages are added if the user is already at the bottom of the chat.

                                                                                                                                                                                          +

                                                                                                                                                                                          Renders the markup of a chat message, converting special entities like player names, portals, etc., into HTML.

                                                                                                                                                                                          @@ -4114,13 +3663,13 @@

                                                                                                                                                                                          Parameters:
                                                                                                                                                                                          - box + markup -jQuery +Array @@ -4130,72 +3679,47 @@
                                                                                                                                                                                          Parameters:
                                                                                                                                                                                          -

                                                                                                                                                                                          The jQuery object of the chat box.

                                                                                                                                                                                          +

                                                                                                                                                                                          The markup array of a chat message.

                                                                                                                                                                                          + + - - - scrollBefore - - - - - -number - - - - + + - + - + -

                                                                                                                                                                                          The scroll position before new messages were added.

                                                                                                                                                                                          - + - - - isOldMsgs - + - - + +
                                                                                                                                                                                          +
                                                                                                                                                                                          Returns:
                                                                                                                                                                                          + -boolean - - - - - +string -

                                                                                                                                                                                          Indicates if the added messages are older messages.

                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          - - - +-

                                                                                                                                                                                          The HTML string representing the complete rendered chat message.

                                                                                                                                                                                          - - - + + @@ -4244,14 +3768,14 @@
                                                                                                                                                                                          Parameters:
                                                                                                                                                                                          -

                                                                                                                                                                                          +

                                                                                                                                                                                          - static keepScrollPosition(box, scrollBefore, isOldMsgs) + static renderMarkupEntity(ent) → {string}

                                                                                                                                                                                          @@ -4263,9 +3787,7 @@

                                                                                                                                                                                          -

                                                                                                                                                                                          Maintains the scroll position of a chat box when new messages are added. -This function is designed to keep the scroll position fixed when old messages are loaded, and to automatically scroll -to the bottom when new messages are added if the user is already at the bottom of the chat.

                                                                                                                                                                                          +

                                                                                                                                                                                          Renders a chat message entity based on its type.

                                                                                                                                                                                          @@ -4301,13 +3823,13 @@

                                                                                                                                                                                          Parameters:
                                                                                                                                                                                          - box + ent -jQuery +Array @@ -4317,72 +3839,47 @@
                                                                                                                                                                                          Parameters:
                                                                                                                                                                                          -

                                                                                                                                                                                          The jQuery object of the chat box.

                                                                                                                                                                                          +

                                                                                                                                                                                          The entity array, where the first element is the type and the second element is the data.

                                                                                                                                                                                          + + - - - scrollBefore - - - - - -number - - - - + + - + - + -

                                                                                                                                                                                          The scroll position before new messages were added.

                                                                                                                                                                                          - + - - - isOldMsgs - + - - + +
                                                                                                                                                                                          +
                                                                                                                                                                                          Returns:
                                                                                                                                                                                          + -boolean - - - - - +string -

                                                                                                                                                                                          Indicates if the added messages are older messages.

                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          - - - +-

                                                                                                                                                                                          The HTML string representing the chat message entity.

                                                                                                                                                                                          - - - + + @@ -4431,14 +3928,14 @@
                                                                                                                                                                                          Parameters:
                                                                                                                                                                                          -

                                                                                                                                                                                          +

                                                                                                                                                                                          - static needMoreMessages() + static renderMsg(msg, nick, time, team, msgToPlayer, systemNarrowcast) → {string}

                                                                                                                                                                                          @@ -4450,8 +3947,7 @@

                                                                                                                                                                                          -

                                                                                                                                                                                          Checks if the currently selected chat tab needs more messages. -This function is triggered by scroll events and loads older messages when the user scrolls to the top.

                                                                                                                                                                                          +

                                                                                                                                                                                          Legacy function for rendering chat messages. Used for backward compatibility with plugins.

                                                                                                                                                                                          @@ -4462,86 +3958,169 @@

                                                                                                                                                                                          +
                                                                                                                                                                                          +
                                                                                                                                                                                          Parameters:
                                                                                                                                                                                          + + + + + + + - + - + - + - + + + + - + + + + - + - + - + - + + - + + + + - + - + - + - + + - + + + + - + + + + + + + + - + + + + + + + + + + + + -
                                                                                                                                                                                          -

                                                                                                                                                                                          + +

                                                                                                                                                                                          + + + + + + - - + + + + + - -
                                                                                                                                                                                          + +
                                                                                                                                                                                          + + + + + + + + + + + + -
                                                                                                                                                                                          -

                                                                                                                                                                                          Checks if the currently selected chat tab needs more messages. -This function is triggered by scroll events and loads older messages when the user scrolls to the top.

                                                                                                                                                                                          +
                                                                                                                                                                                          +
                                                                                                                                                                                          NameTypeDescription
                                                                                                                                                                                          msg + + +string -
                                                                                                                                                                                          + +

                                                                                                                                                                                          The chat message.

                                                                                                                                                                                          nick + + +string - - + +

                                                                                                                                                                                          The nickname of the player who sent the message.

                                                                                                                                                                                          time + + +number - - + +

                                                                                                                                                                                          The timestamp of the message.

                                                                                                                                                                                          team +string + + + +

                                                                                                                                                                                          The team of the player who sent the message.

                                                                                                                                                                                          msgToPlayer - static needMoreMessages() +boolean + + - +

                                                                                                                                                                                          Flag indicating if the message is directed to the player.

                                                                                                                                                                                          systemNarrowcast + + +boolean + + + +

                                                                                                                                                                                          Flag indicating if the message is a system narrowcast.

                                                                                                                                                                                          +
                                                                                                                                                                                          @@ -4556,13 +4135,26 @@

                                                                                                                                                                                          +
                                                                                                                                                                                          +
                                                                                                                                                                                          Returns:
                                                                                                                                                                                          + + - - - +string + + + + + +-

                                                                                                                                                                                          The HTML string representing a chat message row.

                                                                                                                                                                                          + + + + +
                                                                                                                                                                                          @@ -4611,14 +4203,14 @@

                                                                                                                                                                                          -

                                                                                                                                                                                          +

                                                                                                                                                                                          - static nicknameClicked(event, nickname) → {boolean} + static renderMsgCell(msg, classNames) → {string}

                                                                                                                                                                                          @@ -4630,7 +4222,8 @@

                                                                                                                                                                                          -

                                                                                                                                                                                          Handles click events on nicknames in the chat.

                                                                                                                                                                                          +

                                                                                                                                                                                          Renders a cell in the chat table for a chat message. +The message is inserted as inner HTML of the table cell.

                                                                                                                                                                                          @@ -4666,13 +4259,13 @@

                                                                                                                                                                                          Parameters:
                                                                                                                                                                                          - event + msg -Event +string @@ -4682,14 +4275,14 @@
                                                                                                                                                                                          Parameters:
                                                                                                                                                                                          -

                                                                                                                                                                                          The click event.

                                                                                                                                                                                          +

                                                                                                                                                                                          The chat message to be displayed.

                                                                                                                                                                                          - nickname + classNames @@ -4705,7 +4298,7 @@
                                                                                                                                                                                          Parameters:
                                                                                                                                                                                          -

                                                                                                                                                                                          The clicked nickname.

                                                                                                                                                                                          +

                                                                                                                                                                                          Additional class names to be added to the message cell.

                                                                                                                                                                                          @@ -4733,13 +4326,13 @@
                                                                                                                                                                                          Returns:
                                                                                                                                                                                          -boolean +string --

                                                                                                                                                                                          Always returns false.

                                                                                                                                                                                          +-

                                                                                                                                                                                          The HTML string representing a table cell with the chat message.

                                                                                                                                                                                          @@ -4794,14 +4387,14 @@
                                                                                                                                                                                          Returns:
                                                                                                                                                                                          -

                                                                                                                                                                                          +

                                                                                                                                                                                          - static nicknameClicked(event, nickname) → {boolean} + static renderMsgRow(data) → {string}

                                                                                                                                                                                          @@ -4813,7 +4406,7 @@

                                                                                                                                                                                          -

                                                                                                                                                                                          Handles click events on nicknames in the chat.

                                                                                                                                                                                          +

                                                                                                                                                                                          Renders a row for a chat message including time, nickname, and message cells.

                                                                                                                                                                                          @@ -4849,36 +4442,13 @@

                                                                                                                                                                                          Parameters:
                                                                                                                                                                                          - event - - - - - -Event - - - - - - - - - -

                                                                                                                                                                                          The click event.

                                                                                                                                                                                          - - - - - - - nickname + data -string +Object @@ -4888,7 +4458,7 @@
                                                                                                                                                                                          Parameters:
                                                                                                                                                                                          -

                                                                                                                                                                                          The clicked nickname.

                                                                                                                                                                                          +

                                                                                                                                                                                          The data for the message, including time, player, and message content.

                                                                                                                                                                                          @@ -4916,13 +4486,13 @@
                                                                                                                                                                                          Returns:
                                                                                                                                                                                          -boolean +string --

                                                                                                                                                                                          Always returns false.

                                                                                                                                                                                          +-

                                                                                                                                                                                          The HTML string representing a row in the chat table.

                                                                                                                                                                                          @@ -4977,14 +4547,14 @@
                                                                                                                                                                                          Returns:
                                                                                                                                                                                          -

                                                                                                                                                                                          +

                                                                                                                                                                                          - static parseMsgData(data) → {Object} + static renderNickCell(nick, classNames) → {string}

                                                                                                                                                                                          @@ -4996,7 +4566,8 @@

                                                                                                                                                                                          -

                                                                                                                                                                                          Parses chat message data into a more convenient format.

                                                                                                                                                                                          +

                                                                                                                                                                                          Renders a cell in the chat table for a player's nickname. +Wraps the nickname in HTML element for highlighting.

                                                                                                                                                                                          @@ -5032,13 +4603,13 @@

                                                                                                                                                                                          Parameters:
                                                                                                                                                                                          - data + nick -Object +string @@ -5048,7 +4619,30 @@
                                                                                                                                                                                          Parameters:
                                                                                                                                                                                          -

                                                                                                                                                                                          The raw chat message data.

                                                                                                                                                                                          +

                                                                                                                                                                                          The nickname of the player.

                                                                                                                                                                                          + + + + + + + classNames + + + + + +string + + + + + + + + + +

                                                                                                                                                                                          Additional class names to be added to the nickname cell.

                                                                                                                                                                                          @@ -5076,13 +4670,13 @@
                                                                                                                                                                                          Returns:
                                                                                                                                                                                          -Object +string --

                                                                                                                                                                                          The parsed chat message data.

                                                                                                                                                                                          +-

                                                                                                                                                                                          The HTML string representing a table cell with the player's nickname.

                                                                                                                                                                                          @@ -5137,14 +4731,14 @@
                                                                                                                                                                                          Returns:
                                                                                                                                                                                          -

                                                                                                                                                                                          +

                                                                                                                                                                                          - static parseMsgData(data) → {Object} + static renderPlayer(player, at, sender) → {string}

                                                                                                                                                                                          @@ -5156,7 +4750,7 @@

                                                                                                                                                                                          -

                                                                                                                                                                                          Parses chat message data into a more convenient format.

                                                                                                                                                                                          +

                                                                                                                                                                                          Renders a player's nickname in chat.

                                                                                                                                                                                          @@ -5192,7 +4786,7 @@

                                                                                                                                                                                          Parameters:
                                                                                                                                                                                          - data + player @@ -5208,145 +4802,60 @@
                                                                                                                                                                                          Parameters:
                                                                                                                                                                                          -

                                                                                                                                                                                          The raw chat message data.

                                                                                                                                                                                          +

                                                                                                                                                                                          The player object containing nickname and team.

                                                                                                                                                                                          - - - - - - - - - - - - - - + + + at + - -
                                                                                                                                                                                          -
                                                                                                                                                                                          Returns:
                                                                                                                                                                                          - + + - - - -Object - - - - - --

                                                                                                                                                                                          The parsed chat message data.

                                                                                                                                                                                          - - +boolean -
                                                                                                                                                                                          - - - - - -
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - + - + - -
                                                                                                                                                                                          + +

                                                                                                                                                                                          Whether to prepend '@' to the nickname.

                                                                                                                                                                                          + -

                                                                                                                                                                                          - + + + sender - -
                                                                                                                                                                                          - -

                                                                                                                                                                                          + - static postMsg() - - - -

                                                                                                                                                                                          - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          - - -
                                                                                                                                                                                          -

                                                                                                                                                                                          Posts a chat message to the currently active chat tab.

                                                                                                                                                                                          -
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - +boolean - - + + - + + -
                                                                                                                                                                                          +

                                                                                                                                                                                          Whether the player is the sender of a message.

                                                                                                                                                                                          + + + + @@ -5360,77 +4869,30 @@

                                                                                                                                                                                          +
                                                                                                                                                                                          +
                                                                                                                                                                                          Returns:
                                                                                                                                                                                          + + - - - +string - - - - -

                                                                                                                                                                                          +-

                                                                                                                                                                                          The HTML string representing the player's nickname in chat.

                                                                                                                                                                                          - -
                                                                                                                                                                                          - - -
                                                                                                                                                                                          - -

                                                                                                                                                                                          - static postMsg() - - - - -

                                                                                                                                                                                          - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          - - -
                                                                                                                                                                                          -

                                                                                                                                                                                          Posts a chat message to the currently active chat tab.

                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          @@ -5475,14 +4937,14 @@

                                                                                                                                                                                          -

                                                                                                                                                                                          +

                                                                                                                                                                                          - static renderAlerts(oldMsgsWereAdded) + static renderPortal(portal) → {string}

                                                                                                                                                                                          @@ -5494,7 +4956,7 @@

                                                                                                                                                                                          -

                                                                                                                                                                                          Renders alerts chat in the UI.

                                                                                                                                                                                          +

                                                                                                                                                                                          Renders a portal link for use in the chat.

                                                                                                                                                                                          @@ -5530,13 +4992,13 @@

                                                                                                                                                                                          Parameters:
                                                                                                                                                                                          - oldMsgsWereAdded + portal -boolean +Object @@ -5546,7 +5008,7 @@
                                                                                                                                                                                          Parameters:
                                                                                                                                                                                          -

                                                                                                                                                                                          Indicates if older messages were added to the chat.

                                                                                                                                                                                          +

                                                                                                                                                                                          The portal data.

                                                                                                                                                                                          @@ -5567,6 +5029,27 @@
                                                                                                                                                                                          Parameters:
                                                                                                                                                                                          +
                                                                                                                                                                                          +
                                                                                                                                                                                          Returns:
                                                                                                                                                                                          + + + + + +string + + + + + +-

                                                                                                                                                                                          HTML string of the portal link.

                                                                                                                                                                                          + + + + + +
                                                                                                                                                                                          + @@ -5614,14 +5097,14 @@
                                                                                                                                                                                          Parameters:
                                                                                                                                                                                          -

                                                                                                                                                                                          +

                                                                                                                                                                                          - static renderAlerts(oldMsgsWereAdded) + static renderPublic(oldMsgsWereAdded)

                                                                                                                                                                                          @@ -5633,7 +5116,7 @@

                                                                                                                                                                                          -

                                                                                                                                                                                          Renders alerts chat in the UI.

                                                                                                                                                                                          +

                                                                                                                                                                                          Renders public chat in the UI.

                                                                                                                                                                                          @@ -5753,14 +5236,14 @@

                                                                                                                                                                                          Parameters:
                                                                                                                                                                                          -

                                                                                                                                                                                          +

                                                                                                                                                                                          - static renderData(data, element, likelyWereOldMsgs, sortedGuids) + static renderText(text) → {string}

                                                                                                                                                                                          @@ -5772,7 +5255,7 @@

                                                                                                                                                                                          -

                                                                                                                                                                                          Renders data from the data-hash to the element defined by the given ID.

                                                                                                                                                                                          +

                                                                                                                                                                                          Renders text for the chat, converting plain text to HTML and adding links.

                                                                                                                                                                                          @@ -5808,7 +5291,7 @@

                                                                                                                                                                                          Parameters:
                                                                                                                                                                                          - data + text @@ -5824,21387 +5307,13 @@
                                                                                                                                                                                          Parameters:
                                                                                                                                                                                          -

                                                                                                                                                                                          Chat data to be rendered.

                                                                                                                                                                                          +

                                                                                                                                                                                          An object containing the plain text to render.

                                                                                                                                                                                          + + - - - element - - - - - -string - - - - - - - - - -

                                                                                                                                                                                          ID of the DOM element to render the chat into.

                                                                                                                                                                                          - - - - - - - likelyWereOldMsgs - - - - - -boolean - - - - - - - - - -

                                                                                                                                                                                          Flag indicating if older messages are likely to have been added.

                                                                                                                                                                                          - - - - - - - sortedGuids - - - - - -Array - - - - - - - - - -

                                                                                                                                                                                          Sorted array of GUIDs representing the order of messages.

                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          - - - - -

                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          - -

                                                                                                                                                                                          - - static renderData(data, element, likelyWereOldMsgs, sortedGuids) - - - - -

                                                                                                                                                                                          - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          - - -
                                                                                                                                                                                          -

                                                                                                                                                                                          Renders data from the data-hash to the element defined by the given ID.

                                                                                                                                                                                          -
                                                                                                                                                                                          - - - - - - - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          Parameters:
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          NameTypeDescription
                                                                                                                                                                                          data - - -Object - - - -

                                                                                                                                                                                          Chat data to be rendered.

                                                                                                                                                                                          element - - -string - - - -

                                                                                                                                                                                          ID of the DOM element to render the chat into.

                                                                                                                                                                                          likelyWereOldMsgs - - -boolean - - - -

                                                                                                                                                                                          Flag indicating if older messages are likely to have been added.

                                                                                                                                                                                          sortedGuids - - -Array - - - -

                                                                                                                                                                                          Sorted array of GUIDs representing the order of messages.

                                                                                                                                                                                          - -
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          - -

                                                                                                                                                                                          - - static renderDivider(text) → {string} - - - - -

                                                                                                                                                                                          - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          - - -
                                                                                                                                                                                          -

                                                                                                                                                                                          Renders a divider row in the chat table.

                                                                                                                                                                                          -
                                                                                                                                                                                          - - - - - - - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          Parameters:
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          NameTypeDescription
                                                                                                                                                                                          text - - -string - - - -

                                                                                                                                                                                          Text to display within the divider row.

                                                                                                                                                                                          - -
                                                                                                                                                                                          - - - - - - - - - - - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          Returns:
                                                                                                                                                                                          - - - - - -string - - - - - --

                                                                                                                                                                                          The HTML string representing a divider row in the chat table.

                                                                                                                                                                                          - - - - - -
                                                                                                                                                                                          - - - - - -
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          - -

                                                                                                                                                                                          - - static renderDivider(text) → {string} - - - - -

                                                                                                                                                                                          - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          - - -
                                                                                                                                                                                          -

                                                                                                                                                                                          Renders a divider row in the chat table.

                                                                                                                                                                                          -
                                                                                                                                                                                          - - - - - - - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          Parameters:
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          NameTypeDescription
                                                                                                                                                                                          text - - -string - - - -

                                                                                                                                                                                          Text to display within the divider row.

                                                                                                                                                                                          - -
                                                                                                                                                                                          - - - - - - - - - - - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          Returns:
                                                                                                                                                                                          - - - - - -string - - - - - --

                                                                                                                                                                                          The HTML string representing a divider row in the chat table.

                                                                                                                                                                                          - - - - - -
                                                                                                                                                                                          - - - - - -
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          - -

                                                                                                                                                                                          - - static renderFaction(oldMsgsWereAdded) - - - - -

                                                                                                                                                                                          - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          - - -
                                                                                                                                                                                          -

                                                                                                                                                                                          Renders faction chat.

                                                                                                                                                                                          -
                                                                                                                                                                                          - - - - - - - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          Parameters:
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          NameTypeDescription
                                                                                                                                                                                          oldMsgsWereAdded - - -boolean - - - -

                                                                                                                                                                                          Indicates if old messages were added in the current rendering.

                                                                                                                                                                                          - -
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          - -

                                                                                                                                                                                          - - static renderFaction(oldMsgsWereAdded) - - - - -

                                                                                                                                                                                          - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          - - -
                                                                                                                                                                                          -

                                                                                                                                                                                          Renders faction chat.

                                                                                                                                                                                          -
                                                                                                                                                                                          - - - - - - - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          Parameters:
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          NameTypeDescription
                                                                                                                                                                                          oldMsgsWereAdded - - -boolean - - - -

                                                                                                                                                                                          Indicates if old messages were added in the current rendering.

                                                                                                                                                                                          - -
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          - -

                                                                                                                                                                                          - - static renderFactionEnt(faction) → {string} - - - - -

                                                                                                                                                                                          - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          - - -
                                                                                                                                                                                          -

                                                                                                                                                                                          Renders a faction entity for use in the chat.

                                                                                                                                                                                          -
                                                                                                                                                                                          - - - - - - - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          Parameters:
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          NameTypeDescription
                                                                                                                                                                                          faction - - -Object - - - -

                                                                                                                                                                                          The faction data.

                                                                                                                                                                                          - -
                                                                                                                                                                                          - - - - - - - - - - - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          Returns:
                                                                                                                                                                                          - - - - - -string - - - - - --

                                                                                                                                                                                          HTML string representing the faction.

                                                                                                                                                                                          - - - - - -
                                                                                                                                                                                          - - - - - -
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          - -

                                                                                                                                                                                          - - static renderFactionEnt(faction) → {string} - - - - -

                                                                                                                                                                                          - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          - - -
                                                                                                                                                                                          -

                                                                                                                                                                                          Renders a faction entity for use in the chat.

                                                                                                                                                                                          -
                                                                                                                                                                                          - - - - - - - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          Parameters:
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          NameTypeDescription
                                                                                                                                                                                          faction - - -Object - - - -

                                                                                                                                                                                          The faction data.

                                                                                                                                                                                          - -
                                                                                                                                                                                          - - - - - - - - - - - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          Returns:
                                                                                                                                                                                          - - - - - -string - - - - - --

                                                                                                                                                                                          HTML string representing the faction.

                                                                                                                                                                                          - - - - - -
                                                                                                                                                                                          - - - - - -
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          - -

                                                                                                                                                                                          - - static renderMarkup(markup) → {string} - - - - -

                                                                                                                                                                                          - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          - - -
                                                                                                                                                                                          -

                                                                                                                                                                                          Renders the markup of a chat message, converting special entities like player names, portals, etc., into HTML.

                                                                                                                                                                                          -
                                                                                                                                                                                          - - - - - - - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          Parameters:
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          NameTypeDescription
                                                                                                                                                                                          markup - - -Array - - - -

                                                                                                                                                                                          The markup array of a chat message.

                                                                                                                                                                                          - -
                                                                                                                                                                                          - - - - - - - - - - - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          Returns:
                                                                                                                                                                                          - - - - - -string - - - - - --

                                                                                                                                                                                          The HTML string representing the complete rendered chat message.

                                                                                                                                                                                          - - - - - -
                                                                                                                                                                                          - - - - - -
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          - -

                                                                                                                                                                                          - - static renderMarkup(markup) → {string} - - - - -

                                                                                                                                                                                          - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          - - -
                                                                                                                                                                                          -

                                                                                                                                                                                          Renders the markup of a chat message, converting special entities like player names, portals, etc., into HTML.

                                                                                                                                                                                          -
                                                                                                                                                                                          - - - - - - - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          Parameters:
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          NameTypeDescription
                                                                                                                                                                                          markup - - -Array - - - -

                                                                                                                                                                                          The markup array of a chat message.

                                                                                                                                                                                          - -
                                                                                                                                                                                          - - - - - - - - - - - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          Returns:
                                                                                                                                                                                          - - - - - -string - - - - - --

                                                                                                                                                                                          The HTML string representing the complete rendered chat message.

                                                                                                                                                                                          - - - - - -
                                                                                                                                                                                          - - - - - -
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          - -

                                                                                                                                                                                          - - static renderMarkupEntity(ent) → {string} - - - - -

                                                                                                                                                                                          - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          - - -
                                                                                                                                                                                          -

                                                                                                                                                                                          Renders a chat message entity based on its type.

                                                                                                                                                                                          -
                                                                                                                                                                                          - - - - - - - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          Parameters:
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          NameTypeDescription
                                                                                                                                                                                          ent - - -Array - - - -

                                                                                                                                                                                          The entity array, where the first element is the type and the second element is the data.

                                                                                                                                                                                          - -
                                                                                                                                                                                          - - - - - - - - - - - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          Returns:
                                                                                                                                                                                          - - - - - -string - - - - - --

                                                                                                                                                                                          The HTML string representing the chat message entity.

                                                                                                                                                                                          - - - - - -
                                                                                                                                                                                          - - - - - -
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          - -

                                                                                                                                                                                          - - static renderMarkupEntity(ent) → {string} - - - - -

                                                                                                                                                                                          - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          - - -
                                                                                                                                                                                          -

                                                                                                                                                                                          Renders a chat message entity based on its type.

                                                                                                                                                                                          -
                                                                                                                                                                                          - - - - - - - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          Parameters:
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          NameTypeDescription
                                                                                                                                                                                          ent - - -Array - - - -

                                                                                                                                                                                          The entity array, where the first element is the type and the second element is the data.

                                                                                                                                                                                          - -
                                                                                                                                                                                          - - - - - - - - - - - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          Returns:
                                                                                                                                                                                          - - - - - -string - - - - - --

                                                                                                                                                                                          The HTML string representing the chat message entity.

                                                                                                                                                                                          - - - - - -
                                                                                                                                                                                          - - - - - -
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          - -

                                                                                                                                                                                          - - static renderMsg(msg, nick, time, team, msgToPlayer, systemNarrowcast) → {string} - - - - -

                                                                                                                                                                                          - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          - - -
                                                                                                                                                                                          -

                                                                                                                                                                                          Legacy function for rendering chat messages. Used for backward compatibility with plugins.

                                                                                                                                                                                          -
                                                                                                                                                                                          - - - - - - - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          Parameters:
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          NameTypeDescription
                                                                                                                                                                                          msg - - -string - - - -

                                                                                                                                                                                          The chat message.

                                                                                                                                                                                          nick - - -string - - - -

                                                                                                                                                                                          The nickname of the player who sent the message.

                                                                                                                                                                                          time - - -number - - - -

                                                                                                                                                                                          The timestamp of the message.

                                                                                                                                                                                          team - - -string - - - -

                                                                                                                                                                                          The team of the player who sent the message.

                                                                                                                                                                                          msgToPlayer - - -boolean - - - -

                                                                                                                                                                                          Flag indicating if the message is directed to the player.

                                                                                                                                                                                          systemNarrowcast - - -boolean - - - -

                                                                                                                                                                                          Flag indicating if the message is a system narrowcast.

                                                                                                                                                                                          - -
                                                                                                                                                                                          - - - - - - - - - - - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          Returns:
                                                                                                                                                                                          - - - - - -string - - - - - --

                                                                                                                                                                                          The HTML string representing a chat message row.

                                                                                                                                                                                          - - - - - -
                                                                                                                                                                                          - - - - - -
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          - -

                                                                                                                                                                                          - - static renderMsg(msg, nick, time, team, msgToPlayer, systemNarrowcast) → {string} - - - - -

                                                                                                                                                                                          - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          - - -
                                                                                                                                                                                          -

                                                                                                                                                                                          Legacy function for rendering chat messages. Used for backward compatibility with plugins.

                                                                                                                                                                                          -
                                                                                                                                                                                          - - - - - - - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          Parameters:
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          NameTypeDescription
                                                                                                                                                                                          msg - - -string - - - -

                                                                                                                                                                                          The chat message.

                                                                                                                                                                                          nick - - -string - - - -

                                                                                                                                                                                          The nickname of the player who sent the message.

                                                                                                                                                                                          time - - -number - - - -

                                                                                                                                                                                          The timestamp of the message.

                                                                                                                                                                                          team - - -string - - - -

                                                                                                                                                                                          The team of the player who sent the message.

                                                                                                                                                                                          msgToPlayer - - -boolean - - - -

                                                                                                                                                                                          Flag indicating if the message is directed to the player.

                                                                                                                                                                                          systemNarrowcast - - -boolean - - - -

                                                                                                                                                                                          Flag indicating if the message is a system narrowcast.

                                                                                                                                                                                          - -
                                                                                                                                                                                          - - - - - - - - - - - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          Returns:
                                                                                                                                                                                          - - - - - -string - - - - - --

                                                                                                                                                                                          The HTML string representing a chat message row.

                                                                                                                                                                                          - - - - - -
                                                                                                                                                                                          - - - - - -
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          - -

                                                                                                                                                                                          - - static renderMsgCell(msg, classNames) → {string} - - - - -

                                                                                                                                                                                          - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          - - -
                                                                                                                                                                                          -

                                                                                                                                                                                          Renders a cell in the chat table for a chat message. -The message is inserted as inner HTML of the table cell.

                                                                                                                                                                                          -
                                                                                                                                                                                          - - - - - - - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          Parameters:
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          NameTypeDescription
                                                                                                                                                                                          msg - - -string - - - -

                                                                                                                                                                                          The chat message to be displayed.

                                                                                                                                                                                          classNames - - -string - - - -

                                                                                                                                                                                          Additional class names to be added to the message cell.

                                                                                                                                                                                          - -
                                                                                                                                                                                          - - - - - - - - - - - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          Returns:
                                                                                                                                                                                          - - - - - -string - - - - - --

                                                                                                                                                                                          The HTML string representing a table cell with the chat message.

                                                                                                                                                                                          - - - - - -
                                                                                                                                                                                          - - - - - -
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          - -

                                                                                                                                                                                          - - static renderMsgCell(msg, classNames) → {string} - - - - -

                                                                                                                                                                                          - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          - - -
                                                                                                                                                                                          -

                                                                                                                                                                                          Renders a cell in the chat table for a chat message. -The message is inserted as inner HTML of the table cell.

                                                                                                                                                                                          -
                                                                                                                                                                                          - - - - - - - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          Parameters:
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          NameTypeDescription
                                                                                                                                                                                          msg - - -string - - - -

                                                                                                                                                                                          The chat message to be displayed.

                                                                                                                                                                                          classNames - - -string - - - -

                                                                                                                                                                                          Additional class names to be added to the message cell.

                                                                                                                                                                                          - -
                                                                                                                                                                                          - - - - - - - - - - - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          Returns:
                                                                                                                                                                                          - - - - - -string - - - - - --

                                                                                                                                                                                          The HTML string representing a table cell with the chat message.

                                                                                                                                                                                          - - - - - -
                                                                                                                                                                                          - - - - - -
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          - -

                                                                                                                                                                                          - - static renderMsgRow(data) → {string} - - - - -

                                                                                                                                                                                          - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          - - -
                                                                                                                                                                                          -

                                                                                                                                                                                          Renders a row for a chat message including time, nickname, and message cells.

                                                                                                                                                                                          -
                                                                                                                                                                                          - - - - - - - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          Parameters:
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          NameTypeDescription
                                                                                                                                                                                          data - - -Object - - - -

                                                                                                                                                                                          The data for the message, including time, player, and message content.

                                                                                                                                                                                          - -
                                                                                                                                                                                          - - - - - - - - - - - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          Returns:
                                                                                                                                                                                          - - - - - -string - - - - - --

                                                                                                                                                                                          The HTML string representing a row in the chat table.

                                                                                                                                                                                          - - - - - -
                                                                                                                                                                                          - - - - - -
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          - -

                                                                                                                                                                                          - - static renderMsgRow(data) → {string} - - - - -

                                                                                                                                                                                          - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          - - -
                                                                                                                                                                                          -

                                                                                                                                                                                          Renders a row for a chat message including time, nickname, and message cells.

                                                                                                                                                                                          -
                                                                                                                                                                                          - - - - - - - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          Parameters:
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          NameTypeDescription
                                                                                                                                                                                          data - - -Object - - - -

                                                                                                                                                                                          The data for the message, including time, player, and message content.

                                                                                                                                                                                          - -
                                                                                                                                                                                          - - - - - - - - - - - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          Returns:
                                                                                                                                                                                          - - - - - -string - - - - - --

                                                                                                                                                                                          The HTML string representing a row in the chat table.

                                                                                                                                                                                          - - - - - -
                                                                                                                                                                                          - - - - - -
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          - -

                                                                                                                                                                                          - - static renderNickCell(nick, classNames) → {string} - - - - -

                                                                                                                                                                                          - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          - - -
                                                                                                                                                                                          -

                                                                                                                                                                                          Renders a cell in the chat table for a player's nickname. -Wraps the nickname in HTML element for highlighting.

                                                                                                                                                                                          -
                                                                                                                                                                                          - - - - - - - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          Parameters:
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          NameTypeDescription
                                                                                                                                                                                          nick - - -string - - - -

                                                                                                                                                                                          The nickname of the player.

                                                                                                                                                                                          classNames - - -string - - - -

                                                                                                                                                                                          Additional class names to be added to the nickname cell.

                                                                                                                                                                                          - -
                                                                                                                                                                                          - - - - - - - - - - - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          Returns:
                                                                                                                                                                                          - - - - - -string - - - - - --

                                                                                                                                                                                          The HTML string representing a table cell with the player's nickname.

                                                                                                                                                                                          - - - - - -
                                                                                                                                                                                          - - - - - -
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          - -

                                                                                                                                                                                          - - static renderNickCell(nick, classNames) → {string} - - - - -

                                                                                                                                                                                          - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          - - -
                                                                                                                                                                                          -

                                                                                                                                                                                          Renders a cell in the chat table for a player's nickname. -Wraps the nickname in HTML element for highlighting.

                                                                                                                                                                                          -
                                                                                                                                                                                          - - - - - - - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          Parameters:
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          NameTypeDescription
                                                                                                                                                                                          nick - - -string - - - -

                                                                                                                                                                                          The nickname of the player.

                                                                                                                                                                                          classNames - - -string - - - -

                                                                                                                                                                                          Additional class names to be added to the nickname cell.

                                                                                                                                                                                          - -
                                                                                                                                                                                          - - - - - - - - - - - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          Returns:
                                                                                                                                                                                          - - - - - -string - - - - - --

                                                                                                                                                                                          The HTML string representing a table cell with the player's nickname.

                                                                                                                                                                                          - - - - - -
                                                                                                                                                                                          - - - - - -
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          - -

                                                                                                                                                                                          - - static renderPlayer(player, at, sender) → {string} - - - - -

                                                                                                                                                                                          - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          - - -
                                                                                                                                                                                          -

                                                                                                                                                                                          Renders a player's nickname in chat.

                                                                                                                                                                                          -
                                                                                                                                                                                          - - - - - - - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          Parameters:
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          NameTypeDescription
                                                                                                                                                                                          player - - -Object - - - -

                                                                                                                                                                                          The player object containing nickname and team.

                                                                                                                                                                                          at - - -boolean - - - -

                                                                                                                                                                                          Whether to prepend '@' to the nickname.

                                                                                                                                                                                          sender - - -boolean - - - -

                                                                                                                                                                                          Whether the player is the sender of a message.

                                                                                                                                                                                          - -
                                                                                                                                                                                          - - - - - - - - - - - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          Returns:
                                                                                                                                                                                          - - - - - -string - - - - - --

                                                                                                                                                                                          The HTML string representing the player's nickname in chat.

                                                                                                                                                                                          - - - - - -
                                                                                                                                                                                          - - - - - -
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          - -

                                                                                                                                                                                          - - static renderPlayer(player, at, sender) → {string} - - - - -

                                                                                                                                                                                          - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          - - -
                                                                                                                                                                                          -

                                                                                                                                                                                          Renders a player's nickname in chat.

                                                                                                                                                                                          -
                                                                                                                                                                                          - - - - - - - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          Parameters:
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          NameTypeDescription
                                                                                                                                                                                          player - - -Object - - - -

                                                                                                                                                                                          The player object containing nickname and team.

                                                                                                                                                                                          at - - -boolean - - - -

                                                                                                                                                                                          Whether to prepend '@' to the nickname.

                                                                                                                                                                                          sender - - -boolean - - - -

                                                                                                                                                                                          Whether the player is the sender of a message.

                                                                                                                                                                                          - -
                                                                                                                                                                                          - - - - - - - - - - - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          Returns:
                                                                                                                                                                                          - - - - - -string - - - - - --

                                                                                                                                                                                          The HTML string representing the player's nickname in chat.

                                                                                                                                                                                          - - - - - -
                                                                                                                                                                                          - - - - - -
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          - -

                                                                                                                                                                                          - - static renderPortal(portal) → {string} - - - - -

                                                                                                                                                                                          - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          - - -
                                                                                                                                                                                          -

                                                                                                                                                                                          Renders a portal link for use in the chat.

                                                                                                                                                                                          -
                                                                                                                                                                                          - - - - - - - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          Parameters:
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          NameTypeDescription
                                                                                                                                                                                          portal - - -Object - - - -

                                                                                                                                                                                          The portal data.

                                                                                                                                                                                          - -
                                                                                                                                                                                          - - - - - - - - - - - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          Returns:
                                                                                                                                                                                          - - - - - -string - - - - - --

                                                                                                                                                                                          HTML string of the portal link.

                                                                                                                                                                                          - - - - - -
                                                                                                                                                                                          - - - - - -
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          - -

                                                                                                                                                                                          - - static renderPortal(portal) → {string} - - - - -

                                                                                                                                                                                          - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          - - -
                                                                                                                                                                                          -

                                                                                                                                                                                          Renders a portal link for use in the chat.

                                                                                                                                                                                          -
                                                                                                                                                                                          - - - - - - - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          Parameters:
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          NameTypeDescription
                                                                                                                                                                                          portal - - -Object - - - -

                                                                                                                                                                                          The portal data.

                                                                                                                                                                                          - -
                                                                                                                                                                                          - - - - - - - - - - - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          Returns:
                                                                                                                                                                                          - - - - - -string - - - - - --

                                                                                                                                                                                          HTML string of the portal link.

                                                                                                                                                                                          - - - - - -
                                                                                                                                                                                          - - - - - -
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          - -

                                                                                                                                                                                          - - static renderPublic(oldMsgsWereAdded) - - - - -

                                                                                                                                                                                          - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          - - -
                                                                                                                                                                                          -

                                                                                                                                                                                          Renders public chat in the UI.

                                                                                                                                                                                          -
                                                                                                                                                                                          - - - - - - - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          Parameters:
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          NameTypeDescription
                                                                                                                                                                                          oldMsgsWereAdded - - -boolean - - - -

                                                                                                                                                                                          Indicates if older messages were added to the chat.

                                                                                                                                                                                          - -
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          - -

                                                                                                                                                                                          - - static renderPublic(oldMsgsWereAdded) - - - - -

                                                                                                                                                                                          - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          - - -
                                                                                                                                                                                          -

                                                                                                                                                                                          Renders public chat in the UI.

                                                                                                                                                                                          -
                                                                                                                                                                                          - - - - - - - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          Parameters:
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          NameTypeDescription
                                                                                                                                                                                          oldMsgsWereAdded - - -boolean - - - -

                                                                                                                                                                                          Indicates if older messages were added to the chat.

                                                                                                                                                                                          - -
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          - -

                                                                                                                                                                                          - - static renderText(text) → {string} - - - - -

                                                                                                                                                                                          - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          - - -
                                                                                                                                                                                          -

                                                                                                                                                                                          Renders text for the chat, converting plain text to HTML and adding links.

                                                                                                                                                                                          -
                                                                                                                                                                                          - - - - - - - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          Parameters:
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          NameTypeDescription
                                                                                                                                                                                          text - - -Object - - - -

                                                                                                                                                                                          An object containing the plain text to render.

                                                                                                                                                                                          - -
                                                                                                                                                                                          - - - - - - - - - - - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          Returns:
                                                                                                                                                                                          - - - - - -string - - - - - --

                                                                                                                                                                                          The rendered HTML string.

                                                                                                                                                                                          - - - - - -
                                                                                                                                                                                          - - - - - -
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          - -

                                                                                                                                                                                          - - static renderText(text) → {string} - - - - -

                                                                                                                                                                                          - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          - - -
                                                                                                                                                                                          -

                                                                                                                                                                                          Renders text for the chat, converting plain text to HTML and adding links.

                                                                                                                                                                                          -
                                                                                                                                                                                          - - - - - - - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          Parameters:
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          NameTypeDescription
                                                                                                                                                                                          text - - -Object - - - -

                                                                                                                                                                                          An object containing the plain text to render.

                                                                                                                                                                                          - -
                                                                                                                                                                                          - - - - - - - - - - - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          Returns:
                                                                                                                                                                                          - - - - - -string - - - - - --

                                                                                                                                                                                          The rendered HTML string.

                                                                                                                                                                                          - - - - - -
                                                                                                                                                                                          - - - - - -
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          - -

                                                                                                                                                                                          - - static renderTimeCell(time, classNames) → {string} - - - - -

                                                                                                                                                                                          - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          - - -
                                                                                                                                                                                          -

                                                                                                                                                                                          Renders a cell in the chat table to display the time a message was sent. -Formats the time and adds it to a

                                                                                                                                                                                          -
                                                                                                                                                                                          - - - - - - - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          Parameters:
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          NameTypeDescription
                                                                                                                                                                                          time - - -number - - - -

                                                                                                                                                                                          The timestamp of the message.

                                                                                                                                                                                          classNames - - -string - - - -

                                                                                                                                                                                          Additional class names to be added to the time cell.

                                                                                                                                                                                          - -
                                                                                                                                                                                          - - - - - - - - - - - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          Returns:
                                                                                                                                                                                          - - - - - -string - - - - - --

                                                                                                                                                                                          The HTML string representing a table cell with the formatted time.

                                                                                                                                                                                          - - - - - -
                                                                                                                                                                                          - - - - - -
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          - -

                                                                                                                                                                                          - - static renderTimeCell(time, classNames) → {string} - - - - -

                                                                                                                                                                                          - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          - - -
                                                                                                                                                                                          -

                                                                                                                                                                                          Renders a cell in the chat table to display the time a message was sent. -Formats the time and adds it to a

                                                                                                                                                                                          -
                                                                                                                                                                                          - - - - - - - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          Parameters:
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          NameTypeDescription
                                                                                                                                                                                          time - - -number - - - -

                                                                                                                                                                                          The timestamp of the message.

                                                                                                                                                                                          classNames - - -string - - - -

                                                                                                                                                                                          Additional class names to be added to the time cell.

                                                                                                                                                                                          - -
                                                                                                                                                                                          - - - - - - - - - - - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          Returns:
                                                                                                                                                                                          - - - - - -string - - - - - --

                                                                                                                                                                                          The HTML string representing a table cell with the formatted time.

                                                                                                                                                                                          - - - - - -
                                                                                                                                                                                          - - - - - -
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          - -

                                                                                                                                                                                          - - static request() - - - - -

                                                                                                                                                                                          - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          - - -
                                                                                                                                                                                          -

                                                                                                                                                                                          Requests chat messages for the currently active chat tab and background channels. -It calls the appropriate request function based on the active tab or background channels.

                                                                                                                                                                                          -
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          - -

                                                                                                                                                                                          - - static request() - - - - -

                                                                                                                                                                                          - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          - - -
                                                                                                                                                                                          -

                                                                                                                                                                                          Requests chat messages for the currently active chat tab and background channels. -It calls the appropriate request function based on the active tab or background channels.

                                                                                                                                                                                          -
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          - -

                                                                                                                                                                                          - - static requestAlerts(getOlderMsgs, isRetryopt) - - - - -

                                                                                                                                                                                          - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          - - -
                                                                                                                                                                                          -

                                                                                                                                                                                          Initiates a request for alerts chat data.

                                                                                                                                                                                          -
                                                                                                                                                                                          - - - - - - - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          Parameters:
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          NameTypeAttributesDefaultDescription
                                                                                                                                                                                          getOlderMsgs - - -boolean - - - - - - - - - - - -

                                                                                                                                                                                          Whether to retrieve older messages.

                                                                                                                                                                                          isRetry - - -boolean - - - - - - <optional>
                                                                                                                                                                                          - - - - - -
                                                                                                                                                                                          - - false - -

                                                                                                                                                                                          Whether the request is a retry.

                                                                                                                                                                                          - -
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          - -

                                                                                                                                                                                          - - static requestAlerts(getOlderMsgs, isRetryopt) - - - - -

                                                                                                                                                                                          - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          - - -
                                                                                                                                                                                          -

                                                                                                                                                                                          Initiates a request for alerts chat data.

                                                                                                                                                                                          -
                                                                                                                                                                                          - - - - - - - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          Parameters:
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          NameTypeAttributesDefaultDescription
                                                                                                                                                                                          getOlderMsgs - - -boolean - - - - - - - - - - - -

                                                                                                                                                                                          Whether to retrieve older messages.

                                                                                                                                                                                          isRetry - - -boolean - - - - - - <optional>
                                                                                                                                                                                          - - - - - -
                                                                                                                                                                                          - - false - -

                                                                                                                                                                                          Whether the request is a retry.

                                                                                                                                                                                          - -
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          - -

                                                                                                                                                                                          - - static requestFaction(getOlderMsgs, isRetryopt) - - - - -

                                                                                                                                                                                          - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          - - -
                                                                                                                                                                                          -

                                                                                                                                                                                          Requests faction chat messages.

                                                                                                                                                                                          -
                                                                                                                                                                                          - - - - - - - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          Parameters:
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          NameTypeAttributesDefaultDescription
                                                                                                                                                                                          getOlderMsgs - - -boolean - - - - - - - - - - - -

                                                                                                                                                                                          Flag to determine if older messages are being requested.

                                                                                                                                                                                          isRetry - - -boolean - - - - - - <optional>
                                                                                                                                                                                          - - - - - -
                                                                                                                                                                                          - - false - -

                                                                                                                                                                                          Flag to indicate if this is a retry attempt.

                                                                                                                                                                                          - -
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          - -

                                                                                                                                                                                          - - static requestFaction(getOlderMsgs, isRetryopt) - - - - -

                                                                                                                                                                                          - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          - - -
                                                                                                                                                                                          -

                                                                                                                                                                                          Requests faction chat messages.

                                                                                                                                                                                          -
                                                                                                                                                                                          - - - - - - - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          Parameters:
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          NameTypeAttributesDefaultDescription
                                                                                                                                                                                          getOlderMsgs - - -boolean - - - - - - - - - - - -

                                                                                                                                                                                          Flag to determine if older messages are being requested.

                                                                                                                                                                                          isRetry - - -boolean - - - - - - <optional>
                                                                                                                                                                                          - - - - - -
                                                                                                                                                                                          - - false - -

                                                                                                                                                                                          Flag to indicate if this is a retry attempt.

                                                                                                                                                                                          - -
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          - -

                                                                                                                                                                                          - - static requestPublic(getOlderMsgs, isRetryopt) - - - - -

                                                                                                                                                                                          - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          - - -
                                                                                                                                                                                          -

                                                                                                                                                                                          Initiates a request for public chat data.

                                                                                                                                                                                          -
                                                                                                                                                                                          - - - - - - - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          Parameters:
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          NameTypeAttributesDefaultDescription
                                                                                                                                                                                          getOlderMsgs - - -boolean - - - - - - - - - - - -

                                                                                                                                                                                          Whether to retrieve older messages.

                                                                                                                                                                                          isRetry - - -boolean - - - - - - <optional>
                                                                                                                                                                                          - - - - - -
                                                                                                                                                                                          - - false - -

                                                                                                                                                                                          Whether the request is a retry.

                                                                                                                                                                                          - -
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          - -

                                                                                                                                                                                          - - static requestPublic(getOlderMsgs, isRetryopt) - - - - -

                                                                                                                                                                                          - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          - - -
                                                                                                                                                                                          -

                                                                                                                                                                                          Initiates a request for public chat data.

                                                                                                                                                                                          -
                                                                                                                                                                                          - - - - - - - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          Parameters:
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          NameTypeAttributesDefaultDescription
                                                                                                                                                                                          getOlderMsgs - - -boolean - - - - - - - - - - - -

                                                                                                                                                                                          Whether to retrieve older messages.

                                                                                                                                                                                          isRetry - - -boolean - - - - - - <optional>
                                                                                                                                                                                          - - - - - -
                                                                                                                                                                                          - - false - -

                                                                                                                                                                                          Whether the request is a retry.

                                                                                                                                                                                          - -
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          - -

                                                                                                                                                                                          - - static setup() - - - - -

                                                                                                                                                                                          - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          - - -
                                                                                                                                                                                          -

                                                                                                                                                                                          Sets up the chat interface.

                                                                                                                                                                                          -
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          - -

                                                                                                                                                                                          - - static setup() - - - - -

                                                                                                                                                                                          - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          - - -
                                                                                                                                                                                          -

                                                                                                                                                                                          Sets up the chat interface.

                                                                                                                                                                                          -
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          - -

                                                                                                                                                                                          - - static setupPosting() - - - - -

                                                                                                                                                                                          - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          - - -
                                                                                                                                                                                          -

                                                                                                                                                                                          Sets up the chat message posting functionality.

                                                                                                                                                                                          -
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          - -

                                                                                                                                                                                          - - static setupPosting() - - - - -

                                                                                                                                                                                          - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          - - -
                                                                                                                                                                                          -

                                                                                                                                                                                          Sets up the chat message posting functionality.

                                                                                                                                                                                          -
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          - -

                                                                                                                                                                                          - - static setupTime() - - - - -

                                                                                                                                                                                          - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          - - -
                                                                                                                                                                                          -

                                                                                                                                                                                          Sets up the time display in the chat input box. -This function updates the time displayed next to the chat input field every minute to reflect the current time.

                                                                                                                                                                                          -
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          - -

                                                                                                                                                                                          - - static setupTime() - - - - -

                                                                                                                                                                                          - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          - - -
                                                                                                                                                                                          -

                                                                                                                                                                                          Sets up the time display in the chat input box. -This function updates the time displayed next to the chat input field every minute to reflect the current time.

                                                                                                                                                                                          -
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          - -

                                                                                                                                                                                          - - static show(name) - - - - -

                                                                                                                                                                                          - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          - - -
                                                                                                                                                                                          -

                                                                                                                                                                                          Displays the chat interface and activates a specified chat tab.

                                                                                                                                                                                          -
                                                                                                                                                                                          - - - - - - - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          Parameters:
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          NameTypeDescription
                                                                                                                                                                                          name - - -string - - - -

                                                                                                                                                                                          The name of the chat tab to show and activate.

                                                                                                                                                                                          - -
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          - -

                                                                                                                                                                                          - - static show(name) - - - - -

                                                                                                                                                                                          - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          - - -
                                                                                                                                                                                          -

                                                                                                                                                                                          Displays the chat interface and activates a specified chat tab.

                                                                                                                                                                                          -
                                                                                                                                                                                          - - - - - - - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          Parameters:
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          NameTypeDescription
                                                                                                                                                                                          name - - -string - - - -

                                                                                                                                                                                          The name of the chat tab to show and activate.

                                                                                                                                                                                          - -
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          - -

                                                                                                                                                                                          - - static tabToChannel(tab) → {string} - - - - -

                                                                                                                                                                                          - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          - - -
                                                                                                                                                                                          -

                                                                                                                                                                                          Converts a chat tab name to its corresponding COMM channel name.

                                                                                                                                                                                          -
                                                                                                                                                                                          - - - - - - - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          Parameters:
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          NameTypeDescription
                                                                                                                                                                                          tab - - -string - - - -

                                                                                                                                                                                          The name of the chat tab.

                                                                                                                                                                                          - -
                                                                                                                                                                                          - - - - - - - - - - - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          Returns:
                                                                                                                                                                                          - - - - - -string - - - - - --

                                                                                                                                                                                          The corresponding channel name ('faction', 'alerts', or 'all').

                                                                                                                                                                                          - - - - - -
                                                                                                                                                                                          - - - - - -
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          - -

                                                                                                                                                                                          - - static tabToChannel(tab) → {string} - - - - -

                                                                                                                                                                                          - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          - - -
                                                                                                                                                                                          -

                                                                                                                                                                                          Converts a chat tab name to its corresponding COMM channel name.

                                                                                                                                                                                          -
                                                                                                                                                                                          - - - - - - - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          Parameters:
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          NameTypeDescription
                                                                                                                                                                                          tab - - -string - - - -

                                                                                                                                                                                          The name of the chat tab.

                                                                                                                                                                                          - -
                                                                                                                                                                                          - - - - - - - - - - - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          Returns:
                                                                                                                                                                                          - - - - - -string - - - - - --

                                                                                                                                                                                          The corresponding channel name ('faction', 'alerts', or 'all').

                                                                                                                                                                                          - - - - - -
                                                                                                                                                                                          - - - - - -
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          - -

                                                                                                                                                                                          - - static toggle() - - - - -

                                                                                                                                                                                          - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          - - -
                                                                                                                                                                                          -

                                                                                                                                                                                          Toggles the chat window between expanded and collapsed states. -When expanded, the chat window covers a larger area of the screen. -This function also ensures that the chat is scrolled to the bottom when collapsed.

                                                                                                                                                                                          -
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          - -

                                                                                                                                                                                          - - static toggle() - - - - -

                                                                                                                                                                                          - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          - - -
                                                                                                                                                                                          -

                                                                                                                                                                                          Toggles the chat window between expanded and collapsed states. -When expanded, the chat window covers a larger area of the screen. -This function also ensures that the chat is scrolled to the bottom when collapsed.

                                                                                                                                                                                          -
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          - -

                                                                                                                                                                                          - - static transformMessage(markup) → {Array} - - - - -

                                                                                                                                                                                          - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          - - -
                                                                                                                                                                                          -

                                                                                                                                                                                          Transforms a given markup array into an older, more straightforward format for easier understanding.

                                                                                                                                                                                          -
                                                                                                                                                                                          - - - - - - - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          Parameters:
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          NameTypeDescription
                                                                                                                                                                                          markup - - -Array - - - -

                                                                                                                                                                                          An array representing the markup to be transformed.

                                                                                                                                                                                          - -
                                                                                                                                                                                          - - - - - - - - - - - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          Returns:
                                                                                                                                                                                          - - - - - -Array - - - - - --

                                                                                                                                                                                          The transformed markup array with a simplified structure.

                                                                                                                                                                                          - - - - - -
                                                                                                                                                                                          - - - - - -
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          - -

                                                                                                                                                                                          - - static transformMessage(markup) → {Array} - - - - -

                                                                                                                                                                                          - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          - - -
                                                                                                                                                                                          -

                                                                                                                                                                                          Transforms a given markup array into an older, more straightforward format for easier understanding.

                                                                                                                                                                                          -
                                                                                                                                                                                          - - - - - - - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          Parameters:
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          NameTypeDescription
                                                                                                                                                                                          markup - - -Array - - - -

                                                                                                                                                                                          An array representing the markup to be transformed.

                                                                                                                                                                                          - -
                                                                                                                                                                                          - - - - - - - - - - - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          Returns:
                                                                                                                                                                                          - - - - - -Array - - - - - --

                                                                                                                                                                                          The transformed markup array with a simplified structure.

                                                                                                                                                                                          - - - - - -
                                                                                                                                                                                          - - - - - -
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          - -

                                                                                                                                                                                          - - static updateOldNewHash(newData, storageHash, isOlderMsgs, isAscendingOrder) - - - - -

                                                                                                                                                                                          - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          - - -
                                                                                                                                                                                          -

                                                                                                                                                                                          Updates the oldest and newest message timestamps and GUIDs in the chat storage.

                                                                                                                                                                                          -
                                                                                                                                                                                          - - - - - - - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          Parameters:
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          NameTypeDescription
                                                                                                                                                                                          newData - - -Object - - - -

                                                                                                                                                                                          The new chat data received.

                                                                                                                                                                                          storageHash - - -Object - - - -

                                                                                                                                                                                          The chat storage object.

                                                                                                                                                                                          isOlderMsgs - - -boolean - - - -

                                                                                                                                                                                          Whether the new data contains older messages.

                                                                                                                                                                                          isAscendingOrder - - -boolean - - - -

                                                                                                                                                                                          Whether the new data is in ascending order.

                                                                                                                                                                                          - -
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          - -

                                                                                                                                                                                          - - static updateOldNewHash(newData, storageHash, isOlderMsgs, isAscendingOrder) - - - - -

                                                                                                                                                                                          - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          - - -
                                                                                                                                                                                          -

                                                                                                                                                                                          Updates the oldest and newest message timestamps and GUIDs in the chat storage.

                                                                                                                                                                                          -
                                                                                                                                                                                          - - - - - - - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          Parameters:
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          NameTypeDescription
                                                                                                                                                                                          newData - - -Object - - - -

                                                                                                                                                                                          The new chat data received.

                                                                                                                                                                                          storageHash - - -Object - - - -

                                                                                                                                                                                          The chat storage object.

                                                                                                                                                                                          isOlderMsgs - - -boolean - - - -

                                                                                                                                                                                          Whether the new data contains older messages.

                                                                                                                                                                                          isAscendingOrder - - -boolean - - - -

                                                                                                                                                                                          Whether the new data is in ascending order.

                                                                                                                                                                                          - -
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          - -

                                                                                                                                                                                          - - static writeDataToHash(newData, storageHash, isOlderMsgs, isAscendingOrder) - - - - -

                                                                                                                                                                                          - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          - - -
                                                                                                                                                                                          -

                                                                                                                                                                                          Writes new chat data to the chat storage and manages the order of messages.

                                                                                                                                                                                          -
                                                                                                                                                                                          - - - - - - - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          Parameters:
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          NameTypeDescription
                                                                                                                                                                                          newData - - -Object - - - -

                                                                                                                                                                                          The new chat data received.

                                                                                                                                                                                          storageHash - - -Object - - - -

                                                                                                                                                                                          The chat storage object.

                                                                                                                                                                                          isOlderMsgs - - -boolean - - - -

                                                                                                                                                                                          Whether the new data contains older messages.

                                                                                                                                                                                          isAscendingOrder - - -boolean - - - -

                                                                                                                                                                                          Whether the new data is in ascending order.

                                                                                                                                                                                          - -
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          - -

                                                                                                                                                                                          - - static writeDataToHash(newData, storageHash, isOlderMsgs, isAscendingOrder) - - - - -

                                                                                                                                                                                          - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          - - -
                                                                                                                                                                                          -

                                                                                                                                                                                          Writes new chat data to the chat storage and manages the order of messages.

                                                                                                                                                                                          -
                                                                                                                                                                                          - - - - - - - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          Parameters:
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          NameTypeDescription
                                                                                                                                                                                          newData - - -Object - - - -

                                                                                                                                                                                          The new chat data received.

                                                                                                                                                                                          storageHash - - -Object - - - -

                                                                                                                                                                                          The chat storage object.

                                                                                                                                                                                          isOlderMsgs - - -boolean - - - -

                                                                                                                                                                                          Whether the new data contains older messages.

                                                                                                                                                                                          isAscendingOrder - - -boolean - - - -

                                                                                                                                                                                          Whether the new data is in ascending order.

                                                                                                                                                                                          - -
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          - -

                                                                                                                                                                                          - - - - - -

                                                                                                                                                                                          - -
                                                                                                                                                                                          - - - - - - - -
                                                                                                                                                                                          - -
                                                                                                                                                                                          - -

                                                                                                                                                                                          window.chat

                                                                                                                                                                                          - - -
                                                                                                                                                                                          - -
                                                                                                                                                                                          - -
                                                                                                                                                                                          - - -

                                                                                                                                                                                          Namespace for chat-related functionalities.

                                                                                                                                                                                          - - - - - -
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          - - - - - - - - - - - - - - - -

                                                                                                                                                                                          Members

                                                                                                                                                                                          - -
                                                                                                                                                                                          - - -
                                                                                                                                                                                          -

                                                                                                                                                                                          - static _alerts :Object - - - -

                                                                                                                                                                                          - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          - -
                                                                                                                                                                                          -

                                                                                                                                                                                          Holds data related to alerts chat.

                                                                                                                                                                                          -
                                                                                                                                                                                          - - - - - - - -
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          - - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          -

                                                                                                                                                                                          - static _alerts :Object - - - -

                                                                                                                                                                                          - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          - -
                                                                                                                                                                                          -

                                                                                                                                                                                          Holds data related to alerts chat.

                                                                                                                                                                                          -
                                                                                                                                                                                          - - - - - - - -
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          - - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          -

                                                                                                                                                                                          - static _faction :Object - - - -

                                                                                                                                                                                          - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          - -
                                                                                                                                                                                          -

                                                                                                                                                                                          Holds data related to faction chat.

                                                                                                                                                                                          -
                                                                                                                                                                                          - - - - - - - -
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          - - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          -

                                                                                                                                                                                          - static _faction :Object - - - -

                                                                                                                                                                                          - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          - -
                                                                                                                                                                                          -

                                                                                                                                                                                          Holds data related to faction chat.

                                                                                                                                                                                          -
                                                                                                                                                                                          - - - - - - - -
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          - - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          -

                                                                                                                                                                                          - static _public :Object - - - -

                                                                                                                                                                                          - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          - -
                                                                                                                                                                                          -

                                                                                                                                                                                          Holds data related to public chat.

                                                                                                                                                                                          -
                                                                                                                                                                                          - - - - - - - -
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          - - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          -

                                                                                                                                                                                          - static _public :Object - - - -

                                                                                                                                                                                          - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          - -
                                                                                                                                                                                          -

                                                                                                                                                                                          Holds data related to public chat.

                                                                                                                                                                                          -
                                                                                                                                                                                          - - - - - - - -
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          - - - - - -
                                                                                                                                                                                          - -
                                                                                                                                                                                          - - - -

                                                                                                                                                                                          Methods

                                                                                                                                                                                          - -
                                                                                                                                                                                          - - -
                                                                                                                                                                                          - -

                                                                                                                                                                                          - - static addNickname(nick) - - - - -

                                                                                                                                                                                          - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          - - -
                                                                                                                                                                                          -

                                                                                                                                                                                          Adds a nickname to the chat input.

                                                                                                                                                                                          -
                                                                                                                                                                                          - - - - - - - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          Parameters:
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          NameTypeDescription
                                                                                                                                                                                          nick - - -string - - - -

                                                                                                                                                                                          The nickname to add.

                                                                                                                                                                                          - -
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          - -

                                                                                                                                                                                          - - static addNickname(nick) - - - - -

                                                                                                                                                                                          - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          - - -
                                                                                                                                                                                          -

                                                                                                                                                                                          Adds a nickname to the chat input.

                                                                                                                                                                                          -
                                                                                                                                                                                          - - - - - - - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          Parameters:
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          NameTypeDescription
                                                                                                                                                                                          nick - - -string - - - -

                                                                                                                                                                                          The nickname to add.

                                                                                                                                                                                          - -
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          - -

                                                                                                                                                                                          - - static backgroundChannelData(instance, channel, flag) - - - - -

                                                                                                                                                                                          - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          - - -
                                                                                                                                                                                          -

                                                                                                                                                                                          Allows plugins to request and monitor COMM data streams in the background. This is useful for plugins -that need to process COMM data even when the user is not actively viewing the COMM channels. -It tracks the requested channels for each plugin instance and updates the global state accordingly.

                                                                                                                                                                                          -
                                                                                                                                                                                          - - - - - - - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          Parameters:
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          NameTypeDescription
                                                                                                                                                                                          instance - - -string - - - -

                                                                                                                                                                                          A unique identifier for the plugin or instance requesting background COMM data.

                                                                                                                                                                                          channel - - -string - - - -

                                                                                                                                                                                          The name of the COMM channel ('all', 'faction', or 'alerts').

                                                                                                                                                                                          flag - - -boolean - - - -

                                                                                                                                                                                          Set to true to request data for the specified channel, false to stop requesting.

                                                                                                                                                                                          - -
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          - -

                                                                                                                                                                                          - - static backgroundChannelData(instance, channel, flag) - - - - -

                                                                                                                                                                                          - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          - - -
                                                                                                                                                                                          -

                                                                                                                                                                                          Allows plugins to request and monitor COMM data streams in the background. This is useful for plugins -that need to process COMM data even when the user is not actively viewing the COMM channels. -It tracks the requested channels for each plugin instance and updates the global state accordingly.

                                                                                                                                                                                          -
                                                                                                                                                                                          - - - - - - - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          Parameters:
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          NameTypeDescription
                                                                                                                                                                                          instance - - -string - - - -

                                                                                                                                                                                          A unique identifier for the plugin or instance requesting background COMM data.

                                                                                                                                                                                          channel - - -string - - - -

                                                                                                                                                                                          The name of the COMM channel ('all', 'faction', or 'alerts').

                                                                                                                                                                                          flag - - -boolean - - - -

                                                                                                                                                                                          Set to true to request data for the specified channel, false to stop requesting.

                                                                                                                                                                                          - -
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          - -

                                                                                                                                                                                          - - static chooser(event) - - - - -

                                                                                                                                                                                          - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          - - -
                                                                                                                                                                                          -

                                                                                                                                                                                          Chat tab chooser handler. -This function is triggered by a click event on the chat tab. It reads the tab name from the event target -and activates the corresponding chat tab.

                                                                                                                                                                                          -
                                                                                                                                                                                          - - - - - - - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          Parameters:
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          NameTypeDescription
                                                                                                                                                                                          event - - -Event - - - -

                                                                                                                                                                                          The event triggered by clicking a chat tab.

                                                                                                                                                                                          - -
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          - -

                                                                                                                                                                                          - - static chooser(event) - - - - -

                                                                                                                                                                                          - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          - - -
                                                                                                                                                                                          -

                                                                                                                                                                                          Chat tab chooser handler. -This function is triggered by a click event on the chat tab. It reads the tab name from the event target -and activates the corresponding chat tab.

                                                                                                                                                                                          -
                                                                                                                                                                                          - - - - - - - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          Parameters:
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          NameTypeDescription
                                                                                                                                                                                          event - - -Event - - - -

                                                                                                                                                                                          The event triggered by clicking a chat tab.

                                                                                                                                                                                          - -
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          - -

                                                                                                                                                                                          - - static chooseTab(tab) - - - - -

                                                                                                                                                                                          - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          - - -
                                                                                                                                                                                          -

                                                                                                                                                                                          Chooses and activates a specified chat tab. -Also triggers an early refresh of the chat data when switching tabs.

                                                                                                                                                                                          -
                                                                                                                                                                                          - - - - - - - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          Parameters:
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          NameTypeDescription
                                                                                                                                                                                          tab - - -string - - - -

                                                                                                                                                                                          The name of the chat tab to activate ('all', 'faction', or 'alerts').

                                                                                                                                                                                          - -
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          - -

                                                                                                                                                                                          - - static chooseTab(tab) - - - - -

                                                                                                                                                                                          - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          - - -
                                                                                                                                                                                          -

                                                                                                                                                                                          Chooses and activates a specified chat tab. -Also triggers an early refresh of the chat data when switching tabs.

                                                                                                                                                                                          -
                                                                                                                                                                                          - - - - - - - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          Parameters:
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          NameTypeDescription
                                                                                                                                                                                          tab - - -string - - - -

                                                                                                                                                                                          The name of the chat tab to activate ('all', 'faction', or 'alerts').

                                                                                                                                                                                          - -
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          - -

                                                                                                                                                                                          - - static genPostData(channel, storageHash, getOlderMsgs) → {Object} - - - - -

                                                                                                                                                                                          - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          - - -
                                                                                                                                                                                          -

                                                                                                                                                                                          Generates post data for chat requests.

                                                                                                                                                                                          -
                                                                                                                                                                                          - - - - - - - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          Parameters:
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          NameTypeDescription
                                                                                                                                                                                          channel - - -string - - - -

                                                                                                                                                                                          The chat channel.

                                                                                                                                                                                          storageHash - - -Object - - - -

                                                                                                                                                                                          Storage hash for the chat.

                                                                                                                                                                                          getOlderMsgs - - -boolean - - - -

                                                                                                                                                                                          Flag to determine if older messages are being requested.

                                                                                                                                                                                          - -
                                                                                                                                                                                          - - - - - - - - - - - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          Returns:
                                                                                                                                                                                          - - - - - -Object - - - - - --

                                                                                                                                                                                          The generated post data.

                                                                                                                                                                                          - - - - - -
                                                                                                                                                                                          - - - - - -
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          - -

                                                                                                                                                                                          - - static genPostData(channel, storageHash, getOlderMsgs) → {Object} - - - - -

                                                                                                                                                                                          - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          - - -
                                                                                                                                                                                          -

                                                                                                                                                                                          Generates post data for chat requests.

                                                                                                                                                                                          -
                                                                                                                                                                                          - - - - - - - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          Parameters:
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          NameTypeDescription
                                                                                                                                                                                          channel - - -string - - - -

                                                                                                                                                                                          The chat channel.

                                                                                                                                                                                          storageHash - - -Object - - - -

                                                                                                                                                                                          Storage hash for the chat.

                                                                                                                                                                                          getOlderMsgs - - -boolean - - - -

                                                                                                                                                                                          Flag to determine if older messages are being requested.

                                                                                                                                                                                          - -
                                                                                                                                                                                          - - - - - - - - - - - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          Returns:
                                                                                                                                                                                          - - - - - -Object - - - - - --

                                                                                                                                                                                          The generated post data.

                                                                                                                                                                                          - - - - - -
                                                                                                                                                                                          - - - - - -
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          - -

                                                                                                                                                                                          - - static getActive() → {string} - - - - -

                                                                                                                                                                                          - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          - - -
                                                                                                                                                                                          -

                                                                                                                                                                                          Gets the name of the active chat tab.

                                                                                                                                                                                          -
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          Returns:
                                                                                                                                                                                          - - - - - -string - - - - - --

                                                                                                                                                                                          The name of the active chat tab.

                                                                                                                                                                                          - - - - - -
                                                                                                                                                                                          - - - - - -
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          - -

                                                                                                                                                                                          - - static getActive() → {string} - - - - -

                                                                                                                                                                                          - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          - - -
                                                                                                                                                                                          -

                                                                                                                                                                                          Gets the name of the active chat tab.

                                                                                                                                                                                          -
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          Returns:
                                                                                                                                                                                          - - - - - -string - - - - - --

                                                                                                                                                                                          The name of the active chat tab.

                                                                                                                                                                                          - - - - - -
                                                                                                                                                                                          - - - - - -
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          - -

                                                                                                                                                                                          - - static getChatPortalName(markup) → {string} - - - - -

                                                                                                                                                                                          - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          - - -
                                                                                                                                                                                          -

                                                                                                                                                                                          Overrides portal names used repeatedly in chat, such as 'US Post Office', with more specific names.

                                                                                                                                                                                          -
                                                                                                                                                                                          - - - - - - - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          Parameters:
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          NameTypeDescription
                                                                                                                                                                                          markup - - -Object - - - -

                                                                                                                                                                                          An object containing portal markup, including the name and address.

                                                                                                                                                                                          - -
                                                                                                                                                                                          - - - - - - - - - - - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          Returns:
                                                                                                                                                                                          - - - - - -string - - - - - --

                                                                                                                                                                                          The processed portal name.

                                                                                                                                                                                          - - - - - -
                                                                                                                                                                                          - - - - - -
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          - -

                                                                                                                                                                                          - - static getChatPortalName(markup) → {string} - - - - -

                                                                                                                                                                                          - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          - - -
                                                                                                                                                                                          -

                                                                                                                                                                                          Overrides portal names used repeatedly in chat, such as 'US Post Office', with more specific names.

                                                                                                                                                                                          -
                                                                                                                                                                                          - - - - - - - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          Parameters:
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          NameTypeDescription
                                                                                                                                                                                          markup - - -Object - - - -

                                                                                                                                                                                          An object containing portal markup, including the name and address.

                                                                                                                                                                                          - -
                                                                                                                                                                                          - - - - - - - - - - - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          Returns:
                                                                                                                                                                                          - - - - - -string - - - - - --

                                                                                                                                                                                          The processed portal name.

                                                                                                                                                                                          - - - - - -
                                                                                                                                                                                          - - - - - -
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          - -

                                                                                                                                                                                          - - static handleAlerts(data, olderMsgs, ascendingTimestampOrder) - - - - -

                                                                                                                                                                                          - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          - - -
                                                                                                                                                                                          -

                                                                                                                                                                                          Handles the alerts chat data received from the server.

                                                                                                                                                                                          -
                                                                                                                                                                                          - - - - - - - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          Parameters:
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          NameTypeDescription
                                                                                                                                                                                          data - - -Object - - - -

                                                                                                                                                                                          The alerts chat data.

                                                                                                                                                                                          olderMsgs - - -boolean - - - -

                                                                                                                                                                                          Whether the received messages are older.

                                                                                                                                                                                          ascendingTimestampOrder - - -boolean - - - -

                                                                                                                                                                                          Whether messages are in ascending timestamp order.

                                                                                                                                                                                          - -
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          - -

                                                                                                                                                                                          - - static handleAlerts(data, olderMsgs, ascendingTimestampOrder) - - - - -

                                                                                                                                                                                          - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          - - -
                                                                                                                                                                                          -

                                                                                                                                                                                          Handles the alerts chat data received from the server.

                                                                                                                                                                                          -
                                                                                                                                                                                          - - - - - - - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          Parameters:
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          NameTypeDescription
                                                                                                                                                                                          data - - -Object - - - -

                                                                                                                                                                                          The alerts chat data.

                                                                                                                                                                                          olderMsgs - - -boolean - - - -

                                                                                                                                                                                          Whether the received messages are older.

                                                                                                                                                                                          ascendingTimestampOrder - - -boolean - - - -

                                                                                                                                                                                          Whether messages are in ascending timestamp order.

                                                                                                                                                                                          - -
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          - -

                                                                                                                                                                                          - - static handleFaction(data, olderMsgs, ascendingTimestampOrder) - - - - -

                                                                                                                                                                                          - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          - - -
                                                                                                                                                                                          -

                                                                                                                                                                                          Handles faction chat response.

                                                                                                                                                                                          -
                                                                                                                                                                                          - - - - - - - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          Parameters:
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          NameTypeDescription
                                                                                                                                                                                          data - - -Object - - - -

                                                                                                                                                                                          Response data from server.

                                                                                                                                                                                          olderMsgs - - -boolean - - - -

                                                                                                                                                                                          Indicates if older messages were requested.

                                                                                                                                                                                          ascendingTimestampOrder - - -boolean - - - -

                                                                                                                                                                                          Indicates if messages are in ascending timestamp order.

                                                                                                                                                                                          - -
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          - -

                                                                                                                                                                                          - - static handleFaction(data, olderMsgs, ascendingTimestampOrder) - - - - -

                                                                                                                                                                                          - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          - - -
                                                                                                                                                                                          -

                                                                                                                                                                                          Handles faction chat response.

                                                                                                                                                                                          -
                                                                                                                                                                                          - - - - - - - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          Parameters:
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          NameTypeDescription
                                                                                                                                                                                          data - - -Object - - - -

                                                                                                                                                                                          Response data from server.

                                                                                                                                                                                          olderMsgs - - -boolean - - - -

                                                                                                                                                                                          Indicates if older messages were requested.

                                                                                                                                                                                          ascendingTimestampOrder - - -boolean - - - -

                                                                                                                                                                                          Indicates if messages are in ascending timestamp order.

                                                                                                                                                                                          - -
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          - -

                                                                                                                                                                                          - - static handlePublic(data, olderMsgs, ascendingTimestampOrder) - - - - -

                                                                                                                                                                                          - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          - - -
                                                                                                                                                                                          -

                                                                                                                                                                                          Handles the public chat data received from the server.

                                                                                                                                                                                          -
                                                                                                                                                                                          - - - - - - - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          Parameters:
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          NameTypeDescription
                                                                                                                                                                                          data - - -Object - - - -

                                                                                                                                                                                          The public chat data.

                                                                                                                                                                                          olderMsgs - - -boolean - - - -

                                                                                                                                                                                          Whether the received messages are older.

                                                                                                                                                                                          ascendingTimestampOrder - - -boolean - - - -

                                                                                                                                                                                          Whether messages are in ascending timestamp order.

                                                                                                                                                                                          - -
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          - -

                                                                                                                                                                                          - - static handlePublic(data, olderMsgs, ascendingTimestampOrder) - - - - -

                                                                                                                                                                                          - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          - - -
                                                                                                                                                                                          -

                                                                                                                                                                                          Handles the public chat data received from the server.

                                                                                                                                                                                          -
                                                                                                                                                                                          - - - - - - - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          Parameters:
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          NameTypeDescription
                                                                                                                                                                                          data - - -Object - - - -

                                                                                                                                                                                          The public chat data.

                                                                                                                                                                                          olderMsgs - - -boolean - - - -

                                                                                                                                                                                          Whether the received messages are older.

                                                                                                                                                                                          ascendingTimestampOrder - - -boolean - - - -

                                                                                                                                                                                          Whether messages are in ascending timestamp order.

                                                                                                                                                                                          - -
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          - -

                                                                                                                                                                                          - - static handleTabCompletion() - - - - -

                                                                                                                                                                                          - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          - - -
                                                                                                                                                                                          -

                                                                                                                                                                                          Handles tab completion in chat input.

                                                                                                                                                                                          -
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          - -

                                                                                                                                                                                          - - static handleTabCompletion() - - - - -

                                                                                                                                                                                          - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          - - -
                                                                                                                                                                                          -

                                                                                                                                                                                          Handles tab completion in chat input.

                                                                                                                                                                                          -
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          - -

                                                                                                                                                                                          - - static keepScrollPosition(box, scrollBefore, isOldMsgs) - - - - -

                                                                                                                                                                                          - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          - - -
                                                                                                                                                                                          -

                                                                                                                                                                                          Maintains the scroll position of a chat box when new messages are added. -This function is designed to keep the scroll position fixed when old messages are loaded, and to automatically scroll -to the bottom when new messages are added if the user is already at the bottom of the chat.

                                                                                                                                                                                          -
                                                                                                                                                                                          - - - - - - - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          Parameters:
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          NameTypeDescription
                                                                                                                                                                                          box - - -jQuery - - - -

                                                                                                                                                                                          The jQuery object of the chat box.

                                                                                                                                                                                          scrollBefore - - -number - - - -

                                                                                                                                                                                          The scroll position before new messages were added.

                                                                                                                                                                                          isOldMsgs - - -boolean - - - -

                                                                                                                                                                                          Indicates if the added messages are older messages.

                                                                                                                                                                                          - -
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          - -

                                                                                                                                                                                          - - static keepScrollPosition(box, scrollBefore, isOldMsgs) - - - - -

                                                                                                                                                                                          - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          - - -
                                                                                                                                                                                          -

                                                                                                                                                                                          Maintains the scroll position of a chat box when new messages are added. -This function is designed to keep the scroll position fixed when old messages are loaded, and to automatically scroll -to the bottom when new messages are added if the user is already at the bottom of the chat.

                                                                                                                                                                                          -
                                                                                                                                                                                          - - - - - - - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          Parameters:
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          NameTypeDescription
                                                                                                                                                                                          box - - -jQuery - - - -

                                                                                                                                                                                          The jQuery object of the chat box.

                                                                                                                                                                                          scrollBefore - - -number - - - -

                                                                                                                                                                                          The scroll position before new messages were added.

                                                                                                                                                                                          isOldMsgs - - -boolean - - - -

                                                                                                                                                                                          Indicates if the added messages are older messages.

                                                                                                                                                                                          - -
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          - -

                                                                                                                                                                                          - - static needMoreMessages() - - - - -

                                                                                                                                                                                          - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          - - -
                                                                                                                                                                                          -

                                                                                                                                                                                          Checks if the currently selected chat tab needs more messages. -This function is triggered by scroll events and loads older messages when the user scrolls to the top.

                                                                                                                                                                                          -
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          - -

                                                                                                                                                                                          - - static needMoreMessages() - - - - -

                                                                                                                                                                                          - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          - - -
                                                                                                                                                                                          -

                                                                                                                                                                                          Checks if the currently selected chat tab needs more messages. -This function is triggered by scroll events and loads older messages when the user scrolls to the top.

                                                                                                                                                                                          -
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          - -

                                                                                                                                                                                          - - static nicknameClicked(event, nickname) → {boolean} - - - - -

                                                                                                                                                                                          - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          - - -
                                                                                                                                                                                          -

                                                                                                                                                                                          Handles click events on nicknames in the chat.

                                                                                                                                                                                          -
                                                                                                                                                                                          - - - - - - - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          Parameters:
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          NameTypeDescription
                                                                                                                                                                                          event - - -Event - - - -

                                                                                                                                                                                          The click event.

                                                                                                                                                                                          nickname - - -string - - - -

                                                                                                                                                                                          The clicked nickname.

                                                                                                                                                                                          - -
                                                                                                                                                                                          - - - - - - - - - - - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          Returns:
                                                                                                                                                                                          - - - - - -boolean - - - - - --

                                                                                                                                                                                          Always returns false.

                                                                                                                                                                                          - - - - - -
                                                                                                                                                                                          - - - - - -
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          - -

                                                                                                                                                                                          - - static nicknameClicked(event, nickname) → {boolean} - - - - -

                                                                                                                                                                                          - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          - - -
                                                                                                                                                                                          -

                                                                                                                                                                                          Handles click events on nicknames in the chat.

                                                                                                                                                                                          -
                                                                                                                                                                                          - - - - - - - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          Parameters:
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          NameTypeDescription
                                                                                                                                                                                          event - - -Event - - - -

                                                                                                                                                                                          The click event.

                                                                                                                                                                                          nickname - - -string - - - -

                                                                                                                                                                                          The clicked nickname.

                                                                                                                                                                                          - -
                                                                                                                                                                                          - - - - - - - - - - - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          Returns:
                                                                                                                                                                                          - - - - - -boolean - - - - - --

                                                                                                                                                                                          Always returns false.

                                                                                                                                                                                          - - - - - -
                                                                                                                                                                                          - - - - - -
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          - -

                                                                                                                                                                                          - - static parseMsgData(data) → {Object} - - - - -

                                                                                                                                                                                          - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          - - -
                                                                                                                                                                                          -

                                                                                                                                                                                          Parses chat message data into a more convenient format.

                                                                                                                                                                                          -
                                                                                                                                                                                          - - - - - - - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          Parameters:
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          NameTypeDescription
                                                                                                                                                                                          data - - -Object - - - -

                                                                                                                                                                                          The raw chat message data.

                                                                                                                                                                                          - -
                                                                                                                                                                                          - - - - - - - - - - - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          Returns:
                                                                                                                                                                                          - - - - - -Object - - - - - --

                                                                                                                                                                                          The parsed chat message data.

                                                                                                                                                                                          - - - - - -
                                                                                                                                                                                          - - - - - -
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          - -

                                                                                                                                                                                          - - static parseMsgData(data) → {Object} - - - - -

                                                                                                                                                                                          - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          - - -
                                                                                                                                                                                          -

                                                                                                                                                                                          Parses chat message data into a more convenient format.

                                                                                                                                                                                          -
                                                                                                                                                                                          - - - - - - - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          Parameters:
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          NameTypeDescription
                                                                                                                                                                                          data - - -Object - - - -

                                                                                                                                                                                          The raw chat message data.

                                                                                                                                                                                          - -
                                                                                                                                                                                          - - - - - - - - - - - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          Returns:
                                                                                                                                                                                          - - - - - -Object - - - - - --

                                                                                                                                                                                          The parsed chat message data.

                                                                                                                                                                                          - - - - - -
                                                                                                                                                                                          - - - - - -
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          - -

                                                                                                                                                                                          - - static postMsg() - - - - -

                                                                                                                                                                                          - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          - - -
                                                                                                                                                                                          -

                                                                                                                                                                                          Posts a chat message to the currently active chat tab.

                                                                                                                                                                                          -
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          - -

                                                                                                                                                                                          - - static postMsg() - - - - -

                                                                                                                                                                                          - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          - - -
                                                                                                                                                                                          -

                                                                                                                                                                                          Posts a chat message to the currently active chat tab.

                                                                                                                                                                                          -
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          - -

                                                                                                                                                                                          - - static renderAlerts(oldMsgsWereAdded) - - - - -

                                                                                                                                                                                          - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          - - -
                                                                                                                                                                                          -

                                                                                                                                                                                          Renders alerts chat in the UI.

                                                                                                                                                                                          -
                                                                                                                                                                                          - - - - - - - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          Parameters:
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          NameTypeDescription
                                                                                                                                                                                          oldMsgsWereAdded - - -boolean - - - -

                                                                                                                                                                                          Indicates if older messages were added to the chat.

                                                                                                                                                                                          - -
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          - -

                                                                                                                                                                                          - - static renderAlerts(oldMsgsWereAdded) - - - - -

                                                                                                                                                                                          - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          - - -
                                                                                                                                                                                          -

                                                                                                                                                                                          Renders alerts chat in the UI.

                                                                                                                                                                                          -
                                                                                                                                                                                          - - - - - - - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          Parameters:
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          NameTypeDescription
                                                                                                                                                                                          oldMsgsWereAdded - - -boolean - - - -

                                                                                                                                                                                          Indicates if older messages were added to the chat.

                                                                                                                                                                                          - -
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          - -

                                                                                                                                                                                          - - static renderData(data, element, likelyWereOldMsgs, sortedGuids) - - - - -

                                                                                                                                                                                          - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          - - -
                                                                                                                                                                                          -

                                                                                                                                                                                          Renders data from the data-hash to the element defined by the given ID.

                                                                                                                                                                                          -
                                                                                                                                                                                          - - - - - - - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          Parameters:
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          NameTypeDescription
                                                                                                                                                                                          data - - -Object - - - -

                                                                                                                                                                                          Chat data to be rendered.

                                                                                                                                                                                          element - - -string - - - -

                                                                                                                                                                                          ID of the DOM element to render the chat into.

                                                                                                                                                                                          likelyWereOldMsgs - - -boolean - - - -

                                                                                                                                                                                          Flag indicating if older messages are likely to have been added.

                                                                                                                                                                                          sortedGuids - - -Array - - - -

                                                                                                                                                                                          Sorted array of GUIDs representing the order of messages.

                                                                                                                                                                                          - -
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          - -

                                                                                                                                                                                          - - static renderData(data, element, likelyWereOldMsgs, sortedGuids) - - - - -

                                                                                                                                                                                          - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          - - -
                                                                                                                                                                                          -

                                                                                                                                                                                          Renders data from the data-hash to the element defined by the given ID.

                                                                                                                                                                                          -
                                                                                                                                                                                          - - - - - - - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          Parameters:
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          NameTypeDescription
                                                                                                                                                                                          data - - -Object - - - -

                                                                                                                                                                                          Chat data to be rendered.

                                                                                                                                                                                          element - - -string - - - -

                                                                                                                                                                                          ID of the DOM element to render the chat into.

                                                                                                                                                                                          likelyWereOldMsgs - - -boolean - - - -

                                                                                                                                                                                          Flag indicating if older messages are likely to have been added.

                                                                                                                                                                                          sortedGuids - - -Array - - - -

                                                                                                                                                                                          Sorted array of GUIDs representing the order of messages.

                                                                                                                                                                                          - -
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          - -

                                                                                                                                                                                          - - static renderDivider(text) → {string} - - - - -

                                                                                                                                                                                          - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          - - -
                                                                                                                                                                                          -

                                                                                                                                                                                          Renders a divider row in the chat table.

                                                                                                                                                                                          -
                                                                                                                                                                                          - - - - - - - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          Parameters:
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          NameTypeDescription
                                                                                                                                                                                          text - - -string - - - -

                                                                                                                                                                                          Text to display within the divider row.

                                                                                                                                                                                          - -
                                                                                                                                                                                          - - - - - - - - - - - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          Returns:
                                                                                                                                                                                          - - - - - -string - - - - - --

                                                                                                                                                                                          The HTML string representing a divider row in the chat table.

                                                                                                                                                                                          - - - - - -
                                                                                                                                                                                          - - - - - -
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          - -

                                                                                                                                                                                          - - static renderDivider(text) → {string} - - - - -

                                                                                                                                                                                          - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          - - -
                                                                                                                                                                                          -

                                                                                                                                                                                          Renders a divider row in the chat table.

                                                                                                                                                                                          -
                                                                                                                                                                                          - - - - - - - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          Parameters:
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          NameTypeDescription
                                                                                                                                                                                          text - - -string - - - -

                                                                                                                                                                                          Text to display within the divider row.

                                                                                                                                                                                          - -
                                                                                                                                                                                          - - - - - - - - - - - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          Returns:
                                                                                                                                                                                          - - - - - -string - - - - - --

                                                                                                                                                                                          The HTML string representing a divider row in the chat table.

                                                                                                                                                                                          - - - - - -
                                                                                                                                                                                          - - - - - -
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          - -

                                                                                                                                                                                          - - static renderFaction(oldMsgsWereAdded) - - - - -

                                                                                                                                                                                          - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          - - -
                                                                                                                                                                                          -

                                                                                                                                                                                          Renders faction chat.

                                                                                                                                                                                          -
                                                                                                                                                                                          - - - - - - - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          Parameters:
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          NameTypeDescription
                                                                                                                                                                                          oldMsgsWereAdded - - -boolean - - - -

                                                                                                                                                                                          Indicates if old messages were added in the current rendering.

                                                                                                                                                                                          - -
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          - -

                                                                                                                                                                                          - - static renderFaction(oldMsgsWereAdded) - - - - -

                                                                                                                                                                                          - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          - - -
                                                                                                                                                                                          -

                                                                                                                                                                                          Renders faction chat.

                                                                                                                                                                                          -
                                                                                                                                                                                          - - - - - - - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          Parameters:
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          NameTypeDescription
                                                                                                                                                                                          oldMsgsWereAdded - - -boolean - - - -

                                                                                                                                                                                          Indicates if old messages were added in the current rendering.

                                                                                                                                                                                          - -
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          - -

                                                                                                                                                                                          - - static renderFactionEnt(faction) → {string} - - - - -

                                                                                                                                                                                          - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          - - -
                                                                                                                                                                                          -

                                                                                                                                                                                          Renders a faction entity for use in the chat.

                                                                                                                                                                                          -
                                                                                                                                                                                          - - - - - - - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          Parameters:
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          NameTypeDescription
                                                                                                                                                                                          faction - - -Object - - - -

                                                                                                                                                                                          The faction data.

                                                                                                                                                                                          - -
                                                                                                                                                                                          - - - - - - - - - - - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          Returns:
                                                                                                                                                                                          - - - - - -string - - - - - --

                                                                                                                                                                                          HTML string representing the faction.

                                                                                                                                                                                          - - - - - -
                                                                                                                                                                                          - - - - - -
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          - -

                                                                                                                                                                                          - - static renderFactionEnt(faction) → {string} - - - - -

                                                                                                                                                                                          - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          - - -
                                                                                                                                                                                          -

                                                                                                                                                                                          Renders a faction entity for use in the chat.

                                                                                                                                                                                          -
                                                                                                                                                                                          - - - - - - - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          Parameters:
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          NameTypeDescription
                                                                                                                                                                                          faction - - -Object - - - -

                                                                                                                                                                                          The faction data.

                                                                                                                                                                                          - -
                                                                                                                                                                                          - - - - - - - - - - - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          Returns:
                                                                                                                                                                                          - - - - - -string - - - - - --

                                                                                                                                                                                          HTML string representing the faction.

                                                                                                                                                                                          - - - - - -
                                                                                                                                                                                          - - - - - -
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          - -

                                                                                                                                                                                          - - static renderMarkup(markup) → {string} - - - - -

                                                                                                                                                                                          - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          - - -
                                                                                                                                                                                          -

                                                                                                                                                                                          Renders the markup of a chat message, converting special entities like player names, portals, etc., into HTML.

                                                                                                                                                                                          -
                                                                                                                                                                                          - - - - - - - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          Parameters:
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          NameTypeDescription
                                                                                                                                                                                          markup - - -Array - - - -

                                                                                                                                                                                          The markup array of a chat message.

                                                                                                                                                                                          - -
                                                                                                                                                                                          - - - - - - - - - - - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          Returns:
                                                                                                                                                                                          - - - - - -string - - - - - --

                                                                                                                                                                                          The HTML string representing the complete rendered chat message.

                                                                                                                                                                                          - - - - - -
                                                                                                                                                                                          - - - - - -
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          - -

                                                                                                                                                                                          - - static renderMarkup(markup) → {string} - - - - -

                                                                                                                                                                                          - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          - - -
                                                                                                                                                                                          -

                                                                                                                                                                                          Renders the markup of a chat message, converting special entities like player names, portals, etc., into HTML.

                                                                                                                                                                                          -
                                                                                                                                                                                          - - - - - - - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          Parameters:
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          NameTypeDescription
                                                                                                                                                                                          markup - - -Array - - - -

                                                                                                                                                                                          The markup array of a chat message.

                                                                                                                                                                                          - -
                                                                                                                                                                                          - - - - - - - - - - - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          Returns:
                                                                                                                                                                                          - - - - - -string - - - - - --

                                                                                                                                                                                          The HTML string representing the complete rendered chat message.

                                                                                                                                                                                          - - - - - -
                                                                                                                                                                                          - - - - - -
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          - -

                                                                                                                                                                                          - - static renderMarkupEntity(ent) → {string} - - - - -

                                                                                                                                                                                          - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          - - -
                                                                                                                                                                                          -

                                                                                                                                                                                          Renders a chat message entity based on its type.

                                                                                                                                                                                          -
                                                                                                                                                                                          - - - - - - - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          Parameters:
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          NameTypeDescription
                                                                                                                                                                                          ent - - -Array - - - -

                                                                                                                                                                                          The entity array, where the first element is the type and the second element is the data.

                                                                                                                                                                                          - -
                                                                                                                                                                                          - - - - - - - - - - - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          Returns:
                                                                                                                                                                                          - - - - - -string - - - - - --

                                                                                                                                                                                          The HTML string representing the chat message entity.

                                                                                                                                                                                          - - - - - -
                                                                                                                                                                                          - - - - - -
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          - -

                                                                                                                                                                                          - - static renderMarkupEntity(ent) → {string} - - - - -

                                                                                                                                                                                          - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          - - -
                                                                                                                                                                                          -

                                                                                                                                                                                          Renders a chat message entity based on its type.

                                                                                                                                                                                          -
                                                                                                                                                                                          - - - - - - - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          Parameters:
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          NameTypeDescription
                                                                                                                                                                                          ent - - -Array - - - -

                                                                                                                                                                                          The entity array, where the first element is the type and the second element is the data.

                                                                                                                                                                                          - -
                                                                                                                                                                                          - - - - - - - - - - - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          Returns:
                                                                                                                                                                                          - - - - - -string - - - - - --

                                                                                                                                                                                          The HTML string representing the chat message entity.

                                                                                                                                                                                          - - - - - -
                                                                                                                                                                                          - - - - - -
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          - -

                                                                                                                                                                                          - - static renderMsg(msg, nick, time, team, msgToPlayer, systemNarrowcast) → {string} - - - - -

                                                                                                                                                                                          - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          - - -
                                                                                                                                                                                          -

                                                                                                                                                                                          Legacy function for rendering chat messages. Used for backward compatibility with plugins.

                                                                                                                                                                                          -
                                                                                                                                                                                          - - - - - - - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          Parameters:
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          NameTypeDescription
                                                                                                                                                                                          msg - - -string - - - -

                                                                                                                                                                                          The chat message.

                                                                                                                                                                                          nick - - -string - - - -

                                                                                                                                                                                          The nickname of the player who sent the message.

                                                                                                                                                                                          time - - -number - - - -

                                                                                                                                                                                          The timestamp of the message.

                                                                                                                                                                                          team - - -string - - - -

                                                                                                                                                                                          The team of the player who sent the message.

                                                                                                                                                                                          msgToPlayer - - -boolean - - - -

                                                                                                                                                                                          Flag indicating if the message is directed to the player.

                                                                                                                                                                                          systemNarrowcast - - -boolean - - - -

                                                                                                                                                                                          Flag indicating if the message is a system narrowcast.

                                                                                                                                                                                          - -
                                                                                                                                                                                          - - - - - - - - - - - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          Returns:
                                                                                                                                                                                          - - - - - -string - - - - - --

                                                                                                                                                                                          The HTML string representing a chat message row.

                                                                                                                                                                                          - - - - - -
                                                                                                                                                                                          - - - - - -
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          - -

                                                                                                                                                                                          - - static renderMsg(msg, nick, time, team, msgToPlayer, systemNarrowcast) → {string} - - - - -

                                                                                                                                                                                          - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          - - -
                                                                                                                                                                                          -

                                                                                                                                                                                          Legacy function for rendering chat messages. Used for backward compatibility with plugins.

                                                                                                                                                                                          -
                                                                                                                                                                                          - - - - - - - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          Parameters:
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          NameTypeDescription
                                                                                                                                                                                          msg - - -string - - - -

                                                                                                                                                                                          The chat message.

                                                                                                                                                                                          nick - - -string - - - -

                                                                                                                                                                                          The nickname of the player who sent the message.

                                                                                                                                                                                          time - - -number - - - -

                                                                                                                                                                                          The timestamp of the message.

                                                                                                                                                                                          team - - -string - - - -

                                                                                                                                                                                          The team of the player who sent the message.

                                                                                                                                                                                          msgToPlayer - - -boolean - - - -

                                                                                                                                                                                          Flag indicating if the message is directed to the player.

                                                                                                                                                                                          systemNarrowcast - - -boolean - - - -

                                                                                                                                                                                          Flag indicating if the message is a system narrowcast.

                                                                                                                                                                                          - -
                                                                                                                                                                                          - - - - - - - - - - - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          Returns:
                                                                                                                                                                                          - - - - - -string - - - - - --

                                                                                                                                                                                          The HTML string representing a chat message row.

                                                                                                                                                                                          - - - - - -
                                                                                                                                                                                          - - - - - -
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          - -

                                                                                                                                                                                          - - static renderMsgCell(msg, classNames) → {string} - - - - -

                                                                                                                                                                                          - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          - - -
                                                                                                                                                                                          -

                                                                                                                                                                                          Renders a cell in the chat table for a chat message. -The message is inserted as inner HTML of the table cell.

                                                                                                                                                                                          -
                                                                                                                                                                                          - - - - - - - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          Parameters:
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          NameTypeDescription
                                                                                                                                                                                          msg - - -string - - - -

                                                                                                                                                                                          The chat message to be displayed.

                                                                                                                                                                                          classNames - - -string - - - -

                                                                                                                                                                                          Additional class names to be added to the message cell.

                                                                                                                                                                                          - -
                                                                                                                                                                                          - - - - - - - - - - - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          Returns:
                                                                                                                                                                                          - - - - - -string - - - - - --

                                                                                                                                                                                          The HTML string representing a table cell with the chat message.

                                                                                                                                                                                          - - - - - -
                                                                                                                                                                                          - - - - - -
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          - -

                                                                                                                                                                                          - - static renderMsgCell(msg, classNames) → {string} - - - - -

                                                                                                                                                                                          - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          - - -
                                                                                                                                                                                          -

                                                                                                                                                                                          Renders a cell in the chat table for a chat message. -The message is inserted as inner HTML of the table cell.

                                                                                                                                                                                          -
                                                                                                                                                                                          - - - - - - - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          Parameters:
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          NameTypeDescription
                                                                                                                                                                                          msg - - -string - - - -

                                                                                                                                                                                          The chat message to be displayed.

                                                                                                                                                                                          classNames - - -string - - - -

                                                                                                                                                                                          Additional class names to be added to the message cell.

                                                                                                                                                                                          - -
                                                                                                                                                                                          - - - - - - - - - - - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          Returns:
                                                                                                                                                                                          - - - - - -string - - - - - --

                                                                                                                                                                                          The HTML string representing a table cell with the chat message.

                                                                                                                                                                                          - - - - - -
                                                                                                                                                                                          - - - - - -
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          - -

                                                                                                                                                                                          - - static renderMsgRow(data) → {string} - - - - -

                                                                                                                                                                                          - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          - - -
                                                                                                                                                                                          -

                                                                                                                                                                                          Renders a row for a chat message including time, nickname, and message cells.

                                                                                                                                                                                          -
                                                                                                                                                                                          - - - - - - - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          Parameters:
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          NameTypeDescription
                                                                                                                                                                                          data - - -Object - - - -

                                                                                                                                                                                          The data for the message, including time, player, and message content.

                                                                                                                                                                                          - -
                                                                                                                                                                                          - - - - - - - - - - - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          Returns:
                                                                                                                                                                                          - - - - - -string - - - - - --

                                                                                                                                                                                          The HTML string representing a row in the chat table.

                                                                                                                                                                                          - - - - - -
                                                                                                                                                                                          - - - - - -
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          - -

                                                                                                                                                                                          - - static renderMsgRow(data) → {string} - - - - -

                                                                                                                                                                                          - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          - - -
                                                                                                                                                                                          -

                                                                                                                                                                                          Renders a row for a chat message including time, nickname, and message cells.

                                                                                                                                                                                          -
                                                                                                                                                                                          - - - - - - - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          Parameters:
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          NameTypeDescription
                                                                                                                                                                                          data - - -Object - - - -

                                                                                                                                                                                          The data for the message, including time, player, and message content.

                                                                                                                                                                                          - -
                                                                                                                                                                                          - - - - - - - - - - - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          Returns:
                                                                                                                                                                                          - - - - - -string - - - - - --

                                                                                                                                                                                          The HTML string representing a row in the chat table.

                                                                                                                                                                                          - - - - - -
                                                                                                                                                                                          - - - - - -
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          - -

                                                                                                                                                                                          - - static renderNickCell(nick, classNames) → {string} - - - - -

                                                                                                                                                                                          - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          - - -
                                                                                                                                                                                          -

                                                                                                                                                                                          Renders a cell in the chat table for a player's nickname. -Wraps the nickname in HTML element for highlighting.

                                                                                                                                                                                          -
                                                                                                                                                                                          - - - - - - - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          Parameters:
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          NameTypeDescription
                                                                                                                                                                                          nick - - -string - - - -

                                                                                                                                                                                          The nickname of the player.

                                                                                                                                                                                          classNames - - -string - - - -

                                                                                                                                                                                          Additional class names to be added to the nickname cell.

                                                                                                                                                                                          - -
                                                                                                                                                                                          - - - - - - - - - - - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          Returns:
                                                                                                                                                                                          - - - - - -string - - - - - --

                                                                                                                                                                                          The HTML string representing a table cell with the player's nickname.

                                                                                                                                                                                          - - - - - -
                                                                                                                                                                                          - - - - - -
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          - -

                                                                                                                                                                                          - - static renderNickCell(nick, classNames) → {string} - - - - -

                                                                                                                                                                                          - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          - - -
                                                                                                                                                                                          -

                                                                                                                                                                                          Renders a cell in the chat table for a player's nickname. -Wraps the nickname in HTML element for highlighting.

                                                                                                                                                                                          -
                                                                                                                                                                                          - - - - - - - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          Parameters:
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          NameTypeDescription
                                                                                                                                                                                          nick - - -string - - - -

                                                                                                                                                                                          The nickname of the player.

                                                                                                                                                                                          classNames - - -string - - - -

                                                                                                                                                                                          Additional class names to be added to the nickname cell.

                                                                                                                                                                                          - -
                                                                                                                                                                                          - - - - - - - - - - - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          Returns:
                                                                                                                                                                                          - - - - - -string - - - - - --

                                                                                                                                                                                          The HTML string representing a table cell with the player's nickname.

                                                                                                                                                                                          - - - - - -
                                                                                                                                                                                          - - - - - -
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          - -

                                                                                                                                                                                          - - static renderPlayer(player, at, sender) → {string} - - - - -

                                                                                                                                                                                          - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          - - -
                                                                                                                                                                                          -

                                                                                                                                                                                          Renders a player's nickname in chat.

                                                                                                                                                                                          -
                                                                                                                                                                                          - - - - - - - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          Parameters:
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          NameTypeDescription
                                                                                                                                                                                          player - - -Object - - - -

                                                                                                                                                                                          The player object containing nickname and team.

                                                                                                                                                                                          at - - -boolean - - - -

                                                                                                                                                                                          Whether to prepend '@' to the nickname.

                                                                                                                                                                                          sender - - -boolean - - - -

                                                                                                                                                                                          Whether the player is the sender of a message.

                                                                                                                                                                                          - -
                                                                                                                                                                                          - - - - - - - - - - - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          Returns:
                                                                                                                                                                                          - - - - - -string - - - - - --

                                                                                                                                                                                          The HTML string representing the player's nickname in chat.

                                                                                                                                                                                          - - - - - -
                                                                                                                                                                                          - - - - - -
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          - -

                                                                                                                                                                                          - - static renderPlayer(player, at, sender) → {string} - - - - -

                                                                                                                                                                                          - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          - - -
                                                                                                                                                                                          -

                                                                                                                                                                                          Renders a player's nickname in chat.

                                                                                                                                                                                          -
                                                                                                                                                                                          - - - - - - - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          Parameters:
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          NameTypeDescription
                                                                                                                                                                                          player - - -Object - - - -

                                                                                                                                                                                          The player object containing nickname and team.

                                                                                                                                                                                          at - - -boolean - - - -

                                                                                                                                                                                          Whether to prepend '@' to the nickname.

                                                                                                                                                                                          sender - - -boolean - - - -

                                                                                                                                                                                          Whether the player is the sender of a message.

                                                                                                                                                                                          - -
                                                                                                                                                                                          - - - - - - - - - - - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          Returns:
                                                                                                                                                                                          - - - - - -string - - - - - --

                                                                                                                                                                                          The HTML string representing the player's nickname in chat.

                                                                                                                                                                                          - - - - - -
                                                                                                                                                                                          - - - - - -
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          - -

                                                                                                                                                                                          - - static renderPortal(portal) → {string} - - - - -

                                                                                                                                                                                          - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          - - -
                                                                                                                                                                                          -

                                                                                                                                                                                          Renders a portal link for use in the chat.

                                                                                                                                                                                          -
                                                                                                                                                                                          - - - - - - - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          Parameters:
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          NameTypeDescription
                                                                                                                                                                                          portal - - -Object - - - -

                                                                                                                                                                                          The portal data.

                                                                                                                                                                                          - -
                                                                                                                                                                                          - - - - - - - - - - - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          Returns:
                                                                                                                                                                                          - - - - - -string - - - - - --

                                                                                                                                                                                          HTML string of the portal link.

                                                                                                                                                                                          - - - - - -
                                                                                                                                                                                          - - - - - -
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          - -

                                                                                                                                                                                          - - static renderPortal(portal) → {string} - - - - -

                                                                                                                                                                                          - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          - - -
                                                                                                                                                                                          -

                                                                                                                                                                                          Renders a portal link for use in the chat.

                                                                                                                                                                                          -
                                                                                                                                                                                          - - - - - - - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          Parameters:
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          NameTypeDescription
                                                                                                                                                                                          portal - - -Object - - - -

                                                                                                                                                                                          The portal data.

                                                                                                                                                                                          - -
                                                                                                                                                                                          - - - - - - - - - - - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          Returns:
                                                                                                                                                                                          - - - - - -string - - - - - --

                                                                                                                                                                                          HTML string of the portal link.

                                                                                                                                                                                          - - - - - -
                                                                                                                                                                                          - - - - - -
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          - -

                                                                                                                                                                                          - - static renderPublic(oldMsgsWereAdded) - - - - -

                                                                                                                                                                                          - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          - - -
                                                                                                                                                                                          -

                                                                                                                                                                                          Renders public chat in the UI.

                                                                                                                                                                                          -
                                                                                                                                                                                          - - - - - - - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          Parameters:
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          NameTypeDescription
                                                                                                                                                                                          oldMsgsWereAdded - - -boolean - - - -

                                                                                                                                                                                          Indicates if older messages were added to the chat.

                                                                                                                                                                                          - -
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          - -

                                                                                                                                                                                          - - static renderPublic(oldMsgsWereAdded) - - - - -

                                                                                                                                                                                          - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          - - -
                                                                                                                                                                                          -

                                                                                                                                                                                          Renders public chat in the UI.

                                                                                                                                                                                          -
                                                                                                                                                                                          - - - - - - - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          Parameters:
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          NameTypeDescription
                                                                                                                                                                                          oldMsgsWereAdded - - -boolean - - - -

                                                                                                                                                                                          Indicates if older messages were added to the chat.

                                                                                                                                                                                          - -
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          - -

                                                                                                                                                                                          - - static renderText(text) → {string} - - - - -

                                                                                                                                                                                          - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          - - -
                                                                                                                                                                                          -

                                                                                                                                                                                          Renders text for the chat, converting plain text to HTML and adding links.

                                                                                                                                                                                          -
                                                                                                                                                                                          - - - - - - - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          Parameters:
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          NameTypeDescription
                                                                                                                                                                                          text - - -Object - - - -

                                                                                                                                                                                          An object containing the plain text to render.

                                                                                                                                                                                          - -
                                                                                                                                                                                          - - - - - - - - - - - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          Returns:
                                                                                                                                                                                          - - - - - -string - - - - - --

                                                                                                                                                                                          The rendered HTML string.

                                                                                                                                                                                          - - - - - -
                                                                                                                                                                                          - - - - - -
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          - -

                                                                                                                                                                                          - - static renderText(text) → {string} - - - - -

                                                                                                                                                                                          - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          - - -
                                                                                                                                                                                          -

                                                                                                                                                                                          Renders text for the chat, converting plain text to HTML and adding links.

                                                                                                                                                                                          -
                                                                                                                                                                                          - - - - - - - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          Parameters:
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          NameTypeDescription
                                                                                                                                                                                          text - - -Object - - - -

                                                                                                                                                                                          An object containing the plain text to render.

                                                                                                                                                                                          - -
                                                                                                                                                                                          - - - - - - - - - - - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          Returns:
                                                                                                                                                                                          - - - - - -string - - - - - --

                                                                                                                                                                                          The rendered HTML string.

                                                                                                                                                                                          - - - - - -
                                                                                                                                                                                          - - - - - -
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          - -

                                                                                                                                                                                          - - static renderTimeCell(time, classNames) → {string} - - - - -

                                                                                                                                                                                          - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          - - -
                                                                                                                                                                                          -

                                                                                                                                                                                          Renders a cell in the chat table to display the time a message was sent. -Formats the time and adds it to a

                                                                                                                                                                                          -
                                                                                                                                                                                          - - - - - - - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          Parameters:
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          NameTypeDescription
                                                                                                                                                                                          time - - -number - - - -

                                                                                                                                                                                          The timestamp of the message.

                                                                                                                                                                                          classNames - - -string - - - -

                                                                                                                                                                                          Additional class names to be added to the time cell.

                                                                                                                                                                                          - -
                                                                                                                                                                                          - - - - - - - - - - - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          Returns:
                                                                                                                                                                                          - - - - - -string - - - - - --

                                                                                                                                                                                          The HTML string representing a table cell with the formatted time.

                                                                                                                                                                                          - - - - - -
                                                                                                                                                                                          - - - - - -
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          - -

                                                                                                                                                                                          - - static renderTimeCell(time, classNames) → {string} - - - - -

                                                                                                                                                                                          - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          - - -
                                                                                                                                                                                          -

                                                                                                                                                                                          Renders a cell in the chat table to display the time a message was sent. -Formats the time and adds it to a

                                                                                                                                                                                          -
                                                                                                                                                                                          - - - - - - - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          Parameters:
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          NameTypeDescription
                                                                                                                                                                                          time - - -number - - - -

                                                                                                                                                                                          The timestamp of the message.

                                                                                                                                                                                          classNames - - -string - - - -

                                                                                                                                                                                          Additional class names to be added to the time cell.

                                                                                                                                                                                          - -
                                                                                                                                                                                          - - - - - - - - - - - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          Returns:
                                                                                                                                                                                          - - - - - -string - - - - - --

                                                                                                                                                                                          The HTML string representing a table cell with the formatted time.

                                                                                                                                                                                          - - - - - -
                                                                                                                                                                                          - - - - - -
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          - -

                                                                                                                                                                                          - - static request() - - - - -

                                                                                                                                                                                          - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          - - -
                                                                                                                                                                                          -

                                                                                                                                                                                          Requests chat messages for the currently active chat tab and background channels. -It calls the appropriate request function based on the active tab or background channels.

                                                                                                                                                                                          -
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          - -

                                                                                                                                                                                          - - static request() - - - - -

                                                                                                                                                                                          - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          - - -
                                                                                                                                                                                          -

                                                                                                                                                                                          Requests chat messages for the currently active chat tab and background channels. -It calls the appropriate request function based on the active tab or background channels.

                                                                                                                                                                                          -
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          - -

                                                                                                                                                                                          - - static requestAlerts(getOlderMsgs, isRetryopt) - - - - -

                                                                                                                                                                                          - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          - - -
                                                                                                                                                                                          -

                                                                                                                                                                                          Initiates a request for alerts chat data.

                                                                                                                                                                                          -
                                                                                                                                                                                          - - - - - - - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          Parameters:
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          NameTypeAttributesDefaultDescription
                                                                                                                                                                                          getOlderMsgs - - -boolean - - - - - - - - - - - -

                                                                                                                                                                                          Whether to retrieve older messages.

                                                                                                                                                                                          isRetry - - -boolean - - - - - - <optional>
                                                                                                                                                                                          - - - - - -
                                                                                                                                                                                          - - false - -

                                                                                                                                                                                          Whether the request is a retry.

                                                                                                                                                                                          - -
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          - -

                                                                                                                                                                                          - - static requestAlerts(getOlderMsgs, isRetryopt) - - - - -

                                                                                                                                                                                          - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          - - -
                                                                                                                                                                                          -

                                                                                                                                                                                          Initiates a request for alerts chat data.

                                                                                                                                                                                          -
                                                                                                                                                                                          - - - - - - - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          Parameters:
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          NameTypeAttributesDefaultDescription
                                                                                                                                                                                          getOlderMsgs - - -boolean - - - - - - - - - - - -

                                                                                                                                                                                          Whether to retrieve older messages.

                                                                                                                                                                                          isRetry - - -boolean - - - - - - <optional>
                                                                                                                                                                                          - - - - - -
                                                                                                                                                                                          - - false - -

                                                                                                                                                                                          Whether the request is a retry.

                                                                                                                                                                                          - -
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          - -

                                                                                                                                                                                          - - static requestFaction(getOlderMsgs, isRetryopt) - - - - -

                                                                                                                                                                                          - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          - - -
                                                                                                                                                                                          -

                                                                                                                                                                                          Requests faction chat messages.

                                                                                                                                                                                          -
                                                                                                                                                                                          - - - - - - - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          Parameters:
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          NameTypeAttributesDefaultDescription
                                                                                                                                                                                          getOlderMsgs - - -boolean - - - - - - - - - - - -

                                                                                                                                                                                          Flag to determine if older messages are being requested.

                                                                                                                                                                                          isRetry - - -boolean - - - - - - <optional>
                                                                                                                                                                                          - - - - - -
                                                                                                                                                                                          - - false - -

                                                                                                                                                                                          Flag to indicate if this is a retry attempt.

                                                                                                                                                                                          - -
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          - -

                                                                                                                                                                                          - - static requestFaction(getOlderMsgs, isRetryopt) - - - - -

                                                                                                                                                                                          - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          - - -
                                                                                                                                                                                          -

                                                                                                                                                                                          Requests faction chat messages.

                                                                                                                                                                                          -
                                                                                                                                                                                          - - - - - - - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          Parameters:
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          NameTypeAttributesDefaultDescription
                                                                                                                                                                                          getOlderMsgs - - -boolean - - - - - - - - - - - -

                                                                                                                                                                                          Flag to determine if older messages are being requested.

                                                                                                                                                                                          isRetry - - -boolean - - - - - - <optional>
                                                                                                                                                                                          - - - - - -
                                                                                                                                                                                          - - false - -

                                                                                                                                                                                          Flag to indicate if this is a retry attempt.

                                                                                                                                                                                          - -
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          - -

                                                                                                                                                                                          - - static requestPublic(getOlderMsgs, isRetryopt) - - - - -

                                                                                                                                                                                          - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          - - -
                                                                                                                                                                                          -

                                                                                                                                                                                          Initiates a request for public chat data.

                                                                                                                                                                                          -
                                                                                                                                                                                          - - - - - - - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          Parameters:
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          NameTypeAttributesDefaultDescription
                                                                                                                                                                                          getOlderMsgs - - -boolean - - - - - - - - - - - -

                                                                                                                                                                                          Whether to retrieve older messages.

                                                                                                                                                                                          isRetry - - -boolean - - - - - - <optional>
                                                                                                                                                                                          - - - - - -
                                                                                                                                                                                          - - false - -

                                                                                                                                                                                          Whether the request is a retry.

                                                                                                                                                                                          - -
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          - -

                                                                                                                                                                                          - - static requestPublic(getOlderMsgs, isRetryopt) - - - - -

                                                                                                                                                                                          - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          - - -
                                                                                                                                                                                          -

                                                                                                                                                                                          Initiates a request for public chat data.

                                                                                                                                                                                          -
                                                                                                                                                                                          - - - - - - - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          Parameters:
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          NameTypeAttributesDefaultDescription
                                                                                                                                                                                          getOlderMsgs - - -boolean - - - - - - - - - - - -

                                                                                                                                                                                          Whether to retrieve older messages.

                                                                                                                                                                                          isRetry - - -boolean - - - - - - <optional>
                                                                                                                                                                                          - - - - - -
                                                                                                                                                                                          - - false - -

                                                                                                                                                                                          Whether the request is a retry.

                                                                                                                                                                                          - -
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          - -

                                                                                                                                                                                          - - static setup() - - - - -

                                                                                                                                                                                          - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          - - -
                                                                                                                                                                                          -

                                                                                                                                                                                          Sets up the chat interface.

                                                                                                                                                                                          @@ -27219,191 +5328,26 @@

                                                                                                                                                                                          - - - - - - - - - - - - -
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          - - - - -

                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          - -

                                                                                                                                                                                          - - static setup() - - - - -

                                                                                                                                                                                          - +
                                                                                                                                                                                          +
                                                                                                                                                                                          Returns:
                                                                                                                                                                                          - -
                                                                                                                                                                                          -
                                                                                                                                                                                          - - -
                                                                                                                                                                                          -

                                                                                                                                                                                          Sets up the chat interface.

                                                                                                                                                                                          -
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          - -

                                                                                                                                                                                          - - static setupPosting() - - - -

                                                                                                                                                                                          - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          - -
                                                                                                                                                                                          -

                                                                                                                                                                                          Sets up the chat message posting functionality.

                                                                                                                                                                                          -
                                                                                                                                                                                          - - +string - - - - - +-

                                                                                                                                                                                          The rendered HTML string.

                                                                                                                                                                                          - - - + + @@ -27452,14 +5396,14 @@

                                                                                                                                                                                          -

                                                                                                                                                                                          +

                                                                                                                                                                                          - static setupPosting() + static renderTimeCell(time, classNames) → {string}

                                                                                                                                                                                          @@ -27471,7 +5415,8 @@

                                                                                                                                                                                          -

                                                                                                                                                                                          Sets up the chat message posting functionality.

                                                                                                                                                                                          +

                                                                                                                                                                                          Renders a cell in the chat table to display the time a message was sent. +Formats the time and adds it to a

                                                                                                                                                                                          @@ -27482,107 +5427,111 @@

                                                                                                                                                                                          +
                                                                                                                                                                                          +
                                                                                                                                                                                          Parameters:
                                                                                                                                                                                          + + + + + + + - + - + - + - + + + + - + + + + - + - + - + - + + - + + + + - + - + - + - + + + +
                                                                                                                                                                                          NameTypeDescription
                                                                                                                                                                                          time + + +number -
                                                                                                                                                                                          + +

                                                                                                                                                                                          The timestamp of the message.

                                                                                                                                                                                          classNames + + +string - - + +

                                                                                                                                                                                          Additional class names to be added to the time cell.

                                                                                                                                                                                          +
                                                                                                                                                                                          -

                                                                                                                                                                                          - - + - - + -
                                                                                                                                                                                          -

                                                                                                                                                                                          - - static setupTime() +
                                                                                                                                                                                          +
                                                                                                                                                                                          Returns:
                                                                                                                                                                                          + - - - -

                                                                                                                                                                                          - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          - -
                                                                                                                                                                                          -

                                                                                                                                                                                          Sets up the time display in the chat input box. -This function updates the time displayed next to the chat input field every minute to reflect the current time.

                                                                                                                                                                                          -
                                                                                                                                                                                          - - +string - - - - - +-

                                                                                                                                                                                          The HTML string representing a table cell with the formatted time.

                                                                                                                                                                                          - - - + + @@ -27631,14 +5580,14 @@

                                                                                                                                                                                          -

                                                                                                                                                                                          +

                                                                                                                                                                                          - static setupTime() + static request()

                                                                                                                                                                                          @@ -27650,8 +5599,8 @@

                                                                                                                                                                                          -

                                                                                                                                                                                          Sets up the time display in the chat input box. -This function updates the time displayed next to the chat input field every minute to reflect the current time.

                                                                                                                                                                                          +

                                                                                                                                                                                          Requests chat messages for the currently active chat tab and background channels. +It calls the appropriate request function based on the active tab or background channels.

                                                                                                                                                                                          @@ -27721,14 +5670,14 @@

                                                                                                                                                                                          -

                                                                                                                                                                                          +

                                                                                                                                                                                          - static show(name) + static requestAlerts(getOlderMsgs, isRetryopt)

                                                                                                                                                                                          @@ -27740,7 +5689,7 @@

                                                                                                                                                                                          -

                                                                                                                                                                                          Displays the chat interface and activates a specified chat tab.

                                                                                                                                                                                          +

                                                                                                                                                                                          Initiates a request for alerts chat data.

                                                                                                                                                                                          @@ -27764,8 +5713,12 @@

                                                                                                                                                                                          Parameters:
                                                                                                                                                                                          Type + Attributes + + Default + Description @@ -27776,23 +5729,74 @@
                                                                                                                                                                                          Parameters:
                                                                                                                                                                                          - name + getOlderMsgs -string +boolean + + + + + + + + + + + + -

                                                                                                                                                                                          The name of the chat tab to show and activate.

                                                                                                                                                                                          +

                                                                                                                                                                                          Whether to retrieve older messages.

                                                                                                                                                                                          + + + + + + + isRetry + + + + + +boolean + + + + + + + + + <optional>
                                                                                                                                                                                          + + + + + + + + + + + + false + + + + +

                                                                                                                                                                                          Whether the request is a retry.

                                                                                                                                                                                          @@ -27860,14 +5864,14 @@
                                                                                                                                                                                          Parameters:
                                                                                                                                                                                          -

                                                                                                                                                                                          +

                                                                                                                                                                                          - static show(name) + static requestFaction(getOlderMsgs, isRetryopt)

                                                                                                                                                                                          @@ -27879,7 +5883,7 @@

                                                                                                                                                                                          -

                                                                                                                                                                                          Displays the chat interface and activates a specified chat tab.

                                                                                                                                                                                          +

                                                                                                                                                                                          Requests faction chat messages.

                                                                                                                                                                                          @@ -27903,35 +5907,90 @@

                                                                                                                                                                                          Parameters:
                                                                                                                                                                                          Type + Attributes + + Default + + + Description + + + + + + + + + getOlderMsgs + + + + + +boolean + + + + + + + + + + + + + + + + + + + + - Description - - +

                                                                                                                                                                                          Flag to determine if older messages are being requested.

                                                                                                                                                                                          + - - name + isRetry -string +boolean + + + <optional>
                                                                                                                                                                                          + + + + + + + + + + false + + + -

                                                                                                                                                                                          The name of the chat tab to show and activate.

                                                                                                                                                                                          +

                                                                                                                                                                                          Flag to indicate if this is a retry attempt.

                                                                                                                                                                                          @@ -27999,14 +6058,14 @@
                                                                                                                                                                                          Parameters:
                                                                                                                                                                                          -

                                                                                                                                                                                          +

                                                                                                                                                                                          - static tabToChannel(tab) → {string} + static requestPublic(getOlderMsgs, isRetryopt)

                                                                                                                                                                                          @@ -28018,7 +6077,7 @@

                                                                                                                                                                                          -

                                                                                                                                                                                          Converts a chat tab name to its corresponding COMM channel name.

                                                                                                                                                                                          +

                                                                                                                                                                                          Initiates a request for public chat data.

                                                                                                                                                                                          @@ -28042,8 +6101,12 @@

                                                                                                                                                                                          Parameters:
                                                                                                                                                                                          Type + Attributes + + Default + Description @@ -28054,63 +6117,93 @@
                                                                                                                                                                                          Parameters:
                                                                                                                                                                                          - tab + getOlderMsgs -string +boolean + + - + -

                                                                                                                                                                                          The name of the chat tab.

                                                                                                                                                                                          - + + + - - - + + + + + - - +

                                                                                                                                                                                          Whether to retrieve older messages.

                                                                                                                                                                                          + - + + + isRetry + - + + + +boolean - - + + - -
                                                                                                                                                                                          -
                                                                                                                                                                                          Returns:
                                                                                                                                                                                          - + + + + <optional>
                                                                                                                                                                                          + + + + -string + + + + false + + + +

                                                                                                                                                                                          Whether the request is a retry.

                                                                                                                                                                                          + + + + +
                                                                                                                                                                                          + + --

                                                                                                                                                                                          The corresponding channel name ('faction', 'alerts', or 'all').

                                                                                                                                                                                          + + + + - - @@ -28159,14 +6252,14 @@
                                                                                                                                                                                          Returns:
                                                                                                                                                                                          -

                                                                                                                                                                                          +

                                                                                                                                                                                          - static tabToChannel(tab) → {string} + static setup()

                                                                                                                                                                                          @@ -28178,7 +6271,7 @@

                                                                                                                                                                                          -

                                                                                                                                                                                          Converts a chat tab name to its corresponding COMM channel name.

                                                                                                                                                                                          +

                                                                                                                                                                                          Sets up the chat interface.

                                                                                                                                                                                          @@ -28189,58 +6282,6 @@

                                                                                                                                                                                          -
                                                                                                                                                                                          -
                                                                                                                                                                                          Parameters:
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          NameTypeDescription
                                                                                                                                                                                          tab - - -string - - - -

                                                                                                                                                                                          The name of the chat tab.

                                                                                                                                                                                          - -
                                                                                                                                                                                          - - - @@ -28251,26 +6292,7 @@

                                                                                                                                                                                          Parameters:
                                                                                                                                                                                          -
                                                                                                                                                                                          -
                                                                                                                                                                                          Returns:
                                                                                                                                                                                          - - - - - -string - - - - - --

                                                                                                                                                                                          The corresponding channel name ('faction', 'alerts', or 'all').

                                                                                                                                                                                          - - - - -
                                                                                                                                                                                          @@ -28319,14 +6341,14 @@
                                                                                                                                                                                          Returns:
                                                                                                                                                                                          -

                                                                                                                                                                                          +

                                                                                                                                                                                          - static toggle() + static setupPosting()

                                                                                                                                                                                          @@ -28338,9 +6360,7 @@

                                                                                                                                                                                          -

                                                                                                                                                                                          Toggles the chat window between expanded and collapsed states. -When expanded, the chat window covers a larger area of the screen. -This function also ensures that the chat is scrolled to the bottom when collapsed.

                                                                                                                                                                                          +

                                                                                                                                                                                          Sets up the chat message posting functionality.

                                                                                                                                                                                          @@ -28410,14 +6430,14 @@

                                                                                                                                                                                          -

                                                                                                                                                                                          +

                                                                                                                                                                                          - static toggle() + static setupTime()

                                                                                                                                                                                          @@ -28429,9 +6449,8 @@

                                                                                                                                                                                          -

                                                                                                                                                                                          Toggles the chat window between expanded and collapsed states. -When expanded, the chat window covers a larger area of the screen. -This function also ensures that the chat is scrolled to the bottom when collapsed.

                                                                                                                                                                                          +

                                                                                                                                                                                          Sets up the time display in the chat input box. +This function updates the time displayed next to the chat input field every minute to reflect the current time.

                                                                                                                                                                                          @@ -28501,14 +6520,14 @@

                                                                                                                                                                                          -

                                                                                                                                                                                          +

                                                                                                                                                                                          - static transformMessage(markup) → {Array} + static show(name)

                                                                                                                                                                                          @@ -28520,7 +6539,7 @@

                                                                                                                                                                                          -

                                                                                                                                                                                          Transforms a given markup array into an older, more straightforward format for easier understanding.

                                                                                                                                                                                          +

                                                                                                                                                                                          Displays the chat interface and activates a specified chat tab.

                                                                                                                                                                                          @@ -28556,13 +6575,13 @@

                                                                                                                                                                                          Parameters:
                                                                                                                                                                                          - markup + name -Array +string @@ -28572,47 +6591,26 @@
                                                                                                                                                                                          Parameters:
                                                                                                                                                                                          -

                                                                                                                                                                                          An array representing the markup to be transformed.

                                                                                                                                                                                          +

                                                                                                                                                                                          The name of the chat tab to show and activate.

                                                                                                                                                                                          - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          Returns:
                                                                                                                                                                                          - - - - - -Array - - + +
                                                                                                                                                                                          + + --

                                                                                                                                                                                          The transformed markup array with a simplified structure.

                                                                                                                                                                                          + + + + - - @@ -28661,14 +6659,14 @@
                                                                                                                                                                                          Returns:
                                                                                                                                                                                          -

                                                                                                                                                                                          +

                                                                                                                                                                                          - static transformMessage(markup) → {Array} + static tabToChannel(tab) → {string}

                                                                                                                                                                                          @@ -28680,7 +6678,7 @@

                                                                                                                                                                                          -

                                                                                                                                                                                          Transforms a given markup array into an older, more straightforward format for easier understanding.

                                                                                                                                                                                          +

                                                                                                                                                                                          Converts a chat tab name to its corresponding COMM channel name.

                                                                                                                                                                                          @@ -28716,13 +6714,13 @@

                                                                                                                                                                                          Parameters:
                                                                                                                                                                                          - markup + tab -Array +string @@ -28732,7 +6730,7 @@
                                                                                                                                                                                          Parameters:
                                                                                                                                                                                          -

                                                                                                                                                                                          An array representing the markup to be transformed.

                                                                                                                                                                                          +

                                                                                                                                                                                          The name of the chat tab.

                                                                                                                                                                                          @@ -28760,13 +6758,13 @@
                                                                                                                                                                                          Returns:
                                                                                                                                                                                          -Array +string --

                                                                                                                                                                                          The transformed markup array with a simplified structure.

                                                                                                                                                                                          +-

                                                                                                                                                                                          The corresponding channel name ('faction', 'alerts', or 'all').

                                                                                                                                                                                          @@ -28821,14 +6819,14 @@
                                                                                                                                                                                          Returns:
                                                                                                                                                                                          -

                                                                                                                                                                                          +

                                                                                                                                                                                          - static updateOldNewHash(newData, storageHash, isOlderMsgs, isAscendingOrder) + static toggle()

                                                                                                                                                                                          @@ -28840,7 +6838,9 @@

                                                                                                                                                                                          -

                                                                                                                                                                                          Updates the oldest and newest message timestamps and GUIDs in the chat storage.

                                                                                                                                                                                          +

                                                                                                                                                                                          Toggles the chat window between expanded and collapsed states. +When expanded, the chat window covers a larger area of the screen. +This function also ensures that the chat is scrolled to the bottom when collapsed.

                                                                                                                                                                                          @@ -28851,125 +6851,6 @@

                                                                                                                                                                                          -
                                                                                                                                                                                          -
                                                                                                                                                                                          Parameters:
                                                                                                                                                                                          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                          NameTypeDescription
                                                                                                                                                                                          newData - - -Object - - - -

                                                                                                                                                                                          The new chat data received.

                                                                                                                                                                                          storageHash - - -Object - - - -

                                                                                                                                                                                          The chat storage object.

                                                                                                                                                                                          isOlderMsgs - - -boolean - - - -

                                                                                                                                                                                          Whether the new data contains older messages.

                                                                                                                                                                                          isAscendingOrder - - -boolean - - - -

                                                                                                                                                                                          Whether the new data is in ascending order.

                                                                                                                                                                                          - -
                                                                                                                                                                                          - @@ -29029,14 +6910,14 @@

                                                                                                                                                                                          Parameters:
                                                                                                                                                                                          -

                                                                                                                                                                                          +

                                                                                                                                                                                          - static updateOldNewHash(newData, storageHash, isOlderMsgs, isAscendingOrder) + static transformMessage(markup) → {Array}

                                                                                                                                                                                          @@ -29048,7 +6929,7 @@

                                                                                                                                                                                          -

                                                                                                                                                                                          Updates the oldest and newest message timestamps and GUIDs in the chat storage.

                                                                                                                                                                                          +

                                                                                                                                                                                          Transforms a given markup array into an older, more straightforward format for easier understanding.

                                                                                                                                                                                          @@ -29084,13 +6965,13 @@

                                                                                                                                                                                          Parameters:
                                                                                                                                                                                          - newData + markup -Object +Array @@ -29100,99 +6981,51 @@
                                                                                                                                                                                          Parameters:
                                                                                                                                                                                          -

                                                                                                                                                                                          The new chat data received.

                                                                                                                                                                                          +

                                                                                                                                                                                          An array representing the markup to be transformed.

                                                                                                                                                                                          + + - - - storageHash - - - - - -Object - - - - + + - + - + -

                                                                                                                                                                                          The chat storage object.

                                                                                                                                                                                          - + - - - isOlderMsgs - + - - + +
                                                                                                                                                                                          +
                                                                                                                                                                                          Returns:
                                                                                                                                                                                          + -boolean - - - +Array - -

                                                                                                                                                                                          Whether the new data contains older messages.

                                                                                                                                                                                          - - - - - isAscendingOrder - - - - -boolean +-

                                                                                                                                                                                          The transformed markup array with a simplified structure.

                                                                                                                                                                                          - - - - -

                                                                                                                                                                                          Whether the new data is in ascending order.

                                                                                                                                                                                          - - - - - -
                                                                                                                                                                                          - - - - - - - - - - - -
                                                                                                                                                                                          @@ -29237,14 +7070,14 @@
                                                                                                                                                                                          Parameters:
                                                                                                                                                                                          -

                                                                                                                                                                                          +

                                                                                                                                                                                          - static writeDataToHash(newData, storageHash, isOlderMsgs, isAscendingOrder) + static updateOldNewHash(newData, storageHash, isOlderMsgs, isAscendingOrder)

                                                                                                                                                                                          @@ -29256,7 +7089,7 @@

                                                                                                                                                                                          -

                                                                                                                                                                                          Writes new chat data to the chat storage and manages the order of messages.

                                                                                                                                                                                          +

                                                                                                                                                                                          Updates the oldest and newest message timestamps and GUIDs in the chat storage.

                                                                                                                                                                                          diff --git a/window.decodeArray.html b/window.decodeArray.html index cb487c3cc..9b9a98e5f 100644 --- a/window.decodeArray.html +++ b/window.decodeArray.html @@ -34,7 +34,7 @@

                                                                                                                                                                                          IITC-CE

                                                                                                                                                                                            - +
                                                                                                                                                                                            @@ -317,744 +317,6 @@
                                                                                                                                                                                            Returns:
                                                                                                                                                                                            - - - - - - - - - - -
                                                                                                                                                                                            - - - - -

                                                                                                                                                                                            - - - - -
                                                                                                                                                                                            - -

                                                                                                                                                                                            - - static portal(a, detailsopt) → {Object} - - - - -

                                                                                                                                                                                            - - - -
                                                                                                                                                                                            -
                                                                                                                                                                                            - - -
                                                                                                                                                                                            -

                                                                                                                                                                                            Decodes an array of portal data into a more detailed object format.

                                                                                                                                                                                            -
                                                                                                                                                                                            - - - - - - - - - -
                                                                                                                                                                                            -
                                                                                                                                                                                            Parameters:
                                                                                                                                                                                            - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                            NameTypeAttributesDefaultDescription
                                                                                                                                                                                            a - - -Array - - - - - - - - - - - -

                                                                                                                                                                                            Array containing portal data.

                                                                                                                                                                                            details - - -string - - - - - - <optional>
                                                                                                                                                                                            - - - - - -
                                                                                                                                                                                            - - 'anyknown' - -

                                                                                                                                                                                            The level of detail to decode. -Can be 'core', 'summary', 'detailed', 'extended', or 'anyknown'.

                                                                                                                                                                                            - -
                                                                                                                                                                                            - - - - - - - - - - - - - -
                                                                                                                                                                                            -
                                                                                                                                                                                            Returns:
                                                                                                                                                                                            - - - - - -Object - - - - - --

                                                                                                                                                                                            An object containing decoded portal data.

                                                                                                                                                                                            - - - - - -
                                                                                                                                                                                            - - - - - -
                                                                                                                                                                                            - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                            - - - - -
                                                                                                                                                                                            - - - - - - - -
                                                                                                                                                                                            - -
                                                                                                                                                                                            - - - - - - - -
                                                                                                                                                                                            - -
                                                                                                                                                                                            - -

                                                                                                                                                                                            decodeArray

                                                                                                                                                                                            - - -
                                                                                                                                                                                            - -
                                                                                                                                                                                            - -
                                                                                                                                                                                            - - - - - - -
                                                                                                                                                                                            - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                            - - - - -
                                                                                                                                                                                            - - - - - - - - - - - - - - - - - -

                                                                                                                                                                                            Methods

                                                                                                                                                                                            - -
                                                                                                                                                                                            - - -
                                                                                                                                                                                            - -

                                                                                                                                                                                            - - static portal(a, detailsopt) → {Object} - - - - -

                                                                                                                                                                                            - - - -
                                                                                                                                                                                            -
                                                                                                                                                                                            - - -
                                                                                                                                                                                            -

                                                                                                                                                                                            Decodes an array of portal data into a more detailed object format.

                                                                                                                                                                                            -
                                                                                                                                                                                            - - - - - - - - - -
                                                                                                                                                                                            -
                                                                                                                                                                                            Parameters:
                                                                                                                                                                                            - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                            NameTypeAttributesDefaultDescription
                                                                                                                                                                                            a - - -Array - - - - - - - - - - - -

                                                                                                                                                                                            Array containing portal data.

                                                                                                                                                                                            details - - -string - - - - - - <optional>
                                                                                                                                                                                            - - - - - -
                                                                                                                                                                                            - - 'anyknown' - -

                                                                                                                                                                                            The level of detail to decode. -Can be 'core', 'summary', 'detailed', 'extended', or 'anyknown'.

                                                                                                                                                                                            - -
                                                                                                                                                                                            - - - - - - - - - - - - - -
                                                                                                                                                                                            -
                                                                                                                                                                                            Returns:
                                                                                                                                                                                            - - - - - -Object - - - - - --

                                                                                                                                                                                            An object containing decoded portal data.

                                                                                                                                                                                            - - - - - -
                                                                                                                                                                                            - - - - - -
                                                                                                                                                                                            - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                            - - - - -
                                                                                                                                                                                            - - - - -
                                                                                                                                                                                            - -

                                                                                                                                                                                            - - static portal(a, detailsopt) → {Object} - - - - -

                                                                                                                                                                                            - - - -
                                                                                                                                                                                            -
                                                                                                                                                                                            - - -
                                                                                                                                                                                            -

                                                                                                                                                                                            Decodes an array of portal data into a more detailed object format.

                                                                                                                                                                                            -
                                                                                                                                                                                            - - - - - - - - - -
                                                                                                                                                                                            -
                                                                                                                                                                                            Parameters:
                                                                                                                                                                                            - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                            NameTypeAttributesDefaultDescription
                                                                                                                                                                                            a - - -Array - - - - - - - - - - - -

                                                                                                                                                                                            Array containing portal data.

                                                                                                                                                                                            details - - -string - - - - - - <optional>
                                                                                                                                                                                            - - - - - -
                                                                                                                                                                                            - - 'anyknown' - -

                                                                                                                                                                                            The level of detail to decode. -Can be 'core', 'summary', 'detailed', 'extended', or 'anyknown'.

                                                                                                                                                                                            - -
                                                                                                                                                                                            - - - - - - - - - - - - - -
                                                                                                                                                                                            -
                                                                                                                                                                                            Returns:
                                                                                                                                                                                            - - - - - -Object - - - - - --

                                                                                                                                                                                            An object containing decoded portal data.

                                                                                                                                                                                            - - - - - -
                                                                                                                                                                                            - - - - - -
                                                                                                                                                                                            - - - - - - - - - - - - - - - - - - - - diff --git a/window.ornaments.html b/window.ornaments.html index bf5b8d663..11375a4fd 100644 --- a/window.ornaments.html +++ b/window.ornaments.html @@ -34,7 +34,7 @@

                                                                                                                                                                                            IITC-CE

                                                                                                                                                                                              - +
                                                                                                                                                                                              @@ -264,12 +264,12 @@
                                                                                                                                                                                              Properties:
                                                                                                                                                                                              -

                                                                                                                                                                                              - static excludedOrnaments +

                                                                                                                                                                                              + static icon

                                                                                                                                                                                              @@ -279,7 +279,23 @@

                                                                                                                                                                                              -

                                                                                                                                                                                              List of ornaments to be excluded.

                                                                                                                                                                                              +

                                                                                                                                                                                              Object holding optional definitions for ornaments and beacons. +The icon object holds optional definitions for the ornaments an beacons. The object shall +be filled from a plugin

                                                                                                                                                                                              +
                                                                                                                                                                                              'ornamentID' : {
                                                                                                                                                                                              +  name: 'meaningful name',     // shows up in dialog
                                                                                                                                                                                              +  layer: 'name for the Layer', // shows up in layerchooser, optional, if not set
                                                                                                                                                                                              +                               // ornament will be in "Ornaments"
                                                                                                                                                                                              +  url: 'url',                  // from which the image will be taken, optional,
                                                                                                                                                                                              +                               // 84x84px is default, if not set, stock images will be
                                                                                                                                                                                              +                               // used
                                                                                                                                                                                              +  offset: [dx,dy],             // optional, shift the ornament vertically or horizontally by
                                                                                                                                                                                              +                               // dx (vertical)and dy )horizontal.
                                                                                                                                                                                              +                               // [0, 0.5] to place right above the portal.
                                                                                                                                                                                              +                               // default is [0, 0] to center
                                                                                                                                                                                              +  opacity: 0..1                // optional, default is 0.6
                                                                                                                                                                                              +}
                                                                                                                                                                                              +
                                                                                                                                                                                              @@ -316,13 +332,13 @@
                                                                                                                                                                                              Properties:
                                                                                                                                                                                              - excludedOrnaments + icon -Array.<string> +object @@ -332,7 +348,7 @@
                                                                                                                                                                                              Properties:
                                                                                                                                                                                              -

                                                                                                                                                                                              Patterns to be excluded from display.

                                                                                                                                                                                              +

                                                                                                                                                                                              The icon object for ornaments and beacons.

                                                                                                                                                                                              @@ -385,12 +401,12 @@
                                                                                                                                                                                              Properties:
                                                                                                                                                                                              -

                                                                                                                                                                                              - static icon +

                                                                                                                                                                                              + static knownOrnaments

                                                                                                                                                                                              @@ -400,23 +416,7 @@

                                                                                                                                                                                              -

                                                                                                                                                                                              Object holding optional definitions for ornaments and beacons. -The icon object holds optional definitions for the ornaments an beacons. The object shall -be filled from a plugin

                                                                                                                                                                                              -
                                                                                                                                                                                              'ornamentID' : {
                                                                                                                                                                                              -  name: 'meaningful name',     // shows up in dialog
                                                                                                                                                                                              -  layer: 'name for the Layer', // shows up in layerchooser, optional, if not set
                                                                                                                                                                                              -                               // ornament will be in "Ornaments"
                                                                                                                                                                                              -  url: 'url',                  // from which the image will be taken, optional,
                                                                                                                                                                                              -                               // 84x84px is default, if not set, stock images will be
                                                                                                                                                                                              -                               // used
                                                                                                                                                                                              -  offset: [dx,dy],             // optional, shift the ornament vertically or horizontally by
                                                                                                                                                                                              -                               // dx (vertical)and dy )horizontal.
                                                                                                                                                                                              -                               // [0, 0.5] to place right above the portal.
                                                                                                                                                                                              -                               // default is [0, 0] to center
                                                                                                                                                                                              -  opacity: 0..1                // optional, default is 0.6
                                                                                                                                                                                              -}
                                                                                                                                                                                              -
                                                                                                                                                                                              +

                                                                                                                                                                                              List of known ornaments.

                                                                                                                                                                                              @@ -453,7 +453,7 @@
                                                                                                                                                                                              Properties:
                                                                                                                                                                                              - icon + knownOrnaments @@ -469,7 +469,7 @@
                                                                                                                                                                                              Properties:
                                                                                                                                                                                              -

                                                                                                                                                                                              The icon object for ornaments and beacons.

                                                                                                                                                                                              +

                                                                                                                                                                                              Object tracking known ornaments.

                                                                                                                                                                                              @@ -522,12 +522,12 @@
                                                                                                                                                                                              Properties:
                                                                                                                                                                                              -

                                                                                                                                                                                              - static icon +

                                                                                                                                                                                              + static, constant OVERLAY_OPACITY :number

                                                                                                                                                                                              @@ -537,83 +537,25 @@

                                                                                                                                                                                              -

                                                                                                                                                                                              Object holding optional definitions for ornaments and beacons. -The icon object holds optional definitions for the ornaments an beacons. The object shall -be filled from a plugin

                                                                                                                                                                                              -
                                                                                                                                                                                              'ornamentID' : {
                                                                                                                                                                                              -  name: 'meaningful name',     // shows up in dialog
                                                                                                                                                                                              -  layer: 'name for the Layer', // shows up in layerchooser, optional, if not set
                                                                                                                                                                                              -                               // ornament will be in "Ornaments"
                                                                                                                                                                                              -  url: 'url',                  // from which the image will be taken, optional,
                                                                                                                                                                                              -                               // 84x84px is default, if not set, stock images will be
                                                                                                                                                                                              -                               // used
                                                                                                                                                                                              -  offset: [dx,dy],             // optional, shift the ornament vertically or horizontally by
                                                                                                                                                                                              -                               // dx (vertical)and dy )horizontal.
                                                                                                                                                                                              -                               // [0, 0.5] to place right above the portal.
                                                                                                                                                                                              -                               // default is [0, 0] to center
                                                                                                                                                                                              -  opacity: 0..1                // optional, default is 0.6
                                                                                                                                                                                              -}
                                                                                                                                                                                              -
                                                                                                                                                                                              +

                                                                                                                                                                                              Default opacity for ornament.

                                                                                                                                                                                              - - - - -
                                                                                                                                                                                              Properties:
                                                                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +number - - + + - -
                                                                                                                                                                                              NameTypeDescription
                                                                                                                                                                                              icon - +
                                                                                                                                                                                              Type:
                                                                                                                                                                                              +
                                                                                                                                                                                                +
                                                                                                                                                                                              • -object - - - -

                                                                                                                                                                                              The icon object for ornaments and beacons.

                                                                                                                                                                                              - + --> +
                                                                                                                                                                                              @@ -659,12 +601,12 @@
                                                                                                                                                                                              Properties:
                                                                                                                                                                                              -

                                                                                                                                                                                              - static knownOrnaments +

                                                                                                                                                                                              + static, constant OVERLAY_SIZE :number

                                                                                                                                                                                              @@ -674,67 +616,25 @@

                                                                                                                                                                                              -

                                                                                                                                                                                              List of known ornaments.

                                                                                                                                                                                              +

                                                                                                                                                                                              Default size for ornament.

                                                                                                                                                                                              - - - - -
                                                                                                                                                                                              Properties:
                                                                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +number - - + + - -
                                                                                                                                                                                              NameTypeDescription
                                                                                                                                                                                              knownOrnaments - +
                                                                                                                                                                                              Type:
                                                                                                                                                                                              +
                                                                                                                                                                                                +
                                                                                                                                                                                              • -object - - - -

                                                                                                                                                                                              Object tracking known ornaments.

                                                                                                                                                                                              - + --> +
                                                                                                                                                                                              @@ -776,41 +676,51 @@
                                                                                                                                                                                              Properties:
                                                                                                                                                                                              - - - -
                                                                                                                                                                                              -

                                                                                                                                                                                              - static knownOrnaments +

                                                                                                                                                                                              - + -

                                                                                                                                                                                              +

                                                                                                                                                                                              Methods

                                                                                                                                                                                              +
                                                                                                                                                                                              + + +
                                                                                                                                                                                              + +

                                                                                                                                                                                              + + static addPortal(portal) + + + + +

                                                                                                                                                                                              + +
                                                                                                                                                                                              +
                                                                                                                                                                                              -

                                                                                                                                                                                              List of known ornaments.

                                                                                                                                                                                              +

                                                                                                                                                                                              Adds ornament overlays to the specified portal.

                                                                                                                                                                                              - - -
                                                                                                                                                                                              Properties:
                                                                                                                                                                                              - - + +
                                                                                                                                                                                              +
                                                                                                                                                                                              Parameters:
                                                                                                                                                                                              + +
                                                                                                                                                                                              @@ -832,7 +742,7 @@
                                                                                                                                                                                              Properties:
                                                                                                                                                                                              - + +
                                                                                                                                                                                              knownOrnamentsportal @@ -848,5449 +758,13 @@
                                                                                                                                                                                              Properties:
                                                                                                                                                                                              -

                                                                                                                                                                                              Object tracking known ornaments.

                                                                                                                                                                                              The portal to which ornaments are added.

                                                                                                                                                                                              - - - -
                                                                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                              - - - - - -
                                                                                                                                                                                              - - - - -
                                                                                                                                                                                              -

                                                                                                                                                                                              - static, constant OVERLAY_OPACITY :number - - - -

                                                                                                                                                                                              - - -
                                                                                                                                                                                              -
                                                                                                                                                                                              - -
                                                                                                                                                                                              -

                                                                                                                                                                                              Default opacity for ornament.

                                                                                                                                                                                              -
                                                                                                                                                                                              - - - - - - - -
                                                                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                              - - - - - -
                                                                                                                                                                                              - - - - -
                                                                                                                                                                                              -

                                                                                                                                                                                              - static, constant OVERLAY_OPACITY :number - - - -

                                                                                                                                                                                              - - -
                                                                                                                                                                                              -
                                                                                                                                                                                              - -
                                                                                                                                                                                              -

                                                                                                                                                                                              Default opacity for ornament.

                                                                                                                                                                                              -
                                                                                                                                                                                              - - - - - - - -
                                                                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                              - - - - - -
                                                                                                                                                                                              - - - - -
                                                                                                                                                                                              -

                                                                                                                                                                                              - static, constant OVERLAY_SIZE :number - - - -

                                                                                                                                                                                              - - -
                                                                                                                                                                                              -
                                                                                                                                                                                              - -
                                                                                                                                                                                              -

                                                                                                                                                                                              Default size for ornament.

                                                                                                                                                                                              -
                                                                                                                                                                                              - - - - - - - -
                                                                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                              - - - - - -
                                                                                                                                                                                              - - - - -
                                                                                                                                                                                              -

                                                                                                                                                                                              - static, constant OVERLAY_SIZE :number - - - -

                                                                                                                                                                                              - - -
                                                                                                                                                                                              -
                                                                                                                                                                                              - -
                                                                                                                                                                                              -

                                                                                                                                                                                              Default size for ornament.

                                                                                                                                                                                              -
                                                                                                                                                                                              - - - - - - - -
                                                                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                              - - - - - -
                                                                                                                                                                                              - -
                                                                                                                                                                                              - - - -

                                                                                                                                                                                              Methods

                                                                                                                                                                                              - -
                                                                                                                                                                                              - - -
                                                                                                                                                                                              - -

                                                                                                                                                                                              - - static addPortal(portal) - - - - -

                                                                                                                                                                                              - - - -
                                                                                                                                                                                              -
                                                                                                                                                                                              - - -
                                                                                                                                                                                              -

                                                                                                                                                                                              Adds ornament overlays to the specified portal.

                                                                                                                                                                                              -
                                                                                                                                                                                              - - - - - - - - - -
                                                                                                                                                                                              -
                                                                                                                                                                                              Parameters:
                                                                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                              NameTypeDescription
                                                                                                                                                                                              portal - - -object - - - -

                                                                                                                                                                                              The portal to which ornaments are added.

                                                                                                                                                                                              - -
                                                                                                                                                                                              - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                              - - - - -
                                                                                                                                                                                              - - - - -
                                                                                                                                                                                              - -

                                                                                                                                                                                              - - static addPortal(portal) - - - - -

                                                                                                                                                                                              - - - -
                                                                                                                                                                                              -
                                                                                                                                                                                              - - -
                                                                                                                                                                                              -

                                                                                                                                                                                              Adds ornament overlays to the specified portal.

                                                                                                                                                                                              -
                                                                                                                                                                                              - - - - - - - - - -
                                                                                                                                                                                              -
                                                                                                                                                                                              Parameters:
                                                                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                              NameTypeDescription
                                                                                                                                                                                              portal - - -object - - - -

                                                                                                                                                                                              The portal to which ornaments are added.

                                                                                                                                                                                              - -
                                                                                                                                                                                              - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                              - - - - -
                                                                                                                                                                                              - - - - -
                                                                                                                                                                                              - -

                                                                                                                                                                                              - - static createLayer(layerID) - - - - -

                                                                                                                                                                                              - - - -
                                                                                                                                                                                              -
                                                                                                                                                                                              - - -
                                                                                                                                                                                              -

                                                                                                                                                                                              Creates a new layer for a given ornament ID.

                                                                                                                                                                                              -
                                                                                                                                                                                              - - - - - - - - - -
                                                                                                                                                                                              -
                                                                                                                                                                                              Parameters:
                                                                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                              NameTypeDescription
                                                                                                                                                                                              layerID - - -string - - - -

                                                                                                                                                                                              The ID for the new layer.

                                                                                                                                                                                              - -
                                                                                                                                                                                              - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                              - - - - -
                                                                                                                                                                                              - - - - -
                                                                                                                                                                                              - -

                                                                                                                                                                                              - - static createLayer(layerID) - - - - -

                                                                                                                                                                                              - - - -
                                                                                                                                                                                              -
                                                                                                                                                                                              - - -
                                                                                                                                                                                              -

                                                                                                                                                                                              Creates a new layer for a given ornament ID.

                                                                                                                                                                                              -
                                                                                                                                                                                              - - - - - - - - - -
                                                                                                                                                                                              -
                                                                                                                                                                                              Parameters:
                                                                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                              NameTypeDescription
                                                                                                                                                                                              layerID - - -string - - - -

                                                                                                                                                                                              The ID for the new layer.

                                                                                                                                                                                              - -
                                                                                                                                                                                              - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                              - - - - -
                                                                                                                                                                                              - - - - -
                                                                                                                                                                                              - -

                                                                                                                                                                                              - - static initOrnaments() - - - - -

                                                                                                                                                                                              - - - -
                                                                                                                                                                                              -
                                                                                                                                                                                              - - -
                                                                                                                                                                                              -

                                                                                                                                                                                              Initializes known ornaments.

                                                                                                                                                                                              -
                                                                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                              - - - - -
                                                                                                                                                                                              - - - - -
                                                                                                                                                                                              - -

                                                                                                                                                                                              - - static initOrnaments() - - - - -

                                                                                                                                                                                              - - - -
                                                                                                                                                                                              -
                                                                                                                                                                                              - - -
                                                                                                                                                                                              -

                                                                                                                                                                                              Initializes known ornaments.

                                                                                                                                                                                              -
                                                                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                              - - - - -
                                                                                                                                                                                              - - - - -
                                                                                                                                                                                              - -

                                                                                                                                                                                              - - static load() - - - - -

                                                                                                                                                                                              - - - -
                                                                                                                                                                                              -
                                                                                                                                                                                              - - -
                                                                                                                                                                                              -

                                                                                                                                                                                              Loads ornament data from localStorage.

                                                                                                                                                                                              -
                                                                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                              - - - - -
                                                                                                                                                                                              - - - - -
                                                                                                                                                                                              - -

                                                                                                                                                                                              - - static load() - - - - -

                                                                                                                                                                                              - - - -
                                                                                                                                                                                              -
                                                                                                                                                                                              - - -
                                                                                                                                                                                              -

                                                                                                                                                                                              Loads ornament data from localStorage.

                                                                                                                                                                                              -
                                                                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                              - - - - -
                                                                                                                                                                                              - - - - -
                                                                                                                                                                                              - -

                                                                                                                                                                                              - - static onChangeHandler() - - - - -

                                                                                                                                                                                              - - - -
                                                                                                                                                                                              -
                                                                                                                                                                                              - - -
                                                                                                                                                                                              -

                                                                                                                                                                                              Handles changes in ornament options and updates the map accordingly.

                                                                                                                                                                                              -
                                                                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                              - - - - -
                                                                                                                                                                                              - - - - -
                                                                                                                                                                                              - -

                                                                                                                                                                                              - - static onChangeHandler() - - - - -

                                                                                                                                                                                              - - - -
                                                                                                                                                                                              -
                                                                                                                                                                                              - - -
                                                                                                                                                                                              -

                                                                                                                                                                                              Handles changes in ornament options and updates the map accordingly.

                                                                                                                                                                                              -
                                                                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                              - - - - -
                                                                                                                                                                                              - - - - -
                                                                                                                                                                                              - -

                                                                                                                                                                                              - - static ornamentsList() → {string} - - - - -

                                                                                                                                                                                              - - - -
                                                                                                                                                                                              -
                                                                                                                                                                                              - - -
                                                                                                                                                                                              -

                                                                                                                                                                                              Generates a list of ornaments for display in the options dialog.

                                                                                                                                                                                              -
                                                                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                              -
                                                                                                                                                                                              Returns:
                                                                                                                                                                                              - - - - - -string - - - - - --

                                                                                                                                                                                              HTML string representing the list of ornaments.

                                                                                                                                                                                              - - - - - -
                                                                                                                                                                                              - - - - - -
                                                                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                              - - - - -
                                                                                                                                                                                              - - - - -
                                                                                                                                                                                              - -

                                                                                                                                                                                              - - static ornamentsList() → {string} - - - - -

                                                                                                                                                                                              - - - -
                                                                                                                                                                                              -
                                                                                                                                                                                              - - -
                                                                                                                                                                                              -

                                                                                                                                                                                              Generates a list of ornaments for display in the options dialog.

                                                                                                                                                                                              -
                                                                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                              -
                                                                                                                                                                                              Returns:
                                                                                                                                                                                              - - - - - -string - - - - - --

                                                                                                                                                                                              HTML string representing the list of ornaments.

                                                                                                                                                                                              - - - - - -
                                                                                                                                                                                              - - - - - -
                                                                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                              - - - - -
                                                                                                                                                                                              - - - - -
                                                                                                                                                                                              - -

                                                                                                                                                                                              - - static ornamentsOpt() - - - - -

                                                                                                                                                                                              - - - -
                                                                                                                                                                                              -
                                                                                                                                                                                              - - -
                                                                                                                                                                                              -

                                                                                                                                                                                              Opens the dialog for ornament options, allowing users to manage ornament visibility.

                                                                                                                                                                                              -
                                                                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                              - - - - -
                                                                                                                                                                                              - - - - -
                                                                                                                                                                                              - -

                                                                                                                                                                                              - - static ornamentsOpt() - - - - -

                                                                                                                                                                                              - - - -
                                                                                                                                                                                              -
                                                                                                                                                                                              - - -
                                                                                                                                                                                              -

                                                                                                                                                                                              Opens the dialog for ornament options, allowing users to manage ornament visibility.

                                                                                                                                                                                              -
                                                                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                              - - - - -
                                                                                                                                                                                              - - - - -
                                                                                                                                                                                              - -

                                                                                                                                                                                              - - static processInput() - - - - -

                                                                                                                                                                                              - - - -
                                                                                                                                                                                              -
                                                                                                                                                                                              - - -
                                                                                                                                                                                              -

                                                                                                                                                                                              Processes input data for managing ornaments.

                                                                                                                                                                                              -
                                                                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                              - - - - -
                                                                                                                                                                                              - - - - -
                                                                                                                                                                                              - -

                                                                                                                                                                                              - - static processInput() - - - - -

                                                                                                                                                                                              - - - -
                                                                                                                                                                                              -
                                                                                                                                                                                              - - -
                                                                                                                                                                                              -

                                                                                                                                                                                              Processes input data for managing ornaments.

                                                                                                                                                                                              -
                                                                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                              - - - - -
                                                                                                                                                                                              - - - - -
                                                                                                                                                                                              - -

                                                                                                                                                                                              - - static reload() - - - - -

                                                                                                                                                                                              - - - -
                                                                                                                                                                                              -
                                                                                                                                                                                              - - -
                                                                                                                                                                                              -

                                                                                                                                                                                              Reloads all ornaments on the map.

                                                                                                                                                                                              -
                                                                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                              - - - - -
                                                                                                                                                                                              - - - - -
                                                                                                                                                                                              - -

                                                                                                                                                                                              - - static reload() - - - - -

                                                                                                                                                                                              - - - -
                                                                                                                                                                                              -
                                                                                                                                                                                              - - -
                                                                                                                                                                                              -

                                                                                                                                                                                              Reloads all ornaments on the map.

                                                                                                                                                                                              -
                                                                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                              - - - - -
                                                                                                                                                                                              - - - - -
                                                                                                                                                                                              - -

                                                                                                                                                                                              - - static removePortal(portal) - - - - -

                                                                                                                                                                                              - - - -
                                                                                                                                                                                              -
                                                                                                                                                                                              - - -
                                                                                                                                                                                              -

                                                                                                                                                                                              Removes ornament overlays from the specified portal.

                                                                                                                                                                                              -
                                                                                                                                                                                              - - - - - - - - - -
                                                                                                                                                                                              -
                                                                                                                                                                                              Parameters:
                                                                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                              NameTypeDescription
                                                                                                                                                                                              portal - - -object - - - -

                                                                                                                                                                                              The portal from which ornaments are removed.

                                                                                                                                                                                              - -
                                                                                                                                                                                              - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                              - - - - -
                                                                                                                                                                                              - - - - -
                                                                                                                                                                                              - -

                                                                                                                                                                                              - - static removePortal(portal) - - - - -

                                                                                                                                                                                              - - - -
                                                                                                                                                                                              -
                                                                                                                                                                                              - - -
                                                                                                                                                                                              -

                                                                                                                                                                                              Removes ornament overlays from the specified portal.

                                                                                                                                                                                              -
                                                                                                                                                                                              - - - - - - - - - -
                                                                                                                                                                                              -
                                                                                                                                                                                              Parameters:
                                                                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                              NameTypeDescription
                                                                                                                                                                                              portal - - -object - - - -

                                                                                                                                                                                              The portal from which ornaments are removed.

                                                                                                                                                                                              - -
                                                                                                                                                                                              - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                              - - - - -
                                                                                                                                                                                              - - - - -
                                                                                                                                                                                              - -

                                                                                                                                                                                              - - static replaceOL() - - - - -

                                                                                                                                                                                              - - - -
                                                                                                                                                                                              -
                                                                                                                                                                                              - - -
                                                                                                                                                                                              -

                                                                                                                                                                                              Replaces the content of the ornaments list in the dialog.

                                                                                                                                                                                              -
                                                                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                              - - - - -
                                                                                                                                                                                              - - - - -
                                                                                                                                                                                              - -

                                                                                                                                                                                              - - static replaceOL() - - - - -

                                                                                                                                                                                              - - - -
                                                                                                                                                                                              -
                                                                                                                                                                                              - - -
                                                                                                                                                                                              -

                                                                                                                                                                                              Replaces the content of the ornaments list in the dialog.

                                                                                                                                                                                              -
                                                                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                              - - - - -
                                                                                                                                                                                              - - - - -
                                                                                                                                                                                              - -

                                                                                                                                                                                              - - static save() - - - - -

                                                                                                                                                                                              - - - -
                                                                                                                                                                                              -
                                                                                                                                                                                              - - -
                                                                                                                                                                                              -

                                                                                                                                                                                              Saves the current ornament configuration to localStorage.

                                                                                                                                                                                              -
                                                                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                              - - - - -
                                                                                                                                                                                              - - - - -
                                                                                                                                                                                              - -

                                                                                                                                                                                              - - static save() - - - - -

                                                                                                                                                                                              - - - -
                                                                                                                                                                                              -
                                                                                                                                                                                              - - -
                                                                                                                                                                                              -

                                                                                                                                                                                              Saves the current ornament configuration to localStorage.

                                                                                                                                                                                              -
                                                                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                              - - - - -
                                                                                                                                                                                              - - - - -
                                                                                                                                                                                              - -

                                                                                                                                                                                              - - static setup() - - - - -

                                                                                                                                                                                              - - - -
                                                                                                                                                                                              -
                                                                                                                                                                                              - - -
                                                                                                                                                                                              -

                                                                                                                                                                                              Sets up the ornament layer and necessary event handlers.

                                                                                                                                                                                              -
                                                                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                              - - - - -
                                                                                                                                                                                              - - - - -
                                                                                                                                                                                              - -

                                                                                                                                                                                              - - static setup() - - - - -

                                                                                                                                                                                              - - - -
                                                                                                                                                                                              -
                                                                                                                                                                                              - - -
                                                                                                                                                                                              -

                                                                                                                                                                                              Sets up the ornament layer and necessary event handlers.

                                                                                                                                                                                              -
                                                                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                              - - - - -
                                                                                                                                                                                              - -
                                                                                                                                                                                              - - - - - -

                                                                                                                                                                                              - -
                                                                                                                                                                                              - - - - - - - -
                                                                                                                                                                                              - -
                                                                                                                                                                                              - -

                                                                                                                                                                                              ornaments

                                                                                                                                                                                              - - -
                                                                                                                                                                                              - -
                                                                                                                                                                                              - -
                                                                                                                                                                                              - - -

                                                                                                                                                                                              Manages the overlay of additional images (ornaments) on portals, such as beacons, frackers, -and anomaly markers.

                                                                                                                                                                                              -

                                                                                                                                                                                              Added as part of the Ingress #Helios in 2014, ornaments are additional image overlays for portals. -currently there are 6 known types of ornaments: ap$x$suffix

                                                                                                                                                                                              -
                                                                                                                                                                                                -
                                                                                                                                                                                              • cluster portals (without suffix)
                                                                                                                                                                                              • -
                                                                                                                                                                                              • volatile portals (_v)
                                                                                                                                                                                              • -
                                                                                                                                                                                              • meeting points (_start)
                                                                                                                                                                                              • -
                                                                                                                                                                                              • finish points (_end)
                                                                                                                                                                                              • -
                                                                                                                                                                                              -

                                                                                                                                                                                              Beacons and Frackers were introduced at the launch of the Ingress ingame store on November 1st, 2015

                                                                                                                                                                                              -
                                                                                                                                                                                                -
                                                                                                                                                                                              • Beacons (pe$TAG - $NAME) ie: peNIA - NIANTIC
                                                                                                                                                                                              • -
                                                                                                                                                                                              • Frackers ('peFRACK') -(there are 7 different colors for each of them)
                                                                                                                                                                                              • -
                                                                                                                                                                                              -

                                                                                                                                                                                              Ornament IDs are dynamic. NIANTIC might change them at any time without prior notice. -New ornamnent IDs found on the map will be recorded and saved to knownOrnaments from -which the Ornaments dialog will be filled with checked checkboxes. -To exclude a set of ornaments, even if they have not yet shown up on the map, the user -can add an entry to excludedOrnaments, which will compared (startsWith) to all known and -future IDs. example: "ap" to exclude all Ornaments for anomalies (ap1, ap2, ap2_v)

                                                                                                                                                                                              - - - - - -
                                                                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                              - - - - -
                                                                                                                                                                                              - - - - - - - - - - - - - - - -

                                                                                                                                                                                              Members

                                                                                                                                                                                              - -
                                                                                                                                                                                              - - -
                                                                                                                                                                                              -

                                                                                                                                                                                              - static excludedOrnaments - - - -

                                                                                                                                                                                              - - -
                                                                                                                                                                                              -
                                                                                                                                                                                              - -
                                                                                                                                                                                              -

                                                                                                                                                                                              List of ornaments to be excluded.

                                                                                                                                                                                              -
                                                                                                                                                                                              - - - - - - - -
                                                                                                                                                                                              Properties:
                                                                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                              NameTypeDescription
                                                                                                                                                                                              excludedOrnaments - - -Array.<string> - - - -

                                                                                                                                                                                              Patterns to be excluded from display.

                                                                                                                                                                                              - - - - -
                                                                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                              - - - - - -
                                                                                                                                                                                              - - - - -
                                                                                                                                                                                              -

                                                                                                                                                                                              - static excludedOrnaments - - - -

                                                                                                                                                                                              - - -
                                                                                                                                                                                              -
                                                                                                                                                                                              - -
                                                                                                                                                                                              -

                                                                                                                                                                                              List of ornaments to be excluded.

                                                                                                                                                                                              -
                                                                                                                                                                                              - - - - - - - -
                                                                                                                                                                                              Properties:
                                                                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                              NameTypeDescription
                                                                                                                                                                                              excludedOrnaments - - -Array.<string> - - - -

                                                                                                                                                                                              Patterns to be excluded from display.

                                                                                                                                                                                              - - - - -
                                                                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                              - - - - - -
                                                                                                                                                                                              - - - - -
                                                                                                                                                                                              -

                                                                                                                                                                                              - static icon - - - -

                                                                                                                                                                                              - - -
                                                                                                                                                                                              -
                                                                                                                                                                                              - -
                                                                                                                                                                                              -

                                                                                                                                                                                              Object holding optional definitions for ornaments and beacons. -The icon object holds optional definitions for the ornaments an beacons. The object shall -be filled from a plugin

                                                                                                                                                                                              -
                                                                                                                                                                                              'ornamentID' : {
                                                                                                                                                                                              -  name: 'meaningful name',     // shows up in dialog
                                                                                                                                                                                              -  layer: 'name for the Layer', // shows up in layerchooser, optional, if not set
                                                                                                                                                                                              -                               // ornament will be in "Ornaments"
                                                                                                                                                                                              -  url: 'url',                  // from which the image will be taken, optional,
                                                                                                                                                                                              -                               // 84x84px is default, if not set, stock images will be
                                                                                                                                                                                              -                               // used
                                                                                                                                                                                              -  offset: [dx,dy],             // optional, shift the ornament vertically or horizontally by
                                                                                                                                                                                              -                               // dx (vertical)and dy )horizontal.
                                                                                                                                                                                              -                               // [0, 0.5] to place right above the portal.
                                                                                                                                                                                              -                               // default is [0, 0] to center
                                                                                                                                                                                              -  opacity: 0..1                // optional, default is 0.6
                                                                                                                                                                                              -}
                                                                                                                                                                                              -
                                                                                                                                                                                              -
                                                                                                                                                                                              - - - - - - - -
                                                                                                                                                                                              Properties:
                                                                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                              NameTypeDescription
                                                                                                                                                                                              icon - - -object - - - -

                                                                                                                                                                                              The icon object for ornaments and beacons.

                                                                                                                                                                                              - - - - -
                                                                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                              - - - - - -
                                                                                                                                                                                              - - - - -
                                                                                                                                                                                              -

                                                                                                                                                                                              - static icon - - - -

                                                                                                                                                                                              - - -
                                                                                                                                                                                              -
                                                                                                                                                                                              - -
                                                                                                                                                                                              -

                                                                                                                                                                                              Object holding optional definitions for ornaments and beacons. -The icon object holds optional definitions for the ornaments an beacons. The object shall -be filled from a plugin

                                                                                                                                                                                              -
                                                                                                                                                                                              'ornamentID' : {
                                                                                                                                                                                              -  name: 'meaningful name',     // shows up in dialog
                                                                                                                                                                                              -  layer: 'name for the Layer', // shows up in layerchooser, optional, if not set
                                                                                                                                                                                              -                               // ornament will be in "Ornaments"
                                                                                                                                                                                              -  url: 'url',                  // from which the image will be taken, optional,
                                                                                                                                                                                              -                               // 84x84px is default, if not set, stock images will be
                                                                                                                                                                                              -                               // used
                                                                                                                                                                                              -  offset: [dx,dy],             // optional, shift the ornament vertically or horizontally by
                                                                                                                                                                                              -                               // dx (vertical)and dy )horizontal.
                                                                                                                                                                                              -                               // [0, 0.5] to place right above the portal.
                                                                                                                                                                                              -                               // default is [0, 0] to center
                                                                                                                                                                                              -  opacity: 0..1                // optional, default is 0.6
                                                                                                                                                                                              -}
                                                                                                                                                                                              -
                                                                                                                                                                                              -
                                                                                                                                                                                              - - - - - - - -
                                                                                                                                                                                              Properties:
                                                                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                              NameTypeDescription
                                                                                                                                                                                              icon - - -object - - - -

                                                                                                                                                                                              The icon object for ornaments and beacons.

                                                                                                                                                                                              - - - - -
                                                                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                              - - - - - -
                                                                                                                                                                                              - - - - -
                                                                                                                                                                                              -

                                                                                                                                                                                              - static knownOrnaments - - - -

                                                                                                                                                                                              - - -
                                                                                                                                                                                              -
                                                                                                                                                                                              - -
                                                                                                                                                                                              -

                                                                                                                                                                                              List of known ornaments.

                                                                                                                                                                                              -
                                                                                                                                                                                              - - - - - - - -
                                                                                                                                                                                              Properties:
                                                                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                              NameTypeDescription
                                                                                                                                                                                              knownOrnaments - - -object - - - -

                                                                                                                                                                                              Object tracking known ornaments.

                                                                                                                                                                                              - - - - -
                                                                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                              - - - - - -
                                                                                                                                                                                              - - - - -
                                                                                                                                                                                              -

                                                                                                                                                                                              - static knownOrnaments - - - -

                                                                                                                                                                                              - - -
                                                                                                                                                                                              -
                                                                                                                                                                                              - -
                                                                                                                                                                                              -

                                                                                                                                                                                              List of known ornaments.

                                                                                                                                                                                              -
                                                                                                                                                                                              - - - - - - - -
                                                                                                                                                                                              Properties:
                                                                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                              NameTypeDescription
                                                                                                                                                                                              knownOrnaments - - -object - - - -

                                                                                                                                                                                              Object tracking known ornaments.

                                                                                                                                                                                              - - - - -
                                                                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                              - - - - - -
                                                                                                                                                                                              - - - - -
                                                                                                                                                                                              -

                                                                                                                                                                                              - static, constant OVERLAY_OPACITY :number - - - -

                                                                                                                                                                                              - - -
                                                                                                                                                                                              -
                                                                                                                                                                                              - -
                                                                                                                                                                                              -

                                                                                                                                                                                              Default opacity for ornament.

                                                                                                                                                                                              -
                                                                                                                                                                                              - - - - - - - -
                                                                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                              - - - - - -
                                                                                                                                                                                              - - - - -
                                                                                                                                                                                              -

                                                                                                                                                                                              - static, constant OVERLAY_OPACITY :number - - - -

                                                                                                                                                                                              - - -
                                                                                                                                                                                              -
                                                                                                                                                                                              - -
                                                                                                                                                                                              -

                                                                                                                                                                                              Default opacity for ornament.

                                                                                                                                                                                              -
                                                                                                                                                                                              - - - - - - - -
                                                                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                              - - - - - -
                                                                                                                                                                                              - - - - -
                                                                                                                                                                                              -

                                                                                                                                                                                              - static, constant OVERLAY_SIZE :number - - - -

                                                                                                                                                                                              - - -
                                                                                                                                                                                              -
                                                                                                                                                                                              - -
                                                                                                                                                                                              -

                                                                                                                                                                                              Default size for ornament.

                                                                                                                                                                                              -
                                                                                                                                                                                              - - - - - - - -
                                                                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                              - - - - - -
                                                                                                                                                                                              - - - - -
                                                                                                                                                                                              -

                                                                                                                                                                                              - static, constant OVERLAY_SIZE :number - - - -

                                                                                                                                                                                              - - -
                                                                                                                                                                                              -
                                                                                                                                                                                              - -
                                                                                                                                                                                              -

                                                                                                                                                                                              Default size for ornament.

                                                                                                                                                                                              -
                                                                                                                                                                                              - - - - - - - -
                                                                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                              - - - - - -
                                                                                                                                                                                              - -
                                                                                                                                                                                              - - - -

                                                                                                                                                                                              Methods

                                                                                                                                                                                              - -
                                                                                                                                                                                              - - -
                                                                                                                                                                                              - -

                                                                                                                                                                                              - - static addPortal(portal) - - - - -

                                                                                                                                                                                              - - - -
                                                                                                                                                                                              -
                                                                                                                                                                                              - - -
                                                                                                                                                                                              -

                                                                                                                                                                                              Adds ornament overlays to the specified portal.

                                                                                                                                                                                              -
                                                                                                                                                                                              - - - - - - - - - -
                                                                                                                                                                                              -
                                                                                                                                                                                              Parameters:
                                                                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                              NameTypeDescription
                                                                                                                                                                                              portal - - -object - - - -

                                                                                                                                                                                              The portal to which ornaments are added.

                                                                                                                                                                                              - -
                                                                                                                                                                                              - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                              - - - - -
                                                                                                                                                                                              - - - - -
                                                                                                                                                                                              - -

                                                                                                                                                                                              - - static addPortal(portal) - - - - -

                                                                                                                                                                                              - - - -
                                                                                                                                                                                              -
                                                                                                                                                                                              - - -
                                                                                                                                                                                              -

                                                                                                                                                                                              Adds ornament overlays to the specified portal.

                                                                                                                                                                                              -
                                                                                                                                                                                              - - - - - - - - - -
                                                                                                                                                                                              -
                                                                                                                                                                                              Parameters:
                                                                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                              NameTypeDescription
                                                                                                                                                                                              portal - - -object - - - -

                                                                                                                                                                                              The portal to which ornaments are added.

                                                                                                                                                                                              - -
                                                                                                                                                                                              - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                              - - - - -
                                                                                                                                                                                              - - - - -
                                                                                                                                                                                              - -

                                                                                                                                                                                              - - static createLayer(layerID) - - - - -

                                                                                                                                                                                              - - - -
                                                                                                                                                                                              -
                                                                                                                                                                                              - - -
                                                                                                                                                                                              -

                                                                                                                                                                                              Creates a new layer for a given ornament ID.

                                                                                                                                                                                              -
                                                                                                                                                                                              - - - - - - - - - -
                                                                                                                                                                                              -
                                                                                                                                                                                              Parameters:
                                                                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                              NameTypeDescription
                                                                                                                                                                                              layerID - - -string - - - -

                                                                                                                                                                                              The ID for the new layer.

                                                                                                                                                                                              - -
                                                                                                                                                                                              - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                              - - - - -
                                                                                                                                                                                              - - - - -
                                                                                                                                                                                              - -

                                                                                                                                                                                              - - static createLayer(layerID) - - - - -

                                                                                                                                                                                              - - - -
                                                                                                                                                                                              -
                                                                                                                                                                                              - - -
                                                                                                                                                                                              -

                                                                                                                                                                                              Creates a new layer for a given ornament ID.

                                                                                                                                                                                              -
                                                                                                                                                                                              - - - - - - - - - -
                                                                                                                                                                                              -
                                                                                                                                                                                              Parameters:
                                                                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                              NameTypeDescription
                                                                                                                                                                                              layerID - - -string - - - -

                                                                                                                                                                                              The ID for the new layer.

                                                                                                                                                                                              - -
                                                                                                                                                                                              - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                              - - - - -
                                                                                                                                                                                              - - - - -
                                                                                                                                                                                              - -

                                                                                                                                                                                              - - static initOrnaments() - - - - -

                                                                                                                                                                                              - - - -
                                                                                                                                                                                              -
                                                                                                                                                                                              - - -
                                                                                                                                                                                              -

                                                                                                                                                                                              Initializes known ornaments.

                                                                                                                                                                                              -
                                                                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                              - - - - -
                                                                                                                                                                                              - - - - -
                                                                                                                                                                                              - -

                                                                                                                                                                                              - - static initOrnaments() - - - - -

                                                                                                                                                                                              - - - -
                                                                                                                                                                                              -
                                                                                                                                                                                              - - -
                                                                                                                                                                                              -

                                                                                                                                                                                              Initializes known ornaments.

                                                                                                                                                                                              -
                                                                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                              - - - - -
                                                                                                                                                                                              - - - - -
                                                                                                                                                                                              - -

                                                                                                                                                                                              - - static load() - - - - -

                                                                                                                                                                                              - - - -
                                                                                                                                                                                              -
                                                                                                                                                                                              - - -
                                                                                                                                                                                              -

                                                                                                                                                                                              Loads ornament data from localStorage.

                                                                                                                                                                                              -
                                                                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                              - - - - -
                                                                                                                                                                                              - - - - -
                                                                                                                                                                                              - -

                                                                                                                                                                                              - - static load() - - - - -

                                                                                                                                                                                              - - - -
                                                                                                                                                                                              -
                                                                                                                                                                                              - - -
                                                                                                                                                                                              -

                                                                                                                                                                                              Loads ornament data from localStorage.

                                                                                                                                                                                              -
                                                                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                              - - - - -
                                                                                                                                                                                              - - - - -
                                                                                                                                                                                              - -

                                                                                                                                                                                              - - static onChangeHandler() - - - - -

                                                                                                                                                                                              - - - -
                                                                                                                                                                                              -
                                                                                                                                                                                              - - -
                                                                                                                                                                                              -

                                                                                                                                                                                              Handles changes in ornament options and updates the map accordingly.

                                                                                                                                                                                              -
                                                                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                              - - - - -
                                                                                                                                                                                              - - - - -
                                                                                                                                                                                              - -

                                                                                                                                                                                              - - static onChangeHandler() - - - - -

                                                                                                                                                                                              - - - -
                                                                                                                                                                                              -
                                                                                                                                                                                              - - -
                                                                                                                                                                                              -

                                                                                                                                                                                              Handles changes in ornament options and updates the map accordingly.

                                                                                                                                                                                              -
                                                                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                              - - - - -
                                                                                                                                                                                              - - - - -
                                                                                                                                                                                              - -

                                                                                                                                                                                              - - static ornamentsList() → {string} - - - - -

                                                                                                                                                                                              - - - -
                                                                                                                                                                                              -
                                                                                                                                                                                              - - -
                                                                                                                                                                                              -

                                                                                                                                                                                              Generates a list of ornaments for display in the options dialog.

                                                                                                                                                                                              -
                                                                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                              -
                                                                                                                                                                                              Returns:
                                                                                                                                                                                              - - - - - -string - - - - - --

                                                                                                                                                                                              HTML string representing the list of ornaments.

                                                                                                                                                                                              - - - - - -
                                                                                                                                                                                              - - - - - -
                                                                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                              - - - - -
                                                                                                                                                                                              - - - - -
                                                                                                                                                                                              - -

                                                                                                                                                                                              - - static ornamentsList() → {string} - - - - -

                                                                                                                                                                                              - - - -
                                                                                                                                                                                              -
                                                                                                                                                                                              - - -
                                                                                                                                                                                              -

                                                                                                                                                                                              Generates a list of ornaments for display in the options dialog.

                                                                                                                                                                                              @@ -6308,35 +782,6 @@

                                                                                                                                                                                              - - - - - -
                                                                                                                                                                                              -
                                                                                                                                                                                              Returns:
                                                                                                                                                                                              - - - - - -string - - - - - --

                                                                                                                                                                                              HTML string representing the list of ornaments.

                                                                                                                                                                                              - - - - - -
                                                                                                                                                                                              - - - -
                                                                                                                                                                                              @@ -6381,14 +826,14 @@
                                                                                                                                                                                              Returns:
                                                                                                                                                                                              -

                                                                                                                                                                                              +

                                                                                                                                                                                              - static ornamentsOpt() + static createLayer(layerID)

                                                                                                                                                                                              @@ -6400,7 +845,7 @@

                                                                                                                                                                                              -

                                                                                                                                                                                              Opens the dialog for ornament options, allowing users to manage ornament visibility.

                                                                                                                                                                                              +

                                                                                                                                                                                              Creates a new layer for a given ornament ID.

                                                                                                                                                                                              @@ -6411,183 +856,55 @@

                                                                                                                                                                                              - - - - - - - - - - - - - - - - -
                                                                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                              - - - - -

                                                                                                                                                                                              - - - - -
                                                                                                                                                                                              - -

                                                                                                                                                                                              - - static ornamentsOpt() - - - - -

                                                                                                                                                                                              - +
                                                                                                                                                                                              +
                                                                                                                                                                                              Parameters:
                                                                                                                                                                                              + + + + + + - - -
                                                                                                                                                                                              - - -
                                                                                                                                                                                              -

                                                                                                                                                                                              Opens the dialog for ornament options, allowing users to manage ornament visibility.

                                                                                                                                                                                              -
                                                                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - +
                                                                                                                                                                                              - + - - + + + + + - - - - - -
                                                                                                                                                                                              - -

                                                                                                                                                                                              +

                                                                                                                                                                                              - static processInput() - + - + + - + - + + + + + +
                                                                                                                                                                                              NameTypeDescription
                                                                                                                                                                                              layerID - + +string - - - -
                                                                                                                                                                                              - -
                                                                                                                                                                                              -

                                                                                                                                                                                              Processes input data for managing ornaments.

                                                                                                                                                                                              -
                                                                                                                                                                                              - + +

                                                                                                                                                                                              The ID for the new layer.

                                                                                                                                                                                              +
                                                                                                                                                                                              @@ -6648,14 +965,14 @@

                                                                                                                                                                                              -

                                                                                                                                                                                              +

                                                                                                                                                                                              - static processInput() + static initOrnaments()

                                                                                                                                                                                              @@ -6667,7 +984,7 @@

                                                                                                                                                                                              -

                                                                                                                                                                                              Processes input data for managing ornaments.

                                                                                                                                                                                              +

                                                                                                                                                                                              Initializes known ornaments.

                                                                                                                                                                                              @@ -6737,14 +1054,14 @@

                                                                                                                                                                                              -

                                                                                                                                                                                              +

                                                                                                                                                                                              - static reload() + static load()

                                                                                                                                                                                              @@ -6756,7 +1073,7 @@

                                                                                                                                                                                              -

                                                                                                                                                                                              Reloads all ornaments on the map.

                                                                                                                                                                                              +

                                                                                                                                                                                              Loads ornament data from localStorage.

                                                                                                                                                                                              @@ -6826,14 +1143,14 @@

                                                                                                                                                                                              -

                                                                                                                                                                                              +

                                                                                                                                                                                              - static reload() + static onChangeHandler()

                                                                                                                                                                                              @@ -6845,7 +1162,7 @@

                                                                                                                                                                                              -

                                                                                                                                                                                              Reloads all ornaments on the map.

                                                                                                                                                                                              +

                                                                                                                                                                                              Handles changes in ornament options and updates the map accordingly.

                                                                                                                                                                                              @@ -6915,14 +1232,14 @@

                                                                                                                                                                                              -

                                                                                                                                                                                              +

                                                                                                                                                                                              - static removePortal(portal) + static ornamentsList() → {string}

                                                                                                                                                                                              @@ -6934,7 +1251,7 @@

                                                                                                                                                                                              -

                                                                                                                                                                                              Removes ornament overlays from the specified portal.

                                                                                                                                                                                              +

                                                                                                                                                                                              Generates a list of ornaments for display in the options dialog.

                                                                                                                                                                                              @@ -6945,67 +1262,38 @@

                                                                                                                                                                                              -
                                                                                                                                                                                              -
                                                                                                                                                                                              Parameters:
                                                                                                                                                                                              - - - - - - - - - - + - + - - - + - - - - - + - - - +string - - - - -
                                                                                                                                                                                              NameTypeDescription
                                                                                                                                                                                              portal - + +
                                                                                                                                                                                              +
                                                                                                                                                                                              Returns:
                                                                                                                                                                                              + -object - - -

                                                                                                                                                                                              The portal from which ornaments are removed.

                                                                                                                                                                                              -
                                                                                                                                                                                              - - - +-

                                                                                                                                                                                              HTML string representing the list of ornaments.

                                                                                                                                                                                              - - - + + @@ -7054,14 +1342,14 @@

                                                                                                                                                                                              Parameters:
                                                                                                                                                                                              -

                                                                                                                                                                                              +

                                                                                                                                                                                              - static removePortal(portal) + static ornamentsOpt()

                                                                                                                                                                                              @@ -7073,7 +1361,7 @@

                                                                                                                                                                                              -

                                                                                                                                                                                              Removes ornament overlays from the specified portal.

                                                                                                                                                                                              +

                                                                                                                                                                                              Opens the dialog for ornament options, allowing users to manage ornament visibility.

                                                                                                                                                                                              @@ -7084,56 +1372,6 @@

                                                                                                                                                                                              -
                                                                                                                                                                                              -
                                                                                                                                                                                              Parameters:
                                                                                                                                                                                              - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                              NameTypeDescription
                                                                                                                                                                                              portal - - -object - - - -

                                                                                                                                                                                              The portal from which ornaments are removed.

                                                                                                                                                                                              - -
                                                                                                                                                                                              - @@ -7193,14 +1431,14 @@

                                                                                                                                                                                              Parameters:
                                                                                                                                                                                              -

                                                                                                                                                                                              +

                                                                                                                                                                                              - static replaceOL() + static processInput()

                                                                                                                                                                                              @@ -7212,7 +1450,7 @@

                                                                                                                                                                                              -

                                                                                                                                                                                              Replaces the content of the ornaments list in the dialog.

                                                                                                                                                                                              +

                                                                                                                                                                                              Processes input data for managing ornaments.

                                                                                                                                                                                              @@ -7282,14 +1520,14 @@

                                                                                                                                                                                              -

                                                                                                                                                                                              +

                                                                                                                                                                                              - static replaceOL() + static reload()

                                                                                                                                                                                              @@ -7301,7 +1539,7 @@

                                                                                                                                                                                              -

                                                                                                                                                                                              Replaces the content of the ornaments list in the dialog.

                                                                                                                                                                                              +

                                                                                                                                                                                              Reloads all ornaments on the map.

                                                                                                                                                                                              @@ -7371,14 +1609,14 @@

                                                                                                                                                                                              -

                                                                                                                                                                                              +

                                                                                                                                                                                              - static save() + static removePortal(portal)

                                                                                                                                                                                              @@ -7390,7 +1628,7 @@

                                                                                                                                                                                              -

                                                                                                                                                                                              Saves the current ornament configuration to localStorage.

                                                                                                                                                                                              +

                                                                                                                                                                                              Removes ornament overlays from the specified portal.

                                                                                                                                                                                              @@ -7401,6 +1639,56 @@

                                                                                                                                                                                              +
                                                                                                                                                                                              +
                                                                                                                                                                                              Parameters:
                                                                                                                                                                                              + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                                              NameTypeDescription
                                                                                                                                                                                              portal + + +object + + + +

                                                                                                                                                                                              The portal from which ornaments are removed.

                                                                                                                                                                                              + +
                                                                                                                                                                                              + @@ -7460,14 +1748,14 @@

                                                                                                                                                                                              -

                                                                                                                                                                                              +

                                                                                                                                                                                              - static save() + static replaceOL()

                                                                                                                                                                                              @@ -7479,7 +1767,7 @@

                                                                                                                                                                                              -

                                                                                                                                                                                              Saves the current ornament configuration to localStorage.

                                                                                                                                                                                              +

                                                                                                                                                                                              Replaces the content of the ornaments list in the dialog.

                                                                                                                                                                                              @@ -7549,14 +1837,14 @@

                                                                                                                                                                                              -

                                                                                                                                                                                              +

                                                                                                                                                                                              - static setup() + static save()

                                                                                                                                                                                              @@ -7568,7 +1856,7 @@

                                                                                                                                                                                              -

                                                                                                                                                                                              Sets up the ornament layer and necessary event handlers.

                                                                                                                                                                                              +

                                                                                                                                                                                              Saves the current ornament configuration to localStorage.

                                                                                                                                                                                              diff --git a/window.portalDetail.html b/window.portalDetail.html index 7fcc2e881..7d20eb808 100644 --- a/window.portalDetail.html +++ b/window.portalDetail.html @@ -34,7 +34,7 @@

                                                                                                                                                                                              IITC-CE

                                                                                                                                                                                                - +
                                                                                                                                                                                                @@ -258,161 +258,6 @@
                                                                                                                                                                                                Returns:
                                                                                                                                                                                                - - - - - - - - - - -

                                                                                                                                                                                                - - - - - - - - - -
                                                                                                                                                                                                - -

                                                                                                                                                                                                - - static get(guid) - - - - -

                                                                                                                                                                                                - - - -
                                                                                                                                                                                                -
                                                                                                                                                                                                - - -
                                                                                                                                                                                                -

                                                                                                                                                                                                Retrieves portal details from cache by GUID.

                                                                                                                                                                                                -
                                                                                                                                                                                                - - - - - - - - - -
                                                                                                                                                                                                -
                                                                                                                                                                                                Parameters:
                                                                                                                                                                                                - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                NameTypeDescription
                                                                                                                                                                                                guid - - -string - - - -

                                                                                                                                                                                                The Global Unique Identifier of the portal.

                                                                                                                                                                                                - -
                                                                                                                                                                                                - - - - - - - - - - - - - -
                                                                                                                                                                                                -
                                                                                                                                                                                                Returns:
                                                                                                                                                                                                - - - - - - --

                                                                                                                                                                                                Cached portal details if available.

                                                                                                                                                                                                - - - - - -
                                                                                                                                                                                                - - - - - -
                                                                                                                                                                                                - - - - - - - - - - - - - - - - - - - - @@ -595,14 +440,14 @@
                                                                                                                                                                                                Returns:
                                                                                                                                                                                                -

                                                                                                                                                                                                +

                                                                                                                                                                                                - static isFresh(guid) → {boolean} + static request(guid) → {Promise}

                                                                                                                                                                                                @@ -614,7 +459,8 @@

                                                                                                                                                                                                -

                                                                                                                                                                                                Checks if portal details are fresh in the cache.

                                                                                                                                                                                                +

                                                                                                                                                                                                Requests detailed information for a specific portal. If the information is not already being requested, +it initiates a new request. Returns a promise that resolves with the portal details.

                                                                                                                                                                                                @@ -694,13 +540,13 @@

                                                                                                                                                                                                Returns:
                                                                                                                                                                                                -boolean +Promise --

                                                                                                                                                                                                True if details are fresh, false otherwise.

                                                                                                                                                                                                +-

                                                                                                                                                                                                A promise that resolves with the portal details upon successful retrieval or rejection on failure.

                                                                                                                                                                                                @@ -755,14 +601,14 @@
                                                                                                                                                                                                Returns:
                                                                                                                                                                                                -

                                                                                                                                                                                                +

                                                                                                                                                                                                - static request(guid) → {Promise} + static setup()

                                                                                                                                                                                                @@ -774,8 +620,7 @@

                                                                                                                                                                                                -

                                                                                                                                                                                                Requests detailed information for a specific portal. If the information is not already being requested, -it initiates a new request. Returns a promise that resolves with the portal details.

                                                                                                                                                                                                +

                                                                                                                                                                                                Sets up the portal detail handler, initializing the cache.

                                                                                                                                                                                                @@ -786,2252 +631,17 @@

                                                                                                                                                                                                -
                                                                                                                                                                                                -
                                                                                                                                                                                                Parameters:
                                                                                                                                                                                                - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                NameTypeDescription
                                                                                                                                                                                                guid - - -string - - - -

                                                                                                                                                                                                The Global Unique Identifier of the portal.

                                                                                                                                                                                                - -
                                                                                                                                                                                                - - - - - - - -
                                                                                                                                                                                                -
                                                                                                                                                                                                Returns:
                                                                                                                                                                                                - - - - - -Promise - - - - - --

                                                                                                                                                                                                A promise that resolves with the portal details upon successful retrieval or rejection on failure.

                                                                                                                                                                                                - - - - -
                                                                                                                                                                                                - -
                                                                                                                                                                                                - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                - - - - -

                                                                                                                                                                                                - - - - -
                                                                                                                                                                                                - -

                                                                                                                                                                                                - - static request(guid) → {Promise} - - - - -

                                                                                                                                                                                                - - - -
                                                                                                                                                                                                -
                                                                                                                                                                                                - - -
                                                                                                                                                                                                -

                                                                                                                                                                                                Requests detailed information for a specific portal. If the information is not already being requested, -it initiates a new request. Returns a promise that resolves with the portal details.

                                                                                                                                                                                                -
                                                                                                                                                                                                - - - - - - - - - -
                                                                                                                                                                                                -
                                                                                                                                                                                                Parameters:
                                                                                                                                                                                                - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                NameTypeDescription
                                                                                                                                                                                                guid - - -string - - - -

                                                                                                                                                                                                The Global Unique Identifier of the portal.

                                                                                                                                                                                                - -
                                                                                                                                                                                                - - - - - - - - - - - - - -
                                                                                                                                                                                                -
                                                                                                                                                                                                Returns:
                                                                                                                                                                                                - - - - - -Promise - - - - - --

                                                                                                                                                                                                A promise that resolves with the portal details upon successful retrieval or rejection on failure.

                                                                                                                                                                                                - - - - - -
                                                                                                                                                                                                - - - - - -
                                                                                                                                                                                                - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                - - - - -
                                                                                                                                                                                                - - - - -
                                                                                                                                                                                                - -

                                                                                                                                                                                                - - static setup() - - - - -

                                                                                                                                                                                                - - - -
                                                                                                                                                                                                -
                                                                                                                                                                                                - - -
                                                                                                                                                                                                -

                                                                                                                                                                                                Sets up the portal detail handler, initializing the cache.

                                                                                                                                                                                                -
                                                                                                                                                                                                - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                - - - - -
                                                                                                                                                                                                - - - - -
                                                                                                                                                                                                - -

                                                                                                                                                                                                - - static setup() - - - - -

                                                                                                                                                                                                - - - -
                                                                                                                                                                                                -
                                                                                                                                                                                                - - -
                                                                                                                                                                                                -

                                                                                                                                                                                                Sets up the portal detail handler, initializing the cache.

                                                                                                                                                                                                -
                                                                                                                                                                                                - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                - - - - -
                                                                                                                                                                                                - - - - -
                                                                                                                                                                                                - -

                                                                                                                                                                                                - - static store(guid, dict, freshtime) - - - - -

                                                                                                                                                                                                - - - -
                                                                                                                                                                                                -
                                                                                                                                                                                                - - -
                                                                                                                                                                                                -

                                                                                                                                                                                                Stores portal details in the cache.

                                                                                                                                                                                                -
                                                                                                                                                                                                - - - - - - - - - -
                                                                                                                                                                                                -
                                                                                                                                                                                                Parameters:
                                                                                                                                                                                                - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                NameTypeDescription
                                                                                                                                                                                                guid - - -string - - - -

                                                                                                                                                                                                The Global Unique Identifier of the portal.

                                                                                                                                                                                                dict - - -object - - - -

                                                                                                                                                                                                The portal detail data.

                                                                                                                                                                                                freshtime - - -number - - - -

                                                                                                                                                                                                Optional freshness time for cache.

                                                                                                                                                                                                - -
                                                                                                                                                                                                - - - - - - - - - - - - - -
                                                                                                                                                                                                -
                                                                                                                                                                                                Returns:
                                                                                                                                                                                                - - - - - - --

                                                                                                                                                                                                Result of cache storage operation.

                                                                                                                                                                                                - - - - - -
                                                                                                                                                                                                - - - - - -
                                                                                                                                                                                                - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                - - - - -
                                                                                                                                                                                                - - - - -
                                                                                                                                                                                                - -

                                                                                                                                                                                                - - static store(guid, dict, freshtime) - - - - -

                                                                                                                                                                                                - - - -
                                                                                                                                                                                                -
                                                                                                                                                                                                - - -
                                                                                                                                                                                                -

                                                                                                                                                                                                Stores portal details in the cache.

                                                                                                                                                                                                -
                                                                                                                                                                                                - - - - - - - - - -
                                                                                                                                                                                                -
                                                                                                                                                                                                Parameters:
                                                                                                                                                                                                - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                NameTypeDescription
                                                                                                                                                                                                guid - - -string - - - -

                                                                                                                                                                                                The Global Unique Identifier of the portal.

                                                                                                                                                                                                dict - - -object - - - -

                                                                                                                                                                                                The portal detail data.

                                                                                                                                                                                                freshtime - - -number - - - -

                                                                                                                                                                                                Optional freshness time for cache.

                                                                                                                                                                                                - -
                                                                                                                                                                                                - - - - - - - - - - - - - -
                                                                                                                                                                                                -
                                                                                                                                                                                                Returns:
                                                                                                                                                                                                - - - - - - --

                                                                                                                                                                                                Result of cache storage operation.

                                                                                                                                                                                                - - - - - -
                                                                                                                                                                                                - - - - - -
                                                                                                                                                                                                - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                - - - - -
                                                                                                                                                                                                - - - - - - - -
                                                                                                                                                                                                - -
                                                                                                                                                                                                - - - - - - - -
                                                                                                                                                                                                - -
                                                                                                                                                                                                - -

                                                                                                                                                                                                window.portalDetail

                                                                                                                                                                                                - - -
                                                                                                                                                                                                - -
                                                                                                                                                                                                - -
                                                                                                                                                                                                - - -

                                                                                                                                                                                                Provides functionality to handle portal details, including caching and server requests.

                                                                                                                                                                                                - - - - - -
                                                                                                                                                                                                - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                - - - - -
                                                                                                                                                                                                - - - - - - - - - - - - - - - - - -

                                                                                                                                                                                                Methods

                                                                                                                                                                                                - -
                                                                                                                                                                                                - - -
                                                                                                                                                                                                - -

                                                                                                                                                                                                - - static get(guid) - - - - -

                                                                                                                                                                                                - - - -
                                                                                                                                                                                                -
                                                                                                                                                                                                - - -
                                                                                                                                                                                                -

                                                                                                                                                                                                Retrieves portal details from cache by GUID.

                                                                                                                                                                                                -
                                                                                                                                                                                                - - - - - - - - - -
                                                                                                                                                                                                -
                                                                                                                                                                                                Parameters:
                                                                                                                                                                                                - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                NameTypeDescription
                                                                                                                                                                                                guid - - -string - - - -

                                                                                                                                                                                                The Global Unique Identifier of the portal.

                                                                                                                                                                                                - -
                                                                                                                                                                                                - - - - - - - - - - - - - -
                                                                                                                                                                                                -
                                                                                                                                                                                                Returns:
                                                                                                                                                                                                - - - - - - --

                                                                                                                                                                                                Cached portal details if available.

                                                                                                                                                                                                - - - - - -
                                                                                                                                                                                                - - - - - -
                                                                                                                                                                                                - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                - - - - -
                                                                                                                                                                                                - - - - -
                                                                                                                                                                                                - -

                                                                                                                                                                                                - - static get(guid) - - - - -

                                                                                                                                                                                                - - - -
                                                                                                                                                                                                -
                                                                                                                                                                                                - - -
                                                                                                                                                                                                -

                                                                                                                                                                                                Retrieves portal details from cache by GUID.

                                                                                                                                                                                                -
                                                                                                                                                                                                - - - - - - - - - -
                                                                                                                                                                                                -
                                                                                                                                                                                                Parameters:
                                                                                                                                                                                                - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                NameTypeDescription
                                                                                                                                                                                                guid - - -string - - - -

                                                                                                                                                                                                The Global Unique Identifier of the portal.

                                                                                                                                                                                                - -
                                                                                                                                                                                                - - - - - - - - - - - - - -
                                                                                                                                                                                                -
                                                                                                                                                                                                Returns:
                                                                                                                                                                                                - - - - - - --

                                                                                                                                                                                                Cached portal details if available.

                                                                                                                                                                                                - - - - - -
                                                                                                                                                                                                - - - - - -
                                                                                                                                                                                                - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                - - - - -
                                                                                                                                                                                                - - - - -
                                                                                                                                                                                                - -

                                                                                                                                                                                                - - static isFresh(guid) → {boolean} - - - - -

                                                                                                                                                                                                - - - -
                                                                                                                                                                                                -
                                                                                                                                                                                                - - -
                                                                                                                                                                                                -

                                                                                                                                                                                                Checks if portal details are fresh in the cache.

                                                                                                                                                                                                -
                                                                                                                                                                                                - - - - - - - - - -
                                                                                                                                                                                                -
                                                                                                                                                                                                Parameters:
                                                                                                                                                                                                - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                NameTypeDescription
                                                                                                                                                                                                guid - - -string - - - -

                                                                                                                                                                                                The Global Unique Identifier of the portal.

                                                                                                                                                                                                - -
                                                                                                                                                                                                - - - - - - - - - - - - - -
                                                                                                                                                                                                -
                                                                                                                                                                                                Returns:
                                                                                                                                                                                                - - - - - -boolean - - - - - --

                                                                                                                                                                                                True if details are fresh, false otherwise.

                                                                                                                                                                                                - - - - - -
                                                                                                                                                                                                - - - - - -
                                                                                                                                                                                                - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                - - - - -
                                                                                                                                                                                                - - - - -
                                                                                                                                                                                                - -

                                                                                                                                                                                                - - static isFresh(guid) → {boolean} - - - - -

                                                                                                                                                                                                - - - -
                                                                                                                                                                                                -
                                                                                                                                                                                                - - -
                                                                                                                                                                                                -

                                                                                                                                                                                                Checks if portal details are fresh in the cache.

                                                                                                                                                                                                -
                                                                                                                                                                                                - - - - - - - - - -
                                                                                                                                                                                                -
                                                                                                                                                                                                Parameters:
                                                                                                                                                                                                - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                NameTypeDescription
                                                                                                                                                                                                guid - - -string - - - -

                                                                                                                                                                                                The Global Unique Identifier of the portal.

                                                                                                                                                                                                - -
                                                                                                                                                                                                - - - - - - - - - - - - - -
                                                                                                                                                                                                -
                                                                                                                                                                                                Returns:
                                                                                                                                                                                                - - - - - -boolean - - - - - --

                                                                                                                                                                                                True if details are fresh, false otherwise.

                                                                                                                                                                                                - - - - - -
                                                                                                                                                                                                - - - - - -
                                                                                                                                                                                                - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                - - - - -
                                                                                                                                                                                                - - - - -
                                                                                                                                                                                                - -

                                                                                                                                                                                                - - static request(guid) → {Promise} - - - - -

                                                                                                                                                                                                - - - -
                                                                                                                                                                                                -
                                                                                                                                                                                                - - -
                                                                                                                                                                                                -

                                                                                                                                                                                                Requests detailed information for a specific portal. If the information is not already being requested, -it initiates a new request. Returns a promise that resolves with the portal details.

                                                                                                                                                                                                -
                                                                                                                                                                                                - - - - - - - - - -
                                                                                                                                                                                                -
                                                                                                                                                                                                Parameters:
                                                                                                                                                                                                - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                NameTypeDescription
                                                                                                                                                                                                guid - - -string - - - -

                                                                                                                                                                                                The Global Unique Identifier of the portal.

                                                                                                                                                                                                - -
                                                                                                                                                                                                - - - - - - - - - - - - - -
                                                                                                                                                                                                -
                                                                                                                                                                                                Returns:
                                                                                                                                                                                                - - - - - -Promise - - - - - --

                                                                                                                                                                                                A promise that resolves with the portal details upon successful retrieval or rejection on failure.

                                                                                                                                                                                                - - - - - -
                                                                                                                                                                                                - - - - - -
                                                                                                                                                                                                - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                - - - - -
                                                                                                                                                                                                - - - - -
                                                                                                                                                                                                - -

                                                                                                                                                                                                - - static request(guid) → {Promise} - - - - -

                                                                                                                                                                                                - - - -
                                                                                                                                                                                                -
                                                                                                                                                                                                - - -
                                                                                                                                                                                                -

                                                                                                                                                                                                Requests detailed information for a specific portal. If the information is not already being requested, -it initiates a new request. Returns a promise that resolves with the portal details.

                                                                                                                                                                                                -
                                                                                                                                                                                                - - - - - - - - - -
                                                                                                                                                                                                -
                                                                                                                                                                                                Parameters:
                                                                                                                                                                                                - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                NameTypeDescription
                                                                                                                                                                                                guid - - -string - - - -

                                                                                                                                                                                                The Global Unique Identifier of the portal.

                                                                                                                                                                                                - -
                                                                                                                                                                                                - - - - - - - - - - - - - -
                                                                                                                                                                                                -
                                                                                                                                                                                                Returns:
                                                                                                                                                                                                - - - - - -Promise - - - - - --

                                                                                                                                                                                                A promise that resolves with the portal details upon successful retrieval or rejection on failure.

                                                                                                                                                                                                - - - - - -
                                                                                                                                                                                                - - - - - -
                                                                                                                                                                                                - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                - - - - -
                                                                                                                                                                                                - - - - -
                                                                                                                                                                                                - -

                                                                                                                                                                                                - - static setup() - - - - -

                                                                                                                                                                                                - - - -
                                                                                                                                                                                                -
                                                                                                                                                                                                - - -
                                                                                                                                                                                                -

                                                                                                                                                                                                Sets up the portal detail handler, initializing the cache.

                                                                                                                                                                                                -
                                                                                                                                                                                                - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                - - - - -
                                                                                                                                                                                                - - - - -
                                                                                                                                                                                                - -

                                                                                                                                                                                                - - static setup() - - - - -

                                                                                                                                                                                                - - - -
                                                                                                                                                                                                -
                                                                                                                                                                                                - - -
                                                                                                                                                                                                -

                                                                                                                                                                                                Sets up the portal detail handler, initializing the cache.

                                                                                                                                                                                                -
                                                                                                                                                                                                - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                - - - - -
                                                                                                                                                                                                - - - - -
                                                                                                                                                                                                - -

                                                                                                                                                                                                - - static store(guid, dict, freshtime) - - - - -

                                                                                                                                                                                                - - - -
                                                                                                                                                                                                -
                                                                                                                                                                                                - - -
                                                                                                                                                                                                -

                                                                                                                                                                                                Stores portal details in the cache.

                                                                                                                                                                                                -
                                                                                                                                                                                                - - - - - - - - - -
                                                                                                                                                                                                -
                                                                                                                                                                                                Parameters:
                                                                                                                                                                                                - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                NameTypeDescription
                                                                                                                                                                                                guid - - -string - - - -

                                                                                                                                                                                                The Global Unique Identifier of the portal.

                                                                                                                                                                                                dict - - -object - - - -

                                                                                                                                                                                                The portal detail data.

                                                                                                                                                                                                freshtime - - -number - - - -

                                                                                                                                                                                                Optional freshness time for cache.

                                                                                                                                                                                                - -
                                                                                                                                                                                                - - - - - - - - - - - - - -
                                                                                                                                                                                                -
                                                                                                                                                                                                Returns:
                                                                                                                                                                                                - - - - - - --

                                                                                                                                                                                                Result of cache storage operation.

                                                                                                                                                                                                - - - - - -
                                                                                                                                                                                                diff --git a/window.requests.html b/window.requests.html index 4b3b519f2..c4470c2d3 100644 --- a/window.requests.html +++ b/window.requests.html @@ -34,7 +34,7 @@

                                                                                                                                                                                                IITC-CE

                                                                                                                                                                                                  - +
                                                                                                                                                                                                  @@ -192,184 +192,6 @@

                                                                                                                                                                                                  - - - - - - - - - - -

                                                                                                                                                                                                  - - - - - - - - - -
                                                                                                                                                                                                  - -

                                                                                                                                                                                                  - - private, static _callOnRefreshFunctions() - - - - -

                                                                                                                                                                                                  - - - -
                                                                                                                                                                                                  -
                                                                                                                                                                                                  - - -
                                                                                                                                                                                                  -

                                                                                                                                                                                                  Calls each function in the _onRefreshFunctions array, handling the automatic refresh process.

                                                                                                                                                                                                  -
                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                  - - - - -
                                                                                                                                                                                                  - - - - -
                                                                                                                                                                                                  - -

                                                                                                                                                                                                  - - static abort() - - - - -

                                                                                                                                                                                                  - - - -
                                                                                                                                                                                                  -
                                                                                                                                                                                                  - - -
                                                                                                                                                                                                  -

                                                                                                                                                                                                  Aborts all active AJAX requests and resets related variables and status.

                                                                                                                                                                                                  -
                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - @@ -620,14 +442,14 @@
                                                                                                                                                                                                  Parameters:
                                                                                                                                                                                                  -

                                                                                                                                                                                                  +

                                                                                                                                                                                                  - static add(ajax) + static addRefreshFunction(f)

                                                                                                                                                                                                  @@ -639,7 +461,7 @@

                                                                                                                                                                                                  -

                                                                                                                                                                                                  Adds an AJAX request to the activeRequests array and updates the status.

                                                                                                                                                                                                  +

                                                                                                                                                                                                  Adds a function to the list of functions to be called on each automatic refresh.

                                                                                                                                                                                                  @@ -675,1573 +497,13 @@

                                                                                                                                                                                                  Parameters:
                                                                                                                                                                                                  - ajax + f -jqXHR - - - - - - - - - -

                                                                                                                                                                                                  The jQuery wrapped XMLHttpRequest object.

                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                  - - - - -
                                                                                                                                                                                                  - - - - -
                                                                                                                                                                                                  - -

                                                                                                                                                                                                  - - static addRefreshFunction(f) - - - - -

                                                                                                                                                                                                  - - - -
                                                                                                                                                                                                  -
                                                                                                                                                                                                  - - -
                                                                                                                                                                                                  -

                                                                                                                                                                                                  Adds a function to the list of functions to be called on each automatic refresh.

                                                                                                                                                                                                  -
                                                                                                                                                                                                  - - - - - - - - - -
                                                                                                                                                                                                  -
                                                                                                                                                                                                  Parameters:
                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                  NameTypeDescription
                                                                                                                                                                                                  f - - -function - - - -

                                                                                                                                                                                                  The function to add to the refresh process.

                                                                                                                                                                                                  - -
                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                  - - - - -
                                                                                                                                                                                                  - - - - -
                                                                                                                                                                                                  - -

                                                                                                                                                                                                  - - static addRefreshFunction(f) - - - - -

                                                                                                                                                                                                  - - - -
                                                                                                                                                                                                  -
                                                                                                                                                                                                  - - -
                                                                                                                                                                                                  -

                                                                                                                                                                                                  Adds a function to the list of functions to be called on each automatic refresh.

                                                                                                                                                                                                  -
                                                                                                                                                                                                  - - - - - - - - - -
                                                                                                                                                                                                  -
                                                                                                                                                                                                  Parameters:
                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                  NameTypeDescription
                                                                                                                                                                                                  f - - -function - - - -

                                                                                                                                                                                                  The function to add to the refresh process.

                                                                                                                                                                                                  - -
                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                  - - - - -
                                                                                                                                                                                                  - - - - -
                                                                                                                                                                                                  - -

                                                                                                                                                                                                  - - static remove(ajax) - - - - -

                                                                                                                                                                                                  - - - -
                                                                                                                                                                                                  -
                                                                                                                                                                                                  - - -
                                                                                                                                                                                                  -

                                                                                                                                                                                                  Removes an AJAX request from the activeRequests array and updates the status.

                                                                                                                                                                                                  -
                                                                                                                                                                                                  - - - - - - - - - -
                                                                                                                                                                                                  -
                                                                                                                                                                                                  Parameters:
                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                  NameTypeDescription
                                                                                                                                                                                                  ajax - - -jqXHR - - - -

                                                                                                                                                                                                  The jQuery wrapped XMLHttpRequest object.

                                                                                                                                                                                                  - -
                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                  - - - - -
                                                                                                                                                                                                  - - - - -
                                                                                                                                                                                                  - -

                                                                                                                                                                                                  - - static remove(ajax) - - - - -

                                                                                                                                                                                                  - - - -
                                                                                                                                                                                                  -
                                                                                                                                                                                                  - - -
                                                                                                                                                                                                  -

                                                                                                                                                                                                  Removes an AJAX request from the activeRequests array and updates the status.

                                                                                                                                                                                                  -
                                                                                                                                                                                                  - - - - - - - - - -
                                                                                                                                                                                                  -
                                                                                                                                                                                                  Parameters:
                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                  NameTypeDescription
                                                                                                                                                                                                  ajax - - -jqXHR - - - -

                                                                                                                                                                                                  The jQuery wrapped XMLHttpRequest object.

                                                                                                                                                                                                  - -
                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                  - - - - -
                                                                                                                                                                                                  - - - - - - - -
                                                                                                                                                                                                  - -
                                                                                                                                                                                                  - - - - - - - -
                                                                                                                                                                                                  - -
                                                                                                                                                                                                  - -

                                                                                                                                                                                                  requests

                                                                                                                                                                                                  - - -
                                                                                                                                                                                                  - -
                                                                                                                                                                                                  - -
                                                                                                                                                                                                  - - -

                                                                                                                                                                                                  Manages and tracks active requests within the application.

                                                                                                                                                                                                  - - - - - -
                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                  - - - - -
                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - -

                                                                                                                                                                                                  Methods

                                                                                                                                                                                                  - -
                                                                                                                                                                                                  - - -
                                                                                                                                                                                                  - -

                                                                                                                                                                                                  - - private, static _callOnRefreshFunctions() - - - - -

                                                                                                                                                                                                  - - - -
                                                                                                                                                                                                  -
                                                                                                                                                                                                  - - -
                                                                                                                                                                                                  -

                                                                                                                                                                                                  Calls each function in the _onRefreshFunctions array, handling the automatic refresh process.

                                                                                                                                                                                                  -
                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                  - - - - -
                                                                                                                                                                                                  - - - - -
                                                                                                                                                                                                  - -

                                                                                                                                                                                                  - - private, static _callOnRefreshFunctions() - - - - -

                                                                                                                                                                                                  - - - -
                                                                                                                                                                                                  -
                                                                                                                                                                                                  - - -
                                                                                                                                                                                                  -

                                                                                                                                                                                                  Calls each function in the _onRefreshFunctions array, handling the automatic refresh process.

                                                                                                                                                                                                  -
                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                  - - - - -
                                                                                                                                                                                                  - - - - -
                                                                                                                                                                                                  - -

                                                                                                                                                                                                  - - static abort() - - - - -

                                                                                                                                                                                                  - - - -
                                                                                                                                                                                                  -
                                                                                                                                                                                                  - - -
                                                                                                                                                                                                  -

                                                                                                                                                                                                  Aborts all active AJAX requests and resets related variables and status.

                                                                                                                                                                                                  -
                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                  - - - - -
                                                                                                                                                                                                  - - - - -
                                                                                                                                                                                                  - -

                                                                                                                                                                                                  - - static abort() - - - - -

                                                                                                                                                                                                  - - - -
                                                                                                                                                                                                  -
                                                                                                                                                                                                  - - -
                                                                                                                                                                                                  -

                                                                                                                                                                                                  Aborts all active AJAX requests and resets related variables and status.

                                                                                                                                                                                                  -
                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                  - - - - -
                                                                                                                                                                                                  - - - - -
                                                                                                                                                                                                  - -

                                                                                                                                                                                                  - - static add(ajax) - - - - -

                                                                                                                                                                                                  - - - -
                                                                                                                                                                                                  -
                                                                                                                                                                                                  - - -
                                                                                                                                                                                                  -

                                                                                                                                                                                                  Adds an AJAX request to the activeRequests array and updates the status.

                                                                                                                                                                                                  -
                                                                                                                                                                                                  - - - - - - - - - -
                                                                                                                                                                                                  -
                                                                                                                                                                                                  Parameters:
                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                  NameTypeDescription
                                                                                                                                                                                                  ajax - - -jqXHR - - - -

                                                                                                                                                                                                  The jQuery wrapped XMLHttpRequest object.

                                                                                                                                                                                                  - -
                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                  - - - - -
                                                                                                                                                                                                  - - - - -
                                                                                                                                                                                                  - -

                                                                                                                                                                                                  - - static add(ajax) - - - - -

                                                                                                                                                                                                  - - - -
                                                                                                                                                                                                  -
                                                                                                                                                                                                  - - -
                                                                                                                                                                                                  -

                                                                                                                                                                                                  Adds an AJAX request to the activeRequests array and updates the status.

                                                                                                                                                                                                  -
                                                                                                                                                                                                  - - - - - - - - - -
                                                                                                                                                                                                  -
                                                                                                                                                                                                  Parameters:
                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                  NameTypeDescription
                                                                                                                                                                                                  ajax - - -jqXHR - - - -

                                                                                                                                                                                                  The jQuery wrapped XMLHttpRequest object.

                                                                                                                                                                                                  - -
                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                  - - - - -
                                                                                                                                                                                                  - - - - -
                                                                                                                                                                                                  - -

                                                                                                                                                                                                  - - static addRefreshFunction(f) - - - - -

                                                                                                                                                                                                  - - - -
                                                                                                                                                                                                  -
                                                                                                                                                                                                  - - -
                                                                                                                                                                                                  -

                                                                                                                                                                                                  Adds a function to the list of functions to be called on each automatic refresh.

                                                                                                                                                                                                  -
                                                                                                                                                                                                  - - - - - - - - - -
                                                                                                                                                                                                  -
                                                                                                                                                                                                  Parameters:
                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                  NameTypeDescription
                                                                                                                                                                                                  f - - -function - - - -

                                                                                                                                                                                                  The function to add to the refresh process.

                                                                                                                                                                                                  - -
                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                  - - - - -
                                                                                                                                                                                                  - - - - -
                                                                                                                                                                                                  - -

                                                                                                                                                                                                  - - static addRefreshFunction(f) - - - - -

                                                                                                                                                                                                  - - - -
                                                                                                                                                                                                  -
                                                                                                                                                                                                  - - -
                                                                                                                                                                                                  -

                                                                                                                                                                                                  Adds a function to the list of functions to be called on each automatic refresh.

                                                                                                                                                                                                  -
                                                                                                                                                                                                  - - - - - - - - - -
                                                                                                                                                                                                  -
                                                                                                                                                                                                  Parameters:
                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - - + @@ -4293,7 +656,7 @@
                                                                                                                                                                                                  Parameters:
                                                                                                                                                                                                  - + @@ -4361,14 +724,14 @@
                                                                                                                                                                                                  Parameters:
                                                                                                                                                                                                  -

                                                                                                                                                                                                  +

                                                                                                                                                                                                  - onResultSelected(result, ev) + onResultHoverStart(result, ev)

                                                                                                                                                                                                  @@ -4380,7 +743,7 @@

                                                                                                                                                                                                  -

                                                                                                                                                                                                  Handles the selection of a search result, including map view adjustments and layer management.

                                                                                                                                                                                                  +

                                                                                                                                                                                                  Handles the start of a hover over a search result. Adds the layer for the result to the map if not already selected.

                                                                                                                                                                                                  @@ -4432,7 +795,7 @@

                                                                                                                                                                                                  Parameters:
                                                                                                                                                                                                  -
                                                                                                                                                                                                  + @@ -4455,7 +818,7 @@
                                                                                                                                                                                                  Parameters:
                                                                                                                                                                                                  - + @@ -4523,103 +886,14 @@
                                                                                                                                                                                                  Parameters:
                                                                                                                                                                                                  -

                                                                                                                                                                                                  - - removeHoverResult() - - - - -

                                                                                                                                                                                                  - - - -
                                                                                                                                                                                                  -
                                                                                                                                                                                                  - - -
                                                                                                                                                                                                  -

                                                                                                                                                                                                  Removes the hover result layer from the map unless it's the selected result.

                                                                                                                                                                                                  -
                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                  - - - - -
                                                                                                                                                                                                  - - - - -
                                                                                                                                                                                                  - -

                                                                                                                                                                                                  +

                                                                                                                                                                                                  - removeHoverResult() + onResultSelected(result, ev)

                                                                                                                                                                                                  @@ -4630,42 +904,9 @@

                                                                                                                                                                                                  -
                                                                                                                                                                                                  -

                                                                                                                                                                                                  Removes the hover result layer from the map unless it's the selected result.

                                                                                                                                                                                                  -
                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                  - - - - - - - +
                                                                                                                                                                                                  +

                                                                                                                                                                                                  Handles the selection of a search result, including map view adjustments and layer management.

                                                                                                                                                                                                  +
                                                                                                                                                                                                  @@ -4675,61 +916,78 @@

                                                                                                                                                                                                  +
                                                                                                                                                                                                  +
                                                                                                                                                                                                  Parameters:
                                                                                                                                                                                                  + +

                                                                                                                                                                                                  NameTypeDescription
                                                                                                                                                                                                  f - - -function +function @@ -2436,145 +698,6 @@
                                                                                                                                                                                                  Parameters:
                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                  - -

                                                                                                                                                                                                  - - static remove(ajax) - - - - -

                                                                                                                                                                                                  - - - -
                                                                                                                                                                                                  -
                                                                                                                                                                                                  - - -
                                                                                                                                                                                                  -

                                                                                                                                                                                                  Removes an AJAX request from the activeRequests array and updates the status.

                                                                                                                                                                                                  -
                                                                                                                                                                                                  - - - - - - - - - -
                                                                                                                                                                                                  -
                                                                                                                                                                                                  Parameters:
                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                  NameTypeDescription
                                                                                                                                                                                                  ajax - - -jqXHR - - - -

                                                                                                                                                                                                  The jQuery wrapped XMLHttpRequest object.

                                                                                                                                                                                                  - -
                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                  - - - - - - - - - - - - - - - - - - - - diff --git a/window.search.Query.html b/window.search.Query.html index 456f6dfff..9fe2d5aa2 100644 --- a/window.search.Query.html +++ b/window.search.Query.html @@ -34,7 +34,7 @@

                                                                                                                                                                                                  IITC-CE

                                                                                                                                                                                                    - +
                                                                                                                                                                                                    @@ -362,234 +362,6 @@
                                                                                                                                                                                                    Parameters:
                                                                                                                                                                                                    - - - - - - - - - - -
                                                                                                                                                                                                    - - - - -
                                                                                                                                                                                                    - - - - -
                                                                                                                                                                                                    - -

                                                                                                                                                                                                    - - addResult(result) - - - - -

                                                                                                                                                                                                    - - - -
                                                                                                                                                                                                    -
                                                                                                                                                                                                    - - -
                                                                                                                                                                                                    -

                                                                                                                                                                                                    Adds a search result to this query.

                                                                                                                                                                                                    -
                                                                                                                                                                                                    - - - - - - - - - -
                                                                                                                                                                                                    -
                                                                                                                                                                                                    Parameters:
                                                                                                                                                                                                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                    NameTypeDescription
                                                                                                                                                                                                    result - - -Object - - - -

                                                                                                                                                                                                    The search result object to add.

                                                                                                                                                                                                    - -
                                                                                                                                                                                                    - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                    - - - - -
                                                                                                                                                                                                    - - - - -
                                                                                                                                                                                                    - -

                                                                                                                                                                                                    - - hide() - - - - -

                                                                                                                                                                                                    - - - -
                                                                                                                                                                                                    -
                                                                                                                                                                                                    - - -
                                                                                                                                                                                                    -

                                                                                                                                                                                                    Hides the search query results and cleans up.

                                                                                                                                                                                                    -
                                                                                                                                                                                                    - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                    - - - - - - - - - - - - - - - - - - - - @@ -624,3359 +396,23 @@

                                                                                                                                                                                                    - - - -
                                                                                                                                                                                                    - - -
                                                                                                                                                                                                    -

                                                                                                                                                                                                    Hides the search query results and cleans up.

                                                                                                                                                                                                    -
                                                                                                                                                                                                    - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                    - - - - -
                                                                                                                                                                                                    - - - - -
                                                                                                                                                                                                    - -

                                                                                                                                                                                                    - - init() - - - - -

                                                                                                                                                                                                    - - - -
                                                                                                                                                                                                    -
                                                                                                                                                                                                    - - -
                                                                                                                                                                                                    -

                                                                                                                                                                                                    Initializes the search query, setting up the DOM elements and triggering the 'search' hook.

                                                                                                                                                                                                    -
                                                                                                                                                                                                    - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                    - - - - -
                                                                                                                                                                                                    - - - - -
                                                                                                                                                                                                    - -

                                                                                                                                                                                                    - - init() - - - - -

                                                                                                                                                                                                    - - - -
                                                                                                                                                                                                    -
                                                                                                                                                                                                    - - -
                                                                                                                                                                                                    -

                                                                                                                                                                                                    Initializes the search query, setting up the DOM elements and triggering the 'search' hook.

                                                                                                                                                                                                    -
                                                                                                                                                                                                    - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                    - - - - -
                                                                                                                                                                                                    - - - - -
                                                                                                                                                                                                    - -

                                                                                                                                                                                                    - - onResultHoverEnd(result, ev) - - - - -

                                                                                                                                                                                                    - - - -
                                                                                                                                                                                                    -
                                                                                                                                                                                                    - - -
                                                                                                                                                                                                    -

                                                                                                                                                                                                    Handles the end of a hover over a search result. Removes the hover result layer from the map.

                                                                                                                                                                                                    -
                                                                                                                                                                                                    - - - - - - - - - -
                                                                                                                                                                                                    -
                                                                                                                                                                                                    Parameters:
                                                                                                                                                                                                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                    NameTypeDescription
                                                                                                                                                                                                    result - - -Object - - - -

                                                                                                                                                                                                    The search result object being hovered over.

                                                                                                                                                                                                    ev - - -Event - - - -

                                                                                                                                                                                                    The event associated with the hover end.

                                                                                                                                                                                                    - -
                                                                                                                                                                                                    - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                    - - - - -
                                                                                                                                                                                                    - - - - -
                                                                                                                                                                                                    - -

                                                                                                                                                                                                    - - onResultHoverEnd(result, ev) - - - - -

                                                                                                                                                                                                    - - - -
                                                                                                                                                                                                    -
                                                                                                                                                                                                    - - -
                                                                                                                                                                                                    -

                                                                                                                                                                                                    Handles the end of a hover over a search result. Removes the hover result layer from the map.

                                                                                                                                                                                                    -
                                                                                                                                                                                                    - - - - - - - - - -
                                                                                                                                                                                                    -
                                                                                                                                                                                                    Parameters:
                                                                                                                                                                                                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                    NameTypeDescription
                                                                                                                                                                                                    result - - -Object - - - -

                                                                                                                                                                                                    The search result object being hovered over.

                                                                                                                                                                                                    ev - - -Event - - - -

                                                                                                                                                                                                    The event associated with the hover end.

                                                                                                                                                                                                    - -
                                                                                                                                                                                                    - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                    - - - - -
                                                                                                                                                                                                    - - - - -
                                                                                                                                                                                                    - -

                                                                                                                                                                                                    - - onResultHoverStart(result, ev) - - - - -

                                                                                                                                                                                                    - - - -
                                                                                                                                                                                                    -
                                                                                                                                                                                                    - - -
                                                                                                                                                                                                    -

                                                                                                                                                                                                    Handles the start of a hover over a search result. Adds the layer for the result to the map if not already selected.

                                                                                                                                                                                                    -
                                                                                                                                                                                                    - - - - - - - - - -
                                                                                                                                                                                                    -
                                                                                                                                                                                                    Parameters:
                                                                                                                                                                                                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                    NameTypeDescription
                                                                                                                                                                                                    result - - -Object - - - -

                                                                                                                                                                                                    The search result object being hovered over.

                                                                                                                                                                                                    ev - - -Event - - - -

                                                                                                                                                                                                    The event associated with the hover start.

                                                                                                                                                                                                    - -
                                                                                                                                                                                                    - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                    - - - - -
                                                                                                                                                                                                    - - - - -
                                                                                                                                                                                                    - -

                                                                                                                                                                                                    - - onResultHoverStart(result, ev) - - - - -

                                                                                                                                                                                                    - - - -
                                                                                                                                                                                                    -
                                                                                                                                                                                                    - - -
                                                                                                                                                                                                    -

                                                                                                                                                                                                    Handles the start of a hover over a search result. Adds the layer for the result to the map if not already selected.

                                                                                                                                                                                                    -
                                                                                                                                                                                                    - - - - - - - - - -
                                                                                                                                                                                                    -
                                                                                                                                                                                                    Parameters:
                                                                                                                                                                                                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                    NameTypeDescription
                                                                                                                                                                                                    result - - -Object - - - -

                                                                                                                                                                                                    The search result object being hovered over.

                                                                                                                                                                                                    ev - - -Event - - - -

                                                                                                                                                                                                    The event associated with the hover start.

                                                                                                                                                                                                    - -
                                                                                                                                                                                                    - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                    - - - - -
                                                                                                                                                                                                    - - - - -
                                                                                                                                                                                                    - -

                                                                                                                                                                                                    - - onResultSelected(result, ev) - - - - -

                                                                                                                                                                                                    - - - -
                                                                                                                                                                                                    -
                                                                                                                                                                                                    - - -
                                                                                                                                                                                                    -

                                                                                                                                                                                                    Handles the selection of a search result, including map view adjustments and layer management.

                                                                                                                                                                                                    -
                                                                                                                                                                                                    - - - - - - - - - -
                                                                                                                                                                                                    -
                                                                                                                                                                                                    Parameters:
                                                                                                                                                                                                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                    NameTypeDescription
                                                                                                                                                                                                    result - - -Object - - - -

                                                                                                                                                                                                    The selected search result object.

                                                                                                                                                                                                    ev - - -Event - - - -

                                                                                                                                                                                                    The event associated with the selection.

                                                                                                                                                                                                    - -
                                                                                                                                                                                                    - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                    - - - - -
                                                                                                                                                                                                    - - - - -
                                                                                                                                                                                                    - -

                                                                                                                                                                                                    - - onResultSelected(result, ev) - - - - -

                                                                                                                                                                                                    - - - -
                                                                                                                                                                                                    -
                                                                                                                                                                                                    - - -
                                                                                                                                                                                                    -

                                                                                                                                                                                                    Handles the selection of a search result, including map view adjustments and layer management.

                                                                                                                                                                                                    -
                                                                                                                                                                                                    - - - - - - - - - -
                                                                                                                                                                                                    -
                                                                                                                                                                                                    Parameters:
                                                                                                                                                                                                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                    NameTypeDescription
                                                                                                                                                                                                    result - - -Object - - - -

                                                                                                                                                                                                    The selected search result object.

                                                                                                                                                                                                    ev - - -Event - - - -

                                                                                                                                                                                                    The event associated with the selection.

                                                                                                                                                                                                    - -
                                                                                                                                                                                                    - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                    - - - - -
                                                                                                                                                                                                    - - - - -
                                                                                                                                                                                                    - -

                                                                                                                                                                                                    - - removeHoverResult() - - - - -

                                                                                                                                                                                                    - - - -
                                                                                                                                                                                                    -
                                                                                                                                                                                                    - - -
                                                                                                                                                                                                    -

                                                                                                                                                                                                    Removes the hover result layer from the map unless it's the selected result.

                                                                                                                                                                                                    -
                                                                                                                                                                                                    - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                    - - - - -
                                                                                                                                                                                                    - - - - -
                                                                                                                                                                                                    - -

                                                                                                                                                                                                    - - removeHoverResult() - - - - -

                                                                                                                                                                                                    - - - -
                                                                                                                                                                                                    -
                                                                                                                                                                                                    - - -
                                                                                                                                                                                                    -

                                                                                                                                                                                                    Removes the hover result layer from the map unless it's the selected result.

                                                                                                                                                                                                    -
                                                                                                                                                                                                    - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                    - - - - -
                                                                                                                                                                                                    - - - - -
                                                                                                                                                                                                    - -

                                                                                                                                                                                                    - - removeSelectedResult() - - - - -

                                                                                                                                                                                                    - - - -
                                                                                                                                                                                                    -
                                                                                                                                                                                                    - - -
                                                                                                                                                                                                    -

                                                                                                                                                                                                    Removes the currently selected search result from the map and performs cleanup.

                                                                                                                                                                                                    -
                                                                                                                                                                                                    - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                    - - - - -
                                                                                                                                                                                                    - - - - -
                                                                                                                                                                                                    - -

                                                                                                                                                                                                    - - removeSelectedResult() - - - - -

                                                                                                                                                                                                    - - - -
                                                                                                                                                                                                    -
                                                                                                                                                                                                    - - -
                                                                                                                                                                                                    -

                                                                                                                                                                                                    Removes the currently selected search result from the map and performs cleanup.

                                                                                                                                                                                                    -
                                                                                                                                                                                                    - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                    - - - - -
                                                                                                                                                                                                    - - - - -
                                                                                                                                                                                                    - -

                                                                                                                                                                                                    - - resultLayer(result) → {L.Layer} - - - - -

                                                                                                                                                                                                    - - - -
                                                                                                                                                                                                    -
                                                                                                                                                                                                    - - -
                                                                                                                                                                                                    -

                                                                                                                                                                                                    Creates and returns a layer for the given search result, which could be markers or shapes on the map.

                                                                                                                                                                                                    -
                                                                                                                                                                                                    - - - - - - - - - -
                                                                                                                                                                                                    -
                                                                                                                                                                                                    Parameters:
                                                                                                                                                                                                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                    NameTypeDescription
                                                                                                                                                                                                    result - - -Object - - - -

                                                                                                                                                                                                    The search result object.

                                                                                                                                                                                                    - -
                                                                                                                                                                                                    - - - - - - - - - - - - - -
                                                                                                                                                                                                    -
                                                                                                                                                                                                    Returns:
                                                                                                                                                                                                    - - - - - -L.Layer - - - - - --

                                                                                                                                                                                                    The layer created for this result.

                                                                                                                                                                                                    - - - - - -
                                                                                                                                                                                                    - - - - - -
                                                                                                                                                                                                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                    - - - - -
                                                                                                                                                                                                    - - - - -
                                                                                                                                                                                                    - -

                                                                                                                                                                                                    - - resultLayer(result) → {L.Layer} - - - - -

                                                                                                                                                                                                    - - - -
                                                                                                                                                                                                    -
                                                                                                                                                                                                    - - -
                                                                                                                                                                                                    -

                                                                                                                                                                                                    Creates and returns a layer for the given search result, which could be markers or shapes on the map.

                                                                                                                                                                                                    -
                                                                                                                                                                                                    - - - - - - - - - -
                                                                                                                                                                                                    -
                                                                                                                                                                                                    Parameters:
                                                                                                                                                                                                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                    NameTypeDescription
                                                                                                                                                                                                    result - - -Object - - - -

                                                                                                                                                                                                    The search result object.

                                                                                                                                                                                                    - -
                                                                                                                                                                                                    - - - - - - - - - - - - - -
                                                                                                                                                                                                    -
                                                                                                                                                                                                    Returns:
                                                                                                                                                                                                    - - - - - -L.Layer - - - - - --

                                                                                                                                                                                                    The layer created for this result.

                                                                                                                                                                                                    - - - - - -
                                                                                                                                                                                                    - - - - - -
                                                                                                                                                                                                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                    - - - - -
                                                                                                                                                                                                    - - - - -
                                                                                                                                                                                                    - -

                                                                                                                                                                                                    - - show() - - - - -

                                                                                                                                                                                                    - - - -
                                                                                                                                                                                                    -
                                                                                                                                                                                                    - - -
                                                                                                                                                                                                    -

                                                                                                                                                                                                    Displays the search query results in the search wrapper.

                                                                                                                                                                                                    -
                                                                                                                                                                                                    - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                    - - - - -
                                                                                                                                                                                                    - - - - -
                                                                                                                                                                                                    - -

                                                                                                                                                                                                    - - show() - - - - -

                                                                                                                                                                                                    - - - -
                                                                                                                                                                                                    -
                                                                                                                                                                                                    - - -
                                                                                                                                                                                                    -

                                                                                                                                                                                                    Displays the search query results in the search wrapper.

                                                                                                                                                                                                    -
                                                                                                                                                                                                    - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                    - - - - -
                                                                                                                                                                                                    - -
                                                                                                                                                                                                    - - - - - - - - - - - - - - - -
                                                                                                                                                                                                    - -
                                                                                                                                                                                                    - -

                                                                                                                                                                                                    - .search.Query(term, confirmed)

                                                                                                                                                                                                    - - -
                                                                                                                                                                                                    - -
                                                                                                                                                                                                    - -
                                                                                                                                                                                                    - - - -
                                                                                                                                                                                                    - -

                                                                                                                                                                                                    - - new Query(term, confirmed) - - - - -

                                                                                                                                                                                                    - - - -
                                                                                                                                                                                                    -
                                                                                                                                                                                                    - - -
                                                                                                                                                                                                    -

                                                                                                                                                                                                    Represents a search query.

                                                                                                                                                                                                    -
                                                                                                                                                                                                    - - - - - - - - - -
                                                                                                                                                                                                    -
                                                                                                                                                                                                    Parameters:
                                                                                                                                                                                                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                    NameTypeDescription
                                                                                                                                                                                                    term - - -string - - - -

                                                                                                                                                                                                    The search term.

                                                                                                                                                                                                    confirmed - - -boolean - - - -

                                                                                                                                                                                                    Indicates if the search is confirmed (e.g., by pressing Enter).

                                                                                                                                                                                                    - -
                                                                                                                                                                                                    - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                    - - - - -
                                                                                                                                                                                                    - - -
                                                                                                                                                                                                    - - - - - - - - - - - - - - - - - -

                                                                                                                                                                                                    Methods

                                                                                                                                                                                                    - -
                                                                                                                                                                                                    - - -
                                                                                                                                                                                                    - -

                                                                                                                                                                                                    - - addResult(result) - - - - -

                                                                                                                                                                                                    - - - -
                                                                                                                                                                                                    -
                                                                                                                                                                                                    - - -
                                                                                                                                                                                                    -

                                                                                                                                                                                                    Adds a search result to this query.

                                                                                                                                                                                                    -
                                                                                                                                                                                                    - - - - - - - - - -
                                                                                                                                                                                                    -
                                                                                                                                                                                                    Parameters:
                                                                                                                                                                                                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                    NameTypeDescription
                                                                                                                                                                                                    result - - -Object - - - -

                                                                                                                                                                                                    The search result object to add.

                                                                                                                                                                                                    - -
                                                                                                                                                                                                    - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                    - - - - -
                                                                                                                                                                                                    - - - - -
                                                                                                                                                                                                    - -

                                                                                                                                                                                                    - - addResult(result) - - - - -

                                                                                                                                                                                                    - - - -
                                                                                                                                                                                                    -
                                                                                                                                                                                                    - - -
                                                                                                                                                                                                    -

                                                                                                                                                                                                    Adds a search result to this query.

                                                                                                                                                                                                    -
                                                                                                                                                                                                    - - - - - - - - - -
                                                                                                                                                                                                    -
                                                                                                                                                                                                    Parameters:
                                                                                                                                                                                                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                    NameTypeDescription
                                                                                                                                                                                                    result - - -Object - - - -

                                                                                                                                                                                                    The search result object to add.

                                                                                                                                                                                                    - -
                                                                                                                                                                                                    - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                    - - - - -
                                                                                                                                                                                                    - - - - -
                                                                                                                                                                                                    - -

                                                                                                                                                                                                    - - hide() - - - - -

                                                                                                                                                                                                    - - - -
                                                                                                                                                                                                    -
                                                                                                                                                                                                    - - -
                                                                                                                                                                                                    -

                                                                                                                                                                                                    Hides the search query results and cleans up.

                                                                                                                                                                                                    -
                                                                                                                                                                                                    - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                    - - - - -
                                                                                                                                                                                                    - - - - -
                                                                                                                                                                                                    - -

                                                                                                                                                                                                    - - hide() - - - - -

                                                                                                                                                                                                    - - - -
                                                                                                                                                                                                    -
                                                                                                                                                                                                    - - -
                                                                                                                                                                                                    -

                                                                                                                                                                                                    Hides the search query results and cleans up.

                                                                                                                                                                                                    -
                                                                                                                                                                                                    - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                    - - - - -
                                                                                                                                                                                                    - - - - -
                                                                                                                                                                                                    - -

                                                                                                                                                                                                    - - init() - - - - -

                                                                                                                                                                                                    - - - -
                                                                                                                                                                                                    -
                                                                                                                                                                                                    - - -
                                                                                                                                                                                                    -

                                                                                                                                                                                                    Initializes the search query, setting up the DOM elements and triggering the 'search' hook.

                                                                                                                                                                                                    -
                                                                                                                                                                                                    - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                    - - - - -
                                                                                                                                                                                                    - - - - -
                                                                                                                                                                                                    - -

                                                                                                                                                                                                    - - init() - - - - -

                                                                                                                                                                                                    - - - -
                                                                                                                                                                                                    -
                                                                                                                                                                                                    - - -
                                                                                                                                                                                                    -

                                                                                                                                                                                                    Initializes the search query, setting up the DOM elements and triggering the 'search' hook.

                                                                                                                                                                                                    -
                                                                                                                                                                                                    - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                    - - - - -
                                                                                                                                                                                                    - - - - -
                                                                                                                                                                                                    - -

                                                                                                                                                                                                    - - onResultHoverEnd(result, ev) - - - - -

                                                                                                                                                                                                    - - - -
                                                                                                                                                                                                    -
                                                                                                                                                                                                    - - -
                                                                                                                                                                                                    -

                                                                                                                                                                                                    Handles the end of a hover over a search result. Removes the hover result layer from the map.

                                                                                                                                                                                                    -
                                                                                                                                                                                                    - - - - - - - - - -
                                                                                                                                                                                                    -
                                                                                                                                                                                                    Parameters:
                                                                                                                                                                                                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                    NameTypeDescription
                                                                                                                                                                                                    result - - -Object - - - -

                                                                                                                                                                                                    The search result object being hovered over.

                                                                                                                                                                                                    ev - - -Event - - - -

                                                                                                                                                                                                    The event associated with the hover end.

                                                                                                                                                                                                    - -
                                                                                                                                                                                                    - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                    - - - - -
                                                                                                                                                                                                    - - - - -
                                                                                                                                                                                                    - -

                                                                                                                                                                                                    - - onResultHoverEnd(result, ev) - - - - -

                                                                                                                                                                                                    - - - -
                                                                                                                                                                                                    -
                                                                                                                                                                                                    - - -
                                                                                                                                                                                                    -

                                                                                                                                                                                                    Handles the end of a hover over a search result. Removes the hover result layer from the map.

                                                                                                                                                                                                    -
                                                                                                                                                                                                    - - - - - - - - - -
                                                                                                                                                                                                    -
                                                                                                                                                                                                    Parameters:
                                                                                                                                                                                                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                    NameTypeDescription
                                                                                                                                                                                                    result - - -Object - - - -

                                                                                                                                                                                                    The search result object being hovered over.

                                                                                                                                                                                                    ev - - -Event - - - -

                                                                                                                                                                                                    The event associated with the hover end.

                                                                                                                                                                                                    - -
                                                                                                                                                                                                    - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                    - - - - -
                                                                                                                                                                                                    - - - - -
                                                                                                                                                                                                    - -

                                                                                                                                                                                                    - - onResultHoverStart(result, ev) - - - - -

                                                                                                                                                                                                    - - - -
                                                                                                                                                                                                    -
                                                                                                                                                                                                    - - -
                                                                                                                                                                                                    -

                                                                                                                                                                                                    Handles the start of a hover over a search result. Adds the layer for the result to the map if not already selected.

                                                                                                                                                                                                    -
                                                                                                                                                                                                    - - - - - - - - - -
                                                                                                                                                                                                    -
                                                                                                                                                                                                    Parameters:
                                                                                                                                                                                                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + +
                                                                                                                                                                                                    - + +
                                                                                                                                                                                                    +

                                                                                                                                                                                                    Hides the search query results and cleans up.

                                                                                                                                                                                                    +
                                                                                                                                                                                                    + - + -
                                                                                                                                                                                                    - + - -
                                                                                                                                                                                                    NameTypeDescription
                                                                                                                                                                                                    result - - -Object - - - -

                                                                                                                                                                                                    The search result object being hovered over.

                                                                                                                                                                                                    ev - - -Event - - - -

                                                                                                                                                                                                    The event associated with the hover start.

                                                                                                                                                                                                    -
                                                                                                                                                                                                    @@ -4037,14 +473,14 @@
                                                                                                                                                                                                    Parameters:
                                                                                                                                                                                                    -

                                                                                                                                                                                                    +

                                                                                                                                                                                                    - onResultHoverStart(result, ev) + init()

                                                                                                                                                                                                    @@ -4056,7 +492,7 @@

                                                                                                                                                                                                    -

                                                                                                                                                                                                    Handles the start of a hover over a search result. Adds the layer for the result to the map if not already selected.

                                                                                                                                                                                                    +

                                                                                                                                                                                                    Initializes the search query, setting up the DOM elements and triggering the 'search' hook.

                                                                                                                                                                                                    @@ -4067,79 +503,6 @@

                                                                                                                                                                                                    -
                                                                                                                                                                                                    -
                                                                                                                                                                                                    Parameters:
                                                                                                                                                                                                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                    NameTypeDescription
                                                                                                                                                                                                    result - - -Object - - - -

                                                                                                                                                                                                    The search result object being hovered over.

                                                                                                                                                                                                    ev - - -Event - - - -

                                                                                                                                                                                                    The event associated with the hover start.

                                                                                                                                                                                                    - -
                                                                                                                                                                                                    - @@ -4199,14 +562,14 @@

                                                                                                                                                                                                    Parameters:
                                                                                                                                                                                                    -

                                                                                                                                                                                                    +

                                                                                                                                                                                                    - onResultSelected(result, ev) + onResultHoverEnd(result, ev)

                                                                                                                                                                                                    @@ -4218,7 +581,7 @@

                                                                                                                                                                                                    -

                                                                                                                                                                                                    Handles the selection of a search result, including map view adjustments and layer management.

                                                                                                                                                                                                    +

                                                                                                                                                                                                    Handles the end of a hover over a search result. Removes the hover result layer from the map.

                                                                                                                                                                                                    @@ -4270,7 +633,7 @@

                                                                                                                                                                                                    Parameters:
                                                                                                                                                                                                    -

                                                                                                                                                                                                    The selected search result object.

                                                                                                                                                                                                    The search result object being hovered over.

                                                                                                                                                                                                    The event associated with the selection.

                                                                                                                                                                                                    The event associated with the hover end.

                                                                                                                                                                                                    The selected search result object.

                                                                                                                                                                                                    The search result object being hovered over.

                                                                                                                                                                                                    The event associated with the selection.

                                                                                                                                                                                                    The event associated with the hover start.

                                                                                                                                                                                                    + + + + + - + - + - + - + + + + - + + + + - - + - + - -
                                                                                                                                                                                                    +
                                                                                                                                                                                                    + + -

                                                                                                                                                                                                    + +

                                                                                                                                                                                                    - removeSelectedResult() - + - + + - + - + + + + + +
                                                                                                                                                                                                    NameTypeDescription
                                                                                                                                                                                                    result + + +Object - + +

                                                                                                                                                                                                    The selected search result object.

                                                                                                                                                                                                    ev - + +Event - - - -
                                                                                                                                                                                                    - -
                                                                                                                                                                                                    -

                                                                                                                                                                                                    Removes the currently selected search result from the map and performs cleanup.

                                                                                                                                                                                                    -
                                                                                                                                                                                                    - + +

                                                                                                                                                                                                    The event associated with the selection.

                                                                                                                                                                                                    +
                                                                                                                                                                                                    @@ -4790,14 +1048,14 @@

                                                                                                                                                                                                    -

                                                                                                                                                                                                    +

                                                                                                                                                                                                    - removeSelectedResult() + removeHoverResult()

                                                                                                                                                                                                    @@ -4809,7 +1067,7 @@

                                                                                                                                                                                                    -

                                                                                                                                                                                                    Removes the currently selected search result from the map and performs cleanup.

                                                                                                                                                                                                    +

                                                                                                                                                                                                    Removes the hover result layer from the map unless it's the selected result.

                                                                                                                                                                                                    @@ -4879,14 +1137,14 @@

                                                                                                                                                                                                    -

                                                                                                                                                                                                    +

                                                                                                                                                                                                    - resultLayer(result) → {L.Layer} + removeSelectedResult()

                                                                                                                                                                                                    @@ -4898,7 +1156,7 @@

                                                                                                                                                                                                    -

                                                                                                                                                                                                    Creates and returns a layer for the given search result, which could be markers or shapes on the map.

                                                                                                                                                                                                    +

                                                                                                                                                                                                    Removes the currently selected search result from the map and performs cleanup.

                                                                                                                                                                                                    @@ -4909,58 +1167,6 @@

                                                                                                                                                                                                    -
                                                                                                                                                                                                    -
                                                                                                                                                                                                    Parameters:
                                                                                                                                                                                                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                    NameTypeDescription
                                                                                                                                                                                                    result - - -Object - - - -

                                                                                                                                                                                                    The search result object.

                                                                                                                                                                                                    - -
                                                                                                                                                                                                    - - - @@ -4971,26 +1177,7 @@

                                                                                                                                                                                                    Parameters:
                                                                                                                                                                                                    -
                                                                                                                                                                                                    -
                                                                                                                                                                                                    Returns:
                                                                                                                                                                                                    - - - - - -L.Layer - - - - --

                                                                                                                                                                                                    The layer created for this result.

                                                                                                                                                                                                    - - - - - -
                                                                                                                                                                                                    @@ -5266,95 +1453,6 @@

                                                                                                                                                                                                    - - - - - - - - - - -

                                                                                                                                                                                                    - - - - - - - - - -
                                                                                                                                                                                                    - -

                                                                                                                                                                                                    - - show() - - - - -

                                                                                                                                                                                                    - - - -
                                                                                                                                                                                                    -
                                                                                                                                                                                                    - - -
                                                                                                                                                                                                    -

                                                                                                                                                                                                    Displays the search query results in the search wrapper.

                                                                                                                                                                                                    -
                                                                                                                                                                                                    - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                    - - - - - - - - - - - - - - - - - - - - diff --git a/window.search.html b/window.search.html index f19a886eb..e833b50ac 100644 --- a/window.search.html +++ b/window.search.html @@ -34,7 +34,7 @@

                                                                                                                                                                                                    IITC-CE

                                                                                                                                                                                                      - +
                                                                                                                                                                                                      @@ -146,16 +146,6 @@

                                                                                                                                                                                                      -
                                                                                                                                                                                                      -

                                                                                                                                                                                                      - Query - -

                                                                                                                                                                                                      -
                                                                                                                                                                                                      - -

                                                                                                                                                                                                      @@ -339,191 +329,6 @@
                                                                                                                                                                                                      Parameters:
                                                                                                                                                                                                      - - - - - - - - - - - - - - - -
                                                                                                                                                                                                      - - - - -
                                                                                                                                                                                                      - -

                                                                                                                                                                                                      - - static addSearchResult(query, data, guid) - - - - -

                                                                                                                                                                                                      - - - -
                                                                                                                                                                                                      -
                                                                                                                                                                                                      - - -
                                                                                                                                                                                                      -

                                                                                                                                                                                                      Adds a search result for a portal to the search query results.

                                                                                                                                                                                                      -
                                                                                                                                                                                                      - - - - - - - - - -
                                                                                                                                                                                                      -
                                                                                                                                                                                                      Parameters:
                                                                                                                                                                                                      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                      NameTypeDescription
                                                                                                                                                                                                      query - - -Object - - - -

                                                                                                                                                                                                      The search query object to which the result will be added.

                                                                                                                                                                                                      data - - -Object - - - -

                                                                                                                                                                                                      The data for the search result. This includes information such as title, team, level, health, etc.

                                                                                                                                                                                                      guid - - -string - - - -

                                                                                                                                                                                                      GUID if the portal.

                                                                                                                                                                                                      - -
                                                                                                                                                                                                      - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                      - - - - - - - - - - - - - - - - - - - - @@ -686,1272 +491,6 @@
                                                                                                                                                                                                      Parameters:
                                                                                                                                                                                                      - - - - - - - - - - -
                                                                                                                                                                                                      - - - - -
                                                                                                                                                                                                      - - - - -
                                                                                                                                                                                                      - -

                                                                                                                                                                                                      - - static doSearch(term, confirmed) - - - - -

                                                                                                                                                                                                      - - - -
                                                                                                                                                                                                      -
                                                                                                                                                                                                      - - -
                                                                                                                                                                                                      -

                                                                                                                                                                                                      Initiates a search with the specified term and confirmation status.

                                                                                                                                                                                                      -
                                                                                                                                                                                                      - - - - - - - - - -
                                                                                                                                                                                                      -
                                                                                                                                                                                                      Parameters:
                                                                                                                                                                                                      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                      NameTypeDescription
                                                                                                                                                                                                      term - - -string - - - -

                                                                                                                                                                                                      The search term.

                                                                                                                                                                                                      confirmed - - -boolean - - - -

                                                                                                                                                                                                      Indicates if the search term is confirmed.

                                                                                                                                                                                                      - -
                                                                                                                                                                                                      - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                      - - - - -
                                                                                                                                                                                                      - - - - -
                                                                                                                                                                                                      - -

                                                                                                                                                                                                      - - static setup() - - - - -

                                                                                                                                                                                                      - - - -
                                                                                                                                                                                                      -
                                                                                                                                                                                                      - - -
                                                                                                                                                                                                      -

                                                                                                                                                                                                      Sets up the search input field and button functionality.

                                                                                                                                                                                                      -
                                                                                                                                                                                                      - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                      - - - - -
                                                                                                                                                                                                      - - - - -
                                                                                                                                                                                                      - -

                                                                                                                                                                                                      - - static setup() - - - - -

                                                                                                                                                                                                      - - - -
                                                                                                                                                                                                      -
                                                                                                                                                                                                      - - -
                                                                                                                                                                                                      -

                                                                                                                                                                                                      Sets up the search input field and button functionality.

                                                                                                                                                                                                      -
                                                                                                                                                                                                      - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                      - - - - -
                                                                                                                                                                                                      - - - - - - - -
                                                                                                                                                                                                      - -
                                                                                                                                                                                                      - - - - - - - -
                                                                                                                                                                                                      - -
                                                                                                                                                                                                      - -

                                                                                                                                                                                                      search

                                                                                                                                                                                                      - - -
                                                                                                                                                                                                      - -
                                                                                                                                                                                                      - -
                                                                                                                                                                                                      - - -

                                                                                                                                                                                                      Provides functionality for the search system within the application.

                                                                                                                                                                                                      -

                                                                                                                                                                                                      You can implement your own result provider by listening to the search hook: -window.addHook('search', function(query) {});.

                                                                                                                                                                                                      -

                                                                                                                                                                                                      The query object has the following members:

                                                                                                                                                                                                      -
                                                                                                                                                                                                        -
                                                                                                                                                                                                      • term: The term for which the user has searched.
                                                                                                                                                                                                      • -
                                                                                                                                                                                                      • confirmed: A boolean indicating if the user has pressed enter after searching. -You should not search online or do heavy processing unless the user has confirmed the search term.
                                                                                                                                                                                                      • -
                                                                                                                                                                                                      • addResult(result): A method to add a result to the query.
                                                                                                                                                                                                      • -
                                                                                                                                                                                                      -

                                                                                                                                                                                                      The result object can have the following members (title is required, as well as one of position and bounds):

                                                                                                                                                                                                      -
                                                                                                                                                                                                        -
                                                                                                                                                                                                      • title: The label for this result. Will be interpreted as HTML, so make sure to escape properly.
                                                                                                                                                                                                      • -
                                                                                                                                                                                                      • description: Secondary information for this result. Will be interpreted as HTML, so make sure to escape properly.
                                                                                                                                                                                                      • -
                                                                                                                                                                                                      • position: A L.LatLng object describing the position of this result.
                                                                                                                                                                                                      • -
                                                                                                                                                                                                      • bounds: A L.LatLngBounds object describing the bounds of this result.
                                                                                                                                                                                                      • -
                                                                                                                                                                                                      • layer: An ILayer to be added to the map when the user selects this search result. -Will be generated if not set. Set to null to prevent the result from being added to the map.
                                                                                                                                                                                                      • -
                                                                                                                                                                                                      • icon: A URL to an icon to display in the result list. Should be 12x12 pixels.
                                                                                                                                                                                                      • -
                                                                                                                                                                                                      • onSelected(result, event): A handler to be called when the result is selected. -May return true to prevent the map from being repositioned. You may reposition the map yourself or do other work.
                                                                                                                                                                                                      • -
                                                                                                                                                                                                      • onRemove(result): A handler to be called when the result is removed from the map -(because another result has been selected or the search was cancelled by the user).
                                                                                                                                                                                                      • -
                                                                                                                                                                                                      - - - - - -
                                                                                                                                                                                                      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                      - - - - -
                                                                                                                                                                                                      - - - - - - - -

                                                                                                                                                                                                      Classes

                                                                                                                                                                                                      - - -
                                                                                                                                                                                                      - -
                                                                                                                                                                                                      -

                                                                                                                                                                                                      - Query - -

                                                                                                                                                                                                      -
                                                                                                                                                                                                      - - -
                                                                                                                                                                                                      -

                                                                                                                                                                                                      - Query - -

                                                                                                                                                                                                      -
                                                                                                                                                                                                      - - -
                                                                                                                                                                                                      - - - - - - - - - - - - -

                                                                                                                                                                                                      Methods

                                                                                                                                                                                                      - -
                                                                                                                                                                                                      - - -
                                                                                                                                                                                                      - -

                                                                                                                                                                                                      - - static addSearchResult(query, data, guid) - - - - -

                                                                                                                                                                                                      - - - -
                                                                                                                                                                                                      -
                                                                                                                                                                                                      - - -
                                                                                                                                                                                                      -

                                                                                                                                                                                                      Adds a search result for a portal to the search query results.

                                                                                                                                                                                                      -
                                                                                                                                                                                                      - - - - - - - - - -
                                                                                                                                                                                                      -
                                                                                                                                                                                                      Parameters:
                                                                                                                                                                                                      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                      NameTypeDescription
                                                                                                                                                                                                      query - - -Object - - - -

                                                                                                                                                                                                      The search query object to which the result will be added.

                                                                                                                                                                                                      data - - -Object - - - -

                                                                                                                                                                                                      The data for the search result. This includes information such as title, team, level, health, etc.

                                                                                                                                                                                                      guid - - -string - - - -

                                                                                                                                                                                                      GUID if the portal.

                                                                                                                                                                                                      - -
                                                                                                                                                                                                      - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                      - - - - -
                                                                                                                                                                                                      - - - - -
                                                                                                                                                                                                      - -

                                                                                                                                                                                                      - - static addSearchResult(query, data, guid) - - - - -

                                                                                                                                                                                                      - - - -
                                                                                                                                                                                                      -
                                                                                                                                                                                                      - - -
                                                                                                                                                                                                      -

                                                                                                                                                                                                      Adds a search result for a portal to the search query results.

                                                                                                                                                                                                      -
                                                                                                                                                                                                      - - - - - - - - - -
                                                                                                                                                                                                      -
                                                                                                                                                                                                      Parameters:
                                                                                                                                                                                                      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                      NameTypeDescription
                                                                                                                                                                                                      query - - -Object - - - -

                                                                                                                                                                                                      The search query object to which the result will be added.

                                                                                                                                                                                                      data - - -Object - - - -

                                                                                                                                                                                                      The data for the search result. This includes information such as title, team, level, health, etc.

                                                                                                                                                                                                      guid - - -string - - - -

                                                                                                                                                                                                      GUID if the portal.

                                                                                                                                                                                                      - -
                                                                                                                                                                                                      - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                      - - - - -
                                                                                                                                                                                                      - - - - -
                                                                                                                                                                                                      - -

                                                                                                                                                                                                      - - static doSearch(term, confirmed) - - - - -

                                                                                                                                                                                                      - - - -
                                                                                                                                                                                                      -
                                                                                                                                                                                                      - - -
                                                                                                                                                                                                      -

                                                                                                                                                                                                      Initiates a search with the specified term and confirmation status.

                                                                                                                                                                                                      -
                                                                                                                                                                                                      - - - - - - - - - -
                                                                                                                                                                                                      -
                                                                                                                                                                                                      Parameters:
                                                                                                                                                                                                      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                      NameTypeDescription
                                                                                                                                                                                                      term - - -string - - - -

                                                                                                                                                                                                      The search term.

                                                                                                                                                                                                      confirmed - - -boolean - - - -

                                                                                                                                                                                                      Indicates if the search term is confirmed.

                                                                                                                                                                                                      - -
                                                                                                                                                                                                      - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                      - - - - -
                                                                                                                                                                                                      - - - - -
                                                                                                                                                                                                      - -

                                                                                                                                                                                                      - - static doSearch(term, confirmed) - - - - -

                                                                                                                                                                                                      - - - -
                                                                                                                                                                                                      -
                                                                                                                                                                                                      - - -
                                                                                                                                                                                                      -

                                                                                                                                                                                                      Initiates a search with the specified term and confirmation status.

                                                                                                                                                                                                      -
                                                                                                                                                                                                      - - - - - - - - - -
                                                                                                                                                                                                      -
                                                                                                                                                                                                      Parameters:
                                                                                                                                                                                                      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                      NameTypeDescription
                                                                                                                                                                                                      term - - -string - - - -

                                                                                                                                                                                                      The search term.

                                                                                                                                                                                                      confirmed - - -boolean - - - -

                                                                                                                                                                                                      Indicates if the search term is confirmed.

                                                                                                                                                                                                      - -
                                                                                                                                                                                                      - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                      - - - - -
                                                                                                                                                                                                      - - - - -
                                                                                                                                                                                                      - -

                                                                                                                                                                                                      - - static setup() - - - - -

                                                                                                                                                                                                      - - - -
                                                                                                                                                                                                      -
                                                                                                                                                                                                      - - -
                                                                                                                                                                                                      -

                                                                                                                                                                                                      Sets up the search input field and button functionality.

                                                                                                                                                                                                      -
                                                                                                                                                                                                      - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                      - - - - - - - - - - - - - - - - - - - -