メインコンテンツまでスキップ

読み込み時に自動で実行 されるシナリオを書いてみる

プラグインの読み込み時に自動で実行されるシナリオを書いてみましょう。

概要​

このチュートリアルでは, トリガ on_loadの使い方を学びます。

これを完了すると, サーバの起動時やリロード時に自動で実行されるシナリオを作成できるようになります。
さらに, これを応用すると, CI/CD などで自動テストを行えます。

これについての実践的なチュートリアルは, 以下のドキュメントを参照してください。

ステップ１. 基本的なシナリオを作成する​

まずは, 以下のような簡単なシナリオを作成します。

ヒント

このシナリオは, チュートリアル：最初のシナリオを書いてみるで作成したシナリオと同じものです。

これについての実践的なチュートリアルは, 以下のドキュメントを参照してください。

test-hoge-success.yml
scenamatica: "0.0.1"
name: "test-hoge-success"
description: "hoge 機能の正常系テスト"

context:
  actors:
  - name: Actor1
  stage:
    env: NETHER

on:
- type: manual_dispatch

scenario:
  # Actor1 が /hoge を実行する。
- type: execute
  action: command_dispatch
  command: "/hoge"
  sender: Actor1
  # fuga というメッセージが（Actor1 に）表示される。
- type: expect
  action: message
  content: "fuga"
  recipient: Actor1
  # Actor1 が死ぬ。
- type: expect
  action: player_death
  target: Actor1

ステップ２. トリガに on_load を追加する​

トリガ on_load は, そのプラグインが読み込まれたときに自動で発火するトリガです。
これには, プラグインのリロードも含まれます。 また, このトリガは引数を取りません。

以下のようにして, on_load を追加します。

test-hoge-success.yml

on:
- type: manual_dispatch
- type: on_load

ステップ３. 動作を確認する​

シナリオを作成したら, サーバを再起動するか, プラグインを再読込します。
シナリオが実行されたらこのチュートリアルは完了です。お疲れ様でした。

# サーバを再起動する場合
$ java -jar <サーバのjarファイル名>.jar

# 再読込する場合
$ reload confirm

他の応用的なチュートリアルを読むにはこちらを参照してください。
シナリオファイルの完全な構文についてはこちらを参照してください。