Class SeString

This class provices static utility functions for ReadOnlySeStrings.

Assembly: Dalamud.dll

Declaration

public static class SeString

Methods

CreateItemLink(uint, bool, string?)

Creates an SeString representing an entire Payload chain that can be used to link an item in the chat log.

Declaration

public static ReadOnlySeString CreateItemLink(uint itemId, bool isHq, string? displayNameOverride = null)

Returns

Lumina.Text.ReadOnly.ReadOnlySeString: An SeString containing all the macros necessary to display an item link in the chat log.

Parameters

Type	Name	Description
System.UInt32	itemId	The id of the item to link.
System.Boolean	isHq	Whether to link the high-quality variant of the item.
System.String	displayNameOverride	An optional name override to display, instead of the actual item name.

CreateItemLink(Item, bool, string?)

Creates an SeString representing an entire Payload chain that can be used to link an item in the chat log.

Declaration

public static ReadOnlySeString CreateItemLink(Item item, bool isHq, string? displayNameOverride = null)

Returns

Lumina.Text.ReadOnly.ReadOnlySeString: An SeString containing all the macros necessary to display an item link in the chat log.

Parameters

Type	Name	Description
Dalamud.Excel.Sheets.Item	item	The Lumina Item to link.
System.Boolean	isHq	Whether to link the high-quality variant of the item.
System.String	displayNameOverride	An optional name override to display, instead of the actual item name.

CreateItemLink(uint, ItemKind, string?)

Creates an SeString representing an entire Payload chain that can be used to link an item in the chat log.

Declaration

public static ReadOnlySeString CreateItemLink(uint itemId, ItemKind kind = ItemKind.Normal, string? displayNameOverride = null)

Returns

Lumina.Text.ReadOnly.ReadOnlySeString: An SeString containing all the macros necessary to display an item link in the chat log.

Parameters

Type	Name	Description
System.UInt32	itemId	The id of the item to link.
Dalamud.Utility.ItemKind	kind	The kind of item to link.
System.String	displayNameOverride	An optional name override to display, instead of the actual item name.

CreateMapLink(IGameObject)

Creates an SeString representing an entire payload chain that can be used to link a map position of a GameObject in the chat log.

Declaration

public static ReadOnlySeString CreateMapLink(IGameObject obj)

Returns

Lumina.Text.ReadOnly.ReadOnlySeString: An SeString containing all of the macros necessary to display a map link in the chat log.

Parameters

Type	Name	Description
Dalamud.Game.ClientState.Objects.Types.IGameObject	obj	The GameObject, which position should be used.

CreateMapLink(uint, uint, float, float, float, int, float)

Creates an SeString representing an entire payload chain that can be used to link a map position in the chat log.

Declaration

public static ReadOnlySeString CreateMapLink(uint territoryId, uint mapId, float xCoord, float yCoord, float zCoord = 0, int instanceId = 0, float fudgeFactor = 0.05)

Returns

Lumina.Text.ReadOnly.ReadOnlySeString: An SeString containing all of the macros necessary to display a map link in the chat log.

Parameters

Type	Name	Description
System.UInt32	territoryId	The id of the TerritoryType for this map link.
System.UInt32	mapId	The id of the Map for this map link.
System.Single	xCoord	The human-readable x-coordinate for this link.
System.Single	yCoord	The human-readable y-coordinate for this link.
System.Single	zCoord	An optional human-readable z-coordinate for this link.
System.Int32	instanceId	An optional area instance number to be included in this link.
System.Single	fudgeFactor	An optional offset to account for rounding and truncation errors; it is best to leave this untouched in most cases.

CreatePartyFinderLink(uint, string, bool)

Creates an SeString representing an entire payload chain that can be used to link party finder listings in the chat log.

Declaration

public static ReadOnlySeString CreatePartyFinderLink(uint listingId, string recruiterName, bool isCrossWorld = false)

Returns

Lumina.Text.ReadOnly.ReadOnlySeString: An SeString containing all the macros necessary to display a party finder link in the chat log.

Parameters

Type	Name	Description
System.UInt32	listingId	The listing ID of the party finder entry.
System.String	recruiterName	The name of the recruiter.
System.Boolean	isCrossWorld	Whether the listing is limited to the current world or not.

CreatePartyFinderSearchConditionsLink(string)

Creates an SeString representing an entire payload chain that can be used to link the party finder search conditions.

Declaration

public static ReadOnlySeString CreatePartyFinderSearchConditionsLink(string message)

Returns

Lumina.Text.ReadOnly.ReadOnlySeString: An SeString containing all the macros necessary to display a link to the party finder search conditions.

Parameters

Type	Name	Description
System.String	message	The text that should be displayed for the link.