Maintenance script: UI Lua API import (WAR 1.4.8)

2026-10-16T19:44:56Z

UI Lua API import (WAR 1.4.8)

New page

{{LuaApi|group=Social}}
Returns the players found by the last player search.

<pre>
players = GetSearchList()
</pre>

== Arguments ==
None.

== Returns ==
;players : <code>table</code> – Array of player tables, indexed from 1. Empty if there are no results.

Each player 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>career</code> || <code>wstring</code> || Career name.
|-
| <code>zoneID</code> || <code>number</code> || Zone the player is in. The stock UI treats 0 as offline or hidden.
|-
| <code>guildName</code> || <code>wstring</code> || Guild name.
|}

== Details ==
* The list is the client's copy of the last search result. Use [[API:SendPlayerSearchRequest|SendPlayerSearchRequest]] to request a new one.
* Unlike [[API:GetFriendsList|GetFriendsList]], the entries have no career id, only the career name in <code>career</code>.
* A new table is built on every call.

== Errors ==
None.

== Example ==
From <code>default/ea_socialwindow/source/socialwindowtabsearch.lua</code>:
<pre>
local SearchListData = GetSearchList()

if ( SearchListData ~= nil ) then
numberFound = #SearchListData
for key, value in ipairs( SearchListData ) do
-- These should match the data that was retrived from war_interface::LuaGetSearchList
SocialWindowTabSearch.playerListData[key] = {}
SocialWindowTabSearch.playerListData[key].name = value.name
SocialWindowTabSearch.playerListData[key].career = value.career
if ( value.zoneID ~= 0 ) then
SocialWindowTabSearch.playerListData[key].rankString = L""..value.rank
SocialWindowTabSearch.playerListData[key].location = GetZoneName( value.zoneID )
...
</pre>

== See also ==
* [[API:SendPlayerSearchRequest|SendPlayerSearchRequest]]
* [[API:GetFriendsList|GetFriendsList]]

API:GetSearchList - Revision history

Maintenance script: UI Lua API import (WAR 1.4.8)