Maintenance script: UI Lua API import (WAR 1.4.8)

2026-10-16T19:44:39Z

UI Lua API import (WAR 1.4.8)

New page

{{LuaApi|group=Social}}
Returns the open parties and warbands found by the last world-wide open party search.

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

== Arguments ==
None.

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

Each party table has these fields:
{| class="wikitable"
! Key !! Type !! Meaning
|-
| <code>leaderName</code> || <code>wstring</code> || Name of the party leader.
|-
| <code>objectiveName</code> || <code>wstring</code> || –
|-
| <code>partyNote</code> || <code>wstring</code> || Note set by the party.
|-
| <code>isWarband</code> || <code>boolean</code> || <code>true</code> for a warband, <code>false</code> for a party.
|-
| <code>locationType</code> || <code>number</code> || –
|-
| <code>leaderCareerString</code> || <code>wstring</code> || Career name of the leader.
|-
| <code>leaderLevel</code> || <code>number</code> || Level of the leader.
|-
| <code>leaderCareer</code> || <code>number</code> || Career id of the leader.
|-
| <code>leaderZone</code> || <code>number</code> || Zone id where the leader is.
|-
| <code>isOpen</code> || <code>boolean</code> || –
|-
| <code>tier</code> || <code>number</code> || Tier.
|-
| <code>specificInterest1</code> … <code>specificInterest4</code> || <code>number</code> || The party's four specific interests (zone, scenario or dungeon ids), as set with [[API:SetOpenPartyWorldInterests|SetOpenPartyWorldInterests]].
|-
| <code>numGroupMembers</code> || <code>number</code> || Number of members.
|-
| <code>Group</code> || <code>table</code> || Array of member tables, see below.
|}

Each entry of <code>Group</code> has these fields:
{| class="wikitable"
! Key !! Type !! Meaning
|-
| <code>m_memberName</code> || <code>wstring</code> || Member name.
|-
| <code>m_locationType</code> || <code>number</code> || –
|-
| <code>m_level</code> || <code>number</code> || Member level.
|-
| <code>m_careerID</code> || <code>number</code> || Career id of the member.
|}

== Details ==
* The list is the client's copy of the last search result. Use [[API:SendOpenPartyWorldSearch|SendOpenPartyWorldSearch]] to request a new one. The stock UI rebuilds its list when <code>SystemData.Events.SOCIAL_OPENPARTY_WORLD_UPDATED</code> fires.
* <code>numGroupMembers</code> and the number of entries in <code>Group</code> come from two separate values in the server data.
* A new table is built on every call.

== Errors ==
None.

== Example ==
From <code>default/ea_openpartywindow/source/openpartywindowtabworld.lua</code>:
<pre>
EA_Window_OpenPartyWorld.PartyTable = GetOpenPartyWorldList()
...
for dataIndex, data in ipairs( EA_Window_OpenPartyWorld.PartyTable )
do
-- Don't add to list order (and thus hide) if this is a full warband
if data.isWarband and data.numGroupMembers >= EA_Window_OpenParty.TOTAL_NUM_WARBAND_MEMBERS
...
</pre>

Walking the members, from the same file:
<pre>
for _, groupMember in ipairs( data.Group )
...
data.containsFriend = ( SocialWindowTabFriends and SocialWindowTabFriends.IsPlayerFriend( groupMember.m_memberName ) )
</pre>

== See also ==
* [[API:SendOpenPartyWorldSearch|SendOpenPartyWorldSearch]]
* [[API:SetOpenPartyWorldInterests|SetOpenPartyWorldInterests]]
* [[API:GetOpenPartyFullList|GetOpenPartyFullList]]

API:GetOpenPartyWorldList - Revision history

Maintenance script: UI Lua API import (WAR 1.4.8)