@akashic/engine-files-reftest-helper 1.3.0-beta.3 → 1.3.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -13,6 +13,19 @@
13
13
  * `msg.data.command.name` が `init` の時に、以下のように出力形式を指定することができます。
14
14
  * `msg.data.command.options.outputType`: `console`でコンソール出力して、`post`で任意の HTTP エンドポイントに POST リクエストを送信します。出力形式はデフォルトではコンソール出力になっています。
15
15
  * `msg.data.command.options.outputUrl`:`post`の時の送信先URLを指定します。
16
+ * コンテンツ側で g.game.external.reftest の以下のプロパティを利用することができます。
17
+ * screenshot: (fileName: string, base64: string) => Promise<Response | void>
18
+ * 指定された画像情報を engine-files-reftest 側でスクリーンショットとして取得します
19
+ * finish: () => Promise<Response | void>
20
+ * engine-files-reftest の実行が終了します
21
+ * getImageDataUrlFromCanvas: () => string
22
+ * この関数を実行した時点でのゲーム画面のスクリーンショットを base64 形式で取得します
23
+ * postConsole: (param: ConsoleApiParameter) => Promise<Response>
24
+ * 指定したコマンドの実行ができますが、`screenshot()` や `finish()` の内部で実行されるので、通常コンテンツ側で利用する必要はありません
25
+ * outputType: OutputType
26
+ * コマンドの出力形式を参照・変更できますが、通常コンテンツ側で利用する必要はありません
27
+ * consoleApiUrl: string
28
+ * コマンド API の URL を参照・変更できますが、通常コンテンツ側で利用する必要はありません
16
29
 
17
30
  ## 使い方
18
31
  engine-files-reftestのテスト対象コンテンツのディレクトリで以下のコマンドを実行します。
package/lib/index.js CHANGED
@@ -62,7 +62,7 @@ function getReftestHelperBridge() {
62
62
  return g.game.vars.reftest;
63
63
  }
64
64
  if (typeof g !== "undefined") {
65
- // reftest 関連のプロパティを g.game.vars にセットする
65
+ // reftest 関連のプロパティを g.game.vars.reftest にセットする
66
66
  g.game.vars.reftest = {
67
67
  outputType: "console",
68
68
  consoleApiUrl: "",
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@akashic/engine-files-reftest-helper",
3
- "version": "1.3.0-beta.3",
3
+ "version": "1.3.0",
4
4
  "description": "engine-files-reftestでコンテンツを自動実行するためのライブラリ",
5
5
  "main": "lib/index.js",
6
6
  "typings": "lib/index.d.ts",