Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Map

Classes

Class: Map

Method: AddGivenQuestInfo

(method) Map:AddGivenQuestInfo(type: number, id: number)

Adds quest information to the map with the specified type and ID.

@param type — The quest type.

@param id — The quest ID.

Method: UpdateBossTelescopeInfo

(method) Map:UpdateBossTelescopeInfo()

Updates boss telescope information on the map.

Method: UpdateBossTelescopeArea

(method) Map:UpdateBossTelescopeArea()

Updates the boss telescope area on the map.

Method: UpdateCarryingBackpackSlaveInfo

(method) Map:UpdateCarryingBackpackSlaveInfo()

Updates carrying backpack slave information on the map.

Method: UpdateCorpseInfo

(method) Map:UpdateCorpseInfo()

Updates corpse information on the map.

Method: UpdateCompletedQuestInfo

(method) Map:UpdateCompletedQuestInfo()

Updates completed quest information on the map.

Method: UpdateCurZoneGroupNpcInfo

(method) Map:UpdateCurZoneGroupNpcInfo()

Updates NPC information for the current zone group on the map.

Method: UpdateAllDrawableAnchor

(method) Map:UpdateAllDrawableAnchor()

Updates the anchor points for all drawables on the map.

Method: ShowSkillMapEffect

(method) Map:ShowSkillMapEffect(x: number, y: number, z: number, radius: number, index: number)

Shows a skill map effect at the specified coordinates and radius.

@param x — The x-coordinate.

@param y — The y-coordinate.

@param z — The z-coordinate.

@param radius — The radius of the effect.

@param index — The index of the effect.

Method: SetPingWidget

(method) Map:SetPingWidget(widget: Widget, drawable: DrawableDDS, pingType: `1`|`2`|`3`|`4`|`5`)

Sets the ping widget and drawable for the specified ping type on the map.

@param widget — The widget for the ping.

@param drawable — The drawable for the ping.

@param pingType — The type of ping.

local frame = widget:CreateChildWidget("emptywidget", "ping", 0, true)
frame:SetExtent(24, 24)
frame:Show(false)

local bg = widget:CreateDrawable("ui/map/icon/npc_icon.dds", "my_ping", "overlay")
bg:AddAnchor("CENTER", frame, 0, 0)
frame.bg = bg
bg:SetVisible(false)

widget:SetPingWidget(frame, frame.bg, 1)

function frame:OnShow()
  frame.bg:SetVisible(true)
end

frame:SetHandler("OnShow", frame.OnShow)
function frame:OnHide()
  frame.bg:SetVisible(false)
end

frame:SetHandler("OnHide", frame.OnHide)

pingType:
    | `1` -- Ping
    | `2` -- Enemy
    | `3` -- Attack
    | `4` -- Line
    | `5` -- Eraser

See:

Method: StartNotifyQuestEffect

(method) Map:StartNotifyQuestEffect(index: number, qType: number, isStart: boolean)

Starts or stops a notification quest effect on the map.

@param index — The index of the quest effect.

@param qType — The quest type.

@param isStart — true to start the effect, false to stop.

Method: SetPlayerDrawable

(method) Map:SetPlayerDrawable(player: DrawableDDS)

Sets the player’s icon drawable on the map.

@param player — The drawable for the player icon.

local playerDrawable = widget:CreateDrawable("ui/map/icon/player_cursor.dds", "player_cursor", "overlay")
widget:SetPlayerDrawable(playerDrawable)

See: DrawableDDS

Method: SetTooltipColor

(method) Map:SetTooltipColor(objColor: string|"|cFF000000", nickColor: string|"|cFF000000")

Sets the tooltip colors for objects and nicknames on the map.

@param objColor — The hex color for objects (alpha, red, blue, green).

@param nickColor — The hex color for nicknames (alpha, red, blue, green).

objColor:
    | "|cFF000000"

nickColor:
    | "|cFF000000"

Method: SetSkillEffectWidget

(method) Map:SetSkillEffectWidget(widget: Widget, drawable: ImageDrawable, index: number)

Sets the skill effect widget and drawable for the specified index on the map.

@param widget — The widget for the skill effect.

@param drawable — The drawable for the skill effect.

@param index — The index of the skill effect.

See:

Method: SetPingBtn

(method) Map:SetPingBtn(clicked: boolean, pingType: `1`|`2`|`3`|`4`|`5`)

Sets the ping button state and type for the map.

@param clicked — true if the ping button is clicked, false otherwise.

@param pingType — The type of ping.

pingType:
    | `1` -- Ping
    | `2` -- Enemy
    | `3` -- Attack
    | `4` -- Line
    | `5` -- Eraser

Method: UpdateDominionInfo

(method) Map:UpdateDominionInfo()

Updates dominion information on the map.

Method: UpdateFactionRezDistrictInfo

(method) Map:UpdateFactionRezDistrictInfo()

Updates faction resurrection district information on the map.

Method: UpdatePingInfo

(method) Map:UpdatePingInfo()

Updates ping information on the map.

Method: UpdateNpcInfo

(method) Map:UpdateNpcInfo()

Updates NPC information on the map.

Method: UpdateShipTelescopeInfo

(method) Map:UpdateShipTelescopeInfo()

Updates ship telescope information on the map.

Method: UpdateTransferTelescopeArea

(method) Map:UpdateTransferTelescopeArea()

Updates transfer telescope area information on the map.

Method: UpdateTelescopeArea

(method) Map:UpdateTelescopeArea()

Updates telescope area information on the map.

Method: UpdateDoodadInfo

(method) Map:UpdateDoodadInfo(bRoadMap: boolean)

Updates doodad information on the map.

@param bRoadMap — true to include road map data, false otherwise.

Method: UpdateMySlaveInfo

(method) Map:UpdateMySlaveInfo()

Updates player-owned slave information on the map.

Method: UpdateHousingInfo

(method) Map:UpdateHousingInfo()

Updates housing information on the map.

Method: UpdateFishSchoolArea

(method) Map:UpdateFishSchoolArea()

Updates fish school area information on the map.

Method: UpdateMonitorNpcInfo

(method) Map:UpdateMonitorNpcInfo()

Updates monitored NPC information on the map.

Method: UpdateFishSchoolInfo

(method) Map:UpdateFishSchoolInfo()

Updates fish school information on the map.

Method: UpdateGivenQuestStaticInfo

(method) Map:UpdateGivenQuestStaticInfo()

Updates static given quest information on the map.

Method: UpdateTransferTelescopeInfo

(method) Map:UpdateTransferTelescopeInfo()

Updates transfer telescope information on the map.

Method: SetExpandRatio

(method) Map:SetExpandRatio(ratio: number)

Sets the expansion ratio for the map.

@param ratio — The expansion ratio.

Method: RemoveTransferTelescopeInfo

(method) Map:RemoveTransferTelescopeInfo(index: number)

Removes transfer telescope information at the specified index.

@param index — The index of the transfer telescope info to remove.

Method: ClearGivenQuestStaticInfo

(method) Map:ClearGivenQuestStaticInfo()

Clears static given quest information from the map.

Method: ClearFishSchoolInfo

(method) Map:ClearFishSchoolInfo()

Clears fish school information from the map.

Method: ClearHousingInfo

(method) Map:ClearHousingInfo()

Clears housing information from the map.

Method: ClearNotifyQuestInfo

(method) Map:ClearNotifyQuestInfo()

Clears notification quest information from the map.

Method: ClearMySlaveInfo

(method) Map:ClearMySlaveInfo()

Clears player-owned slave information from the map.

Method: ClearNpcInfo

(method) Map:ClearNpcInfo()

Clears NPC information from the map.

Method: ClearDoodadInfo

(method) Map:ClearDoodadInfo()

Clears doodad information from the map.

Method: ClearCompletedQuestInfo

(method) Map:ClearCompletedQuestInfo()

Clears completed quest information from the map.

Method: AddNotifyQuestInfo

(method) Map:AddNotifyQuestInfo(qType: number)

Adds notification quest information to the map.

@param qType — The quest type.

Method: ClearCorpseInfo

(method) Map:ClearCorpseInfo()

Clears corpse information from the map.

Method: ClearAllInfo

(method) Map:ClearAllInfo()

Clears all information displayed on the map.

Method: ClearCarryingBackpackSlaveInfo

(method) Map:ClearCarryingBackpackSlaveInfo()

Clears carrying backpack slave information from the map.

Method: ClearBossTelescopeInfo

(method) Map:ClearBossTelescopeInfo()

Clears boss telescope information from the map.

Method: ResetCursor

(method) Map:ResetCursor(isNull: boolean)

Resets the map cursor.

@param isNull — true to set cursor to null, false otherwise.

Method: ClearShipTelescopeInfo

(method) Map:ClearShipTelescopeInfo()

Clears ship telescope information from the map.

Method: GetPlayerSextants

(method) Map:GetPlayerSextants()
  -> playerSextant: SEXTANT

Retrieves the player’s sextant location on the map.

@return playerSextant — The player’s sextant data.

Method: RemoveFishSchoolInfo

(method) Map:RemoveFishSchoolInfo(index: number)

Removes fish school information at the specified index.

@param index — The index of the fish school info to remove.

Method: RemoveCarryingBackpackSlaveInfo

(method) Map:RemoveCarryingBackpackSlaveInfo(index: number)

Removes carrying backpack slave information at the specified index.

@param index — The index of the backpack slave info to remove.

Method: RemoveGivenQuestInfo

(method) Map:RemoveGivenQuestInfo(type: number, id: number)

Removes given quest information from the map.

@param type — The quest type.

@param id — The quest ID.

Method: RemoveShipTelescopeInfo

(method) Map:RemoveShipTelescopeInfo(index: number)

Removes ship telescope information at the specified index.

@param index — The index of the ship telescope info to remove.

Method: RemoveNotifyQuestInfo

(method) Map:RemoveNotifyQuestInfo(qType: number)

Removes notification quest information from the map.

@param qType — The quest type.

Method: ClearTransferTelescopeInfo

(method) Map:ClearTransferTelescopeInfo()

Clears transfer telescope information from the map.

Method: RemoveBossTelescopeInfo

(method) Map:RemoveBossTelescopeInfo(index: number)

Removes boss telescope information at the specified index.

@param index — The index of the boss telescope info to remove.

Method: OnLeftClick

(method) Map:OnLeftClick()

Triggers a left-click action on the map.

Method: GetPlayerViewPos

(method) Map:GetPlayerViewPos()
  -> playerViewX: number
  2. playerViewY: number

Retrieves the player’s view position on the map.

@return playerViewX — The player’s x location on the map.

@return playerViewY — The player’s y location on the map.

Method: ReloadAllInfo

(method) Map:ReloadAllInfo()

Reloads all information displayed on the map.

Method: GetTooltipController

(method) Map:GetTooltipController()
  -> tooltipController: Window

Retrieves the tooltip controller for the map.

@return tooltipController — The tooltip controller window.

Method: MapWidgetShown

(method) Map:MapWidgetShown()
  -> widgetShown: boolean

Checks if the map widget is shown.

@return widgetShown — true if the map widget is visible, false otherwise.

Method: UpdateZoneInfo

(method) Map:UpdateZoneInfo()

Updates zone information on the map.