DialogMenu <ModeType, ClickedObj>

@abstract

Hierarchy

• DialogMenu
  • _DialogFocusMenu
  • _DialogDialogMenu

Index

Constructors

• constructor

Properties

• clickStatusCallbacks
• defaultShape
• eventListeners
• ids
• mode

Accessors

• C
• focusGroup
• shape

Methods

• Click
• Draw
• Exit
• GetClickStatus
• Init
• KeyDown
• Load
• Reload
• Resize
• Unload
• _ClickButton
• _ConstructPaginateButtons
• _GetClickedObject
• _Load
• _Reload
• _ReloadButtonGrid
• _ReloadIcon
• _ReloadMenubar
• _ReloadStatus
• _ReloadValidate

Constructors

constructor

• new DialogMenu<ModeType, ClickedObj>(mode: ModeType): DialogMenu<ModeType, ClickedObj>

• Type parameters

  • ModeType: string = string
  • ClickedObj: DialogInventoryItem | ItemActivity | DialogLine = any

  Parameters

  • mode: ModeType

    The name of the mode associated with this instance

  Returns DialogMenu<ModeType, ClickedObj>

Properties

readonlyclickStatusCallbacks

clickStatusCallbacks: Record<string, (C: Character, clickedObj: ClickedObj, 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

readonlydefaultShape

defaultShape: readonly [number, number, number, number] = ...

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

See DialogMenu.shape.

readonlyeventListeners

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 }

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

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

readonlymode

mode: ModeType

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

Accessors

C

• get C(): Character
• set C(value: Character): void

• Get or set the currently selected character.

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

  ---

  Returns Character

• Parameters

  • value: Character

  Returns void

focusGroup

• get focusGroup(): AssetItemGroup
• set focusGroup(value: AssetItemGroup): void

• Get or set the currently selected group.

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

  ---

  Returns AssetItemGroup

• Parameters

  • value: AssetItemGroup

  Returns void

shape

• get shape(): RectTuple
• set shape(value: RectTuple): void

• 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

  • value: RectTuple

  Returns void

Methods

Click

• Click(event: MouseEvent | TouchEvent): void

• Called if the user clicks on the canvas

  ---

  Parameters

  • event: MouseEvent | TouchEvent

    The event that triggered this

  Returns void

Draw

• Draw(): void

• Called each frame when the screen needs to be drawn.

  ---

  Returns void

Exit

• Exit(): void

• Called when user presses Esc

  ---

  Returns void

GetClickStatus

• GetClickStatus(C: Character, clickedObj: ClickedObj, 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: ClickedObj

    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

• Init(C: Character, focusGroup?: AssetItemGroup, style?: { shape?: RectTuple }): HTMLDivElement

• Initialize the DialogMenu subscreen.

  Serves as a ["Load"] wrapper with added parameters.

  ---

  Parameters

  • C: Character

    The character in question

  • focusGroup: AssetItemGroup = null

    The focused item group

  • style: { shape?: RectTuple } = null

    Misc styling for the subscreen

  • optionalshape: RectTuple

  Returns HTMLDivElement

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

KeyDown

• KeyDown(event: KeyboardEvent): boolean

• Called if the the user presses any key

  ---

  Parameters

  • event: KeyboardEvent

    The event that triggered this

  Returns boolean

Load

• Load(): void

• Called when screen is loaded using CommonSetScreen

  ---

  Returns void

Reload

• Reload(C?: Character, focusGroup?: AssetItemGroup, options?: ReloadOptions): Promise<boolean>

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

  ---

  Parameters

  • C: Character = null

    The selected character; defaults to DialogMenu.C and will update the property inplace otherwise

  • focusGroup: AssetItemGroup = null

    The selected group; defaults to DialogMenu.focusGroup and will update the property inplace otherwise

  • optionaloptions: ReloadOptions = null

    Further customization options

  Returns Promise<boolean>

  • Whether an update was triggered or aborted

Resize

• Resize(load: boolean): void

• Called when screen size or position changes or after screen load

  ---

  Parameters

  • load: boolean

    If the reason for call was load (true) or window resize (false)

  Returns void

Unload

• Unload(): void

• Called when this screen is being replaced

  ---

  Returns void

_ClickButton

• _ClickButton(button: HTMLButtonElement, C: Character, clickedObj: ClickedObj, 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: ClickedObj

    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): ClickedObj

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

  @abstract

  ---

  Parameters

  • button: HTMLButtonElement

    The clicked button

  Returns ClickedObj

  • The button's underlying item or activity object

_Load

• _Load(): HTMLElement

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

  @abstract

  ---

  Returns HTMLElement

_Reload

• _Reload(param: ReloadParam, options: ReloadOptions): boolean

• See DialogMenu.Reload

  ---

  Parameters

  • param: ReloadParam

  • options: ReloadOptions

  Returns boolean

_ReloadButtonGrid

• _ReloadButtonGrid(root: HTMLElement, buttonGrid: HTMLElement, C: Character, focusGroup: AssetItemGroup, options: Pick<ReloadOptions, reset | resetScrollbar | resetDialogItems>): void

• A DialogMenu.Reload helper function for reloading DialogMenu.ids.grid elements.

  @abstract

  ---

  Parameters

  • root: HTMLElement

  • buttonGrid: HTMLElement

  • C: Character

  • focusGroup: AssetItemGroup

  • options: Pick<ReloadOptions, reset | resetScrollbar | resetDialogItems>

  Returns void

_ReloadIcon

• _ReloadIcon(root: HTMLElement, icon: HTMLElement, C: Character, focusGroup: AssetItemGroup, options: Pick<ReloadOptions, never>): void

• A DialogMenu.Reload helper function for reloading DialogMenu.ids.icon elements.

  @abstract

  ---

  Parameters

  • root: HTMLElement

  • icon: HTMLElement

  • C: Character

  • focusGroup: AssetItemGroup

  • options: Pick<ReloadOptions, never>

  Returns void

_ReloadMenubar

• _ReloadMenubar(root: HTMLElement, menubar: HTMLElement, C: Character, focusGroup: AssetItemGroup, options: Pick<ReloadOptions, reset>): void

• A DialogMenu.Reload helper function for reloading DialogMenu.ids.menubar elements.

  @abstract

  ---

  Parameters

  • root: HTMLElement

  • menubar: HTMLElement

  • C: Character

  • focusGroup: AssetItemGroup

  • options: Pick<ReloadOptions, reset>

  Returns void

_ReloadStatus

• _ReloadStatus(root: HTMLElement, status: HTMLElement, C: Character, focusGroup: AssetItemGroup, options: Pick<ReloadOptions, status | statusTimer>): void

• A DialogMenu.Reload helper function for reloading DialogMenu.ids.status elements.

  @abstract

  ---

  Parameters

  • root: HTMLElement

  • status: HTMLElement

  • C: Character

  • focusGroup: AssetItemGroup

  • options: Pick<ReloadOptions, status | statusTimer>

  Returns void

_ReloadValidate

• _ReloadValidate(C: Character, focusGroup: AssetItemGroup): { param?: never; status: false } | { param: ReloadParam; status: true }

• See DialogMenu.Reload

  ---

  Parameters

  • C: Character

  • focusGroup: AssetItemGroup

  Returns { param?: never; status: false } | { param: ReloadParam; status: true }