Giter VIP home page Giter VIP logo

raamen's Introduction

RAAmen 🍜

RPG Atsumaru API Mock-up ENgine / RPGアツマールAPIのモックプラグイン

ダウンロード

https://github.com/katai5plate/RAAmen/tree/master/dist

  • -min がついているものは、軽量化されたものです。

使い方

  1. プラグイン設定画面で、RAAmen_core.jsの下に他のRAAmen_plus_**.jsが来るように設定し、ONにします
  2. テストプレイ時に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され、checkValidtrueの時、decorateの出力結果が適用されます。
  • clienttrueの場合、待機時間がRAA.responseTime.clientになり、そうでない場合はRAA.responseTime.normalになります。
引数 初期値 説明
message number 送信する文字列
(decorate) message => string arg => arg 第一引数をmesaageとして、
リクエスト成功時に適用する文字列を返す
(checkValid) message => boolean arg => !!arg 第一引数をmesaageとして、成否を返す
(client) boolean false 疑似サーバーに通信せずローカル作業

raamen's People

Contributors

katai5plate avatar

Stargazers

 avatar

Watchers

James Cloos avatar  avatar  avatar

raamen's Issues

テストの導入

  • jestか何かでテストコードを書けるようにする
    • 本物のAPIのあるなしでモック化するか切り替わるか確認するテストを書く
  • 何かCIを使って動かす

通信APIと非通信APIを分ける

「起こりうるエラーの種類」が記載された関数
window.RPGAtsumaru.experimental.scoreboards.setRecord(boardId: number, score: number)
window.RPGAtsumaru.experimental.scoreboards.getRecords(boardId: number)
window.RPGAtsumaru.experimental.globalServerVariable.getGlobalServerVariable(globalServerVariableId: number)
window.RPGAtsumaru.experimental.globalServerVariable.triggerCall(triggerId:number, delta?: number)
window.RPGAtsumaru.experimental.storage.getSharedItems(userIds: number[], gameId?: number)
window.RPGAtsumaru.experimental.user.getSelfInformation()
window.RPGAtsumaru.experimental.user.getUserInformation(userId: number)
window.RPGAtsumaru.experimental.user.getRecentUsers()
window.RPGAtsumaru.experimental.signal.sendSignalToGlobal(data: string)
window.RPGAtsumaru.experimental.signal.getGlobalSignals()
window.RPGAtsumaru.experimental.signal.sendSignalToUser(receiverId: number, data: string)
window.RPGAtsumaru.experimental.signal.getUserSignals()

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.