chat

This library allows interactions with the chat log.

local chat = require('chat')

✔️ Dependency Not Required

This library does not require an explicit dependency in the manifest.xml file for your package.

Tables

The chat table has the following entries:

• chat.add_text : Adds text to the FFXI chat log.
• chat.text_added : An event that is triggered when text is added to the chat log.

---

chat.add_text

Outputs a line of text to the FFXI chat log.

Definition

function chat.add_text(text : string, type : number = 206, indent: boolean = false)

Parameters

text string

The text to output

type number [default: 206]

The type of line to output.

indent boolean [default: false]

Whether or not to indent the line of text.

Return

This function does not return any values.

chat.text_added

This event is triggered when a new line of text is being added to the chat log.

Definition

chat.text_added : event

Event Parameters

text string

The text being added

type number

The type of the line being added.

indent boolean

Whether or not the line of text is indented.

blocked boolean

Whether or not the line of text has been blocked.