@akashic/amflow-util

1.4.0 • Public • Published

amflow-util

このモジュールは、Akashic Message Flow (AMFlow) のユーティリティモジュールで以下を提供します。 ゲーム開発者(Akashic Engineの利用者)がこのモジュールを直接利用する必要はありません

提供するクラス 内容 import/require() 元
MemoryAMFlowClient tick データをオンメモリに保持する AMFlow 実装 @akashic/amflow-util/lib/MemoryAMFlowClient
ReplayAMFlowProxy 与えられた playlog データをそのまま返す AMFlow 実装。
ただし、与えられた範囲外のデータは別の AMFlow インスタンスに問い合わせる
@akashic/amflow-util/lib/ReplayAmflowProxy
PromisifiedAMFlowProxy 引数に渡された AMFlow 実装の非同期関数を Promise でラップしたクラス。 @akashic/amflow-util/lib/PromisifiedAMFlowProxy
提供する関数 内容 import/require() 元
calculateFinishedTime 与えられた playlog の終了時間(単位:ミリ秒)を算出する関数 @akashic/amflow-util/lib/calculateFinishedTime

このモジュールは利用が限られるため、root からの import/require はできませんので個別に import/require する必要があります。

インストール

Node.jsが必要です。次のコマンドでインストールできます。

npm install @akashic/amflow-util

ビルド方法

TypeScriptで書かれています。インストール後にビルドしてください。

npm install
npm run build

利用方法

require() してください。

var MemoryAMFlowClient = require("@akashic/amflow-util/lib/MemoryAMFlowClient").MemoryAMFlowClient;

var amflow = new MemoryAMFlowClient({
  playId: "0"
});

テスト方法

npm test

ライセンス

本リポジトリは MIT License の元で公開されています。 詳しくは LICENSE をご覧ください。

ただし、画像ファイルおよび音声ファイルは CC BY 2.1 JP の元で公開されています。

Readme

Keywords

none

Package Sidebar

Install

npm i @akashic/amflow-util

Weekly Downloads

140

Version

1.4.0

License

MIT

Unpacked Size

39.4 kB

Total Files

13

Last publish

Collaborators

  • akashic-owner
  • yu-ogi
  • kmkr01
  • akashic-extension-owner
  • shinobu_takahashi