参考 › 函数参考 › Platform

Platform.health_forecast.GetHealthForecastIdentityObservation

公共

调用方式

addon.Platform:GetHealthForecastIdentityObservation(unit)

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

作用

在探测或受限策略客户端上观测确切的 UnitExists(unit),然后仅对存在的单位观测 UnitGUID(unit)。已知不存在时为 false。存在的身份要求可读的非空 GUID;所需信息缺失、失败、格式错误或受限时为不可用。不会添加生命值、提供者或额外单位的观测。

参数

名称类型作用
selfRMPlatformRotation Master 平台适配器(使用冒号调用时隐含传入)。
unitstring所选的非空单位标识。

返回值

1string | boolean | nil存在时为 GUID;已知不存在时为 false,不可用时为 nil。
2string | nil策略、验证或观测的可用性原因。

版本

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

  • 该版本不可用(原因见提示)
  • 仅在暴雪的弃用兼容层开启时
游戏 API经典旧世TBC 周年版经典进阶服永久服正式服
UnitExists经典旧世TBC 周年版经典进阶服永久服正式服
UnitGUID经典旧世TBC 周年版经典进阶服永久服正式服
canaccessvalue经典旧世TBC 周年版经典进阶服永久服正式服

秘密值(正式服和永久服)

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

示例

local guid = addon.Platform:GetHealthForecastIdentityObservation("target")
-- false when there is no target, nil when unavailable
if not guid then return guid end
return guid:sub(1, 9) == "Creature-"

源码

Platform/health_forecast.lua,第 52 行。在游戏中为只读;“复制”会生成一份可编辑的副本。

Platform.health_forecast.GetHealthForecastIdentityObservation(self, unit)
    local policy=self:GetCombatDataPolicy()
    if policy~='probe' and policy~='restricted' then return nil,'unsupported-policy' end
    if not self:CanReadValue(unit) then return nil,'restricted-value' end
    if type(unit)~='string' or unit=='' then return nil,'invalid-unit' end
    if type(UnitExists)~='function' then return nil,'missing-api' end
    local ok,exists=pcall(UnitExists,unit)
    if not ok 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 false end
    if type(UnitGUID)~='function' then return nil,'missing-api' end
    local success,guid=pcall(UnitGUID,unit)
    if not success then return nil,'api-error' end
    if not self:CanReadValue(guid) then return nil,'restricted-value' end
    if canaccessvalue and not canaccessvalue(guid) then return nil,'restricted-value' end
    if guid==nil then return nil,'unit-guid-unavailable' end
    if type(guid)~='string' or guid=='' then return nil,'invalid-api-result' end
    return guid

返回函数参考