Skip to main content

Class: ItemSlots<T>

Type parameters​

NameType
Tnumber

Constructors​

constructor​

• new ItemSlots<T>(options?): ItemSlots<T>

Type parameters​

NameType
Tnumber

Parameters​

NameType
optionsPartial<ItemSlotsOptions>

Returns​

ItemSlots<T>

Properties​

activated​

• activated: boolean = false


canvas​

• canvas: HTMLCanvasElement


focusedCol​

• focusedCol: number = -1


focusedRow​

• focusedRow: number = -1


hoveredCol​

• hoveredCol: number = -1


hoveredRow​

• hoveredRow: number = -1


onSlotClick​

• onSlotClick: (slot: ItemSlot<T>) => void = noop

Type declaration​

▸ (slot): void

Parameters​
NameType
slotItemSlot<T>
Returns​

void


onSlotUpdate​

• onSlotUpdate: (slot: ItemSlot<T>) => void = noop

Type declaration​

▸ (slot): void

Parameters​
NameType
slotItemSlot<T>
Returns​

void


options​

• options: ItemSlotsOptions


renderer​

• renderer: Renderer = null

The page's renderer, which draws the slots into canvas through its own canvas target (attachRenderer). Nothing draws until one is attached.


slotTotalHeight​

• slotTotalHeight: number


slotTotalWidth​

• slotTotalWidth: number


wrapper​

• wrapper: HTMLDivElement

Accessors​

element​

• get element(): HTMLDivElement

Returns​

HTMLDivElement

Methods​

activate​

▸ activate(): void

Returns​

void


attachRenderer​

▸ attachRenderer(renderer): void

Draws the slots with renderer (the page's one renderer) into this canvas from now on.

Parameters​

NameType
rendererRenderer

Returns​

void


connect​

▸ connect(inputs, namespace?): () => void

Parameters​

NameTypeDefault value
inputsInputs<any>undefined
namespacestring"*"

Returns​

fn

▸ (): void

Returns​

void


deactivate​

▸ deactivate(): void

Returns​

void


dispose​

▸ dispose(): void

Returns​

void


getContent​

▸ getContent(row, col): T

Parameters​

NameType
rownumber
colnumber

Returns​

T


getFocused​

▸ getFocused(): ItemSlot<T>

Returns​

ItemSlot<T>


getObject​

▸ getObject(row, col): Object3D<Object3DEventMap>

Parameters​

NameType
rownumber
colnumber

Returns​

Object3D<Object3DEventMap>


getRowColFromEvent​

▸ getRowColFromEvent(event): Object

Parameters​

NameType
eventMouseEvent

Returns​

Object

NameType
colnumber
rownumber

getSlot​

▸ getSlot(row, col): ItemSlot<T>

Parameters​

NameType
rownumber
colnumber

Returns​

ItemSlot<T>


getSubscript​

▸ getSubscript(row, col): string

Parameters​

NameType
rownumber
colnumber

Returns​

string


onFocusChange​

▸ onFocusChange(callbackFunc): () => void

Listen for the focused slot changing.

Parameters​

NameType
callbackFunc(prevSlot: ItemSlot<T>, nextSlot: ItemSlot<T>) => void

Returns​

fn

A function to unsubscribe. A listener owned by something with a lifetime shorter than the hotbar's — a mounted UI component, say — must call it, or every remount leaves another copy running.

▸ (): void

Returns​

void


render​

▸ render(): void

Returns​

void


requestRender​

▸ requestRender(): void

Returns​

void


setContent​

▸ setContent(row, col, content): void

Parameters​

NameType
rownumber
colnumber
contentT

Returns​

void


setFocused​

▸ setFocused(row, col): void

Parameters​

NameType
rownumber
colnumber

Returns​

void


setObject​

▸ setObject(row, col, object): void

Parameters​

NameType
rownumber
colnumber
objectObject3D<Object3DEventMap> | HTMLImageElement

Returns​

void


setSubscript​

▸ setSubscript(row, col, subscript): void

Parameters​

NameType
rownumber
colnumber
subscriptstring

Returns​

void


triggerFocusChange​

▸ triggerFocusChange(prevSlot, nextSlot): void

Parameters​

NameType
prevSlotItemSlot<T>
nextSlotItemSlot<T>

Returns​

void


warm​

▸ warm(): void

Builds this view's draw pipelines (the present pass, and the output transform into its canvas) with one 1x1 draw, while it is still hidden behind the loading screen. Built by the first draw instead, on the click into play, they were a dropped frame there on a cold shader cache. The next real draw sizes the canvas again.

Returns​

void