Interface ILogMessage

Interface representing a log message.

Assembly: Dalamud.dll

Declaration

public interface ILogMessage : IEquatable<ILogMessage>

Properties

Address

Gets the address of the log message in memory.

Declaration

nint Address { get; }

LogMessageId

Gets the ID of this log message.

Declaration

uint LogMessageId { get; }

GameData

Gets the GameData associated with this log message.

Declaration

RowRef<LogMessage> GameData { get; }

SourceEntity

Gets the entity that is the source of this log message, if any.

Declaration

ILogMessageEntity? SourceEntity { get; }

TargetEntity

Gets the entity that is the target of this log message, if any.

Declaration

ILogMessageEntity? TargetEntity { get; }

ParameterCount

Gets the number of parameters.

Declaration

int ParameterCount { get; }

Parameters

Gets a list containing the parameters. The returned object is only valid during the Dalamud.Plugin.Services.IChatGui.LogMessage event and must not be accessed after returning from it.

Declaration

IReadOnlyList<SeStringParameter> Parameters { get; }

IsHandled

Gets a value indicating whether the message is handled and will not appear in chat.

Declaration

bool IsHandled { get; }

Methods

PreventOriginal()

Marks this message as handled (Dalamud.Game.Chat.ILogMessage.IsHandled = true) and prevents it from appearing.

Declaration

void PreventOriginal()

TryGetIntParameter(int, out int)

Retrieves the value of a parameter for the log message if it is an int.

Declaration

bool TryGetIntParameter(int index, out int value)

Returns

System.Boolean: true if the parameter was retrieved successfully.

Parameters

Type	Name	Description
System.Int32	index	The index of the parameter to retrieve.
System.Int32	value	The value of the parameter.

TryGetStringParameter(int, out ReadOnlySeString)

Retrieves the value of a parameter for the log message if it is a string.

Declaration

bool TryGetStringParameter(int index, out ReadOnlySeString value)

Returns

System.Boolean: true if the parameter was retrieved successfully.

Parameters

Type	Name	Description
System.Int32	index	The index of the parameter to retrieve.
Lumina.Text.ReadOnly.ReadOnlySeString	value	The value of the parameter.

FormatLogMessageForDebugging()

Formats this log message into an approximation of the string that will eventually be shown in the log.

Declaration

ReadOnlySeString FormatLogMessageForDebugging()

Returns

Lumina.Text.ReadOnly.ReadOnlySeString: The formatted string.

Remarks

This can cause side effects such as playing sound effects and thus should only be used for debugging.