Class WorkbenchUIHandler

Class used to simplify creation of custom workbenches

Hierarchy

WorkbenchUIHandler

Index

Constructors

constructor

Methods

Constructors

constructor

new WorkbenchUIHandler(target: ElementSet, targetCon: UI.Container, field: Recipes.WorkbenchField): WorkbenchUIHandler

- Defined in core-engine.d.ts:15846
Constructs a new Workbench UI handler

Parameters
- target: ElementSet
  
  target WindowContent.elements section
- targetCon: UI.Container
  
  target container
- field: Recipes.WorkbenchField
  
  workbench field
Returns WorkbenchUIHandler

Methods

deselectCurrentRecipe

deselectCurrentRecipe(): void

- Defined in core-engine.d.ts:15883
Deselects current recipe (asynchronously)

Returns void

refresh

refresh(): number

- Defined in core-engine.d.ts:15858
Refreshes all the recipes in the workbench

Returns number
amount of recipes displayed

refreshAsync

refreshAsync(): void

- Defined in core-engine.d.ts:15865
Runs recipes refresh in the ticking thread delaying refresh process for a tick. To get recipes count use WorkbenchUIHandler.setOnRefreshListener

Returns void

setMaximumRecipesToShow

setMaximumRecipesToShow(count: number): void

- Defined in core-engine.d.ts:15889
Sets workbench recipes displaying limit. By default it is 250

Parameters
- count: number
  
  count of the recipes to show
Returns void

setOnRefreshListener

setOnRefreshListener(listener: { onRefreshCompleted: any; onRefreshStarted: any }): void

- Defined in core-engine.d.ts:15878
Registers listener to be notified when the workbench starts and completes refreshing

Parameters
- listener: { onRefreshCompleted: any; onRefreshStarted: any }
  
  workbench refresh listener
  - onRefreshCompleted:function
    - onRefreshCompleted(count: number): void
    - Defined in core-engine.d.ts:15878
      Parameters
      - count: number
      Returns void
  - onRefreshStarted:function
    - onRefreshStarted(): void
    - Defined in core-engine.d.ts:15878
      Returns void
Returns void

setOnSelectionListener

setOnSelectionListener(listener: { onRecipeSelected: any }): void

- Defined in core-engine.d.ts:15871
Registers listener to be notified when some recipe is selected

Parameters
- listener: { onRecipeSelected: any }
  
  recipe selection listener
  - onRecipeSelected:function
    - onRecipeSelected(recipe: WorkbenchRecipe): void
    - Defined in core-engine.d.ts:15871
      Parameters
      - recipe: WorkbenchRecipe
      Returns void
Returns void

setPrefix

setPrefix(prefix: string): void

- Defined in core-engine.d.ts:15852
Sets custom workbench prefix

Parameters
- prefix: string
  
  custom workbench prefix
Returns void

Generated using TypeDoc