Class GlobalMouseInfo

Hierarchy

Host<IGlobalMouseInfoEvents>
- GlobalMouseInfo

Index

Constructors

Properties

Accessors

target targetElement

Methods

isTarget isWithin update updateTarget updateTargetNextTick

Constructors

constructor

new GlobalMouseInfo(): GlobalMouseInfo
Returns GlobalMouseInfo

Inherited from EventEmitter.Host<IGlobalMouseInfoEvents>.constructor

Properties

`Readonly` event

event: IEventEmitter<GlobalMouseInfo, IGlobalMouseInfoEvents>

position

position: default = Vector2.ZERO

The current position of the mouse.

Accessors

target

get target(): null | default<HTMLElement>
The component the mouse is currently hovering over. null if the hovered element has no associated component.

Returns null | default<HTMLElement>
- Defined in src/game/ui/input/InputManager.ts:85

targetElement

get targetElement(): undefined | HTMLElement
The element the mouse is currently hovering over.

Returns undefined | HTMLElement
- Defined in src/game/ui/input/InputManager.ts:96

Methods

isTarget

isTarget<W>(what?: W, recalcTarget?: boolean): undefined | (W extends default<HTMLElement> ? W : HTMLElement)
Returns whether the mouse is currently within the given component, element, or selector.
Type Parameters
- W extends undefined | string | Element | default<HTMLElement>
Parameters
- Optional what: W
  
  A component, element, or selector.
- recalcTarget: boolean = false
  
  Whether to recalculate the target before this operation. Defaults to false
Returns undefined | (W extends default<HTMLElement> ? W : HTMLElement)
- Defined in src/game/ui/input/InputManager.ts:176

isWithin

isWithin<W>(what?: W, recalcTarget?: boolean): undefined | (W extends default<HTMLElement> ? W : HTMLElement)
Returns whether the mouse is currently within the given component, element, or selector, or its descendants.
Type Parameters
- W extends undefined | string | Element | default<HTMLElement>
Parameters
- Optional what: W
  
  A component, element, or selector.
- recalcTarget: boolean = false
  
  Whether to recalculate the target before this operation. Defaults to false
Returns undefined | (W extends default<HTMLElement> ? W : HTMLElement)
- Defined in src/game/ui/input/InputManager.ts:154

update

update(evt: Event & Partial<MouseEvent> & Partial<TouchEvent>): void
Parameters
- evt: Event & Partial<MouseEvent> & Partial<TouchEvent>
Returns void
- Defined in src/game/ui/input/InputManager.ts:126

updateTarget

updateTarget(force?: boolean): void
Forces a target update. Use as much as you want now ;)
Parameters
- force: boolean = false
Returns void
- Defined in src/game/ui/input/InputManager.ts:111

updateTargetNextTick

updateTargetNextTick(): void
Returns void
- Defined in src/game/ui/input/InputManager.ts:104

Generated using TypeDoc