Methods

static window.MapDataRequest#clearTimeout()

code/map_data_request.js, line 170

Clears the current data refresh timeout.

static window.MapDataRequest#delayProcessRequestQueue(seconds)

code/map_data_request.js, line 385

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

Parameters:

Name	Type	Description
seconds	number	The delay in seconds before starting to process the request queue.

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

code/map_data_request.js, line 223

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)

code/map_data_request.js, line 569

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:

Name	Type	Description
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()

code/map_data_request.js, line 153

Resumes data fetching and rendering after being idle.

static window.MapDataRequest#mapMoveEnd()

code/map_data_request.js, line 123

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

static window.MapDataRequest#mapMoveStart()

code/map_data_request.js, line 109

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

static window.MapDataRequest#pauseRenderQueue(pause)

code/map_data_request.js, line 776

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

Parameters:

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

static window.MapDataRequest#processRenderQueue()

code/map_data_request.js, line 798

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()

code/map_data_request.js, line 404

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)

code/map_data_request.js, line 732

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

Parameters:

Name	Type	Description
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()

code/map_data_request.js, line 234

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)

code/map_data_request.js, line 185

Sets a timeout to refresh the map data.

Parameters:

Name	Type	Description
seconds	number	Time in seconds to wait before refreshing the map data.

static window.MapDataRequest#requeueTile(id, error)

code/map_data_request.js, line 518

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

Parameters:

Name	Type	Description
id	string	The tile identifier.
error	boolean	Flag indicating whether the tile fetch encountered an error.

static window.MapDataRequest#resetRenderQueue()

code/map_data_request.js, line 713

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

static window.MapDataRequest#sendTileRequest(tiles)

code/map_data_request.js, line 473

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

Parameters:

Name	Type	Description
tiles	Array	An array of tile identifiers to request.

static window.MapDataRequest#setStatus(short, longopt, progressopt)

code/map_data_request.js, line 211

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

Parameters:

Name	Type	Attributes	Description
short	string		Short description of the current status.
long	string	<optional>	Long description of the current status.
progress	number	<optional>	Progress indicator, typically represented as a percentage.

static window.MapDataRequest#start()

code/map_data_request.js, line 84

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

static window.MapDataRequest#startQueueTimer(delay)

code/map_data_request.js, line 754

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

Parameters:

Name	Type	Description
delay	number	The delay in seconds before processing the render queue.