_DialogCraftedMenu <T>

Hierarchy

• _DialogFocusMenu
  • _DialogCraftedMenu

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 _DialogCraftedMenu<T>(mode: T): _DialogCraftedMenu<T>

• Inherited from _DialogFocusMenu.constructor

  Type parameters

  • T: string

  Parameters

  • mode: T

    The name of the mode associated with this instance

  Returns _DialogCraftedMenu<T>

Properties

clickStatusCallbacks

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

Overrides _DialogFocusMenu.clickStatusCallbacks

readonlydefaultShape

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

Inherited from _DialogFocusMenu.defaultShape

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 }

Inherited from _DialogFocusMenu.eventListeners

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

ids

ids: Readonly<{ crafter: dialog-crafted-crafter; description: dialog-crafted-description; footer: dialog-crafted-footer; gap: dialog-crafted-gap; icon: dialog-crafted-icon; info: dialog-crafted-info; name: dialog-crafted-name; private: dialog-crafted-private; property: dialog-crafted-property; root: dialog-crafted; status: dialog-crafted-status }> = ...

Overrides _DialogFocusMenu.ids

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

@abstract

readonlymode

mode: T

Inherited from _DialogFocusMenu.mode

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

Accessors

C

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

• Inherited from _DialogFocusMenu.C

  Get or set the currently selected character.

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

  ---

  Returns Character

• Inherited from _DialogFocusMenu.C

  Parameters

  • value: Character

  Returns void

focusGroup

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

• Inherited from _DialogFocusMenu.focusGroup

  Get or set the currently selected group.

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

  ---

  Returns AssetItemGroup

• Inherited from _DialogFocusMenu.focusGroup

  Parameters

  • value: AssetItemGroup

  Returns void

shape

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

• Inherited from _DialogFocusMenu.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

• Inherited from _DialogFocusMenu.shape

  Parameters

  • value: RectTuple

  Returns void

Methods

Click

• Click(event: MouseEvent | TouchEvent): void

• Inherited from _DialogFocusMenu.Click

  Called if the user clicks on the canvas

  ---

  Parameters

  • event: MouseEvent | TouchEvent

    The event that triggered this

  Returns void

Draw

• Draw(): void

• Inherited from _DialogFocusMenu.Draw

  Called each frame when the screen needs to be drawn.

  ---

  Returns void

Exit

• Exit(): void

• Inherited from _DialogFocusMenu.Exit

  Called when user presses Esc

  ---

  Returns void

GetClickStatus

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

• Inherited from _DialogFocusMenu.GetClickStatus

  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: null

    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

• Inherited from _DialogFocusMenu.Init

  Initialize the DialogMenu subscreen.

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

  ---

  Parameters

  • C: Character

    The character in question

  • focusGroup: AssetItemGroup

    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

• Inherited from _DialogFocusMenu.KeyDown

  Called if the the user presses any key

  ---

  Parameters

  • event: KeyboardEvent

    The event that triggered this

  Returns boolean

Load

• Load(): void

• Inherited from _DialogFocusMenu.Load

  Called when screen is loaded using CommonSetScreen

  ---

  Returns void

Reload

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

• Inherited from _DialogFocusMenu.Reload

  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

• Inherited from _DialogFocusMenu.Resize

  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

• Inherited from _DialogFocusMenu.Unload

  Called when this screen is being replaced

  ---

  Returns void

_ClickButton

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

• Overrides _DialogFocusMenu._ClickButton

  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: null

    The buttons underlying object (item or activity)

  • equippedItem: Item

    The currently equipped item

  Returns void

_ConstructPaginateButtons

• _ConstructPaginateButtons(id: string): HTMLDivElement

• Inherited from _DialogFocusMenu._ConstructPaginateButtons

  ---

  Parameters

  • id: string

  Returns HTMLDivElement

_GetClickedObject

• _GetClickedObject(button: HTMLButtonElement): null

• Overrides _DialogFocusMenu._GetClickedObject

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

  @abstract

  ---

  Parameters

  • button: HTMLButtonElement

    The clicked button

  Returns null

  • The button's underlying item or activity object

_Load

• _Load(): HTMLElement

• Overrides _DialogFocusMenu._Load

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

  @abstract

  ---

  Returns HTMLElement

_Reload

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

• Inherited from _DialogFocusMenu._Reload

  See DialogMenu.Reload

  ---

  Parameters

  • param: ReloadFocusParam

  • options: ReloadOptions

  Returns boolean

_ReloadButtonGrid

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

• Overrides _DialogFocusMenu._ReloadButtonGrid

  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

• Overrides _DialogFocusMenu._ReloadIcon

  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

• Overrides _DialogFocusMenu._ReloadMenubar

  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

• Overrides _DialogFocusMenu._ReloadStatus

  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: ReloadFocusParam; status: true }

• Inherited from _DialogFocusMenu._ReloadValidate

  See DialogMenu.Reload

  ---

  Parameters

  • C: Character

  • focusGroup: AssetItemGroup

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