Skip to main content

_DialogSelfMenu <ModeType, T>

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

  • new _DialogSelfMenu<ModeType, T>(mode: ModeType): _DialogSelfMenu<ModeType, T>

Properties

_initProperties

_initProperties: { C: PlayerCharacter } = null

An object for storing all of this classes init properties.

Subclasses should generally implement a public getter/setter interface for safely manipulating each property stored herein.

Type declaration

_initPropertyNames

_initPropertyNames: readonly [C] = ...

A list of all init property names as supported by this class. Represents the set of keys that will be stored in _initProperties

@abstract

readonlyclickStatusCallbacks

clickStatusCallbacks: Record<string, (C: Character, clickedObj: T, equippedItem?: Item) => string>

An object mapping IDs to DialogMenu.GetClickStatus helper functions. Used for evaluating the error statuses of item clicks.

Additional checks can be freely added here.

@abstract

defaultShape

defaultShape: readonly [15, 15, 500, 940] = ...

The default position & shape of the current subscreen as defined by the root element.

See DialogMenu.shape.

eventListeners

eventListeners: { _ClickButton: (this: HTMLButtonElement, ev: MouseEvent) => string; _ClickDisabledButton: (this: HTMLButtonElement, ev: MouseEvent) => string; _ClickPaginateNext: (this: HTMLButtonElement, ev: MouseEvent) => void; _ClickPaginatePrev: (this: HTMLButtonElement, ev: MouseEvent) => void; _WheelGrid: (this: HTMLDivElement, event: WheelEvent) => void; _ClickDisabledMenuButton: any; _ClickMenuButton: any }

An object containg all event listeners referenced in the DialogMenu subclass.

Type declaration

  • _ClickButton: (this: HTMLButtonElement, ev: MouseEvent) => string
    @returns

    A status message if an unexpected error is encountered and null otherwise

      • (this: HTMLButtonElement, ev: MouseEvent): string

      • Parameters

        • this: HTMLButtonElement
        • ev: MouseEvent

        Returns string

  • _ClickDisabledButton: (this: HTMLButtonElement, ev: MouseEvent) => string
    @returns

    A status message if an expected error is encountered and null otherwise

      • (this: HTMLButtonElement, ev: MouseEvent): string

      • Parameters

        • this: HTMLButtonElement
        • ev: MouseEvent

        Returns string

  • _ClickPaginateNext: (this: HTMLButtonElement, ev: MouseEvent) => void

    See DialogMenu.KeyDown

      • (this: HTMLButtonElement, ev: MouseEvent): void

      • Parameters

        • this: HTMLButtonElement
        • ev: MouseEvent

        Returns void

  • _ClickPaginatePrev: (this: HTMLButtonElement, ev: MouseEvent) => void

    See DialogMenu.KeyDown

      • (this: HTMLButtonElement, ev: MouseEvent): void

      • Parameters

        • this: HTMLButtonElement
        • ev: MouseEvent

        Returns void

  • _WheelGrid: (this: HTMLDivElement, event: WheelEvent) => void

    Provide more consistent mouse wheel scroll behavior by using browser-independent increments.

      • (this: HTMLDivElement, event: WheelEvent): void

      • Parameters

        • this: HTMLDivElement
        • event: WheelEvent

        Returns void

  • _ClickDisabledMenuButton: function
    • _ClickDisabledMenuButton(this: HTMLButtonElement, ev: MouseEvent): void

    • Parameters

      • this: HTMLButtonElement
      • ev: MouseEvent

      Returns void

  • _ClickMenuButton: function
    • _ClickMenuButton(this: HTMLButtonElement, ev: MouseEvent): void

    • Parameters

      • this: HTMLButtonElement
      • ev: MouseEvent

      Returns void

readonlyids

ids: Readonly<Record<string, string> & { grid?: string; icon?: string; menubar?: string; paginate?: string; root: string; status?: string }>

An object containg all DOM element IDs referenced in the DialogMenu subclass.

@abstract

menubarEventListeners

menubarEventListeners: { next: MenuButtonData<{ C: PlayerCharacter }> }

An object mapping button HTMLButtonElement.names to their respective click + validation functions

Type declaration

readonlymode

mode: ModeType

The name of the mode associated with this instance (see DialogMenuMode).

Accessors

C

  • get C(): PropType[C]
  • set C(value: PropType[C]): void

  • Get or set the currently selected character.

    Performs a hard DialogMenu.Reload if a new character is assigned.

    Returns PropType[C]

  • Parameters

    • value: PropType[C]

    Returns void

focusGroup

  • Get or set the currently selected group.

    Performs a hard DialogMenu.Reload if a new focus group is assigned.

    Returns AssetGroup

shape

  • Get or set the position & shape of the current subscreen as defined by the root element.

    Performs a DialogMenu.Resize if a new shape is assigned.

    Returns RectTuple

  • Parameters

    Returns void

Methods

Click

  • Click(event: MouseEvent | TouchEvent): void

  • Parameters

    • event: MouseEvent | TouchEvent

    Returns void

Draw

  • Draw(): void

  • Returns void

Exit

  • Exit(): void

  • Returns void

GetClickStatus

  • GetClickStatus(C: Character, clickedObj: T, equippedItem?: Item): string

  • Return an error status (if any) for when an item or activity is clicked.

    Error statuses are used for evaluating whether the relevant grid buttons must be disabled or not.

    Parameters

    • C: Character

      The target character

    • clickedObj: T

      The item that is clicked

    • equippedItem: Item = null

      The item that is equipped (if any)

    Returns string

    • The error status or null if everything is ok

Init

  • Initialize the DialogMenu subscreen.

    Serves as a ScreenLoadHandler wrapper with added parameters.

    Parameters

    Returns HTMLDivElement

    The div containing the dialog subscreen root element or null if the screen failed to initialize

IsAvailable

  • Whether this self-menu is accessible via the "view next page" button.

    Parameters

    Returns boolean

KeyDown

  • KeyDown(event: KeyboardEvent): boolean

  • Parameters

    • event: KeyboardEvent

    Returns boolean

Load

  • Load(): void

  • Returns void

Reload

  • Reload the subscreen, updating the DOM elements and, if required, re-assigning the character and focus group.

    Parameters

    Returns Promise<boolean>

    • Whether an update was triggered or aborted

Resize

  • Resize(load: boolean): void

  • Parameters

    • load: boolean

    Returns void

Run

  • Run(time: number): void

  • Parameters

    • time: number

    Returns void

Unload

  • Unload(): void

  • Returns void

_ClickButton

  • _ClickButton(button: HTMLButtonElement, C: Character, clickedObj: T, equippedItem: Item): void

  • Helper function for handling the clicks of succesfully validated grid button clicks.

    @abstract

    Parameters

    • button: HTMLButtonElement

      The clicked button

    • C: Character

      The target character

    • clickedObj: T

      The buttons underlying object (item or activity)

    • equippedItem: Item

      The currently equipped item

    Returns void

_ConstructPaginateButtons

  • _ConstructPaginateButtons(id: string): HTMLDivElement

  • Parameters

    • id: string

    Returns HTMLDivElement

_GetClickedObject

  • _GetClickedObject(button: HTMLButtonElement): T

  • Return the underlying item or activity object of the passed grid button.

    @abstract

    Parameters

    • button: HTMLButtonElement

      The clicked button

    Returns T

    • The button's underlying item or activity object

_Load

  • _Load(): HTMLElement

  • Construct and return the (unpopulated) DialogMenu.ids.root element.

    @abstract

    Returns HTMLElement

_Reload

_ReloadButtonGrid

  • _ReloadButtonGrid(root: HTMLElement, buttonGrid: HTMLElement, properties: { C: PlayerCharacter }, options: Pick<ReloadOptions, reset | resetScrollbar | resetDialogItems>): void

_ReloadIcon

_ReloadMenubar

_ReloadStatus

  • _ReloadStatus(root: HTMLElement, status: HTMLElement, properties: { C: PlayerCharacter }, options: Pick<ReloadOptions, status | statusTimer>): void

_ReloadValidate

Page Options