Platform.creature_type.GetUnitCreatureTypeID

呼叫方式

addon.Platform:GetUnitCreatureTypeID(unit)

可直接透過 addon 使用，不需要相依項目。

作用

在探測或受限政策用戶端上，從原生 UnitCreatureType 的第二個傳回值觀測生物身分。先檢查確切的 UnitExists(unit)；可讀的 false 會直接傳回 false，不需要也不呼叫生物中繼資料。存在的單位要求可讀的有限數字 ID；未使用的在地化名稱不影響可用性。帶正負號、小數、零以及未來的有限 ID 都會作為已知值保留。所需資訊缺少、失敗、為 nil、受限或格式錯誤時傳回 nil 及原因。不會新增生物列舉、翻譯標題比較或長期快取。

參數

名稱	類型	作用
`self`	`RMPlatform`	Rotation Master 平台轉接器（使用冒號呼叫時隱含傳入）。
`unit`	`string`	可讀的非空所選單位代碼，作為單一參數原樣傳給存在性與生物中繼資料查詢。

傳回值

1	`number \| boolean \| nil`	有限的原生生物 ID；已知單位不存在時為 false，所需觀測無法使用時為 nil。
2	`string \| nil`	ID 為 nil 時的政策、查詢驗證或所需觀測的可用性原因。

版本

內建輔助函式在每個版本上都會註冊。不同的是它們讀取的遊戲 API；某個 API 不存在時，輔助函式會改用備用方式，或傳回 nil 並附上原因。

該版本無法使用（原因請見提示）
僅在暴雪的棄用相容層開啟時

遊戲 API
`UnitCreatureType`
`UnitExists`
`canaccessvalue`

機密值（正式版與永久）

在正式版與永久上，遊戲交給插件的是機密值。此輔助函式會檢查它讀取的內容（addon.Platform:CanReadValue），遇到無法比較的機密值時，會傳回 nil 並附上原因（例如 restricted-value），而不是傳回該機密值。請將 nil 視為無法使用，而非假。

範例

local id = addon.Platform:GetUnitCreatureTypeID("target")
if id == nil then return nil end
-- false (no target) never equals 6, the Undead creature type.
return id == 6

原始碼

Platform/creature_type.lua，第 17 行。在遊戲中為唯讀；「複製」會產生一份可編輯的複本。

Platform.creature_type.GetUnitCreatureTypeID(self, unit)

    local policy=self:GetCombatDataPolicy()
    if policy~='probe' and policy~='restricted' then return nil,'unsupported-policy' end
    if not self:CanReadValue(unit) then return nil,'restricted-value' end
    if type(unit)~='string' or unit=='' then return nil,'invalid-unit' end
    if type(UnitExists)~='function' then return nil,'missing-api' end
    local existsOk,exists=pcall(UnitExists,unit)
    if not existsOk then return nil,'api-error' end
    if not self:CanReadValue(exists) then return nil,'restricted-value' end
    if exists==nil then return nil,'unit-data-unavailable' end
    if type(exists)~='boolean' then return nil,'invalid-api-result' end
    if not exists then return false end
    local native=UnitCreatureType
    if type(native)~='function' then return nil,'missing-api' end
    local observed,_,id=pcall(native,unit)
    if not observed then return nil,'api-error' end
    if not self:CanReadValue(id) then return nil,'restricted-value' end
    if canaccessvalue and not canaccessvalue(id) then return nil,'restricted-value' end
    if id==nil then return nil,'unit-creature-type-unavailable' end
    if type(id)~='number' or id~=id or id==math.huge or id==-math.huge then return nil,'invalid-api-result' end
    return id

返回函式參考