API:IsWarBandActive

UI Lua API · Group functions
Version: WAR 1.4.8

Returns whether the player is in a warband.

active = IsWarBandActive()

Arguments

None.

Returns

active

boolean – true if the client's warband data is in use. Nothing if the client has no warband data object.

Details

• The value is read from the client's warband data; nothing is requested from the server.
• The stock UI uses it to choose between party and warband handling, for example in PartyUtils.OnSummonPlayer and in the group window, which hides its party member frames while a warband is active.

Errors

None.

Example

From default/easystem_utils/source/partyutils.lua:

if( IsWarBandActive() )
then
    local partyIndex, memberIndex = PartyUtils.IsPlayerInWarband( playerToSummon )
    player = PartyUtils.GetWarbandMember( partyIndex, memberIndex )
else
    local party = PartyUtils.GetPartyData()
    ...
end

See also

• GetBattlegroupMemberData
• IsPlayerSolo