Interface IGameScreenEvents

Hierarchy

Events<default>
- IGameScreenEvents

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

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

hideContextMenu

hideContextMenu(contextMenu: default<string | number | symbol>): any
Parameters
- contextMenu: default<string | number | symbol>
Returns any
Inherited from Events.hideContextMenu
- Defined in src/game/ui/screen/Screen.ts:37

hideDialog

hideDialog(dialogId: DialogId): any
Parameters
- dialogId: DialogId
Returns any
Inherited from Events.hideDialog
- Defined in src/game/ui/screen/Screen.ts:34

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

obscure

obscure(): any
Emitted when this screen is obscured by another

Returns any
Inherited from Events.obscure
- Defined in src/game/ui/screen/Screen.ts:39

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

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

reveal

reveal(): any
Emitted when this screen is no longer obscured

Returns any
Inherited from Events.reveal
- Defined in src/game/ui/screen/Screen.ts:41

rooted

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

show

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

showContextMenu

showContextMenu(contextMenu: default<string | number | symbol>): any
Parameters
- contextMenu: default<string | number | symbol>
Returns any
Inherited from Events.showContextMenu
- Defined in src/game/ui/screen/Screen.ts:36

showDialog

showDialog(dialog: default): any
Parameters
- dialog: default
Returns any
Inherited from Events.showDialog
- Defined in src/game/ui/screen/Screen.ts:35

toggleScreenshotMode

toggleScreenshotMode(enabled: boolean): any
Parameters
- enabled: boolean
Returns any
- Defined in src/game/ui/screen/screens/GameScreen.ts:101

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