Class MoveTouchControlsHandler

PrivateconfigurationEventListeners

PrivatedraggingElement

PrivateisLandscapeMode

Privateoverlay

PrivatetouchControls

PrivatechangeOrientation

• changeOrientation(isLandscapeMode: boolean): Promise<void>

  Changes the state of the touch controls to the given orientation.

  Parameters

  • isLandscapeMode: boolean

    Whether the screen is in landscape mode.

  Returns Promise<void>

PrivatecreateConfigurationEventListeners

• createConfigurationEventListeners(
      controlGroups: HTMLDivElement[],
  ): ConfigurationEventListeners

  Creates the event listeners for the configuration mode.

  Parameters

  • controlGroups: HTMLDivElement[]

    The elements that can be dragged around the screen.

  Returns ConfigurationEventListeners

  The event listeners for the configuration mode.

PrivatecreateOverlay

• createOverlay(ui: UI): void

  Creates an overlay that covers the screen and allows the user to drag the touch controls around. Also enables the toolbar for saving, resetting, and canceling the changes.

  Parameters

  • ui: UI

    The UI of the game.

  Returns void

PrivatecreateToolbar

• createToolbar(): void

  Initializes the toolbar of the configuration mode. Places its elements at the top of the touch controls and adds event listeners to them.

  Returns void

PrivatecreateToolbarElement

• createToolbarElement(): HTMLDivElement

  Creates the toolbar element for the configuration mode.

  Returns HTMLDivElement

  A new div element that contains the toolbar for the configuration mode.

Privatedrag

• drag(event: PointerEvent): void

  Drags the currently dragged element to the given pointer position.

  Parameters

  • event: PointerEvent

    The pointer event that is currently happening.

  Returns void

PrivategetConfigToolbarRefs

• getConfigToolbarRefs(): undefined | ToolbarRefs

  Returns the references to the elements of the configuration toolbar.

  Returns undefined | ToolbarRefs

  The references to the elements of the configuration toolbar or undefined if the elements can not be found (e.g. during tests)

PrivategetControlGroupElements

• getControlGroupElements(): HTMLDivElement[]

  Returns all control groups of the touch controls. These are groups of buttons that can be dragged around the screen.

  Returns HTMLDivElement[]

  All control groups of the touch controls.

PrivategetLocalStorageKey

• getLocalStorageKey(): string

  Returns the key of the local storage for the control positions data of this orientation

  Returns string

PrivategetModifiedCurrentPositions

• getModifiedCurrentPositions(): ControlPosition[]

  Returns the current positions of all touch controls that have moved from their default positions of this orientation.

  Returns ControlPosition[]

  The current positions of all touch controls that have moved from their default positions of this orientation

PrivategetSavedPositionsOfCurrentOrientation

• getSavedPositionsOfCurrentOrientation(): ControlPosition[]

  Returns the saved positions of the touch controls. Filters result by the given orientation.

  Returns ControlPosition[]

  The saved positions of the touch controls of this orientation

PrivategetScreenSize

• getScreenSize(): { height: number; width: number }

  Returns { height: number; width: number }

PrivateisLeft

• isLeft(element: HTMLElement): undefined | boolean

  Elements that are inside the left div are anchored to the left boundary of the screen. The x value of the positions are considered offsets to their respective boundaries.

  Parameters

  • element: HTMLElement

    Either an element in the left div or the right div.

  Returns undefined | boolean

  Whether the given element is inside the left div.

PrivateresetPositions

• resetPositions(): void

  Resets the positions of the touch controls to their default positions and clears the saved positions. Does not save the changes.

  Returns void

PrivatesaveCurrentPositions

• saveCurrentPositions(): void

  Saves the current positions of the touch controls to the local storage.

  Returns void

PrivatesetPosition

• setPosition(controlElement: HTMLElement, x: number, y: number): void

  Sets a control element to the given position. The x values are either offsets to the left or right boundary of the screen, depending on the side of the element. E.g. For left elements, (0, 0) is the bottom left corner of the screen and for right elements, (0, 0) is the bottom right corner of the screen.

  Parameters

  • controlElement: HTMLElement
  • x: number

    Either an offset to the left or right boundary of the screen.

  • y: number

    An offset to the bottom boundary of the screen.

  Returns void

PrivatesetPositions

• setPositions(positions: ControlPosition[]): void

  Updates the positions of the touch controls.

  Parameters

  • positions: ControlPosition[]

    The new positions of the touch controls.

  Returns void

PrivatestartDrag

• startDrag(controlGroup: HTMLElement): void

  Start dragging the given button.

  Parameters

  • controlGroup: HTMLElement

    The button that is being dragged.

  Returns void

PrivatestopDrag

• stopDrag(): void

  Stops dragging the currently dragged element.

  Returns void