Class MapLinkPayload

An SeString Payload representing an interactable map position link.

Assembly: Dalamud.dll

Declaration

public class MapLinkPayload : Payload

Inheritance: System.Object -> Dalamud.Game.Text.SeStringHandling.Payload

Properties

Type

Gets the type of this payload.

Declaration

public override PayloadType Type { get; }

Map

Gets the Map specified for this map link.

Declaration

[JsonIgnore]
public RowRef<Map> Map { get; }

TerritoryType

Gets the TerritoryType specified for this map link.

Declaration

[JsonIgnore]
public RowRef<TerritoryType> TerritoryType { get; }

RawX

Gets the internal x-coordinate for this map position.

Declaration

public int RawX { get; }

RawY

Gets the internal y-coordinate for this map position.

Declaration

public int RawY { get; }

XCoord

Gets the readable x-coordinate position for this map link. This value is approximate and unrounded.

Declaration

public float XCoord { get; }

YCoord

Gets the readable y-coordinate position for this map link. This value is approximate and unrounded.

Declaration

[JsonIgnore]
public float YCoord { get; }

CoordinateString

Gets the printable map coordinates for this link. This value tries to match the in-game printable text as closely as possible but is an approximation and may be slightly off for some positions.

Declaration

[JsonIgnore]
public string CoordinateString { get; }

PlaceNameRegion

Gets the region name for this map link. This corresponds to the upper zone name found in the actual in-game map UI. eg, "La Noscea".

Declaration

[JsonIgnore]
public string PlaceNameRegion { get; }

PlaceName

Gets the place name for this map link. This corresponds to the lower zone name found in the actual in-game map UI. eg, "Limsa Lominsa Upper Decks".

Declaration

[JsonIgnore]
public string PlaceName { get; }

DataString

Gets the data string for this map link, for use by internal game functions that take a string variant and not a binary payload.

Declaration

public string DataString { get; }

Methods

ToString()

Declaration

public override string ToString()

Returns

System.String

EncodeImpl()

Encodes the internal state of this payload into a byte[] suitable for sending to in-game handlers such as the chat log.

Declaration

protected override byte[] EncodeImpl()

Returns

System.Byte[]: Encoded binary payload data suitable for use with in-game handlers.

DecodeImpl(BinaryReader, long)

Decodes a byte stream from the game into a payload object.

Declaration

protected override void DecodeImpl(BinaryReader reader, long endOfStream)

Parameters

Type	Name	Description
System.IO.BinaryReader	reader	A BinaryReader containing at least all the data for this payload.
System.Int64	endOfStream	The location holding the end of the data for this payload.