API:IsShowingCloakHeraldry

UI Lua API · Appearance functions
Version: WAR 1.4.8

Returns whether the player has cloak heraldry display turned on.

showing = IsShowingCloakHeraldry()

Arguments

None.

Returns

showing

boolean – true if the cloak heraldry flag is set.

Details

• The value is one bit of a flag byte the client keeps for the player.
• The stock character window uses it to set up its "show cloak heraldry" check button, next to GetEquippedItemVisible for the helm and cloak.

Errors

None.

Example

From ea_characterwindow/source/characterwindow.lua:

local showHelm = GetEquippedItemVisible( GameData.EquipSlots.HELM )
local showCloak = GetEquippedItemVisible( GameData.EquipSlots.BACK )
local showCloakHeraldry = IsShowingCloakHeraldry()
CharacterWindow.OnVisibleEquipmentUpdated( showHelm, showCloak, showCloakHeraldry )

See also

• GetEquipmentData