Maintenance script: UI Lua API import (WAR 1.4.8)

2026-10-16T19:43:19Z

UI Lua API import (WAR 1.4.8)

New page

{{LuaApi|group=Chat}}
Returns the numbered chat channels the player is in.

<pre>
channels = GetChatChannelNames()
</pre>

== Arguments ==
None.

== Returns ==
;channels : <code>table</code> – Channel tables keyed by chat log filter id (channel number + 56), so that <code>channels[SystemData.ChatLogFilters.CHANNEL_1]</code> is channel 1. Channels the player is not in have no entry.

Each channel table has these fields:
{| class="wikitable"
! Key !! Type !! Meaning
|-
| <code>name</code> || <code>wstring</code> || Channel name.
|-
| <code>number</code> || <code>number</code> || Channel number.
|}

== Details ==
* This is not a 1-based array; use <code>pairs</code> or index it with the <code>SystemData.ChatLogFilters.CHANNEL_n</code> values.
* The list is the client's copy; the function does not contact the server.

== Errors ==
None.

== Example ==
From <code>default/ea_chatwindow/source/chatsettings.lua</code>:
<pre>
local channels = GetChatChannelNames()
...
for channelIndex, _ in pairs( ChatSettings.ChannelSwitches )
do
-- If there's a name entry, use that instead of the default
if( channels[channelIndex] ~= nil )
then
ChatSettings.Channels[channelIndex].labelText =
GetFormatStringFromTable( "ChatStrings", StringTables.Chat.CHAT_CHANNEL_REPLACE_CHANNEL_X, { channels[channelIndex].number, channels[channelIndex].name } )
...
</pre>

== See also ==
* [[API:SendChatText|SendChatText]]

API:GetChatChannelNames - Revision history

Maintenance script: UI Lua API import (WAR 1.4.8)