RPG Atsumaru API Mock-up ENgine / RPGアツマールAPIのモックプラグイン
https://github.com/katai5plate/RAAmen/tree/master/dist
-min
がついているものは、軽量化されたものです。
- プラグイン設定画面で、
RAAmen_core.js
の下に他のRAAmen_plus_**.js
が来るように設定し、ON
にします
- テストプレイ時に
F8
キーを押してデバッグコンソールを開き、console.log(!!RAA&&!!RPGAtsumaru);
を入力しtrue
が表示されたら導入成功です。
RAA.send() => { result, ?error }
返り値 |
型 |
説明 |
result |
boolean |
正常なレスポンスか |
(error) |
RAA.errors<AtsumaruApiError>/null |
(result が false のとき)エラー内容 |
RAA.request({?waitTime, ?post, ?checkValid, ?succeeded, ?feiled, ?client}) => Promise<any>
- 疑似サーバーにリクエストを送信します。
- 時間・成功時処理・失敗時処理のあるPromiseを生成します。
引数 |
型 |
初期値 |
説明 |
(waitTime) |
number |
RAA.responseTime.normal |
レスポンスが返ってくる時間 |
(post) |
any |
{} |
送信するデータ |
(checkValid) |
post => boolean |
arg => !!arg |
第一引数をpostとして、成否を返す |
(succeeded) |
any |
{} |
成功時のレスポンス内容 |
(feiled) |
any |
RAA.errors.BAD_REQUEST |
失敗時のレスポンス内容 |
(client) |
boolean |
false |
疑似サーバーに通信せずローカル作業 |
返り値 |
型 |
説明 |
|
Promise<any> |
処理状態 |
RAA.clientRequest({?post, ?checkValid, ?succeeded, ?feiled}) => Promise<any>
- Promiseを作成します。
- APIサーバーへの通信を行わないであろうリクエストに使用します。
引数 |
型 |
初期値 |
説明 |
(post) |
any |
{} |
送信するデータ |
(checkValid) |
post => boolean |
arg => !!arg |
第一引数をpostとして、成否を返す |
(succeeded) |
any |
{} |
成功時のレスポンス内容 |
(feiled) |
any |
RAA.errors.BAD_REQUEST |
失敗時のレスポンス内容 |
返り値 |
型 |
説明 |
|
Promise<any> |
処理状態 |
RAA.modal({ message, ?decorate, ?checkValid, ?client }) => void
- 疑似サーバーにモーダルを開くリクエストを送信します。
message
が疑似サーバーにPOSTされ、checkValid
がtrue
の時、decorate
の出力結果が適用されます。
client
がtrue
の場合、待機時間がRAA.responseTime.client
になり、そうでない場合はRAA.responseTime.normal
になります。
引数 |
型 |
初期値 |
説明 |
message |
number |
|
送信する文字列 |
(decorate) |
message => string |
arg => arg |
第一引数をmesaageとして、 リクエスト成功時に適用する文字列を返す |
(checkValid) |
message => boolean |
arg => !!arg |
第一引数をmesaageとして、成否を返す |
(client) |
boolean |
false |
疑似サーバーに通信せずローカル作業 |