ClassInput & Controls@public

Mouse

Deterministic pointer/mouse state with camera-aware coordinates.

export declare class Mouse extends FlxPoint

Constructors

constructor(context: FlxContext)

Constructs a new instance of the Mouse class

Parameter	Type	Description
context	FlxContext	-

Properties

Property	Modifiers	Type	Description
cursor	readonly	string	-
screenX	-	number	-
screenY	-	number	-
visible	readonly	boolean	-
wheel	-	number	-

Methods

destroy()

destroy(): void

Returns: void

getGlobalPosition()

getGlobalPosition(point?: FlxPoint): FlxPoint

Copies logical canvas coordinates before camera transforms.

Parameters:

Parameter	Type	Description
point	FlxPoint	-

Returns: FlxPoint

getScreenPosition()

getScreenPosition(camera?: FlxCamera, point?: FlxPoint): FlxPoint

Returns camera-local coordinates before zoom/rotation/viewport transforms.

Parameters:

Parameter	Type	Description
camera	FlxCamera	-
point	FlxPoint	-

Returns: FlxPoint

getWorldPosition()

getWorldPosition(camera?: FlxCamera, point?: FlxPoint): FlxPoint

Parameters:

Parameter	Type	Description
camera	FlxCamera	-
point	FlxPoint	-

Returns: FlxPoint

handleMouseDown()

handleMouseDown(event: FlxPointerEventLike): void

Parameters:

Parameter	Type	Description
event	FlxPointerEventLike	-

Returns: void

handleMouseUp()

handleMouseUp(event: FlxPointerEventLike): void

Parameters:

Parameter	Type	Description
event	FlxPointerEventLike	-

Returns: void

handleMouseWheel()

handleMouseWheel(delta: number): void

Parameters:

Parameter	Type	Description
delta	number	-

Returns: void

handlePointerCancel()

handlePointerCancel(event: FlxPointerEventLike): void

Parameters:

Parameter	Type	Description
event	FlxPointerEventLike	-

Returns: void

handlePointerDown()

handlePointerDown(event: FlxPointerEventLike): void

Parameters:

Parameter	Type	Description
event	FlxPointerEventLike	-

Returns: void

handlePointerMove()

handlePointerMove(event: FlxPointerEventLike): void

Parameters:

Parameter	Type	Description
event	FlxPointerEventLike	-

Returns: void

handlePointerUp()

handlePointerUp(event: FlxPointerEventLike): void

Parameters:

Parameter	Type	Description
event	FlxPointerEventLike	-

Returns: void

handleWheel()

handleWheel(delta: number): void

Parameters:

Parameter	Type	Description
delta	number	-

Returns: void

hide()

hide(): void

Returns: void

justCancelled()

justCancelled(button?: number): boolean

Parameters:

Parameter	Type	Description
button	number	-

Returns: boolean

justPressed()

justPressed(button?: number): boolean

Parameters:

Parameter	Type	Description
button	number	-

Returns: boolean

justReleased()

justReleased(button?: number): boolean

Parameters:

Parameter	Type	Description
button	number	-

Returns: boolean

load()

load(cursorUrl: string, xOffset?: number, yOffset?: number): void

Parameters:

Parameter	Type	Description
cursorUrl	string	-
xOffset	number	-
yOffset	number	-

Returns: void

playback()

playback(record: FlxMouseRecord): void

Parameters:

Parameter	Type	Description
record	FlxMouseRecord	-

Returns: void

pressed()

pressed(button?: number): boolean

Parameters:

Parameter	Type	Description
button	number	-

Returns: boolean

record()

record(): FlxMouseRecord

Returns: FlxMouseRecord

releaseAll()

releaseAll(cancelled?: boolean): void

Queues releases for published buttons and discards unpublished input.

Parameters:

Parameter	Type	Description
cancelled	boolean	-

Returns: void

reset()

reset(): void

Returns: void

show()

show(): void

Returns: void

unload()

unload(): void

Returns: void

update()

update(): void

Publishes queued pointer changes for one authoritative simulation step.

Returns: void