Interface ICanvasDialogEvents

Hierarchy

Events<default>
- ICanvasDialogEvents

Methods

addChild

addChild(child: HTMLElement | default<HTMLElement>): any
Parameters
- child: HTMLElement | default<HTMLElement>
Returns any
Inherited from Events.addChild
- Defined in src/game/ui/component/IComponent.ts:26

append

append(to: HTMLElement | default<HTMLElement>): any
Parameters
- to: HTMLElement | default<HTMLElement>
Returns any
Inherited from Events.append
- Defined in src/game/ui/component/IComponent.ts:23

blur

blur(): any
Returns any
Inherited from Events.blur
- Defined in src/game/ui/component/IComponent.ts:39

close

close(): any
Emitted when the close button is pressed in the dialog, or when the close method is called.

Returns any
Inherited from Events.close
- Defined in src/game/ui/screen/screens/game/component/Dialog.ts:221

enter

enter(reason: "focus" | "mouse"): any
Parameters
- reason: "focus" | "mouse"
Returns any
Inherited from Events.enter
- Defined in src/game/ui/component/IComponent.ts:36

focus

focus(): any
Returns any
Inherited from Events.focus
- Defined in src/game/ui/component/IComponent.ts:38

hide

hide(): any
Returns any
Inherited from Events.hide
- Defined in src/game/ui/component/IComponent.ts:21

inputChange

inputChange(event: Event): any
Parameters
- event: Event
Returns any
Inherited from Events.inputChange
- Defined in src/game/ui/component/IComponent.ts:30

leave

leave(reason: "remove" | "focus" | "mouse"): any
Parameters
- reason: "remove" | "focus" | "mouse"
Returns any
Inherited from Events.leave
- Defined in src/game/ui/component/IComponent.ts:37

load

load(initial: boolean): any
Emitted after all fields decorated with @Save are loaded
Parameters
- initial: boolean
Returns any
Inherited from Events.load
- Defined in src/game/ui/screen/screens/game/component/Dialog.ts:243

makeTopDialog

makeTopDialog(order: number): any
Parameters
- order: number
Returns any
Inherited from Events.makeTopDialog
- Defined in src/game/ui/screen/screens/game/component/Dialog.ts:244

mouseEnter

mouseEnter(): any
Returns any
Inherited from Events.mouseEnter
- Defined in src/game/ui/screen/screens/game/component/Dialog.ts:245

mouseLeave

mouseLeave(): any
Returns any
Inherited from Events.mouseLeave
- Defined in src/game/ui/screen/screens/game/component/Dialog.ts:246

move

move(xDiff: number, yDiff: number, rectangle: default): any
Emitted when the dialog is moved
Parameters
- xDiff: number
- yDiff: number
- rectangle: default
Returns any
Inherited from Events.move
- Defined in src/game/ui/screen/screens/game/component/Dialog.ts:233

observed

observed(): any
Fired when the element is first observed. observe() must be called to setup this event.

Returns any
Inherited from Events.observed
- Defined in src/game/ui/component/IComponent.ts:46

options

options(): any
Emitted when the settings button is pressed in the dialog.

Returns any
Inherited from Events.options
- Defined in src/game/ui/screen/screens/game/component/Dialog.ts:225

regenerateBox

regenerateBox(box: IBox): any
Parameters
- box: IBox
Returns any
Inherited from Events.regenerateBox
- Defined in src/game/ui/component/IComponent.ts:35

remove

remove(): any
Returns any
Inherited from Events.remove
- Defined in src/game/ui/component/IComponent.ts:24

removeChild

removeChild(): any
Returns any
Inherited from Events.removeChild
- Defined in src/game/ui/component/IComponent.ts:27

removeContextMenu

removeContextMenu(): any
Returns any
Inherited from Events.removeContextMenu
- Defined in src/game/ui/component/IComponent.ts:40

removeForAppend

removeForAppend(): any
Returns any
Inherited from Events.removeForAppend
- Defined in src/game/ui/component/IComponent.ts:25

resetView

resetView(): any
Returns any
- Defined in src/game/ui/screen/screens/game/component/CanvasDialog.ts:237

resize

resize(wDiff: number, hDiff: number, rectangle: default): any
Emitted when the dialog is resized
Parameters
- wDiff: number
- hDiff: number
- rectangle: default
Returns any
Inherited from Events.resize
- Defined in src/game/ui/screen/screens/game/component/Dialog.ts:229

rooted

rooted(): any
Returns any
Inherited from Events.rooted
- Defined in src/game/ui/component/IComponent.ts:28

setSubId

setSubId(id: string, oldId: string): any
Parameters
- id: string
- oldId: string
Returns any
Inherited from Events.setSubId
- Defined in src/game/ui/screen/screens/game/component/Dialog.ts:247

show

show(): any
Returns any
Inherited from Events.show
- Defined in src/game/ui/component/IComponent.ts:20

switchPanel

switchPanel(id: string | number, panel: default<HTMLElement>): any
Emitted when the dialog panel changes
Parameters
- id: string | number
  
  The string or number representing the panel that was switched to
- panel: default<HTMLElement>
  
  The panel that was switched to
Returns any
Inherited from Events.switchPanel
- Defined in src/game/ui/screen/screens/game/component/Dialog.ts:239

toggleVisible

toggleVisible(visible: boolean): any
Parameters
- visible: boolean
Returns any
Inherited from Events.toggleVisible
- Defined in src/game/ui/component/IComponent.ts:22

unapplyImagePathHandler

unapplyImagePathHandler(component: default<HTMLElement>, variableName: string): any
Parameters
- component: default<HTMLElement>
- variableName: string
Returns any
Inherited from Events.unapplyImagePathHandler
- Defined in src/game/ui/util/ImagePath.ts:32

unrooted

unrooted(): any
Returns any
Inherited from Events.unrooted
- Defined in src/game/ui/component/IComponent.ts:29

willRemove

willRemove(): boolean | void
Returns
false to cancel removal.

Returns boolean | void
Inherited from Events.willRemove
- Defined in src/game/ui/component/IComponent.ts:34

Generated using TypeDoc