Returns the scale to be used for displaying battleground map icons. Used in the default UI to determine the size of the point of interest icons (towers, graveyards, etc.) on the zone map (the small battle minimap). The default size of the icons is set by DEFAULT_POI_ICON_SIZE and the scale is used to grow or shrink them depending on the size of the map.


See also Battlefield functions.

Signature:

scale = GetBattlefieldMapIconScale()

Returns:

  • scale - Scale factor for map icons (between 0 and 1) (number)

Examples:

-- Set the size of an icon scaled by this value
local size = DEFAULT_POI_ICON_SIZE * GetBattlefieldMapIconScale()
icon:SetWidth(size)
icon:SetHeight(size)