JA API Manual - LIHACHTETAN/ClassicUO-BadNewbie-BasicIDE GitHub Wiki

API Manual と Inspector

ナビゲーション:

Age of Power:

API Manual

現在のリファレンスには1103個のシンボルと、呼び出し可能な1037個すべてのコマンド名が含まれ、各コマンドに複数の例があります。クライアントは外部の API Manual フォルダーから編集可能なファイルを読み込みます。変更後はTheiaでマニュアルを開き直してください。共通の詳細ページはロシア語と一部英語で、コマンド識別子は翻訳されません。

API · A–Z · Examples · Audit

唯一の情報源

API 文書は次の方向で生成されます:

Runtime registration → API Manual

古い Manual、サンプル、過去のコマンド名は、現在その API が存在する根拠にはなりません。現在の Basic Runtime に実際に登録され、スクリプトから利用できる elements だけを Manual に含めます。Runtime に存在し旧 Manual にない element は追加対象です。

API 項目に含まれる情報

  • 正確な名前と element type;
  • 実際の 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 でユーザーが宣言した SUBFUNCTION、globals、constants は Runtime API ではありません。これらは選択ファイルの Outline、references、navigation、static analysis に表示されます。

コマンドカードの表示

コマンドを選択すると、正確な名前、種類、短いシグネチャ、戻り値(または効果)を含む概要カードが表示されます。

詳細情報を開くと、全 overload、パラメータ、既定値、制約、依存関係、Runtime 経路、関連項目、実行可能な Basic Script 例を確認できます。どちらの表示でも構文と return は残ります。

API Inspector、debugger、戻り値

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 から文書を使う

  • completion は現在の Runtime がサポートする signature を表示;
  • API 項目を 1 回クリックすると Inspector に詳細を表示;
  • ダブルクリックすると完全なコマンド形式を挿入;
  • Ctrl+F1 でカーソル位置の symbol 文書を開く;
  • Ctrl を押しながら hover すると簡潔な説明を表示し、離すと非表示;
  • tooltip は折り返し、画面内に収まる。

言語

Manual UI と説明は EURUUAFRDEITESZHJAKO に対応します。言語を切り替えても 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 が空の場合

画面枠は開くのに navigation が空なら、frontend が Runtime catalog を取得できていない可能性があります。フル client、完全な Basic payload、古い IDE フォルダーを上書きしていないことを確認し、フルクライアントを再起動してください。詳しくはトラブルシューティングを参照してください。

ナビゲーション:

Age of Power: