Class WorkbenchUIHandler

Class used to simplify creation of custom workbenches.

Index

Constructors

Methods

deselectCurrentRecipe refresh refreshAsync setMaximumRecipesToShow setOnRefreshListener setOnSelectionListener setPrefix

Constructors

constructor

new WorkbenchUIHandler(target, targetCon, field): WorkbenchUIHandler
Constructs a new Workbench UI handler.
Parameters
- target: ElementSet
  target UI.WindowContent.elements section
- targetCon: Container
  target container
- field: WorkbenchField
  workbench field
Returns WorkbenchUIHandler
- Defined in Recipes.d.ts:233

Methods

deselectCurrentRecipe

deselectCurrentRecipe(): void
Deselects current recipe (asynchronously).

Returns void
- Defined in Recipes.d.ts:269

refresh

refresh(): number
Refreshes all the recipes in the workbench.

Returns number
Amount of recipes displayed.
- Defined in Recipes.d.ts:245

refreshAsync

refreshAsync(): void
Runs recipes refresh in the ticking thread delaying refresh process for a tick. To get recipes count use WorkbenchUIHandler.setOnRefreshListener.

Returns void
- Defined in Recipes.d.ts:251

setMaximumRecipesToShow

setMaximumRecipesToShow(count): void
Sets workbench recipes displaying limit.
Parameters
- count: number
  count of the recipes to show
Returns void
Default
```
250
```
- Defined in Recipes.d.ts:276

setOnRefreshListener

setOnRefreshListener(listener): void
Registers listener to be notified when the workbench starts and completes refreshing.
Parameters
- listener: {
  onRefreshCompleted: ((count: number) => void);
  onRefreshStarted: (() => void);
  }
  workbench refresh listener
  - onRefreshCompleted: ((count: number) => void)
    - (count): void
      Parameters
      count: number
      Returns void
  - onRefreshStarted: (() => void)
    - (): void
      Returns void
Returns void
- Defined in Recipes.d.ts:264

setOnSelectionListener

setOnSelectionListener(listener): void
Registers listener to be notified when some recipe is selected.
Parameters
- listener: {
  onRecipeSelected: ((recipe: WorkbenchRecipe) => void);
  }
  recipe selection listener
  - onRecipeSelected: ((recipe: WorkbenchRecipe) => void)
    - (recipe): void
      Parameters
      recipe: WorkbenchRecipe
      Returns void
Returns void
- Defined in Recipes.d.ts:257

setPrefix

setPrefix(prefix): void
Sets custom workbench prefix.
Parameters
- prefix: string
  custom workbench prefix
Returns void
- Defined in Recipes.d.ts:239

Copyright © 2024 Nernar. Copyright © 2020 #mineprogramming. Built with ❤ and TypeDoc.