Class Utf8StringExtensions

A set of helpful utilities for working with FFXIVClientStructs.FFXIV.Client.System.String.Utf8Strings from ClientStructs.

Remarks

WARNING: Will break if a custom ClientStructs is used. These are here for CONVENIENCE ONLY.

Assembly: Dalamud.dll

Declaration

public static class Utf8StringExtensions

Methods

AsReadOnlySeStringSpan(Utf8String)

Convert a Utf8String to a ReadOnlySeStringSpan.

Declaration

public static ReadOnlySeStringSpan AsReadOnlySeStringSpan(this Utf8String str)

Returns

Lumina.Text.ReadOnly.ReadOnlySeStringSpan: A span.

Parameters

Type	Name	Description
FFXIVClientStructs.FFXIV.Client.System.String.Utf8String	str	The Utf8String to convert.

AsDalamudSeString(Utf8String)

Convert a Utf8String to a Dalamud SeString.

Declaration

public static SeString AsDalamudSeString(this Utf8String str)

Returns

Dalamud.Game.Text.SeStringHandling.SeString: A Dalamud-flavored SeString.

Parameters

Type	Name	Description
FFXIVClientStructs.FFXIV.Client.System.String.Utf8String	str	The Utf8String to convert.

AsReadOnlySeString(Utf8String)

Get a new ReadOnlySeString that's a copy of the text in this Utf8String.

Declaration

public static ReadOnlySeString AsReadOnlySeString(this Utf8String str)

Returns

Lumina.Text.ReadOnly.ReadOnlySeString: A new Lumina ReadOnlySeString.

Parameters

Type	Name	Description
FFXIVClientStructs.FFXIV.Client.System.String.Utf8String	str	The Utf8String to copy.

Remarks

This should be functionally identical to Dalamud.Utility.Utf8StringExtensions.AsReadOnlySeStringSpan(FFXIVClientStructs.FFXIV.Client.System.String.Utf8String), but exists for convenience in places that already expect ReadOnlySeString as a type (and where a copy is desired).

ExtractText(Utf8String)

Extract text from this Utf8String following Lumina.Text.ReadOnly.ReadOnlySeStringSpan.ExtractText's rules.

Declaration

public static string ExtractText(this Utf8String str)

Returns

System.String: Extracted text.

Parameters

Type	Name	Description
FFXIVClientStructs.FFXIV.Client.System.String.Utf8String	str	The Utf8String to process.