Maintenance script: UI Lua API import (WAR 1.4.8)

2026-10-16T19:44:38Z

UI Lua API import (WAR 1.4.8)

New page

{{LuaApi|group=Social}}
Returns the short list of open parties and warbands that the server last announced to the player.

<pre>
parties = GetOpenPartyNotificationList()
</pre>

== Arguments ==
None.

== Returns ==
;parties : <code>table</code> – Array of party tables, indexed from 1. Empty if there are none.

Each party table has these fields:
{| class="wikitable"
! Key !! Type !! Meaning
|-
| <code>leaderName</code> || <code>wstring</code> || Name of the party leader.
|-
| <code>numGroupMembers</code> || <code>number</code> || Number of members.
|-
| <code>isWarband</code> || <code>boolean</code> || <code>true</code> for a warband, <code>false</code> for a party.
|}

== Details ==
* The list is the client's copy; the function does not contact the server. The stock UI reads it in its handler for <code>SystemData.Events.SOCIAL_OPENPARTY_NOTIFY</code>.
* For the full details of nearby parties use [[API:GetOpenPartyFullList|GetOpenPartyFullList]].
* A new table is built on every call.

== Errors ==
None.

== Example ==
From <code>default/ea_openpartywindow/source/openpartywindow.lua</code>:
<pre>
function EA_Window_OpenParty.OnOpenPartyNotification()

local openPartyAvailable = GetOpenPartyNotificationList()
...
-- If there's nothing in the list, tell the user nothing was found
if( #openPartyAvailable <= 0 )
then
LabelSetText( FLY_OUT_WINDOW.."Header", GetStringFromTable( "SocialStrings", StringTables.Social.LABEL_SOCIAL_HEADER_NOOPENPARTY ) )
...
</pre>

== See also ==
* [[API:GetOpenPartyFullList|GetOpenPartyFullList]]
* [[API:SendOpenPartySearchRequest|SendOpenPartySearchRequest]]

API:GetOpenPartyNotificationList - Revision history

Maintenance script: UI Lua API import (WAR 1.4.8)