ZEPETO.Multiplay.Inventory
Tipe | Deskripsi |
|---|---|
Kode error yang menunjukkan penyebab kegagalan permintaan terkait inventaris. | |
Informasi produk dalam inventaris. | |
Inventory mengelola operasi yang berkaitan dengan inventaris produk in-World milik pemain. |
InventoryError
enum
Kode error yang menunjukkan penyebab kegagalan permintaan terkait inventaris.
Nama | Nilai | Deskripsi |
|---|---|---|
Unknown | -1 | Error: Kesalahan tidak dikenal. |
NetworkError | 0 | Error: Kesalahan terkait masalah jaringan, termasuk koneksi terputus atau koneksi tidak stabil. |
InventoryRecord
interface
Informasi produk dalam inventaris.
Properti
Nama | Tipe | Deskripsi |
|---|---|---|
productId | string | ID produk. |
quantity | number | Jumlah produk. |
createdAt | Date | Tanggal dan waktu saat produk ditambahkan ke inventaris. |
updatedAt | Date | Tanggal dan waktu saat informasi produk terakhir diperbarui. |
Inventory
interface
Inventory mengelola operasi yang berkaitan dengan inventaris produk in-World milik pemain.
Metode
use
use(productId: string, quantity?: number, reason?: string) → Promise<boolean>
Menggunakan produk in-World dari inventaris pemain. Melempar InventoryError.
Parameter | Tipe | Deskripsi |
|---|---|---|
productId | string | ID produk yang akan digunakan. |
quantity (opsional) | number | Jumlah produk yang akan digunakan. Nilai defaultnya adalah 1. |
reason (opsional) | string | Secara opsional menjelaskan alasan penggunaan. |
Mengembalikan: Promise<boolean> — Promise yang selesai setelah proses berakhir, menunjukkan keberhasilan (true) atau kegagalan (false).
add
add(productId: string, quantity?: number, reason?: string) → Promise<boolean>
Menambahkan produk in-World ke inventaris pemain. Melempar InventoryError.
Parameter | Tipe | Deskripsi |
|---|---|---|
productId | string | ID produk yang akan ditambahkan. |
quantity (opsional) | number | Jumlah produk yang akan ditambahkan. Nilai defaultnya adalah 1. |
reason (opsional) | string | Secara opsional menjelaskan alasan penambahan. |
Mengembalikan: Promise<boolean> — Promise yang selesai setelah proses berakhir, menunjukkan keberhasilan (true) atau kegagalan (false).
madd
madd(products: { productId: string; quantity: number; reason?: string }[]) → Promise<boolean>
Menambahkan beberapa produk in-World ke inventaris pemain. Melempar InventoryError.
Parameter | Tipe | Deskripsi |
|---|---|---|
products | { productId: string; quantity: number; reason?: string }[] | Array produk yang akan ditambahkan. |
Mengembalikan: Promise<boolean> — Promise yang selesai setelah proses berakhir, menunjukkan keberhasilan (true) atau kegagalan (false).
has
has(productId: string) → Promise<boolean>
Memeriksa keberadaan produk in-World di inventaris pemain. Melempar InventoryError.
Parameter | Tipe | Deskripsi |
|---|---|---|
productId | string | ID produk yang akan diperiksa. |
Mengembalikan: Promise<boolean> — Promise yang selesai setelah proses berakhir, menunjukkan ada (true) atau tidak ada (false).
get
get(productId: string) → Promise<InventoryRecord | null>
Mengambil produk in-World dari inventaris pemain. Melempar InventoryError.
Parameter | Tipe | Deskripsi |
|---|---|---|
productId | string | ID produk yang akan diambil. |
Mengembalikan: Promise<InventoryRecord | null> — Promise yang selesai setelah proses berakhir, dengan objek InventoryRecord yang diambil.
remove
remove(productId: string) → Promise<boolean>
Menghapus produk in-World dari inventaris pemain. Melempar InventoryError.
Parameter | Tipe | Deskripsi |
|---|---|---|
productId | string | ID produk yang akan dihapus. |
Mengembalikan: Promise<boolean> — Promise yang selesai setelah proses berakhir, menunjukkan keberhasilan (true) atau kegagalan (false).
list
list() → Promise<InventoryRecord[]>
Mengambil seluruh produk in-World dari inventaris pemain. Melempar InventoryError.
Mengembalikan: Promise<InventoryRecord[]> — Promise yang selesai setelah proses berakhir, dengan array objek InventoryRecord yang diambil.