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 }> — 处理完成时兑现的 Promise,携带以各 World 内货币 ID 为键、对应余额为值的对象。