Class Input

Hierarchy

Implements

  • IInput

Constructors

constructor

Accessors

mouseClick mouseDoubleClick mouseDown mousePosition mousePositionRC mousePressed mouseUp mouseWheelChanged

Methods

convertScreenspaceToRaycastSpace createPointerDown createPointerMove createPointerUp foreachPointerId foreachTouchId getIsMouse getIsTouch getKeyDown getKeyPressed getMouseWheelChanged getMouseWheelDeltaY getPointerClicked getPointerDoubleClicked getPointerDown getPointerDownTime getPointerEvent getPointerLongPress getPointerPosition getPointerPositionDelta getPointerPositionLastFrame getPointerPositionRC getPointerPressed getPointerPressedCount getPointerUp getPointerUpTime getPointerUsed getTouchesPressedCount isKeyDown isKeyPressed isKeyUp setCursorNormal setCursorPointer setPointerUsed

Constructors

constructor

  • new Input(context): Input

  • Parameters

    Returns Input

Accessors

mouseClick

  • get mouseClick(): boolean

  • Returns boolean

mouseDoubleClick

  • get mouseDoubleClick(): boolean

  • Returns boolean

mouseDown

  • get mouseDown(): boolean

  • Returns boolean

mousePosition

  • get mousePosition(): Vector2

  • Returns Vector2

mousePositionRC

  • get mousePositionRC(): Vector2

  • Returns Vector2

mousePressed

  • get mousePressed(): boolean

  • Returns boolean

mouseUp

  • get mouseUp(): boolean

  • Returns boolean

mouseWheelChanged

  • get mouseWheelChanged(): boolean

  • Returns boolean

Methods

convertScreenspaceToRaycastSpace

  • convertScreenspaceToRaycastSpace(vec2): void

  • Parameters

    • vec2: Vec2

    Returns void

createPointerDown

  • createPointerDown(args): void

  • Parameters

    • args: PointerEventArgs

    Returns void

createPointerMove

  • createPointerMove(args): void

  • Parameters

    • args: PointerEventArgs

    Returns void

createPointerUp

  • createPointerUp(args): void

  • Parameters

    • args: PointerEventArgs

    Returns void

foreachPointerId

  • foreachPointerId(pointerType?): Generator<number, any, unknown>

  • Parameters

    • Optional pointerType: string | string[] | PointerType[]

    Returns Generator<number, any, unknown>

foreachTouchId

getIsMouse

  • getIsMouse(i): boolean

  • Parameters

    • i: number

    Returns boolean

getIsTouch

  • getIsTouch(i): boolean

  • Parameters

    • i: number

    Returns boolean

getKeyDown

  • getKeyDown(): string

  • Returns string

getKeyPressed

  • getKeyPressed(): string

  • Returns string

getMouseWheelChanged

  • getMouseWheelChanged(i?): boolean

  • Parameters

    • i: number = 0

    Returns boolean

getMouseWheelDeltaY

  • getMouseWheelDeltaY(i?): number

  • Parameters

    • i: number = 0

    Returns number

getPointerClicked

  • getPointerClicked(i): boolean

  • Parameters

    • i: number

    Returns boolean

getPointerDoubleClicked

  • getPointerDoubleClicked(i): boolean

  • Parameters

    • i: number

    Returns boolean

getPointerDown

  • getPointerDown(i): boolean

  • Parameters

    • i: number

    Returns boolean

getPointerDownTime

  • getPointerDownTime(i): number

  • Parameters

    • i: number

    Returns number

getPointerEvent

  • getPointerEvent(i): Event

  • Parameters

    • i: number

    Returns Event

getPointerLongPress

  • getPointerLongPress(i): boolean

  • Parameters

    • i: number

    Returns boolean

getPointerPosition

  • getPointerPosition(i): any

  • Parameters

    • i: number

    Returns any

getPointerPositionDelta

  • getPointerPositionDelta(i): any

  • Parameters

    • i: number

    Returns any

getPointerPositionLastFrame

  • getPointerPositionLastFrame(i): any

  • Parameters

    • i: number

    Returns any

getPointerPositionRC

  • getPointerPositionRC(i): any

  • Parameters

    • i: number

    Returns any

getPointerPressed

  • getPointerPressed(i): boolean

  • Parameters

    • i: number

    Returns boolean

getPointerPressedCount

  • getPointerPressedCount(): number

  • how many pointers are currently pressed

    Returns number

getPointerUp

  • getPointerUp(i): boolean

  • Parameters

    • i: number

    Returns boolean

getPointerUpTime

  • getPointerUpTime(i): number

  • Parameters

    • i: number

    Returns number

getPointerUsed

  • getPointerUsed(i): boolean

  • Parameters

    • i: number

    Returns boolean

getTouchesPressedCount

  • getTouchesPressedCount(): number

  • Returns number

isKeyDown

  • isKeyDown(keyCode): boolean

  • Parameters

    • keyCode: string

    Returns boolean

isKeyPressed

  • isKeyPressed(keyCode): boolean

  • Parameters

    • keyCode: string

    Returns boolean

isKeyUp

  • isKeyUp(keyCode): boolean

  • Parameters

    • keyCode: string

    Returns boolean

setCursorNormal

  • setCursorNormal(): void

  • Returns void

setCursorPointer

  • setCursorPointer(): void

  • Returns void

setPointerUsed

  • setPointerUsed(i, used?): void

  • Parameters

    • i: number
    • used: boolean = true

    Returns void

Settings

Member Visibility

Theme

On This Page

constructormouseClickmouseDoubleClickmouseDownmousePositionmousePositionRCmousePressedmouseUpmouseWheelChangedconvertScreenspaceToRaycastSpacecreatePointerDowncreatePointerMovecreatePointerUpforeachPointerIdforeachTouchIdgetIsMousegetIsTouchgetKeyDowngetKeyPressedgetMouseWheelChangedgetMouseWheelDeltaYgetPointerClickedgetPointerDoubleClickedgetPointerDowngetPointerDownTimegetPointerEventgetPointerLongPressgetPointerPositiongetPointerPositionDeltagetPointerPositionLastFramegetPointerPositionRCgetPointerPressedgetPointerPressedCountgetPointerUpgetPointerUpTimegetPointerUsedgetTouchesPressedCountisKeyDownisKeyPressedisKeyUpsetCursorNormalsetCursorPointersetPointerUsed

Generated using TypeDoc