參考資料 › 函式參考 › Platform

Platform.player_movement.GetPlayerMovementObservation

公用

呼叫方式

addon.Platform:GetPlayerMovementObservation()

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

作用

在受支援且可讀的用戶端上觀測玩家目前的移動速度。這只針對 player 查詢 GetUnitSpeed,不檢測其他單位,也不重新導向載具擁有權。零表示靜止;正的有限小數速度仍然有效。缺少、失敗、受限或格式錯誤的觀測會傳回 nil 及原因。

參數

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

傳回值

1table | nil全新的可讀記錄,包含有限的非負速度;無法使用時為 nil。
2string | nil移動觀測為 nil 時的政策或可用性原因。

版本

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

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

機密值(正式版與永久)

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

範例

local movement = addon.Platform:GetPlayerMovementObservation()
if not movement then return nil end
return movement.speed > 0

原始碼

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

Platform.player_movement.GetPlayerMovementObservation(self)
    local policy=self:GetCombatDataPolicy()
    if policy~='probe' and policy~='restricted' then return nil,'unsupported-policy' end
    if type(GetUnitSpeed)~='function' then return nil,'missing-api' end
    local ok,speed=pcall(GetUnitSpeed,'player')
    if not ok then return nil,'api-error' end
    if not self:CanReadValue(speed) then return nil,'restricted-value' end
    if canaccessvalue and not canaccessvalue(speed) then return nil,'restricted-value' end
    if speed==nil then return nil,'movement-data-unavailable' end
    if type(speed)~='number' or speed~=speed or speed==math.huge or speed==-math.huge or speed<0 then return nil,'invalid-api-result' end
    return {speed=speed}

返回函式參考