Conditions.bossmod.encounterNote

调用方式

Conditions.bossmod.encounterNote()

记录依赖项 Conditions.bossmod.encounterNote，然后按该名称调用。带命名空间的调用不会传入 self：请使用冒号调用，或自行传入该对象。

作用

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).

参数

无。

返回值

版本

内置辅助函数在每个版本上都会注册。不同的是它们读取的游戏 API；某个 API 缺失时，辅助函数会改用后备方案，或返回 nil 并附上原因。

它不直接读取任何游戏 API。

插件如何调用它

• 首领模块首领战 (widget)

  note(parent, encounterNote())

• 首领模块首领战阶段 (widget)

  note(parent, encounterNote())

源码

Conditions/bossmod.lua，第 97 行。在游戏中为只读；“复制”会生成一份可编辑的副本。

    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))