參考資料 › 函式參考 › 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)

返回函式參考