Members

static chat.channelContainerTemplate :string

code/chat.js, line 29

Template of a channel message container appended to the chat panel.

static chat.channelTabTemplate :string

code/chat.js, line 21

Template of a channel tab link shown in the chat controls.

static chat.channels :Array.<ChannelDescription>

code/chat.js, line 154

Holds channels infos.

Methods

static chat.addChannel(channelDesc)

code/chat.js, line 435

Add to the channel list a new channel description

If tabs are already created, a tab is created for this channel as well

Parameters:

Name	Type	Description
channelDesc	ChannelDescription	channel description

static chat.addNickname(nick)

code/chat.js, line 41

Adds a nickname to the chat input.

Parameters:

Name	Type	Description
nick	string	The nickname to add.

static chat.backgroundChannelData(instance, channel, flag)

code/chat.js, line 187

Allows plugins to request and monitor COMM data streams in the background. This is useful for plugins that need to process COMM data even when the user is not actively viewing the COMM channels. It tracks the requested channels for each plugin instance and updates the global state accordingly.

Parameters:

Name	Type	Description
instance	string	A unique identifier for the plugin or instance requesting background COMM data.
channel	string	The name of the COMM channel ('all', 'faction', or 'alerts').
flag	boolean	Set to true to request data for the specified channel, false to stop requesting.

static chat.channelState(el) → {Object}

code/chat.js, line 84

Returns the per-channel-element UI flag store for the given channel DOM element. The native WeakMap store is the source of truth, but writes are mirrored into $(el).data(key) and reads fall back to it, so legacy plugins that access these flags via jQuery .data() keep working.

Parameters:

Name	Type	Description
el	HTMLElement	The channel DOM element.

Returns:

Object -

A proxy exposing the element's UI flags.

static chat.chooseTab(tab)

code/chat.js, line 249

Chooses and activates a specified chat tab. Also triggers an early refresh of the chat data when switching tabs.

Parameters:

Name	Type	Description
tab	string	The name of the chat tab to activate ('all', 'faction', or 'alerts').

static chat.chooser(event)

code/chat.js, line 348

Chat tab chooser handler. This function is triggered by a click event on the chat tab. It reads the tab name from the event target and activates the corresponding chat tab.

Parameters:

Name	Type	Description
event	Event	The event triggered by clicking a chat tab.

static chat.getActive() → {string}

code/chat.js, line 162

Gets the name of the active chat tab.

Returns:

string -

The name of the active chat tab.

static chat.getChannelDesc(tab) → {ChannelDescription}

code/chat.js, line 173

Converts a chat tab name to its corresponding channel object.

Parameters:

Name	Type	Description
tab	string	The name of the chat tab.

Returns:

ChannelDescription -

The corresponding channel name ('faction', 'alerts', or 'all').

static chat.handleTabCompletion()

code/chat.js, line 611

Handles tab completion in chat input.

static chat.keepScrollPosition(box, scrollBefore, isOldMsgs)

code/chat.js, line 368

Maintains the scroll position of a chat box when new messages are added. This function is designed to keep the scroll position fixed when old messages are loaded, and to automatically scroll to the bottom when new messages are added if the user is already at the bottom of the chat.

Parameters:

Name	Type	Description
box	HTMLElement | jQuery	The chat box element (a jQuery object is also accepted for legacy callers).
scrollBefore	number	The scroll position before new messages were added.
isOldMsgs	boolean	Indicates if the added messages are older messages.

static chat.needMoreMessages()

code/chat.js, line 227

Checks if the currently selected chat tab needs more messages. This function is triggered by scroll events and loads older messages when the user scrolls to the top.

static chat.nicknameClicked(event, nickname) → {boolean}

code/chat.js, line 55

Handles click events on nicknames in the chat.

Parameters:

Name	Type	Description
event	Event	The click event.
nickname	string	The clicked nickname.

Returns:

boolean -

Always returns false.

static chat.postMsg()

code/chat.js, line 655

Posts a chat message to the currently active chat tab.

static chat.renderAlerts(oldMsgsWereAdded)

code/chat.js, line 538

Renders alerts chat in the UI.

Parameters:

Name	Type	Description
oldMsgsWereAdded	boolean	Indicates if older messages were added to the chat.

static chat.renderFaction(oldMsgsWereAdded)

code/chat.js, line 528

Renders faction chat.

Parameters:

Name	Type	Description
oldMsgsWereAdded	boolean	Indicates if old messages were added in the current rendering.

static chat.renderMsg(msg, nick, time, team, msgToPlayer, systemNarrowcast) → {string}

code/chat.js, line 714

Legacy function for rendering chat messages. Used for backward compatibility with plugins.

Parameters:

Name	Type	Description
msg	string	The chat message.
nick	string	The nickname of the player who sent the message.
time	number	The timestamp of the message.
team	string	The team of the player who sent the message.
msgToPlayer	boolean	Flag indicating if the message is directed to the player.
systemNarrowcast	boolean	Flag indicating if the message is a system narrowcast.

Returns:

string -

The HTML string representing a chat message row.

Deprecated:

• Yes

static chat.renderPublic(oldMsgsWereAdded)

code/chat.js, line 518

Renders public chat in the UI.

Parameters:

Name	Type	Description
oldMsgsWereAdded	boolean	Indicates if older messages were added to the chat.

static chat.request()

code/chat.js, line 212

Requests chat messages for the currently active chat tab and background channels. It calls the appropriate request function based on the active tab or background channels.

static chat.requestAlerts(getOlderMsgs, isRetryopt)

code/chat.js, line 508

Initiates a request for alerts chat data.

Parameters:

Name	Type	Attributes	Default	Description
getOlderMsgs	boolean			Whether to retrieve older messages.
isRetry	boolean	<optional>	false	Whether the request is a retry.

static chat.requestFaction(getOlderMsgs, isRetryopt)

code/chat.js, line 497

Requests faction chat messages.

Parameters:

Name	Type	Attributes	Default	Description
getOlderMsgs	boolean			Flag to determine if older messages are being requested.
isRetry	boolean	<optional>	false	Flag to indicate if this is a retry attempt.

static chat.requestPublic(getOlderMsgs, isRetryopt)

code/chat.js, line 486

Initiates a request for public chat data.

Parameters:

Name	Type	Attributes	Default	Description
getOlderMsgs	boolean			Whether to retrieve older messages.
isRetry	boolean	<optional>	false	Whether the request is a retry.

static chat.setup()

code/chat.js, line 548

Sets up the chat interface.

static chat.setupPosting()

code/chat.js, line 674

Sets up the chat message posting functionality.

static chat.setupTabs()

code/chat.js, line 463

Sets up all channels starting from intel COMM

static chat.setupTime()

code/chat.js, line 585

Sets up the time display in the chat input box. This function updates the time displayed next to the chat input field every minute to reflect the current time.

static chat.show(name)

code/chat.js, line 328

Displays the chat interface and activates a specified chat tab.

Parameters:

Name	Type	Description
name	string	The name of the chat tab to show and activate.

static chat.tabToChannel(tab) → {string}

code/chat.js, line 749

Legacy function for converts a chat tab name to its corresponding COMM channel name. Used for backward compatibility with plugins.

Parameters:

Name	Type	Description
tab	string	The name of the chat tab.

Returns:

string -

The corresponding channel name ('faction', 'alerts', or 'all').

Deprecated:

• Yes

static chat.toggle()

code/chat.js, line 298

Toggles the chat window between expanded and collapsed states. When expanded, the chat window covers a larger area of the screen. This function also ensures that the chat is scrolled to the bottom when collapsed.