account

This library provides data and events related to account information.

local account = require('account')

❗ Dependency Required

To use this library, you must include account in the manifest.xml file for your package:

<dependency>account</dependency>

Tables

The account table has the following entries:

• account.login : An event that triggers when logging in.
• account.logout : An event that triggers when logging out.
• account.logged_in : Boolean that specifies whether the user is currently logged into an account.
• account.name : The name of the current account.
• account.server : The server ID of the current account.
• account.server_name : The server name of the current account.
• account.id : The id of the current account.

---

account.login

This event is triggered when logging into a FFXI character

Definition

account.login : event

Event Parameters

This event does not receive any parameters.

account.logout

This event is triggered when logging out of a FFXI character

Definition

account.logout : event

Event Parameters

This event does not receive any parameters.

Data Entries

account.logged_in boolean

Whether or not the player is currently logged in.

account.name string

The name of the currently logged in character.

account.id integer

The ID of the currently logged in character.

account.server integer

The ID of the server currently logged in to.

account.server_name string

The name of the server currently logged in to. nil if the server is unknown.