API:GetOpenPartyFullList

UI Lua API · Social functions
Version: WAR 1.4.8

Returns the detailed list of nearby open parties and warbands from the last open party search.

parties = GetOpenPartyFullList()

Arguments

None.

Returns

parties: table – Array of party tables, indexed from 1. Empty if there are none.

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.
`timedDistance`	`number`	Distance to the party. The stock UI shows it as seconds, or minutes when 60 or more.
`locationType`	`number`	–
`leaderCareerString`	`wstring`	Career name of the leader.
`leaderLevel`	`number`	Level of the leader.
`leaderCareer`	`number`	Career id of the leader.
`influenceID`	`number`	–
`pvpAreaName`	`wstring`	Name of the area. The stock UI shows it as the objective in its tooltip.
`numGroupMembers`	`number`	Number of members.
`Group`	`table`	Only present when `numGroupMembers` is 2 or more. Array of member tables with `m_memberName` (`wstring`), `m_locationType` (`number`), `m_level` (`number`) and `m_careerID` (`number`).

Details

The list is the client's copy of the last search result. SendOpenPartySearchRequest asks for a new one; the stock UI rebuilds its list when SystemData.Events.SOCIAL_OPENPARTY_UPDATED fires.
Unlike GetOpenPartyWorldList, Group is missing for one-member parties. Check it for nil.
A new table is built on every call.

Errors

None.

Example

From default/ea_openpartywindow/source/openpartywindowtabnearby.lua:

local function InitOpenPartyListData()
    EA_Window_OpenPartyNearby.OpenPartyTable = {}
    EA_Window_OpenPartyNearby.OpenPartyTable = GetOpenPartyFullList()
    ...

Showing the distance, from the same file:

if( groupData.timedDistance >= 60 )
then
    LabelSetText( rowWindow.."TimedDistanceText", GetFormatStringFromTable( "SocialStrings",  StringTables.Social.LABEL_SOCIAL_TIMEDIST_MIN, { math.floor(groupData.timedDistance/60) } ) )

Return of Reckoning