参考 › 函数参考 › Platform

Platform.runes.validIndex

依赖项

调用方式

Platform.runes.validIndex(self, index)

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

作用

Validates a rune slot index. Returns true for a readable integer from 1 through 6; otherwise nil with "restricted-value" or "invalid-rune-index".

参数

名称类型作用
selfRMPlatformRotation Master platform adapter (normally addon.Platform), used for its CanReadValue check.
indexanyRune slot index to validate.

返回值

1boolean | nilTrue when index is a valid rune slot; nil otherwise.
2string | nilReason when invalid.

版本

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

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

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

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

插件如何调用它

依赖项

源码

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

Platform.runes.validIndex(self, index)
    if not self:CanReadValue(index) then return nil,'restricted-value' end
    if not finite(index) or index%1~=0 or index<1 or index>6 then return nil,'invalid-rune-index' end
    return true

返回函数参考