Player Input Manager

プレイヤーの前後左右移動やジャンプ、スニーク、右クリックや攻撃などの入力において、シングルタップ、ダブルタップ、長押しなどに応じたコマンドの実行を簡単に設定できるようにするためのデータパックです。

対応バージョン：1.21.5

主な機能

前後左右移動(WASD)、ジャンプ(space)、スニーク(shift)、ダッシュ(ctrl)、アイテムの右クリックの操作に対応
シングルタップ、ダブルタップ、長押し、長押しの開始および終了のそれぞれに個別のコマンドを設定する
アイテムは、アイテムごとにコマンドを設定できる
消費アイテムについて、消費後に自動でアイテムを手元に戻す（クールダウン付きの非消費アイテムが作成できる）
利用頻度が高いconsume_secondsが0または非常に大きいパターンなどのコンポーネント記述の省略・簡略化
ダブルタップや長押しの判定用のパラメータの個別設定
入力の履歴を参照し、コマンド入力などの判定ができる
キー入力の組み合わせで特定のコマンドを実行するコマンド入力のシステム

使い方

プレイヤーのキー入力にイベントを設定する場合と、アイテムの右クリックにイベントを設定する場合で方法が異なります。

キー入力のイベント設定

ファンクションからプレイヤー個別、またはプレイヤー全員に適用されるイベントを設定することができます。

`player_input:key/set_event`

イベントを設定するファンクション。名前(name)によって個別に設定することが可能です。
ストレージのplayer_input: inに/dataコマンドを用いて入力内容をセットした後にファンクションを実行します。

入力フォーマット

* <>内はデータ型 ()内は初期値

player_input: in {
    name : <string>,            | ("") イベントグループの名前
    replace : <boolen>,         | (true) 設定を完全に上書きするかマージするか trueの場合完全に上書きし、falseの場合マージをする。
    everyone : <boolen>,        | (false) 全員に適用するかどうか　falseの場合、実行者となるプレイヤーに個別設定を適用する。
    forward : {                 | 前進キーの設定
        every_input : <string>,     | ("") キーを一回押したときと素早く二回押したときに実行されるコマンド
        single_input : <string>,    | ("") キーを一回押したときに実行されるコマンド
        double_input : <string>,    | ("") キーを素早く二回押したときに実行されるコマンド
        hold : <string>,            | ("") キーを長押ししているときに実行されるコマンド
        hold_init : <string>,       | ("") キーの長押しがを開始したときに実行されるコマンド
        hold_end : <string>,        | ("") キーの長押しを終了したときに実行されるコマンド
    },
    backward : {                | 後退キーを押したときのコマンドの設定
        ...,                        | forwardと同じフォーマット
    },
    right : {                   | 右移動キーを押したときのコマンドの設定
        ...,                        | forwardと同じフォーマット
    },
    left : {                    | 左移動キーを押したときのコマンドの設定
        ...,                        | forwardと同じフォーマット
    },
    jump : {                    | ジャンプキーを押したときのコマンドの設定
        ...,                        | forwardと同じフォーマット
    },
    sneak : {                   | スニークキーを押したときのコマンドの設定
        ...,                        | forwardと同じフォーマット
    },
    sprint : {                  | ダッシュキーを押したときのコマンドの設定
        ...,                        | forwardと同じフォーマット
    },
    commands : [                | コマンドのリスト
        {
            command : <string>,         | コマンド入力が成功したときに実行されるコマンド
            exclude_key : <list>,       | 判定しないキー このキーをおしてもコマンド判定は中断されない
            exclude_hold : <boolen>,    | (true) ホールドを判定するかしないか
            cancel_command:<boolen>,     | (false) コマンド成功時に他のコマンドの判定を中断するかどうか
            list:[
                {
                    key : <string>,         | キーの名前
                    action : <string>,      | ("input") 動作の名前 "input", "hold_init", "hold_end"
                    time : {                | 前回の入力から何tickで判定するか
                        min : <int>,            | (0) 下限
                        max : <int>,            | (5) 上限
                    }
                },
                ...,
            ],
        },
        ...,
    ]
}

`player_input:key/delete_event`

イベントの設定を削除するファンクション。名前(name)を指定して削除します。
everyone:trueの場合は共通設定の削除、everyone:falseの場合は実行者となるプレイヤーの個別設定のみ削除します。

入力フォーマット

* <>内はデータ型 ()内は初期値

player_input: in{
    name : <string>,            | ("") クエリの名前
    everyone : <boolen>,        | (false) 共通設定を削除するか個別設定を削除するか
}

アイテム右クリックのイベント設定

アイテムのminecraft:custom_dataコンポーネントに以下のフォーマットで時のコマンドを設定することで利用ができます。
これとは別に、バニラで用意されているminecraft:use_cooldownやminecraft:consumable、minecraft:blocks_attacksなどを併用することができます。

データフォーマット

* <>内はデータ型 ()内は初期値

"minecraft:custom_data" : {
    right_click : {
        single_input : <string>,    | ("") シングルタップのときに実行するコマンド。
        double_input : <string>,    | ("") ダブルタップのときに実行するコマンド。設定されていない場合は、clickに設定したコマンドが実行される。
        hold : <string>,            | ("") 長押し中に実行するコマンド。長押し中はclick、double_clickは実行されない。
        hold_init : <string>,       | ("") 長押しを開始したときに実行するコマンド。
        hold_end : <string>,        | ("") 長押しを終了したときに実行するコマンド。
        
        input_interval : <int>,     | (1) 1回のから、次のまで何tickの間隔が空いた場合に断続的なとするかの設定。
        hold_threshold : <int>,     | (4) が何tickの間連続ししたら長押しとするかの設定。
        double_input_range : {       | ダブルタップの判定についてのパラメーター。
            min : <int>,                | (2) 最小値。
            max : <int>,                | (5) 最大値。
        }

        no_consume : <boolen>       | (true) 消費アイテムを消費した際に、アイテムを復元するかどうかの設定。trueの場合、アイテムを復元する。
        4t_hold : <boolen>          | (false) アイテムを長押しした際、4tick間隔でされるようにするかどうかの設定。trueの場合、4tick間隔になる。
                                              ニンジン付き棒などの挙動と同じになる。use_cooldownを占有するため、use_cooldownは使用不可となる。
    }
}

共通設定

input_interval hold_threshold double_input_rangeについては共通設定としてストレージplayer_input:から設定することもできます。
アイテムに個別パラメーターが設定されていた場合は、アイテムの個別パラメーターが優先されます。

データフォーマット

* <>内はデータ型 ()内は初期値

player_input: {                 
    key_input : {               | キー入力の設定
        input_interval : <int>,     | (1) 1回のから、次のまで何tickの間隔が空いた場合に断続的なとするかの設定。
        hold_threshold : <int>,     | (4) が何tickの間連続ししたら長押しとするかの設定。
        double_input_range : {      | ダブルタップの判定についてのパラメーター。
            min : <int>,                | (2) 最小値。
            max : <int>,                | (5) 最大値。
        }
    },
    click_item : {              | アイテム右クリックの設定
        input_interval : <int>,     | (1) 1回のから、次のまで何tickの間隔が空いた場合に断続的なとするかの設定。
        hold_threshold : <int>,     | (4) が何tickの間連続ししたら長押しとするかの設定。
        double_input_range : {      | ダブルタップの判定についてのパラメーター。
            min : <int>,                | (2) 最小値。
            max : <int>,                | (5) 最大値。
        }
    }
}

ファンクション

`player_input:execute`

　ファンクションの入力設定と実行を、マクロによって1行で行うためのファンクションです。マクロを使う分負荷がやや高くなりますが、簡易的に実行することができます。

入力フォーマット

* <>内はデータ型 ()内は初期値

function player_input:execute {                 
    func : <string>,        | 実行するファンクション player_input:以降のファンクションのパスを記入する 例:player_input:key/set_event -> key/set_event
    in : <comapund>,        | ファンクションの入力 player_input: に設定するNBTデータ
}

`player_input:key/get_history`

　キー入力の履歴を取得するファンクション。player_input: historyに履歴が格納される。

出力フォーマット

* <>内はデータ型 ()内は初期値

player_input: history[
    {
        key : <string>,             | 入力されたキー "forward", "backward", "right", "left", "jump", "sneak", "sprint"
        action : <string>,          | キーの入力タイプ "single_input", "double_input", "hold_init", "hold_end"
        action_type : <string>,     | キーの入力タイプ その2 "input", "hold_init", "hold_end"
        time : <int>,               | 入力されたゲームタイム
    }
]

`player_input:command/check`

　キー入力の履歴を参照し、コマンド入力の判定を行い、成功していたらコマンドを実行する。

出力フォーマット

* <>内はデータ型 ()内は初期値

player_input: in{
    delay : <int>,              | 何tick前の入力まで判定をするか
    commands : [                | コマンドのリスト
        {
            command : <string>,         | コマンド入力が成功したときに実行されるコマンド
            exclude_key : <list>,       | 判定しないキー このキーをおしてもコマンド判定は中断されない
            exclude_hold : <boolen>,    | (true) ホールドを判定するかしないか
            cancel_command:<boolen>,     | (false) コマンド成功時に他のコマンドの判定を中断するかどうか
            list:[
                {
                    key : <string>,         | キーの名前
                    action : <string>,      | ("input") 動作の名前 "input", "hold_init", "hold_end"
                    time : {                | 前回の入力から何tickで判定するか
                        min : <int>,            | (0) 下限
                        max : <int>,            | (5) 上限
                    }
                },
                ...,
            ],
        },
        ...,
    ]
}

スコアボード

　このデータパックで使用されるスコアボードのうち、ユーザ向けに用意しているものは次の通りです。

スコアボード	名前	説明
`time.right_click`	の保持時間	アイテムにおいて、ホールドしている場合は最初のタップから何tick経過したか、ダブルタップの場合は一回目のタップから何tick後かを意味する。
`time.forward`	前進の保持時間	前進において、ホールドしている場合は最初のタップから何tick経過したか、ダブルタップの場合は一回目のタップから何tick後かを意味する。
`time.backward`	後退の保持時間	後退において、ホールドしている場合は最初のタップから何tick経過したか、ダブルタップの場合は一回目のタップから何tick後かを意味する。
`time.right`	右移動の保持時間	右移動において、ホールドしている場合は最初のタップから何tick経過したか、ダブルタップの場合は一回目のタップから何tick後かを意味する。
`time.left`	左移動の保持時間	左移動において、ホールドしている場合は最初のタップから何tick経過したか、ダブルタップの場合は一回目のタップから何tick後かを意味する。
`time.jump`	ジャンプの保持時間	ジャンプにおいて、ホールドしている場合は最初のタップから何tick経過したか、ダブルタップの場合は一回目のタップから何tick後かを意味する。
`time.sneak`	スニークの保持時間	スニークにおいて、ホールドしている場合は最初のタップから何tick経過したか、ダブルタップの場合は一回目のタップから何tick後かを意味する。
`time.sprint`	ダッシュの保持時間	ダッシュにおいて、ホールドしている場合は最初のタップから何tick経過したか、ダブルタップの場合は一回目のタップから何tick後かを意味する。
`mode.right_click`	の保持時間	アイテムにおいて、最後に行ったアクションの状態を記録する。0:シングルタップ、 1:ダブルタップ、 2:ホールド開始、 3:ホールド終了
`mode.forward`	前進の状態	前進において、最後に行ったアクションの状態を記録する。0:シングルタップ、 1:ダブルタップ、 2:ホールド開始、 3:ホールド終了
`mode.backward`	後退の状態	後退において、最後に行ったアクションの状態を記録する。0:シングルタップ、 1:ダブルタップ、 2:ホールド開始、 3:ホールド終了
`mode.right`	右移動の状態	右移動において、最後に行ったアクションの状態を記録する。0:シングルタップ、 1:ダブルタップ、 2:ホールド開始、 3:ホールド終了
`mode.left`	左移動の状態	左移動において、最後に行ったアクションの状態を記録する。0:シングルタップ、 1:ダブルタップ、 2:ホールド開始、 3:ホールド終了
`mode.jump`	ジャンプの状態	ジャンプにおいて、最後に行ったアクションの状態を記録する。0:シングルタップ、 1:ダブルタップ、 2:ホールド開始、 3:ホールド終了
`mode.sneak`	スニークの状態	スニークにおいて、最後に行ったアクションの状態を記録する。0:シングルタップ、 1:ダブルタップ、 2:ホールド開始、 3:ホールド終了
`mode.sprint`	ダッシュの状態	ダッシュにおいて、最後に行ったアクションの状態を記録する。0:シングルタップ、 1:ダブルタップ、 2:ホールド開始、 3:ホールド終了

使用例

# ジャンプ長押しで空中ジャンプ(個別設定)
data modify storage player_input: in set value {name:"debug1",jump:{hold_init:"function player_input:example/boost"}}
execute as @p run function key/set_event

# 前進をダブルタップでスピードアップ(全体設定)
data modify storage player_input: in set value {name:"debug2",everyone:true,forward:{double_input:"function player_input:example/dush"}}
function key/set_event

# アイテム
give @s recovery_compass[custom_data={right_click:{click:"say click", double_click:"say double click", hold_init:"say hold init", hold_end:"say hold end"}}]

# アイテム 4tick毎判定
give @s recovery_compass[custom_data={right_click:{4t_hold:true, click:"say click"}}]

# アイテム クールダウン付き
give @s recovery_compass[custom_data={right_click:{click:"say click"}},use_cooldown={seconds:3f,cooldown_group:"a"}]

# ストレージからの設定変更
data modify storage player_input: input_interval set value 4
data modify storage player_input: hold_threshold set value 4
data modify storage player_input: double_input_range set value {min:1,max:3}

# player_input:executeを使った実行
execute as @p run function player_input:execute {func:"key/set_event",in:{name:"debug1",jump:{hold_init:"function player_input:example/boost"}}}

Name		Name	Last commit message	Last commit date
Latest commit History 42 Commits
data		data
doc		doc
LICENSE		LICENSE
Readme.md		Readme.md
pack.mcmeta		pack.mcmeta

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Repository files navigation

Player Input Manager

主な機能

目次

使い方

キー入力のイベント設定

`player_input:key/set_event`

`player_input:key/delete_event`

アイテム右クリックのイベント設定

共通設定

ファンクション

`player_input:execute`

`player_input:key/get_history`

`player_input:command/check`

スコアボード

使用例

About

Uh oh!

Releases 6

Languages

License

RuskEocssar/PlayerInputManager

Folders and files

Latest commit

History

Repository files navigation

Player Input Manager

主な機能

目次

使い方

キー入力のイベント設定

player_input:key/set_event

player_input:key/delete_event

アイテム右クリックのイベント設定

共通設定

ファンクション

player_input:execute

player_input:key/get_history

player_input:command/check

スコアボード

使用例

About

Resources

License

Uh oh!

Stars

Watchers

Forks

Releases 6

Languages

`player_input:key/set_event`

`player_input:key/delete_event`

`player_input:execute`

`player_input:key/get_history`

`player_input:command/check`