ItemContainerSlot

Implements

• AbstractSlot

Index

Constructors

• constructor

Properties

• count
• data
• extra
• id

Methods

• asJson
• asScriptable
• clear
• dropAt
• getContainer
• getCount
• getData
• getExtra
• getId
• getName
• isEmpty
• isSavingEnabled
• markDirty
• resetSavingEnabled
• set
• setSavingEnabled
• setSlot
• validate

Constructors

constructor

• new ItemContainerSlot(id: number, count: number, data: number): ItemContainerSlot
• new ItemContainerSlot(id: number, count: number, data: number, extra: ItemExtraData): ItemContainerSlot
• new ItemContainerSlot(item: ItemInstance): ItemContainerSlot
• new ItemContainerSlot(json: JSONObject, convert: boolean): ItemContainerSlot
• new ItemContainerSlot(): ItemContainerSlot

• Parameters

  • id: number

  • count: number

  • data: number

  Returns ItemContainerSlot

Properties

count

count: number

data

data: number

extra

extra: ItemExtraData

id

id: number

Methods

asJson

• asJson(): JSONObject

• ---

  Returns JSONObject

  Following ItemContainerSlot as org.json.JSONObject instance.

asScriptable

• asScriptable(): ItemInstance

• ---

  Returns ItemInstance

  Following ItemContainerSlot as ItemInstance object.

clear

• clear(): void

• Clears slot contents.

  ---

  Returns void

dropAt

• dropAt(region: BlockSource, x: number, y: number, z: number): void

• Drops slot contents in given world at given coords.

  ---

  Parameters

  • region: BlockSource

  • x: number

  • y: number

  • z: number

  Returns void

getContainer

• getContainer(): ItemContainer

• ---

  Returns ItemContainer

  Container linked to the slot.

getCount

• getCount(): number

• Implementation of UI.AbstractSlot.getCount

  ---

  Returns number

  Count of the item in slot.

getData

• getData(): number

• Implementation of UI.AbstractSlot.getData

  ---

  Returns number

  Data of the item in slot.

getExtra

• getExtra(): ItemExtraData

• Implementation of UI.AbstractSlot.getExtra

  ---

  Returns ItemExtraData

  Extra data object of the item in slot, or null if it is not present in the given item.

getId

• getId(): number

• Implementation of UI.AbstractSlot.getId

  ---

  Returns number

  Numeric ID of the item in slot.

getName

• getName(): string

• ---

  Returns string

  Slot name.

isEmpty

• isEmpty(): boolean

• ---

  Returns boolean

  Whether the slot is empty or not.

isSavingEnabled

• isSavingEnabled(): boolean

• @since

  2.2.0b82

  ---

  Returns boolean

markDirty

• markDirty(): void

• Refreshes slot in UI.

  ---

  Returns void

resetSavingEnabled

• resetSavingEnabled(): void

• @since

  2.2.0b82

  ---

  Returns void

set

• set(id: number, count: number, data: number, extra: ItemExtraData): void

• Implementation of UI.AbstractSlot.set

  Sets slot contents.

  ---

  Parameters

  • id: number

  • count: number

  • data: number

  • extra: ItemExtraData

  Returns void

setSavingEnabled

• setSavingEnabled(enabled: boolean): void

• @since

  2.2.0b82

  ---

  Parameters

  • enabled: boolean

  Returns void

setSlot

• setSlot(id: number, count: number, data: number): void
• setSlot(id: number, count: number, data: number, extra: ItemExtraData): void

• Sets slot contents.

  ---

  Parameters

  • id: number

  • count: number

  • data: number

  Returns void

validate

• validate(): void

• Implementation of UI.AbstractSlot.validate

  Resets slot if it's ID or count equals 0.

  ---

  Returns void