C_PvP.IsWarModeDesired

Main Menu
WoW API Lua API FrameXML Widget API Widget scripts XML schema Events CVars Macro commands Combat Log Escape sequences Hyperlinks API changes HOWTOs wowuidev

Flavors
war within  mainline
Links
Blizzard Docs  Townlong Yak  Offline /api  GitHub Search
Info
Added in 8.0.1

Indicates whether the player has opted into War Mode beginning with Battle for Azeroth, regardless if the player is in an outdoor zone where such PvP is actually possible.

warModeDesired = C_PvP.IsWarModeDesired()

Returns

warModeDesired

boolean - True if the player has turned war mode on; false otherwise.

Example

The following example is adpated from FrameXML/PartyMemberFrame.lua^[1]

for i=1, 4                                  
	local unit = "party"..i
	if UnitExists(unit) then                   
		if UnitInPhase(unit) then                
			print(string.format("Party member %d: Currently in phase!", i))
		else
			if UnitIsWarModePhased(unit) then
				if C_PvP.IsWarModeDesired() then    
					print(string.format("Party member &d: %s",i, PARTY_PLAYER_WARMODE_DISABLED))
				else
					print(string.format("Party member &d: %s",i, PARTY_PLAYER_WARMODE_ENABLED))
				end
			else
				print(string.format("Party member &d: %s",i, PARTY_PHASED_MESSAGE))
			end
		end
	end
end

Patch changes

Patch 8.0.1 (2018-07-17): Added.

See also

• GetPVPDesired()