ZEPETO.Multiplay.Currency
6 分
型 説明 currencyerror /#currencyerror world 内通貨に関連するリクエストが失敗した理由を示すエラーコード。 currency /#currency currency は、zepeto world の通貨に関連する操作を管理します。 currencyerror enum world 内通貨に関連するリクエストが失敗した理由を示すエラーコード。 名前 値 説明 unknown 1 エラー 不明なエラー。 networkerror 0 エラー 接続の切断や不安定な接続など、ネットワークに関連するエラー。 currency interface currency は、zepeto world の通貨に関連する操作を管理します。 メソッド debit debit(id string, quantity? number, reason? string) → promise\<boolean> プレイヤーの world 内通貨残高から指定した数量を差し引きます。 currencyerror をスローします。 パラメーター 型 説明 id string 差し引く通貨の id。 quantity (省略可能) number 差し引く通貨の数量。デフォルト値は 1 です。 reason (省略可能) string 差し引きの理由を任意で記述します。 戻り値 promise\<boolean> — 処理の完了時に解決される promise 。成功時は true 、失敗時は false を示します。 credit credit(id string, quantity? number, reason? string) → promise\<boolean> プレイヤーの world 内通貨残高に指定した数量を加算します。 currencyerror をスローします。 パラメーター 型 説明 id string 加算する通貨の id。 quantity (省略可能) number 加算する通貨の数量。デフォルト値は 1 です。 reason (省略可能) string 加算の理由を任意で記述します。 戻り値 promise\<boolean> — 処理の完了時に解決される promise 。成功時は true 、失敗時は false を示します。 getbalance getbalance(id string) → promise\<number> プレイヤーの world 内通貨の残高を取得します。 currencyerror をスローします。 パラメーター 型 説明 id string 取得する通貨の id。 戻り値 promise\<number> — 処理の完了時に、取得した残高の値とともに解決される promise 。 getbalances getbalances() → promise<{ \[key string] number }> プレイヤーが保有する各 world 内通貨の残高を取得します。 currencyerror をスローします。 戻り値 promise<{ \[key string] number }> — 処理の完了時に、各 world 内通貨の id をキー、対応する残高を値とするオブジェクトとともに解決される promise 。