参考 › 函数参考 › Platform

Platform.roster_class.rosterUnit

依赖项

调用方式

Platform.roster_class.rosterUnit(unit)

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

作用

Returns true when unit is exactly player, party1 through party4, or raid1 through raid40 (no leading zeros), and false for any other string. unit must be a string; callers check its type first.

参数

名称类型作用
unitstringUnit token to test.

返回值

1booleanTrue for an accepted roster unit token.

版本

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

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

插件如何调用它

源码

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

Platform.roster_class.rosterUnit(unit)
    if unit=='player' or unit:match('^party[1-4]$') then return true end
    local slot=unit:match('^raid(%d+)$');slot=slot and tonumber(slot)
    return slot~=nil and slot>=1 and slot<=40 and unit=='raid'..tostring(slot)

返回函数参考