Script API 早見表
バージョンごとに、追加されたクラス・メソッド・プロパティを確認できます。最新版を、自動で読み込みます。
バージョンごとの追加内容
データは、@minecraft/* の型定義(npm)から自動で作っています。名前の横のリンクは、Microsoft の公式ドキュメントです。
Script API 早見表の使い方
Script API は、アドオンの動きを JavaScript で書くための仕組みで、@minecraft/server などのモジュールとして提供されています。バージョンが上がるたびに、新しいクラスやメソッドが増え、ベータで先に出てから、安定版に入る機能も、あります。この早見表は、各バージョンで「何が追加されたか」を、まとめて確認できます。
使い方
- 「モジュール」で、@minecraft/server(本体)や @minecraft/server-ui(フォーム)などを選びます。
- バージョンの一覧が、新しい順に出ます。開くと、新しく増えたクラスと、既存のクラスに増えたメソッドやプロパティが見られます。
- 探している機能があるときは、検索欄に名前を入れます。最初に追加されたバージョンも、表示します。
- 名前をクリックすると、Microsoft の公式ドキュメントが開き、引数や使い方を確認できます。
manifest.json での指定
安定版は、manifest.json の dependencies に、「@minecraft/server」と「2.10.0」のように、バージョンを書きます。ベータは「2.13.0-beta」のように書き、実験的な機能の設定が、必要です。サーバーとモジュールのバージョンが合っていないと、読み込めないため、このページの「Minecraft 1.26.xx」の表示と、サーバーの版を、見比べてください。manifest は、manifest.json ジェネレーターで作れます。
データについて
npm で公開されている最新の型定義(index.d.ts)から、自動で作っています。新しいバージョンが出ると、1時間以内に、一覧に加わります。
関連するツール
- server-ui フォームビルダー Script APIのフォームを組み立ててコード生成
- server-ui フォームビルダー(OreUI版) OreUI(DDUI)のCustomFormを組み立てる
- アドオンスタジオ ブラウザでアドオンを作って.mcaddonに書き出し
よくある質問
このページの情報は、最新ですか?
はい。npm で公開されている @minecraft/server などの最新バージョンを、1時間ごとに確認し、新しい版が出ると、自動で一覧に追加します。各バージョンの型定義ファイル(index.d.ts)を読み取って、1つ前の安定版との差を計算しています。
「安定版」と「ベータ」の違いは何ですか?
安定版は、manifest.json で「2.10.0」のように指定する、正式に使える API です。ベータは「2.13.0-beta」のように指定する、開発中の API で、実験的な機能の設定が必要で、予告なく変更や削除が行われます。ベータの版(1.1.0-beta、2.9.0-beta など)は、安定版と同じ一覧に、版の順に並べています(例: 1.0.0 → 1.1.0-beta → 1.1.0 → 1.2.0-beta)。ベータの版には、ひとつ前のベータの版との差を、安定版には、ひとつ前の安定版との差を表示しています。「ベータ(開発中)も表示」のチェックを外すと、安定版だけになります。
ベータの版は、どう選んでいますか?
npm には、同じ「2.9.0-beta」でも、プレビューや安定版のビルドが、何本も公開されています。各ベータの版について、いちばん新しいビルド(安定版のビルドがあれば、それ)の型定義を読んで、比べています。
点線の枠の名前は、何ですか?
型定義ファイルの中で「@beta」と書かれている、ベータ限定の機能です。安定版の manifest では、使えません。その機能が安定版に入ると、「ベータから安定版へ」と表示されます。
Minecraft のバージョンとの対応は、どう見ますか?
各バージョンの横に、対応する Minecraft のバージョンを表示しています。例えば、@minecraft/server 2.10.0 は、Minecraft 1.26.60 向けです。サーバー(BDS)と、モジュールの版が合っていないと、アドオンが読み込まれないことがあります。
名前をクリックすると、どこに飛びますか?
Microsoft の公式ドキュメント(Minecraft Creator)の、そのクラスのページです。メソッドの引数や、使い方の例は、そちらで確認できます。
メソッドや値の名前を検索できますか?
できます。上の検索欄に、名前(例: sendMessage)を入れると、その名前が含まれる追加だけに絞り込み、いちばん最初に追加されたバージョンも表示します。