ZEPETO.Multiplay.Currency
型 | 説明 |
|---|---|
World 内通貨に関連するリクエストが失敗した理由を示すエラーコード。 | |
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。