Interface IChatGui
This class handles interacting with the native chat UI.
Assembly: Dalamud.dll
View Source
public interface IChatGui
Properties
LastLinkedItemId
Gets the ID of the last linked item.
View Source
int LastLinkedItemId { get; }
LastLinkedItemFlags
Gets the flags of the last linked item.
View Source
byte LastLinkedItemFlags { get; }
RegisteredLinkHandlers
Gets the dictionary of Dalamud Link Handlers.
View Source
IReadOnlyDictionary<(string PluginName, uint CommandId), Action<uint, SeString>> RegisteredLinkHandlers { get; }
Methods
Print(XivChatEntry)
Queue a chat message. Dalamud will send queued messages on the next framework event.
View Source
void Print(XivChatEntry chat)
Parameters
| Type | Name | Description |
|---|---|---|
| Dalamud.Game.Text.XivChatEntry | chat | A message to send. |
Print(string, string?, ushort?)
Queue a chat message. Dalamud will send queued messages on the next framework event.
View Source
void Print(string message, string? messageTag = null, ushort? tagColor = null)
Parameters
| Type | Name | Description |
|---|---|---|
System.String | message | A message to send. |
System.String | messageTag | String to prepend message with "[messageTag] ". |
System.Nullable<System.UInt16> | tagColor | Color to display the message tag with. |
Print(SeString, string?, ushort?)
Queue a chat message. Dalamud will send queued messages on the next framework event.
View Source
void Print(SeString message, string? messageTag = null, ushort? tagColor = null)
Parameters
| Type | Name | Description |
|---|---|---|
| Dalamud.Game.Text.SeStringHandling.SeString | message | A message to send. |
System.String | messageTag | String to prepend message with "[messageTag] ". |
System.Nullable<System.UInt16> | tagColor | Color to display the message tag with. |
PrintError(string, string?, ushort?)
Queue a chat message. Dalamud will send queued messages on the next framework event.
View Source
void PrintError(string message, string? messageTag = null, ushort? tagColor = null)
Parameters
| Type | Name | Description |
|---|---|---|
System.String | message | A message to send. |
System.String | messageTag | String to prepend message with "[messageTag] ". |
System.Nullable<System.UInt16> | tagColor | Color to display the message tag with. |
PrintError(SeString, string?, ushort?)
Queue a chat message. Dalamud will send queued messages on the next framework event.
View Source
void PrintError(SeString message, string? messageTag = null, ushort? tagColor = null)
Parameters
| Type | Name | Description |
|---|---|---|
| Dalamud.Game.Text.SeStringHandling.SeString | message | A message to send. |
System.String | messageTag | String to prepend message with "[messageTag] ". |
System.Nullable<System.UInt16> | tagColor | Color to display the message tag with. |
Events
ChatMessage
Event that will be fired when a chat message is sent to chat by the game.
View Source
event IChatGui.OnMessageDelegate ChatMessage
Event Type
Dalamud.Plugin.Services.IChatGui.OnMessageDelegate
CheckMessageHandled
Event that allows you to stop messages from appearing in chat by setting the isHandled parameter to true.
View Source
event IChatGui.OnCheckMessageHandledDelegate CheckMessageHandled
Event Type
Dalamud.Plugin.Services.IChatGui.OnCheckMessageHandledDelegate
ChatMessageHandled
Event that will be fired when a chat message is handled by Dalamud or a Plugin.
View Source
event IChatGui.OnMessageHandledDelegate ChatMessageHandled
Event Type
Dalamud.Plugin.Services.IChatGui.OnMessageHandledDelegate
ChatMessageUnhandled
Event that will be fired when a chat message is not handled by Dalamud or a Plugin.
View Source
event IChatGui.OnMessageUnhandledDelegate ChatMessageUnhandled