Class SeString
This class provices static utility functions for ReadOnlySeStrings.
Assembly: Dalamud.dll
public static class SeString
Methods
CreateItemLink(uint, bool, ReadOnlySeString)
Creates a ReadOnlySeString representing an entire macro chain that can be used to link an item in the chat log.
public static ReadOnlySeString CreateItemLink(uint itemId, bool isHq, ReadOnlySeString displayNameOverride = default)
Returns
Lumina.Text.ReadOnly.ReadOnlySeString: A ReadOnlySeString 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. |
Lumina.Text.ReadOnly.ReadOnlySeString | displayNameOverride | An optional name override to display, instead of the actual item name. |
CreateItemLink(Item, bool, ReadOnlySeString)
Creates a ReadOnlySeString representing an entire macro chain that can be used to link an item in the chat log.
public static ReadOnlySeString CreateItemLink(Item item, bool isHq, ReadOnlySeString displayNameOverride = default)
Returns
Lumina.Text.ReadOnly.ReadOnlySeString: A ReadOnlySeString 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. |
Lumina.Text.ReadOnly.ReadOnlySeString | displayNameOverride | An optional name override to display, instead of the actual item name. |
CreateItemLink(uint, ItemKind, ReadOnlySeString)
Creates a ReadOnlySeString representing an entire macro chain that can be used to link an item in the chat log.
public static ReadOnlySeString CreateItemLink(uint itemId, ItemKind kind = ItemKind.Normal, ReadOnlySeString displayNameOverride = default)
Returns
Lumina.Text.ReadOnly.ReadOnlySeString: A ReadOnlySeString 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. |
Lumina.Text.ReadOnly.ReadOnlySeString | displayNameOverride | An optional name override to display, instead of the actual item name. |
CreateMapLink(IGameObject)
Creates a ReadOnlySeString representing an entire macros chain that can be used to link a map position of a GameObject in the chat log.
public static ReadOnlySeString CreateMapLink(IGameObject obj)
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 |
|---|---|---|
| Dalamud.Game.ClientState.Objects.Types.IGameObject | obj | The GameObject, which position should be used. |
CreateMapLink(Level)
Creates a ReadOnlySeString representing an entire macros chain that can be used to link a Level position in the chat log.
public static ReadOnlySeString CreateMapLink(Level levelRow)
Returns
Lumina.Text.ReadOnly.ReadOnlySeString: A ReadOnlySeString containing all of the macros necessary to display a map link of a Level position in the chat log.
Parameters
| Type | Name | Description |
|---|---|---|
Dalamud.Excel.Sheets.Level | levelRow | The Level row. |
CreateMapLink(WorldCoordinate, uint)
Creates a ReadOnlySeString representing an entire macros chain that can be used to link a map position in the chat log.
public static ReadOnlySeString CreateMapLink(WorldCoordinate worldPos, 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 |
|---|---|---|
| Dalamud.Utility.WorldCoordinate | worldPos | The world-space coordinate. |
System.UInt32 | placeNameIdOverride | An optional PlaceName RowId that is used for the locations name. |
CreateMapLink(MapCoordinate)
Creates a ReadOnlySeString representing an entire macros chain that can be used to link a map position in the chat log.
public static ReadOnlySeString CreateMapLink(MapCoordinate mapPos)
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 |
|---|---|---|
| Dalamud.Utility.MapCoordinate | mapPos | The map-space coordinate. |
CreatePartyFinderLink(uint, string, bool)
Creates a ReadOnlySeString representing an entire macros chain that can be used to link party finder listings in the chat log.
public static ReadOnlySeString CreatePartyFinderLink(uint listingId, string recruiterName, bool isCrossWorld = false)
Returns
Lumina.Text.ReadOnly.ReadOnlySeString: A ReadOnlySeString 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 a ReadOnlySeString representing an entire macros chain that can be used to link the party finder search conditions.
public static ReadOnlySeString CreatePartyFinderSearchConditionsLink(string message)
Returns
Lumina.Text.ReadOnly.ReadOnlySeString: A ReadOnlySeString 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. |