Struct MapCoordinate
Represents map-space coordinate within a specific territory, map, and instance.
Assembly: Dalamud.dll​
public struct MapCoordinate
Properties​
TerritoryId​
Gets or sets the TerritoryType RowId.
public uint TerritoryId { readonly get; set; }
MapId​
Gets or sets the Map RowId.
If set to 0, falls back to Dalamud.Excel.Sheets.TerritoryType.Map from the given Dalamud.Utility.MapCoordinate.TerritoryId.
public uint MapId { readonly get; set; }
X​
Gets or sets the map X coordinate.
public float X { readonly get; set; }
Y​
Gets or sets the map Y coordinate.
public float Y { readonly get; set; }
Z​
Gets or sets the optional map Z coordinate. This is the altitude.
public float? Z { readonly get; set; }
InstanceId​
Gets or sets the Instance Id.
public uint InstanceId { readonly get; set; }
Methods​
ToWorldCoordinate()​
Converts this map-space coordinate into the corresponding, approximate world-space coordinate.
public WorldCoordinate ToWorldCoordinate()
Returns​
Dalamud.Utility.WorldCoordinate: A Dalamud.Utility.WorldCoordinate representing the approximate position in the world, or a default value if the map data cannot be retrieved.
ToMapLink(uint)​
Creates a ReadOnlySeString representing an entire macros chain that can be used to link a map position in the chat log.
public ReadOnlySeString ToMapLink(uint placeNameIdOverride = 0)
Returns​
Lumina.Text.ReadOnly.ReadOnlySeString: A ReadOnlySeString containing all of the macros necessary to display a map link in the chat log.
Parameters​
| Type | Name | Description |
|---|---|---|
System.UInt32 | placeNameIdOverride | An optional PlaceName RowId that is used for the locations name. |