Skip to main content

IItem

Hierarchy

Index

Properties

optional_wiki

_wiki?: IWiki

optionalautoUnlocked

autoUnlocked?: boolean

optionalclosetHide

closetHide?: boolean

Hide from closet (Outfit request)

optionaldye

dye?: IItemDye

Dye slots on item.

optionalfavourited

favourited?: boolean

optionalgroup

group?: ItemGroup

Item group.

guid

guid: string

optionalhiddenNodes

hiddenNodes?: INode[]

Spirit tree nodes that unlock this item without showing the item. Generally ones added retroactively.

optionaliaps

iaps?: IIAP[]

IAPs that unlock this item.

optionalicon

icon?: string

Path to item icon.

optionalid

id?: number

Unique item ID.

optionallevel

level?: number

Emote level.

optionallistNodes

listNodes?: IItemListNode[]

Item list nodes that unlock this item.

name

name: string

Item name.

optionalnodes

nodes?: INode[]

Spirit tree nodes that unlock this item.

optionalorder

order?: number

Item order (within category).

optionalpreviewUrl

previewUrl?: string

Path to preview image.

optionalquantity

quantity?: number

Quantity (not properly supported yet)

optionalseason

season?: ISeason

Season the item was introduced in.

@remarks

Only available for season spirit trees and IAPs.

optionalsheet

sheet?: string

Music sheet

optionalsubtype

subtype?: ItemSubtype

type

type: ItemType

Item type.

optionalunlocked

unlocked?: boolean