Gesture

MMO.inputs · 1 symbol · generated 5 Oct 2026

class

Gesture

Gesture Options: - allow_move: {Boolean} true to capture mouse move - allow_out: {Boolean} true to allow mouse to go out of the element Events : - fail - done - start - stop - update

class MMO.inputs.Gesture extends MMO.core.EventEmitter

Namespace: MMO.inputs
Extends: EventEmitter

Index

	node readonly accessor
	constructor(input, name, opts)
	toString()
	remove()	Unregister this gesture from its input.
	isInTarget(e)	Tells if event happened inside input element or one of its children
	clear(status)	[internal] Stop gesture by setting its status and unscheduling everything left
	cancel()	[internal]
	done()	[internal]
	start()	[internal]
	stop()	[internal]
	update(e)	Called everytime an event is captured from the element
	allowDispatch(gesture)	Called if status = S_IN and another gesture is completed.
	statusProgress()	Get the progress of the gesture before completion
	setStatus(status)	Set gesture status : - S_IDDLE: the gesture has not started.
	schedule(name, time)	Schedule a function
	unschedule(name)	Unschedule a function

Properties1

node

readonlyaccessorGesture.js:36

get node()

Type: Element

Methods15

constructor(input, name, opts)

constructor(input, name, opts)

input
name
opts

toString()

toString()

returns string

remove()

Unregister this gesture from its input.

remove()

isInTarget(e)

Tells if event happened inside input element or one of its children

isInTarget(e)

e	`Event`
returns	`Boolean`

clear(status)

[internal] Stop gesture by setting its status and unscheduling everything left

clear(status)

status	`int`	by default MMO.inputs.S_IDDLE
returns

cancel()

[internal]

cancel()

done()

[internal]

done()

start()

[internal]

start()

stop()

[internal]

stop()

update(e)

Called everytime an event is captured from the element

update(e)

e	`Event`	the event
returns	`bool`	true if gesture is completed

allowDispatch(gesture)

Called if status = S_IN and another gesture is completed.

allowDispatch(gesture)

Return false if you want to ignore the gesture

gesture	`Gesture`
returns	`bool`

statusProgress()

Get the progress of the gesture before completion

statusProgress()

returns float [0,1]

setStatus(status)

Set gesture status : - S_IDDLE: the gesture has not started. No events are captured.

setStatus(status)

- S_IN: the gesture has started and events are captured. - S_DONE: the gesture has been completed. No events are captured.

status number

schedule(name, time)

Schedule a function

schedule(name, time)

name	`string`	the gesture's function to call
time	`int`	in ms. The time to wait before calling function
returns

unschedule(name)

Unschedule a function

unschedule(name)

name	`string`	the gesture's function to call
returns