Interface ISeStringEvaluator
Defines a service for retrieving localized text for various in-game entities.
Assembly: Dalamud.dll
View Source
public interface ISeStringEvaluator
Methods
Evaluate(ReadOnlySeString, Span<SeStringParameter>, ClientLanguage?)
Evaluates macros in a Lumina.Text.ReadOnly.ReadOnlySeString.
View Source
ReadOnlySeString Evaluate(ReadOnlySeString str, Span<SeStringParameter> localParameters = default, ClientLanguage? language = null)
Returns
Lumina.Text.ReadOnly.ReadOnlySeString: An evaluated Lumina.Text.ReadOnly.ReadOnlySeString.
Parameters
| Type | Name | Description |
|---|---|---|
Lumina.Text.ReadOnly.ReadOnlySeString | str | The string containing macros. |
System.Span<Dalamud.Game.Text.Evaluator.SeStringParameter> | localParameters | An optional list of local parameters. |
System.Nullable<Dalamud.Game.ClientLanguage> | language | An optional language override. |
Evaluate(ReadOnlySeStringSpan, Span<SeStringParameter>, ClientLanguage?)
Evaluates macros in a Lumina.Text.ReadOnly.ReadOnlySeStringSpan.
View Source
ReadOnlySeString Evaluate(ReadOnlySeStringSpan str, Span<SeStringParameter> localParameters = default, ClientLanguage? language = null)
Returns
Lumina.Text.ReadOnly.ReadOnlySeString: An evaluated Lumina.Text.ReadOnly.ReadOnlySeString.
Parameters
| Type | Name | Description |
|---|---|---|
Lumina.Text.ReadOnly.ReadOnlySeStringSpan | str | The string containing macros. |
System.Span<Dalamud.Game.Text.Evaluator.SeStringParameter> | localParameters | An optional list of local parameters. |
System.Nullable<Dalamud.Game.ClientLanguage> | language | An optional language override. |
EvaluateFromAddon(uint, Span<SeStringParameter>, ClientLanguage?)
Evaluates macros in text from the Addon sheet.
View Source
ReadOnlySeString EvaluateFromAddon(uint addonId, Span<SeStringParameter> localParameters = default, ClientLanguage? language = null)
Returns
Lumina.Text.ReadOnly.ReadOnlySeString: An evaluated Lumina.Text.ReadOnly.ReadOnlySeString.
Parameters
| Type | Name | Description |
|---|---|---|
System.UInt32 | addonId | The row id of the Addon sheet. |
System.Span<Dalamud.Game.Text.Evaluator.SeStringParameter> | localParameters | An optional list of local parameters. |
System.Nullable<Dalamud.Game.ClientLanguage> | language | An optional language override. |
EvaluateFromLobby(uint, Span<SeStringParameter>, ClientLanguage?)
Evaluates macros in text from the Lobby sheet.
View Source
ReadOnlySeString EvaluateFromLobby(uint lobbyId, Span<SeStringParameter> localParameters = default, ClientLanguage? language = null)
Returns
Lumina.Text.ReadOnly.ReadOnlySeString: An evaluated Lumina.Text.ReadOnly.ReadOnlySeString.
Parameters
| Type | Name | Description |
|---|---|---|
System.UInt32 | lobbyId | The row id of the Lobby sheet. |
System.Span<Dalamud.Game.Text.Evaluator.SeStringParameter> | localParameters | An optional list of local parameters. |
System.Nullable<Dalamud.Game.ClientLanguage> | language | An optional language override. |
EvaluateFromLogMessage(uint, Span<SeStringParameter>, ClientLanguage?)
Evaluates macros in text from the LogMessage sheet.
View Source
ReadOnlySeString EvaluateFromLogMessage(uint logMessageId, Span<SeStringParameter> localParameters = default, ClientLanguage? language = null)
Returns
Lumina.Text.ReadOnly.ReadOnlySeString: An evaluated Lumina.Text.ReadOnly.ReadOnlySeString.
Parameters
| Type | Name | Description |
|---|---|---|
System.UInt32 | logMessageId | The row id of the LogMessage sheet. |
System.Span<Dalamud.Game.Text.Evaluator.SeStringParameter> | localParameters | An optional list of local parameters. |
System.Nullable<Dalamud.Game.ClientLanguage> | language | An optional language override. |
EvaluateActStr(ActionKind, uint, ClientLanguage?)
Evaluates ActStr from the given ActionKind and id.
View Source
string EvaluateActStr(ActionKind actionKind, uint id, ClientLanguage? language = null)
Returns
System.String: The name of the action.
Parameters
| Type | Name | Description |
|---|---|---|
| Dalamud.Game.ActionKind | actionKind | The ActionKind. |
System.UInt32 | id | The action id. |
System.Nullable<Dalamud.Game.ClientLanguage> | language | An optional language override. |
EvaluateObjStr(ObjectKind, uint, ClientLanguage?)
Evaluates ObjStr from the given ObjectKind and id.
View Source
string EvaluateObjStr(ObjectKind objectKind, uint id, ClientLanguage? language = null)
Returns
System.String: The singular name of the object.
Parameters
| Type | Name | Description |
|---|---|---|
| Dalamud.Game.ClientState.Objects.Enums.ObjectKind | objectKind | The ObjectKind. |
System.UInt32 | id | The object id. |
System.Nullable<Dalamud.Game.ClientLanguage> | language | An optional language override. |