Button Events

Event	Fires when…
gc.button.press	…a button is pressed.
gc.button.hold	…a button is being held. Will fire continuously until it is released.
gc.button.release	…a button is released.

These events pass a Button instance to the detail property of the Event object.

Example

window.addEventListener('gc.button.press', function(event) {
	console.log(event.detail);
}, false);

>> Button {…}

Events

gc.button.press

This is fired as when a button's value property becomes anything greater than 0.

Note: Because not all buttons are binary (some are pressure sensitive and return values between 0.0 and 1.0) it is possible for the gc.button.press event to fire but the button's pressed attribute to be false.

gc.button.hold

This event fires rapidly as long as a button's value is greater than 0. The interval at which it fires is tied to requestAnimationFrame() and therefor cannot be guaranteed to be regular.

gc.button.release

This will fire once as soon as a button's value returns to 0 after having been above 0.

Button Objects

A Button represent a button input's state.

Properties

Name	Type	Description
controllerIndex	Int	The [[index
time	Int	A DOMHighResTimeStamp representing when the button was updated.
name	String	The name of the button.
pressed	Bool	Whether the button is pressed or not.
value	Float	A number between 0 (not pressed) and 1 (fully pressed) indicating how far down a button is pressed. Although most buttons don't report values between 0 and 1, some — such as triggers — do.

Example

// Button object
Button {
	controllerIndex: 0,
	time: 4526.165,
	name: "DPAD_UP",
	pressed: false,
	value: 0
}