参考 › 函数参考 › Platform

Platform.role.roleValue

依赖项

调用方式

Platform.role.roleValue(self, value)

记录依赖项 Platform.role.roleValue,然后按该名称调用。带命名空间的调用不会传入 self:请使用冒号调用,或自行传入该对象。

作用

Validates a role returned by a native API. Returns the value when it is a readable nonempty string (such as TANK, HEALER or DAMAGER); otherwise nil with "restricted-value", "role-unavailable" (nil) or "invalid-api-result".

参数

名称类型作用
selfRMPlatformRotation Master platform adapter (normally addon.Platform), used for its CanReadValue check.
valueanyRole value returned by the native API.

返回值

1string | nilThe role string, or nil when unavailable.
2string | nilReason when the role is nil.

版本

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

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

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

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

插件如何调用它

源码

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

Platform.role.roleValue(self, value)
    if not self:CanReadValue(value) then return nil,'restricted-value' end
    if canaccessvalue and not canaccessvalue(value) then return nil,'restricted-value' end
    if value==nil then return nil,'role-unavailable' end
    if type(value)~='string' or value=='' then return nil,'invalid-api-result' end
    return value

返回函数参考