Skip to main content

AdjustmentAction

Abstract base class for adjustment actions

Adjustment actions handle continuous input devices that can be turned or moved to adjust values incrementally. These actions can optionally support reset functionality.

Example​

class VolumeAdjustment extends AdjustmentAction {
  name = "volume-adjustment";
  displayName = "Volume Control";
  description = "Adjust system volume";
  hasReset = true;

  execute(event: AdjustmentActionExecuteEvent) {
    // Adjust volume based on event.tick
    console.log(`Adjusting volume by ${event.tick}`);
  }
}

See​

Extends​

  • ManageAction

Constructors​

Constructor​

new AdjustmentAction(): AdjustmentAction;

Returns​

AdjustmentAction

Inherited from​

ManageAction.constructor;

Methods​

execute()​

abstract execute(event: AdjustmentActionExecuteEvent): void | Promise<void>;

Handles the user interaction with assigned key.

Parameters​

event​

AdjustmentActionExecuteEvent

Returns​

void | Promise<void>

Properties​

description​

abstract description: string;

Action Description shown in the UI.

Inherited from​

ManageAction.description;

displayName​

abstract displayName: string;

Display Name (or title) shown in the UI.

Inherited from​

ManageAction.displayName;

groupName​

readonly groupName: string = '';

Optional group/folder under which this action is listed in the UI. Leave empty to place the action at the top level.

Inherited from​

ManageAction.groupName;

hasReset​

abstract readonly hasReset: boolean;

Defines if action has reset command.

name​

abstract readonly name: string;

Unique name for the action. Used for identification in the system.

Inherited from​

ManageAction.name;