API:GetOpenPartyWorldList

UI Lua API · Social functions
Version: WAR 1.4.8

Returns the open parties and warbands found by the last world-wide open party search.

parties = GetOpenPartyWorldList()

Arguments

None.

Returns

parties

table – Array of party tables, indexed from 1. Empty if there are no results.

Each party table has these fields:

Key	Type	Meaning
leaderName	wstring	Name of the party leader.
objectiveName	wstring	–
partyNote	wstring	Note set by the party.
isWarband	boolean	true for a warband, false for a party.
locationType	number	–
leaderCareerString	wstring	Career name of the leader.
leaderLevel	number	Level of the leader.
leaderCareer	number	Career id of the leader.
leaderZone	number	Zone id where the leader is.
isOpen	boolean	–
tier	number	Tier.
specificInterest1 … specificInterest4	number	The party's four specific interests (zone, scenario or dungeon ids), as set with SetOpenPartyWorldInterests.
numGroupMembers	number	Number of members.
Group	table	Array of member tables, see below.

Each entry of Group has these fields:

Key	Type	Meaning
m_memberName	wstring	Member name.
m_locationType	number	–
m_level	number	Member level.
m_careerID	number	Career id of the member.

Details

• The list is the client's copy of the last search result. Use SendOpenPartyWorldSearch to request a new one. The stock UI rebuilds its list when SystemData.Events.SOCIAL_OPENPARTY_WORLD_UPDATED fires.
• numGroupMembers and the number of entries in Group come from two separate values in the server data.
• A new table is built on every call.

Errors

None.

Example

From default/ea_openpartywindow/source/openpartywindowtabworld.lua:

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
    ...

Walking the members, from the same file:

for _, groupMember in ipairs( data.Group )
...
    data.containsFriend = ( SocialWindowTabFriends and SocialWindowTabFriends.IsPlayerFriend( groupMember.m_memberName ) )

See also

• SendOpenPartyWorldSearch
• SetOpenPartyWorldInterests
• GetOpenPartyFullList