【ScriptAPI】カスタムコマンドを作ろう

import { system, world, CommandPermissionLevel, CustomCommandStatus, CustomCommandOrigin } from "@minecraft/server";

system.beforeEvents.startup.subscribe(ev => {
    /**
     * saba:helloコマンドを定義
     * @type {import("@minecraft/server").CustomCommand}
     */
    const helloCommand = {
        name: "saba:hello", // コマンド名
        description: "あいさつを行う", // コマンド説明
        permissionLevel: CommandPermissionLevel.Any, // 権限レベル: 誰でも
        // 必須の引数
        mandatoryParameters: [], // なし
        // 引数
        optionalParameters: [], // なし
    }

    // helloコマンドを登録
    ev.customCommandRegistry.registerCommand(helloCommand, hello);
});

/**
 * saba:helloコマンドの処理関数
 * @param {CustomCommandOrigin} origin 
 * @returns {import("@minecraft/server").CustomCommandResult}
 */
function hello(origin) {
    // origin には実行者エンティティやブロックが入る

    // もし実行者エンティティの種族がプレイヤーではないなら
    if (origin.sourceEntity?.typeId !== "minecraft:player") {
        // コマンド結果を返す
        return {
            status: CustomCommandStatus.Failure, // 失敗
            message: "実行者はプレイヤーである必要があります",
        }
    }

    const player = origin.sourceEntity;

    // 挨拶メッセージを送る
    world.sendMessage(`[${player.nameTag}] こんにちは！`);

    // コマンド結果を返す
    return {
        status: CustomCommandStatus.Success, // 成功
        message: undefined, // メッセージなし
    }
}

// CustomCommandParamType を追加
import { system, world, CommandPermissionLevel, CustomCommandStatus, CustomCommandOrigin, CustomCommandParamType } from "@minecraft/server";

system.beforeEvents.startup.subscribe(ev => {
    // 省略

    /**
     * saba:sayコマンドを定義
     * @type {import("@minecraft/server").CustomCommand}
     */
    const sayCommand = {
        name: "saba:say",
        description: "メッセージを送信する",
        permissionLevel: CommandPermissionLevel.Any,
        // 必須の引数
        mandatoryParameters: [
            // 一つ目の引数 文字列型
            { name: "message", type: CustomCommandParamType.String },
        ],
        optionalParameters: [],
    }

    ev.customCommandRegistry.registerCommand(sayCommand, say);
});

/**
 * saba:sayコマンドで呼び出される関数
 * @param {CustomCommandOrigin} origin
 * @param {string} message 
 * @returns {import("@minecraft/server").CustomCommandResult}
 */
function say(origin, message) {
    // 関数には (origin, 引数1, 引数2, 引数3...) のように値が渡される

    if (origin.sourceEntity?.typeId !== "minecraft:player") {
        return {
            status: CustomCommandStatus.Failure,
            message: "実行者はプレイヤーである必要があります",
        }
    }

    const player = origin.sourceEntity;

    // コマンドの引数 message の値を埋め込んで送る
    world.sendMessage(`[${player.nameTag}] ${message}`);

    return {
        status: CustomCommandStatus.Success,
        message: undefined,
    }
}