API:GetZoneLargestHotspotSize

UI Lua API · RvR functions
Version: WAR 1.4.8

Returns the largest hotspot size the client has stored for a zone, as used for the hotspot markers on the stock world map.

size = GetZoneLargestHotspotSize(zoneId)

Arguments

zoneId: number – Zone id.

Returns

size: number – Stored hotspot size for the zone, or 0 if the client has no entry for it. The stock UI compares it with GameData.HotSpotSize values.

Details

The value is looked up in a table the client keeps per zone; nothing is requested from the server.
The stock world map shows a hotspot marker per campaign zone based on this value and uses GameData.HotSpotSize.NONE when it does not want one.
The function takes exactly one argument.

Errors

None besides the generic Invalid Parameters message when the argument is missing or not a number.

Example

From default/ea_worldmapwindow/source/campaignview.lua:

for zoneId, iconType in pairs( EA_Window_WorldMap.campaignZones )
do
    local hotspotSize = GameData.HotSpotSize.NONE
    if (show) then
        hotspotSize = GetZoneLargestHotspotSize( zoneId )
    end

Return of Reckoning