@zikeji/hypixel / SkyBlockProfileCollection

Interface: SkyBlockProfileCollection

Interface describing an individual collection.

Properties

amount

amount: number

The amount of resources in this collection the profile has collected toward tiers.

Note: If the profile is a coop and all players do not have their collection API enabled, this will only account for the amounts collected by members with their collection API enabled.

---

id

id: string

The ID of this collection, e.g. "LOG:2"

---

maxTier

maxTier: number

The maximum tier of this collection.

---

name

name: string

The name of this collection, e.g. "Birch Wood"

---

nextTier?

optional nextTier: number

The next tier the profile can reach. If the profile has reached the max tier, this value is omitted.

---

nextTierAmountRequired?

optional nextTierAmountRequired: number

The amount required to reach the next collection tier. If the profile has reached the max tier, this value is omitted.

---

progress

progress: number

The progress the profile is toward maxing this collection.

---

tier

tier: number

The tier the profile has reached.