Class TooltipSurface

Hierarchy

Host<ITooltipSurfaceEvents>
- TooltipSurface

Index

Constructors

Properties

event surface tooltip?

Accessors

Methods

hasTooltip hideTooltip remove removeTooltip setId showTooltip updatePosition

Constructors

constructor

new TooltipSurface(): TooltipSurface
Returns TooltipSurface

Inherited from EventEmitter.Host<ITooltipSurfaceEvents>.constructor

Properties

`Readonly` event

event: IEventEmitter<TooltipSurface, ITooltipSurfaceEvents>

`Readonly` surface

surface: default<HTMLElement> = ...

`Optional` tooltip

tooltip?: default

Accessors

host

get host(): undefined | HTMLElement
Returns undefined | HTMLElement
- Defined in src/game/ui/tooltip/TooltipManager.ts:152

Methods

hasTooltip

hasTooltip(host?: HTMLElement): boolean
Parameters
- Optional host: HTMLElement
Returns boolean
- Defined in src/game/ui/tooltip/TooltipManager.ts:165

hideTooltip

hideTooltip(host?: undefined | HTMLElement): boolean
Parameters
- host: undefined | HTMLElement = ...
Returns boolean
- Defined in src/game/ui/tooltip/TooltipManager.ts:201

remove

remove(): void
Returns void
- Defined in src/game/ui/tooltip/TooltipManager.ts:216

removeTooltip

removeTooltip(): void
Returns void
- Defined in src/game/ui/tooltip/TooltipManager.ts:210

setId

setId(id: string): TooltipSurface
Parameters
- id: string
Returns TooltipSurface
- Defined in src/game/ui/tooltip/TooltipManager.ts:160

showTooltip

showTooltip(host: HTMLElement, initialize?: ((tooltip: default) => any)): undefined | default
Parameters
- host: HTMLElement
- Optional initialize: ((tooltip: default) => any)
  - - (tooltip: default): any
    - Parameters
      
      tooltip: default
      
      Returns any
Returns undefined | default
- Defined in src/game/ui/tooltip/TooltipManager.ts:170

updatePosition

updatePosition(): void
Returns void
- Defined in src/game/ui/tooltip/TooltipManager.ts:222

Generated using TypeDoc