参考 › 函数参考 › Platform

Platform.form.GetPlayerFormObservation

公共

调用方式

addon.Platform:GetPlayerFormObservation()

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

作用

使用一次受保护的无参数 GetShapeshiftForm 调用观测玩家当前的形态。保留每个可读的有限数字结果,包括零、带符号和小数值;不会推断更严格的原生索引范围。缺失、失败、为 nil、受限或非有限的数据保持为不可用。不会添加形态数量、职业、法术 ID、单位或可选参数。

参数

名称类型作用
selfRMPlatformRotation Master 平台适配器(使用冒号调用时隐含传入)。

返回值

1number | nil可读的有限当前形态观测,包括与当前未变形状态比较时的零;不可用时为 nil。
2string | nil形态为 nil 时的客户端策略、能力、调用或观测可用性原因。

版本

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

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

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

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

示例

local form = addon.Platform:GetPlayerFormObservation()
if form == nil then return nil end
return form == 0 -- not shapeshifted

源码

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

Platform.form.GetPlayerFormObservation(self)
    local policy=self:GetCombatDataPolicy()
    if policy~='probe' and policy~='restricted' then return nil,'unsupported-policy' end
    if type(GetShapeshiftForm)~='function' then return nil,'missing-api' end
    local ok,result=pcall(GetShapeshiftForm)
    if not ok then return nil,'api-error' end
    if not self:CanReadValue(result) then return nil,'restricted-value' end
    if canaccessvalue and not canaccessvalue(result) then return nil,'restricted-value' end
    if result==nil then return nil,'form-unavailable' end
    if type(result)~='number' or result~=result or result==math.huge or result==-math.huge then return nil,'invalid-api-result' end
    return result

返回函数参考