Astrolabe/API PlaceIconOnMinimap

From Esamynn's Wiki

Jump to: navigation, search

Astrolabe ยป Astrolabe/API PlaceIconOnMinimap

Places an icons on the Minimap, relative to the player, using the provided World Map Point.

result = Astrolabe:PlaceIconOnMinimap( icon, continent, zone, xPos, yPos )

Arguments

icon
UI Widget - the icon to be positioned (can be any anchorable Widget)
continent, zone, xPos, yPos
World Map Point - the position to use when calculating the icon's position

Returns

result
Number - 0 if there were no errors, -1 if the position provided has no meaningful position relative to the player's current location

Details

icon:Show() is called before this function returns, assuming that no errors were encountered.

After an icon has been placed on the Minimap with this function, it's position will be continuously updated by Astrolabe until it is removed, either manually, or automatically by Astrolabe.

This function can also be used to update the world map postion used for positioning an icon because the most recent call to the function for a given icon is the data that is used by the position management system.

Personal tools