Maintenance script: UI Lua API import (WAR 1.4.8)

2026-10-16T19:43:44Z

UI Lua API import (WAR 1.4.8)

New page

{{LuaApi|group=Social}}
Returns the player's friends list.

<pre>
friends = GetFriendsList()
</pre>

== Arguments ==
None.

== Returns ==
;friends : <code>table</code> – Array of friend tables, indexed from 1. Empty if the list is empty.

Each friend table has these fields:
{| class="wikitable"
! Key !! Type !! Meaning
|-
| <code>name</code> || <code>wstring</code> || Character name.
|-
| <code>rank</code> || <code>number</code> || Character rank (level).
|-
| <code>careerID</code> || <code>number</code> || Career id.
|-
| <code>careerName</code> || <code>wstring</code> || Career name. The stock UI treats <code>L""</code> as "details unknown" and hides the rank.
|-
| <code>zoneID</code> || <code>number</code> || Zone the friend is in. The stock UI treats 0 as offline.
|-
| <code>guildName</code> || <code>wstring</code> || Guild name.
|}

== Details ==
* The list is the client's copy; the function does not contact the server.
* [[API:GetIgnoreList|GetIgnoreList]] returns the same fields for the ignore list.
* A new table is built on every call.

== Errors ==
None.

== Example ==
From <code>default/ea_socialwindow/source/socialwindowbuddylisttabfriends.lua</code>:
<pre>
local FriendsListData = GetFriendsList()

if ( FriendsListData ~= nil ) then
for key, value in ipairs( FriendsListData ) do
-- These should match the data that was retrived from war_interface::LuaGetFriendsList
SocialWindowBuddyListTabFriends.playerListData[key] = {}
SocialWindowBuddyListTabFriends.playerListData[key].name = value.name
SocialWindowBuddyListTabFriends.playerListData[key].friendType = FRIENDTYPE.FRIENDED
SocialWindowBuddyListTabFriends.playerListData[key].isOnline = ( value.zoneID ~= 0 )
...
</pre>

== See also ==
* [[API:GetIgnoreList|GetIgnoreList]]
* [[API:GetSearchList|GetSearchList]]

API:GetFriendsList - Revision history

Maintenance script: UI Lua API import (WAR 1.4.8)