API:SendOpenPartySearchRequest

UI Lua API · Social functions
Version: WAR 1.4.8

Asks the server for the open parties and warbands near the player.

SendOpenPartySearchRequest(requestType)

Arguments

requestType: number – A GameData.OpenPartyRequestType value. The stock UI uses ALL for the full list and ALL_BRIEF when the player enters a new influence area. Sent as an 8-bit value.

Returns

Nothing.

Details

The detailed results are read with GetOpenPartyFullList; the stock UI rebuilds its list when SystemData.Events.SOCIAL_OPENPARTY_UPDATED fires.
If there is no player object, or the Lua state is not available, nothing is sent.

Errors

None besides the generic Invalid Parameters message when the argument is missing or not a number.

Example

From default/ea_openpartywindow/source/openpartywindowtabnearby.lua:

function EA_Window_OpenPartyNearby.RequestUpdateFullList()
    if (EA_Window_OpenPartyNearby.RequestDelay == 0)
    then
        SendOpenPartySearchRequest( GameData.OpenPartyRequestType.ALL )
        EA_Window_OpenPartyNearby.RequestDelay = EA_Window_OpenPartyNearby.REFRESH_DELAY_TIMER
    end
end

Return of Reckoning