ZEPETO.Multiplay.Inventory

11 分

型	説明
InventoryError	インベントリ関連のリクエストが失敗した理由を示すエラーコード。
InventoryRecord	インベントリ内の商品の情報。
Inventory	Inventory は、プレイヤーの World 内商品インベントリに関連する操作を管理します。

InventoryError

enum

インベントリ関連のリクエストが失敗した理由を示すエラーコード。

名前	値	説明
Unknown	-1	エラー: 不明なエラー。
NetworkError	0	エラー: 接続の切断や不安定な接続など、ネットワークに関連するエラー。

InventoryRecord

interface

インベントリ内の商品の情報。

プロパティ

名前	型	説明
productId	string	商品の ID。
quantity	number	商品の数量。
createdAt	Date	商品がインベントリに追加された日時。
updatedAt	Date	商品情報が最後に更新された日時。

Inventory

interface

Inventory は、プレイヤーの World 内商品インベントリに関連する操作を管理します。

メソッド

use

use(productId: string, quantity?: number, reason?: string) → Promise<boolean>

プレイヤーのインベントリから World 内商品を使用します。InventoryError をスローします。

パラメーター	型	説明
productId	string	使用する商品の ID。
quantity (省略可能)	number	使用する商品の数量。デフォルト値は 1 です。
reason (省略可能)	string	使用理由を任意で記述します。

戻り値: Promise<boolean> — 処理の完了時に解決される Promise。成功時は true、失敗時は false を示します。

add

add(productId: string, quantity?: number, reason?: string) → Promise<boolean>

プレイヤーのインベントリに World 内商品を追加します。InventoryError をスローします。

パラメーター	型	説明
productId	string	追加する商品の ID。
quantity (省略可能)	number	追加する商品の数量。デフォルト値は 1 です。
reason (省略可能)	string	追加の理由を任意で記述します。

戻り値: Promise<boolean> — 処理の完了時に解決される Promise。成功時は true、失敗時は false を示します。

madd

madd(products: { productId: string; quantity: number; reason?: string }[]) → Promise<boolean>

プレイヤーのインベントリに複数の World 内商品を追加します。InventoryError をスローします。

パラメーター	型	説明
products	{ productId: string; quantity: number; reason?: string }[]	追加する商品の配列。

戻り値: Promise<boolean> — 処理の完了時に解決される Promise。成功時は true、失敗時は false を示します。

has

has(productId: string) → Promise<boolean>

プレイヤーのインベントリに World 内商品が存在するかどうかを確認します。InventoryError をスローします。

パラメーター	型	説明
productId	string	確認する商品の ID。

戻り値: Promise<boolean> — 処理の完了時に解決される Promise。存在する場合は true、存在しない場合は false を示します。

get

get(productId: string) → Promise<InventoryRecord | null>

プレイヤーのインベントリから World 内商品を取得します。InventoryError をスローします。

パラメーター	型	説明
productId	string	取得する商品の ID。

戻り値: Promise<InventoryRecord | null> — 処理の完了時に、取得した InventoryRecord オブジェクトとともに解決される Promise。

remove

remove(productId: string) → Promise<boolean>

プレイヤーのインベントリから World 内商品を削除します。InventoryError をスローします。

パラメーター	型	説明
productId	string	削除する商品の ID。

戻り値: Promise<boolean> — 処理の完了時に解決される Promise。成功時は true、失敗時は false を示します。

list

list() → Promise<InventoryRecord[]>

プレイヤーのインベントリからすべての World 内商品を取得します。InventoryError をスローします。

戻り値: Promise<InventoryRecord[]> — 処理の完了時に、取得した InventoryRecord オブジェクトの配列とともに解決される Promise。