API:GetReleventAreaIndex

UI Lua API · Game functions
Version: WAR 1.4.8

Returns a map key for the first area the player is in that has map data.

areaKey = GetReleventAreaIndex()

Arguments

None.

Returns

areaKey

number – zoneId * 1000 + areaId for the first matching area, or nothing if none matches.

Details

• The name is spelled "Relevent" in the client.
• The client goes through the areas the player is currently in. For each one it builds the key zoneId * 1000 + areaId from the player's current zone, and returns the first key for which the map data has an entry.
• If the map data is not loaded, or no area matches, the function returns nothing.
• The stock UI never calls this function.

Errors

None.

Example

A minimal example built from the signature:

local key = GetReleventAreaIndex()
if key then
    local zoneId = math.floor( key / 1000 )
    local areaId = key % 1000
end

See also

• GetAreaData