參考資料 › 函式參考 › Platform

Platform.range.GetNameplateMaxDistance

公用

呼叫方式

addon.Platform:GetNameplateMaxDistance()

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

作用

使用受支援的 CVar API 讀取目前正的名條可見距離。這會限制「距離內計數」查詢;它不能證明所有附近的單位都已被觀測到。缺少、格式錯誤、受限或失敗的觀測會傳回 nil 及原因。

參數

名稱類型作用
selfRMPlatformRotation Master 平台轉接器(使用冒號呼叫時隱含傳入)。

傳回值

1number | nil目前的正可見距離,單位為碼;無法使用時為 nil。
2string | nil結果為 nil 時的可用性原因。

版本

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

  • 該版本無法使用(原因請見提示)
  • 僅在暴雪的棄用相容層開啟時
遊戲 API經典時代TBC 週年版經典進程永久正式版
C_CVar.GetCVar經典時代TBC 週年版經典進程永久正式版
GetCVar經典時代TBC 週年版經典進程永久正式版

機密值(正式版與永久)

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

插件如何呼叫它

  • 距離內計數 (widget)
    local maximum=addon.Platform:GetNameplateMaxDistance()

原始碼

Platform/range.lua,第 109 行。在遊戲中為唯讀;「複製」會產生一份可編輯的複本。

Platform.range.GetNameplateMaxDistance(self)
    local query=C_CVar and C_CVar.GetCVar or GetCVar
    if type(query)~='function' then return nil,'missing-api' end
    local ok,value=pcall(query,'nameplateMaxDistance')
    if not ok then return nil,'api-error' end
    if not self:CanReadValue(value) then return nil,'restricted-value' end
    if type(value)~='string' and type(value)~='number' then return nil,'nameplate-distance-unavailable' end
    local maximum=tonumber(value)
    if not maximum or maximum~=maximum or maximum<=0 or maximum==math.huge then return nil,'nameplate-distance-unavailable' end
    return maximum

返回函式參考