Platform.casting.GetUnitCastObservation

调用方式

addon.Platform:GetUnitCastObservation(unit, kind)

可直接通过 addon 使用，无需依赖项。

作用

在探测或受限策略客户端上观测单位的施法或引导。已知不存在的单位或可读的非活动结果返回 active=false。活动记录包含 name，或在名称为机密时包含 nameReason（单位仍在施法），以及可独立获取的 remainingSeconds、durationSeconds、interruptible 和 spellID 字段；可选字段不可用时附带 remainingReason、durationReason、interruptibleReason 或 spellReason。存在性观测缺失、失败或受限时返回 nil 及原因。

参数

名称	类型	作用
`self`	`RMPlatform`	Rotation Master 平台适配器（使用冒号调用时隐含传入）。
`unit`	`string`	要观测其当前施法或引导的单位标识。
`kind`	`string`	观测种类：cast 或 channel。它们使用原生可打断元组中的不同位置。

返回值

1	`table \| nil`	新读取的可读记录，包含 active，然后是 name 或 nameReason、remainingSeconds、durationSeconds、interruptible 和 spellID。剩余时间和持续时间以秒为单位；剩余时间最低为零。不可用的可选字段有其自身的原因；它不会使活动记录失效。
2	`string \| nil`	整个观测不可用时的可用性或查询验证原因。

版本

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

该版本不可用（原因见提示）
仅在暴雪的弃用兼容层开启时

游戏 API
`UnitCastingInfo`
`UnitChannelInfo`
`UnitExists`

秘密值（正式服和永久服）

在正式服和永久服上，游戏交给插件的是秘密值。此辅助函数会检查它读取的内容（addon.Platform:CanReadValue），遇到无法比较的秘密值时返回 nil 并附上原因（例如 restricted-value），而不是返回该秘密值。请将 nil 视为不可用，而不是假。

示例

local cast = addon.Platform:GetUnitCastObservation("target", "cast")
if not cast then return nil end
if not cast.active then return false end
if cast.interruptible == nil or cast.remainingSeconds == nil then return nil end
return cast.interruptible and cast.remainingSeconds > 0.5

依赖项

durationSeconds → Platform.casting.durationSeconds
interruptibility → Platform.casting.interruptibility
remainingSeconds → Platform.casting.remainingSeconds
spellIdentity → Platform.casting.spellIdentity

源码

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

Platform.casting.GetUnitCastObservation(self, unit, kind)

    local policy=self:GetCombatDataPolicy()
    if policy~='probe' and policy~='restricted' then return nil,'unsupported-policy' end
    if not self:CanReadValue(unit) or not self:CanReadValue(kind) then return nil,'restricted-value' end
    if type(unit)~='string' or unit=='' then return nil,'invalid-unit' end
    if kind~='cast' and kind~='channel' then return nil,'invalid-cast-query' end
    if type(UnitExists)~='function' then return nil,'missing-api' end
    local existsOk,exists=pcall(UnitExists,unit)
    if not existsOk then return nil,'api-error' end
    if not self:CanReadValue(exists) then return nil,'restricted-value' end
    if exists==nil then return nil,'unit-data-unavailable' end
    if type(exists)~='boolean' then return nil,'invalid-api-result' end
    if not exists then return {active=false} end
    local fn
    if kind=='cast' then fn=UnitCastingInfo else fn=UnitChannelInfo end
    if type(fn)~='function' then return nil,'missing-api' end
    -- Capture into an owned tuple table without comparing native values. The
    -- channel flag is slot7; casting includes castID and uses slot8 instead,
    -- so the spell ID is slot9 for a cast and slot8 for a channel.
    local ok,tuple=pcall(function() return {fn(unit)} end)
    if not ok then return nil,'api-error' end
    local name=tuple[1]
    local record
    if not self:CanReadValue(name) then
        -- Retail and Forever make cast fields secret for a unit other than the
        -- player or pet unless the spell is flagged never secret
        -- (SecretWhenUnitSpellCastRestricted). A secret is a value, never nil:
        -- the unit is casting, and only the name is hidden.
        record={active=true,nameReason='restricted-value'}
    else
        if name==nil then return {active=false} end
        if type(name)~='string' or name=='' then return nil,'invalid-api-result' end
        record={active=true,name=name}
    end
    record.remainingSeconds,record.remainingReason=remainingSeconds(tuple[5])
    record.durationSeconds,record.durationReason=durationSeconds(tuple[4],tuple[5])
    record.interruptible,record.interruptibleReason=interruptibility(tuple[kind=='cast' and 8 or 7])
    record.spellID,record.spellReason=spellIdentity(tuple[kind=='cast' and 9 or 8])
    return record

返回函数参考