API Manual 與 Inspector

Home · BASIC · UO API · A–Z · Examples · Languages

API Manual

目前的參考手冊包含 1103 個符號及全部 1037 個可呼叫的命令名稱，每個命令都有多個範例。客戶端從外部 API Manual 資料夾讀取可編輯的檔案；修改後請在 Theia 中重新開啟手冊。共用的詳細說明以俄文及部分英文撰寫，命令識別名稱不會隨介面語言改變。

API · A–Z · Examples · Audit

唯一可信來源

API 文件依下列方向建立：

Runtime registration → API Manual

舊文件、範例檔或歷史名稱不能證明命令仍存在。只有目前 Basic Runtime 實際註冊、可供腳本呼叫的 elements 才能出現在 Manual；Runtime 新增而舊 Manual 沒有的 element 必須加入。

每個 API 項目應包含

• 精確名稱與 element 類型；
• 實際 signature 與所有已註冊 overload；
• required／optional parameters；
• 已實作的 default values；
• return value 或 side effect；
• parameter 的允許值與限制；
• data source 與 dispatch route；
• 到 ClassicUO 的具體呼叫路徑；
• related properties／elements；
• 使用真實 Basic Script 語法的 examples。

命令名稱、identifier、path、type 與語法不翻譯。只有說明文字可依 Manual 語言顯示。

不屬於 Runtime API 的內容

使用者在 AutoLoad 或 Autoload\Scripts 宣告的 SUB、FUNCTION、globals 與 constants 不是 Runtime API，因此不加入 API Manual。這些 symbols 會出現在目前檔案的 Outline、references、跳轉與靜態分析結果中。

指令卡片模式

選取指令時先顯示精簡卡片：精確名稱、類型、簡短簽名與回傳值（或效果）。

展開詳細資訊會顯示所有 overload、參數要求、預設值、限制、相依性、Runtime 路徑、相關項目與可執行的 Basic Script 範例。兩種模式都保留語法與 return。

API Inspector、除錯器與回傳值

API Inspector 用來回答「這個命令的定義與用法是什麼」，會顯示 signature、parameters、return/effect、example 與技術路徑。它不是持續執行中每次呼叫結果的歷史表。

查看實際回傳值的方法：

VAR item = UO.FindType(0x0F43, -1, backpack, -1, TRUE)
UO.Print('Result: ' + CStr(item))

也可以把值存入變數，在呼叫後一行設 breakpoint，等除錯器停止後於 Variables 或 Watch 查看。Local、global、constant、frame 與 call stack 的執行期資訊屬於 debugger panels。

IDE 中的文件操作

• 自動完成顯示目前 Runtime 支援的 signature；
• 單擊 API 項目在 Inspector 顯示詳細資訊；
• 雙擊插入完整命令形式；
• Ctrl+F1 開啟游標 symbol 的文件；
• 按住 Ctrl 再 hover 顯示緊湊說明；放開 Ctrl 後隱藏；
• tooltip 需自動換行且保持在螢幕範圍內。

語言

Manual 介面與說明可使用 EU、RU、UA、FR、DE、IT、ES、ZH、JA、KO。切換語言不會改變 UO.*、signature、Basic keywords、paths 或實際 Runtime 行為。

API 一致性稽核

發行前的 Runtime／Manual 比對預期：

Missing from Manual: 0
Not registered in Runtime: 0
Invalid signatures: 0
Duplicate entries: 0
Invalid Basic Script examples: 0

此檢查表示項目集合、signature、重複與 examples 可由自動測試驗證；它不代表每個遊戲伺服器都會傳送相同的擴充資料。

Manual 空白時

如果框架已開啟但左側沒有項目，通常是 frontend 未取得 Runtime catalog。請確認使用完整 client、Basic payload 完整、沒有覆蓋舊 IDE 目錄，然後重新啟動完整客戶端。完整流程見疑難排解。