エディタのイベントに応答する

events 拡張機能を使用すると、プラグインにエディタ内の特定のイベントをリッスンさせ、アクションの実行により応答させることができます。

エディタのイベントの詳細については、「エディタのイベントを発行および処理する」も参照してください。

イベントの拡張機能ごとに、次の環境設定パラメータが必要です。

extensions = {
    events = [
        {
            on = "event-name"
            do = [
                "first_action"
                "second_action"
            ]
            for = "global"
            options = {
                ...
            }
        }
    ]
}

on

この拡張機能をトリガするイベントの名前です。必須。

do

この拡張機能がトリガされたときに実行される 1 つのアクションまたはアクションの配列です。各アクション値は actions 拡張機能またはインライン アクション定義で既に設定したアクションの名前にすることができます。詳細については、「アクションを登録する」を参照してください。必須。

for

プラグインがイベントを検索する範囲を決定します。許容値: global、engine、editor、window、view。また、plugin-service や debugger-service など、応答先のイベントを発行する JavaScript サービス モジュールの名前を使用することもできます。(オプション) 既定値は global です。

options

各 do アクションに引数として渡されるオブジェクトです。オプション。