Navi API
クライアントMODからワールド内の経路案内を利用できます。Naviが歩ける経路の計算と、経路・目的地の描画を担当します。呼び出すMODが目的地・依頼・人間向けUI・設定保存を管理します。
初めて組み込む場合は 導入と最初の案内、所有権とライフサイクルの順に確認してください。English。
できること
- 座標、名前付き経由地点、観測済みエンティティへの案内。
- ポータルや転送装置を、地点間の方向付き接続として登録。
- 目的地と通過済みの経由地点を保ったまま、案内を補足・更新。
- 残りの案内を保存し、次回のワールド参加時に復元。
- Minecraftの内部状態に依存せず、進行と終了の通知を受け取る。
Naviは案内を表示します。プレイヤーの自動操作、転送装置の起動、ゲームコマンドの実行は行いません。AI接続も不要です。
責任の分担
| 呼び出すMOD | Navi |
|---|---|
| 目的地、経由地点の名前、既知の転送接続 | 経路計算、追跡、経路表示 |
| 案内オブジェクトの保持・破棄 | 呼び出し元間で共有する、同時に1件の案内 |
| ワールドごとのチェックポイント保存 | チェックポイントの生成と検証 |
| 必要に応じた未解決経路の調査 | 現在の状態と補助調査の対象 |
| HUD・設定画面・キー・設定差分の保存 | 全設定の既定値と、所有する案内の設定更新 |
NaviClient.navigation() でAPIを取得できます。公開APIのパッケージは dev.miyomiyo.navi.api です。内部パッケージや探索エンジンのクラスは実装の詳細です。
バージョン 1.0.0
この資料はNavi 1.0.0を対象にしています。Minecraftのバージョンとローダーに合うJARを使用してください。導入先はクライアントです。専用サーバーではこのAPIを提供しません。
APIと配布JARのライセンスはNaviと同じ All Rights Reserved です。依存として利用する際、呼び出すMODへの埋め込みは不要です。