VuhDo Custom Flag Bouquet Validators

Custom flags are bouquet validators which accept a user defined anonymous function that returns a boolean value. This allows for any custom condition to be used as part of the evaluation of a bouquet's chain of validators. These custom flag validators can be any valid Lua snippet which returns true or false.

Table of Contents

• Table of Contents
• Accessing Unit Information
  • Example 1
• Checking for an Aura (Midnight)
  • Example 2
  • Example 3
• Deprecated: Debuff Icon and HoT Icon APIs
• Secret Values (Midnight)
• More Examples
• Unit Information Table Schema

Accessing Unit Information

The VUHDO_unitInfo table provides the relevant cached information on the subject unit to the anonymous function.

The simple example below returns true if the unit is named 'Ivaria':

return ("Ivaria" == VUHDO_unitInfo["name"])

Full details on the unit information available in the VUHDO_unitInfo table can be found below.

Example 1

The following is a more complicated example which returns true only if the player's spell 'Prayer of Mending' is off cooldown and the unit is below 90% health:

return  ((VUHDO_getSpellCooldown("Prayer of Mending") == 0) and ((VUHDO_unitInfo["health"] / VUHDO_unitInfo["healthmax"]) < 0.9)) and true or false;

Checking for an Aura (Midnight)

As of VuhDo for Midnight, aura presence for custom flags is resolved through VuhDo's aura cache (VUHDO_UNIT_AURA_CACHE). Only auras that VuhDo is already configured to track (for example via bouquets, aura groups, or panel aura displays) are present in this cache. If a spell is not tracked, these APIs will not find it even if the unit has the aura in game.

VUHDO_hasUnitAura(unit, spell, filter)

Returns true if the unit has a cached aura matching spell (spell name string or spell ID number). Optional third argument filter:

• "HARMFUL" — only harmful (debuff) auras
• "HELPFUL" — only helpful (buff) auras
• omitted or nil — any cached aura matching the spell

Spell IDs may be passed as numbers or as numeric strings (e.g. "12345").

return VUHDO_hasUnitAura(VUHDO_unitInfo["unit"], "Penetrating Cold", "HARMFUL") or false;

return VUHDO_hasUnitAura(VUHDO_unitInfo["unit"], 123456, "HELPFUL") or false;

VUHDO_getUnitAura(unit, spell, filter)

Returns the cached aura entry table for the first matching aura, or nil if none. The same spell and filter rules as VUHDO_hasUnitAura apply. This is the same table VuhDo uses internally; treat it as read-only (do not assign into it from custom flags).

Typical keys (values may be Midnight secret values; see below):

Example 2

Returns true only if the unit is marked with raid icon 'Green Triangle' (index 4) and has a cached harmful aura named 'Penetrating Cold':

return VUHDO_unitInfo["raidIcon"] == 4 and VUHDO_hasUnitAura(VUHDO_unitInfo["unit"], "Penetrating Cold", "HARMFUL") or false;

Example 3

Returns true only if the unit has a cached helpful aura for 'Atonement' on the player:

return VUHDO_hasUnitAura(VUHDO_unitInfo["unit"], "Atonement", "HELPFUL") or false;

Use VUHDO_getUnitAura when you need stacks or timing. Use issecretvalue() before comparing or doing arithmetic on numeric fields:

local tAura = VUHDO_getUnitAura(VUHDO_unitInfo["unit"], "Renew", "HELPFUL");
local tStacks = tAura and tAura["applications"];
return tStacks and not issecretvalue(tStacks) and tStacks >= 3 or false;

Deprecated: Debuff Icon and HoT Icon APIs

Older documentation referred to:

• VUHDO_hasUnitDebuff(unit, spell) — tied to the legacy Debuff Icon system
• VUHDO_hasUnitHot(unit, spellName[, sourceType]) — tied to the legacy HoT Icon system

These functions still exist for backward compatibility but are implemented as thin wrappers around the Midnight aura cache:

• VUHDO_hasUnitDebuff is equivalent to VUHDO_hasUnitAura(unit, spell, "HARMFUL")
• VUHDO_hasUnitHot is equivalent to VUHDO_hasUnitAura(unit, spellName, "HELPFUL") (the old sourceType argument is ignored)

New custom flags should prefer VUHDO_hasUnitAura / VUHDO_getUnitAura directly.

Secret Values (Midnight)

Some aura-related values may be secret in Midnight. Custom flag code must use issecretvalue() (and avoid native comparisons or arithmetic on secret values) when reading fields from the table returned by VUHDO_getUnitAura.

More Examples

More example bouquets using custom flags of various kinds can be found via Ivaria's profile on wago.io. Note that older examples may need updating to use the Midnight aura APIs above.

Unit Information Table Schema

Unit information (VUHDO_unitInfo table):