Conditions.bossmod.encounterNote

Call as

Conditions.bossmod.encounterNote()

Record the dependency Conditions.bossmod.encounterNote, then call it by that name. A namespaced call does not pass self: use a colon call or pass the object yourself.

What it does

Builds the status line the boss-mod condition editors show about the current encounter. Reads addon:GetBossModEncounter and reports the encounter name, ID and stage, that no encounter is in progress, or why boss-mod data is unavailable (adapter-unavailable when the adapter API is missing).

Arguments

None.

Returns

Editions

Built In helpers are registered on every edition. What differs is the game API they read; where one is missing the helper falls back or returns nil with a reason.

It reads no game API directly.

How the addon calls it

• Boss Mod Encounter (widget)

  note(parent, encounterNote())

• Boss Mod Encounter Stage (widget)

  note(parent, encounterNote())

Source

Conditions/bossmod.lua, line 97. Read only in game; Duplicate makes an editable copy.

    if type(addon.GetBossModEncounter) ~= "function" then return string.format(L["Boss mod data unavailable: %s"], "adapter-unavailable") end
    local active, id, stage, detail = addon:GetBossModEncounter()
    if active == nil then return string.format(L["Boss mod data unavailable: %s"], tostring(detail or "unknown")) end
    if not active then return L["No boss-mod encounter is in progress."] end
    return string.format(L["Current encounter: %s (ID %s), stage %s"], detail or L["Unknown"], id and tostring(id) or L["none"], tostring(stage))