Class GlobalMouseInfo

Hierarchy

Constructors

constructor

Properties

event position

Accessors

target targetElement

Methods

invalidateTarget isTarget isWithin update updateTarget

Constructors

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>

targetElement

  • get targetElement(): undefined | HTMLElement

  • The element the mouse is currently hovering over.

    Returns undefined | HTMLElement

Methods

invalidateTarget

  • Returns void

isTarget

  • 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)

isWithin

  • 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)

update

  • Parameters

    • evt: Event & Partial<MouseEvent> & Partial<TouchEvent>

    Returns void

updateTarget

  • Forces a target update. Use as much as you want now ;)

    Returns void

Settings

Member Visibility

Theme

Generated using TypeDoc