Astrolabe/API GetDistanceToIcon

From Esamynn's Wiki

Jump to: navigation, search

Astrolabe ยป Astrolabe/API GetDistanceToIcon

Returns the distance to the specified icon, as last calculated by the positioning system.

dist, xDelta, yDelta = Astrolabe:GetDistanceToIcon( icon )

Arguments

icon
UI Widget - the icon for which the information is to be retrieved for

Returns

dist
Number - the absolute distance between the icon and the player in game yards
xDelta
Number - the East/West distance from the player to the icon in game yards
yDelta
Number - the North/South distance from the player to the icon in game yards

Details

This function is meant to be a quick way to retrieve the approximate distance to an icon, on the assumption that the last numbers used by the update system should be "good enough" in most cases.

This funciton will return nil for all arguments if the specified icon is not currently in the positioning buffer.

Personal tools