Interface
: (key: Key | Key[], action: (key: Key) => void): KEventController Register an event that runs every frame when a key is held down.
param key- The key(s) to listen for.
param action- The function to run when the event is triggered.
// move left by SPEED pixels per frame every frame when left arrow key is being held down
onKeyDown("left", () => {
bean.move(-SPEED, 0)
});
returns The event controller.
since v2000.1
group Input
subgroup Keyboard
Register an event that runs every frame when any key is held down.
param action- The function to run when the event is triggered.
returns The event controller.
since v2000.1
group Input
subgroup Keyboard
Register an event that runs when user presses certain keys.
param key- The key(s) to listen for.
param action- The function to run when the event is triggered.
// .jump() once when "space" is just being pressed
onKeyPress("space", () => {
bean.jump();
});
onKeyPress(["up", "space"], () => {
bean.jump();
});
returns The event controller.
since v2000.1
group Input
subgroup Keyboard
Register an event that runs when user presses any key.
param action- The function to run when the event is triggered.
// Call restart() when player presses any key
onKeyPress((key) => {
debug.log(`key pressed ${key}`);
restart();
});
returns The event controller.
since v3001.0
group Input
subgroup Keyboard
Register an event that runs when user presses certain keys (also fires repeatedly when the keys are being held down).
param k- The key(s) to listen for.
param action- The function to run when the event is triggered.
// delete last character when "backspace" is being pressed and held
onKeyPressRepeat("backspace", () => {
input.text = input.text.substring(0, input.text.length - 1);
});
returns The event controller.
since v3000.1
group Input
subgroup Keyboard
Register an event that runs when user presses any key and fires repeatedly when the keys are being held down.
param action- The function to run when the event is triggered.
// delete last character when "backspace" is being pressed and held
onKeyPressRepeat((key) => {
debug.log(`key ${key} is being repeatedly pressed`)
});
returns The event controller.
since v3000.1
group Input
subgroup Keyboard
Register an event that runs when user release certain keys.
param k- = The key(s) to listen for. See
param action- The function that runs when a user releases certain keys
// release `a` or `b` keys
onKeyRelease([`a`, `b`], (k) => {
debug.log(`Released the ${k} key...`);
});
returns The event controller.
since v2000.1
group Input
subgroup Keyboard
Register an event that runs when user releases a key.
param action- The function that runs when a user releases a
// release a key
onKeyRelease((k) => {
debug.log(`Released the ${k} key...`);
});
returns The event controller.
since v2000.1
group Input
Register an event that runs when user inputs text.
param action- The function to run when the event is triggered.
// type into input
onCharInput((ch) => {
input.text += ch
})
returns The event controller.
since v2000.1
group Input
subgroup Keyboard
Register an event that runs every frame when certain mouse buttons are being held down.
param btn- The mouse button(s) to listen for. See
param action- The function that is run when certain mouse buttons are being held down.
// count time with left mouse button down
let mouseTime = 0;
onMouseDown("left", () => {
mouseTime += dt();
debug.log(`Time with mouse down: ${mouseTime});
});
returns The event controller.
since v3001.0
group Input
subgroup Mouse
Register an event that runs every frame when any mouse button is being held down.
param action- The function that is run when any mouse button is being held down.
// count time with any mouse button down
let mouseTime = 0;
onMouseDown((m) => {
mouseTime += dt();
});
returns The event controller.
since v3001.0
group Input
subgroup Mouse
Register an event that runs when user clicks mouse.
param action- The function that is run when user clicks a mouse button.
// gives cookies on left press, remove on right press
let cookies = 0;
onMousePress(["left", "right"], (m) => {
if (m == "left") {
cookies++;
} else {
cookies--;
}
});
returns The event controller.
since v3001.0
group Input
subgroup Mouse
Register an event that runs when user clicks mouse.
param btn- The mouse button(s) to listen for. See
param action- The function that is run what the user clicks cetain mouse buttons.
// gives cookies on any mouse press
let cookies = 0;
onMousePress((m) => {
cookies++;
debug.log(`Cookies: ${cookies}`);
});
returns The event controller.
since v3001.0
group Input
subgroup Mouse
Register an event that runs when user releases mouse.
param action- The function that is run what the user clicks a provided mouse button.
// spawn bean where right mouse is released
onMouseRelease("right", (m) => {
debug.log(`${m} released, spawning bean...`);
add([
pos(mousePos()),
sprite("bean"),
anchor("center"),
]);
});
returns The event controller.
since v3001.0
group Input
subgroup Mouse
Register an event that runs when user releases mouse.
param btn- The button(s) to listen for. See
param action- The function that is run what the user clicks a provided mouse button.
// spawn bean where right mouse is released
onMouseRelease((m) => {
if (m == "right") {
debug.log(`${m} released, spawning bean...`);
add([
pos(mousePos()),
sprite("bean"),
anchor("center"),
]);
});
});
returns The event controller.
since v3001.0
group Input
subgroup Mouse
Register an event that runs whenever user moves the mouse.
param action- The function that is run what the user moves the mouse.
// runs when the mouse has moved
onMouseMove((p, d) => {
bean.pos = p; // set bean position to mouse position
});
returns The event controller.
since v2000.1
group Input
subgroup Mouse
Register an event that runs when a touch starts.
param action- The function to run when the event is triggered.
returns The event controller.
since v2000.1
group Input
subgroup Touch
Register an event that runs when a touch ends.
param action- The function to run when the event is triggered.
returns The event controller.
since v2000.1
group Input
subgroup Touch
Register an event that runs whenever touch moves.
param action- The function to run when the event is triggered.
returns The event controller.
since v2000.1
group Input
subgroup Touch
Register an event that runs when mouse wheel scrolled.
param action- The function to run when the event is triggered.
// Zoom camera on scroll
onScroll((delta) => {
const zoom = delta.y / 500;
camScale(camScale().add(zoom));
});
returns The event controller.
since v3000.0
group Input
subgroup Mouse
Register an event that runs when a gamepad is connected.
param action- The function that runs when quit() is called.
// watch for a controller connecting
onGamepadConnect((gp) => {
debug.log(`ohhi player ${gp.index + 1}`);
});
returns The event controller.
since v3000.0
group Input
subgroup Gamepad
Register an event that runs when a gamepad is disconnected.
param action- The function that runs when quit() is called.
// watch for a controller disconnecting
onGamepadDisconnect((gp) => {
debug.log(`ohbye player ${gp.index + 1}`);
});
returns The event controller.
since v3000.0
group Input
subgroup Gamepad
Register an event that runs every frame when certain gamepad buttons are held down.
param btn- The button(s) to listen for. See
param action- The function that is run while certain gamepad buttons are held down.
// when button is being held down
onGamepadButtonDown("rtrigger", (gp) => {
car.addForce(Vec2.fromAngle(car.angle).scale(10));
});
returns The event controller.
since v3001.0
group Input
subgroup Gamepad
Register an event that runs every frame when any gamepad buttons are held down.
param action- The function that is run while any gamepad buttons are held down.
// when button is being held down
onGamepadButtonDown((btn, gp) => {
if (btn == "rtrigger") {
car.addForce(Vec2.fromAngle(car.angle).scale(10));
} else if (btn == "ltrigger") {
car.addForce(Vec2.fromAngle(car.angle).scale(-5));
}
});
returns The event controller.
since v3001.0
group Input
subgroup Gamepad
Register an event that runs when user presses certain gamepad button.
param btn- The button(s) to listen for. See
param action- The function that is run when certain gamepad buttons are pressed.
// when user presses button
onGamepadButtonPress("south", (btn, gp) => {
player.jump(200);
});
returns The event controller.
since v3001.0
group Input
subgroup Gamepad
Register an event that runs when user presses any gamepad button.
param action- The function that is run when any gamepad buttons is pressed.
// when user presses button
onGamepadButtonPress((btn, gp) => {
if (btn == "south") {
player.jump(200); // jump
}
});
returns The event controller.
since v3001.0
group Input
subgroup Gamepad
Register an event that runs when user releases certain gamepad button
param btn- The button(s) to listen for. See
param action- The function that is run when certain gamepad buttons are released.
// charged attack
let chargeTime = 0
onGamepadButtonPress("west", (btn, gp) => {
chargeTime = time();
});
// when a gamepad button is released, this is run
onGamepadButtonRelease("west", (btn, gp) => {
let chargedt = time() - chargeTime;
debug.log(`Used ${chargedt * 1000} power!`);
});
returns The event controller.
since v3001.0
group Input
subgroup Gamepad
Register an event that runs when user releases any gamepad button.
param action- The function that is run when any gamepad buttons are released.
// when a gamepad button is released, this is run
onGamepadButtonRelease((btn, gp) => {
if (btn == "north") {
player.jump(500);
}
});
returns The event controller.
since v3000.0
group Input
subgroup Gamepad
Register an event that runs when the gamepad axis exists.
param stick- The stick to listen for. See
param action- The function that is run when a specific gamepad stick is moved.
// player move
let player = add([
pos(center()),
sprite(`bean`),
]);
// when left stick is moved
onGamepadStick("left", (stickVector, gp) => {
player.move(stickVector.x, 0);
});
returns The event controller.
since v3000.0
group Input
subgroup Gamepad
Register an event that runs when user press a defined button
(like "jump") on any input (keyboard, gamepad).
param btn- The button(s) to listen for.
param action- The function to run when the event is triggered.
returns The event controller.
since v3001.0
group Input
subgroup Buttons API
Register an event that runs when user press a defined button
(like "jump") on any input (keyboard, gamepad).
param btn- The button(s) to listen for.
param action- The function to run when the event is triggered.
returns The event controller.
since v3001.0
group Input
subgroup Buttons API
Register an event that runs when user release a defined button
(like "jump") on any input (keyboard, gamepad).
param btn- The button(s) to listen for.
param action- The function to run when the event is triggered.
returns The event controller.
since v3001.0
group Input
subgroup Buttons API
Register an event that runs when tab is shown.
param action- The function that is run when the tab is shown.
// User has returned to this tab
onTabShow(() => {
burp();
});
returns The event controller.
since v3001.0
group Events
Register an event that runs when tab is hidden.
param action- The function that is run what the tab is hidden.
// spooky ghost
let ghosty = add([
pos(center()),
sprite("ghosty"),
anchor("center"),
]);
// when switching tabs, this runs
onTabHide(() => {
destroy(ghosty);
add([
text("There was never aa ghosttttt"),
pos(center()),
anchor("center")
]);
});
returns The event controller.
since v3001.0
group Events
param action- The function that is run what the tab is hidden.
deprecated use `onTabHide` instead
Register an event that runs when tab is hidden.
// spooky ghost
let ghosty = add([
pos(center()),
sprite("ghosty"),
anchor("center"),
]);
// when switching tabs, this runs
onHide(() => {
destroy(ghosty);
add([
text("There was never aa ghosttttt"),
pos(center()),
anchor("center")
]);
});
returns The event controller.
since v3001.0
group Events
param action- The function that is run when the tab is shown.
deprecated use `onTabShow` instead
Register an event that runs when tab is shown.
// user has returned to this tab
onShow(() => {
burp();
});
returns The event controller.
since v3001.0
group Events
Register an event that runs at a fixed framerate.
param action- The function to run when the event is triggered.
returns The event controller.
since v3001.0
group Events
Register an event that runs every frame.
param action- The function to run when the event is triggered.
returns The event controller.
since v2000.0
group Events
Register an event that runs every frame (this is the same as onUpdate but all draw events are run after update events, drawXXX() functions only work in this phase).
onDraw(() => {
drawLine({
p1: vec2(0),
p2: mousePos(),
color: rgb(0, 0, 255),
})
})
returns The event controller.
since v2000.1
group Events