Skip to main content

Interface ISeStringEvaluator

Defines a service for retrieving localized text for various in-game entities.

Assembly: Dalamud.dll​
Declaration
public interface ISeStringEvaluator : IDalamudService

Methods​

Evaluate(ReadOnlySeString, Span<SeStringParameter>, ClientLanguage?)​

Evaluates macros in a Lumina.Text.ReadOnly.ReadOnlySeString.

Declaration
ReadOnlySeString Evaluate(ReadOnlySeString str, Span<SeStringParameter> localParameters = default, ClientLanguage? language = null)
Returns​

Lumina.Text.ReadOnly.ReadOnlySeString: An evaluated Lumina.Text.ReadOnly.ReadOnlySeString.

Parameters​
TypeNameDescription
Lumina.Text.ReadOnly.ReadOnlySeStringstrThe string containing macros.
System.Span<Dalamud.Game.Text.Evaluator.SeStringParameter>localParametersAn optional list of local parameters.
System.Nullable<Dalamud.Game.ClientLanguage>languageAn optional language override.

Evaluate(ReadOnlySeStringSpan, Span<SeStringParameter>, ClientLanguage?)​

Evaluates macros in a Lumina.Text.ReadOnly.ReadOnlySeStringSpan.

Declaration
ReadOnlySeString Evaluate(ReadOnlySeStringSpan str, Span<SeStringParameter> localParameters = default, ClientLanguage? language = null)
Returns​

Lumina.Text.ReadOnly.ReadOnlySeString: An evaluated Lumina.Text.ReadOnly.ReadOnlySeString.

Parameters​
TypeNameDescription
Lumina.Text.ReadOnly.ReadOnlySeStringSpanstrThe string containing macros.
System.Span<Dalamud.Game.Text.Evaluator.SeStringParameter>localParametersAn optional list of local parameters.
System.Nullable<Dalamud.Game.ClientLanguage>languageAn optional language override.

EvaluateMacroString(string, Span<SeStringParameter>, ClientLanguage?)​

Evaluates macros in a macro string.

Declaration
ReadOnlySeString EvaluateMacroString(string macroString, Span<SeStringParameter> localParameters = default, ClientLanguage? language = null)
Returns​

Lumina.Text.ReadOnly.ReadOnlySeString: An evaluated Lumina.Text.ReadOnly.ReadOnlySeString.

Parameters​
TypeNameDescription
System.StringmacroStringThe macro string.
System.Span<Dalamud.Game.Text.Evaluator.SeStringParameter>localParametersAn optional list of local parameters.
System.Nullable<Dalamud.Game.ClientLanguage>languageAn optional language override.

EvaluateMacroString(ReadOnlySpan<byte>, Span<SeStringParameter>, ClientLanguage?)​

Evaluates macros in a macro string.

Declaration
ReadOnlySeString EvaluateMacroString(ReadOnlySpan<byte> macroString, Span<SeStringParameter> localParameters = default, ClientLanguage? language = null)
Returns​

Lumina.Text.ReadOnly.ReadOnlySeString: An evaluated Lumina.Text.ReadOnly.ReadOnlySeString.

Parameters​
TypeNameDescription
System.ReadOnlySpan<System.Byte>macroStringThe macro string.
System.Span<Dalamud.Game.Text.Evaluator.SeStringParameter>localParametersAn optional list of local parameters.
System.Nullable<Dalamud.Game.ClientLanguage>languageAn optional language override.

EvaluateFromAddon(uint, Span<SeStringParameter>, ClientLanguage?)​

Evaluates macros in text from the Addon sheet.

Declaration
ReadOnlySeString EvaluateFromAddon(uint addonId, Span<SeStringParameter> localParameters = default, ClientLanguage? language = null)
Returns​

Lumina.Text.ReadOnly.ReadOnlySeString: An evaluated Lumina.Text.ReadOnly.ReadOnlySeString.

Parameters​
TypeNameDescription
System.UInt32addonIdThe row id of the Addon sheet.
System.Span<Dalamud.Game.Text.Evaluator.SeStringParameter>localParametersAn optional list of local parameters.
System.Nullable<Dalamud.Game.ClientLanguage>languageAn optional language override.

EvaluateFromLobby(uint, Span<SeStringParameter>, ClientLanguage?)​

Evaluates macros in text from the Lobby sheet.

Declaration
ReadOnlySeString EvaluateFromLobby(uint lobbyId, Span<SeStringParameter> localParameters = default, ClientLanguage? language = null)
Returns​

Lumina.Text.ReadOnly.ReadOnlySeString: An evaluated Lumina.Text.ReadOnly.ReadOnlySeString.

Parameters​
TypeNameDescription
System.UInt32lobbyIdThe row id of the Lobby sheet.
System.Span<Dalamud.Game.Text.Evaluator.SeStringParameter>localParametersAn optional list of local parameters.
System.Nullable<Dalamud.Game.ClientLanguage>languageAn optional language override.

EvaluateFromLogMessage(uint, Span<SeStringParameter>, ClientLanguage?)​

Evaluates macros in text from the LogMessage sheet.

Declaration
ReadOnlySeString EvaluateFromLogMessage(uint logMessageId, Span<SeStringParameter> localParameters = default, ClientLanguage? language = null)
Returns​

Lumina.Text.ReadOnly.ReadOnlySeString: An evaluated Lumina.Text.ReadOnly.ReadOnlySeString.

Parameters​
TypeNameDescription
System.UInt32logMessageIdThe row id of the LogMessage sheet.
System.Span<Dalamud.Game.Text.Evaluator.SeStringParameter>localParametersAn optional list of local parameters.
System.Nullable<Dalamud.Game.ClientLanguage>languageAn optional language override.

EvaluateActStr(ActionKind, uint, ClientLanguage?)​

Evaluates ActStr from the given ActionKind and id.

Declaration
string EvaluateActStr(ActionKind actionKind, uint id, ClientLanguage? language = null)
Returns​

System.String: The name of the action.

Parameters​
TypeNameDescription
Dalamud.Game.ActionKindactionKindThe ActionKind.
System.UInt32idThe action id.
System.Nullable<Dalamud.Game.ClientLanguage>languageAn optional language override.

EvaluateObjStr(ObjectKind, uint, ClientLanguage?)​

Evaluates ObjStr from the given ObjectKind and id.

Declaration
string EvaluateObjStr(ObjectKind objectKind, uint id, ClientLanguage? language = null)
Returns​

System.String: The singular name of the object.

Parameters​
TypeNameDescription
Dalamud.Game.ClientState.Objects.Enums.ObjectKindobjectKindThe ObjectKind.
System.UInt32idThe object id.
System.Nullable<Dalamud.Game.ClientLanguage>languageAn optional language override.