Skip to content

Commit

Permalink
doc
Browse files Browse the repository at this point in the history 
: clarify descriptions
  • Loading branch information
@lajbel
lajbel committed Dec 20, 2024
1 parent a7bd27d commit 26da419
Showing 1 changed file with 28 additions and 28 deletions.
56 changes: 28 additions & 28 deletions guides/en/1_getting_started/6_events.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -245,31 +245,31 @@ obj.trigger("hi"); // :>

### App Events List

| Event | Description | Global Handler | Object Handler |
| ---------------------- | --------------------------------------- | ------------------------------------------------------------- | ------------------------------------------------------------------------------------ |
| `mouseMove` | Runs when mouse moves | [`onMouseMove()`](/doc/ctx/onMouseMove) | [`obj.onMouseMove()`](/doc/GameObjRaw/#GameObjRaw-onMouseMove) |
| `mouseDown` | Runs when mouse is clicked | [`onMouseDown()`](/doc/ctx/onMouseDown) | [`obj.onMouseDown()`](/doc/GameObjRaw/#GameObjRaw-onMouseDown) |
| `mousePress` | Runs when mouse button is pressed | [`onMousePress()`](/doc/ctx/onMousePress) | [`obj.onMousePress()`](/doc/GameObjRaw/#GameObjRaw-onMousePress) |
| `mouseRelease` | Runs when mouse button is released | [`onMouseRelease()`](/doc/ctx/onMouseRelease) | [`obj.onMouseRelease()`](/doc/GameObjRaw/#GameObjRaw-onMouseRelease) |
| `charInput` | Runs when a character input is detected | [`onCharInput()`](/doc/ctx/onCharInput) | [`obj.onCharInput()`](/doc/GameObjRaw/#GameObjRaw-onCharInput) |
| `keyPress` | Runs when a key is pressed | [`onKeyPress()`](/doc/ctx/onKeyPress) | [`obj.onKeyPress()`](/doc/GameObjRaw/#GameObjRaw-onKeyPress) |
| `keyDown` | Runs when a key is held down | [`onKeyDown()`](/doc/ctx/onKeyDown) | [`obj.onKeyDown()`](/doc/GameObjRaw/#GameObjRaw-onKeyDown) |
| `keyPressRepeat` | Runs when a key is repeatedly pressed | [`onKeyPressRepeat()`](/doc/ctx/onKeyPressRepeat) | [`obj.onKeyPressRepeat()`](/doc/GameObjRaw/#GameObjRaw-onKeyPressRepeat) |
| `keyRelease` | Runs when a key is released | [`onKeyRelease()`](/doc/ctx/onKeyRelease) | [`obj.onKeyRelease()`](/doc/GameObjRaw/#GameObjRaw-onKeyRelease) |
| `touchStart` | Runs when a touch starts | [`onTouchStart()`](/doc/ctx/onTouchStart) | [`obj.onTouchStart()`](/doc/GameObjRaw/#GameObjRaw-onTouchStart) |
| `touchMove` | Runs when a touch moves | [`onTouchMove()`](/doc/ctx/onTouchMove) | [`obj.onTouchMove()`](/doc/GameObjRaw/#GameObjRaw-onTouchMove) |
| `touchEnd` | Runs when a touch ends | [`onTouchEnd()`](/doc/ctx/onTouchEnd) | [`obj.onTouchEnd()`](/doc/GameObjRaw/#GameObjRaw-onTouchEnd) |
| `gamepadButtonDown` | Runs when a gamepad button is pressed | [`onGamepadButtonDown()`](/doc/ctx/onGamepadButtonDown) | [`obj.onGamepadButtonDown()`](/doc/GameObjRaw/#GameObjRaw-onGamepadButtonDown) |
| `gamepadButtonPress` | Runs when a gamepad button is held down | [`onGamepadButtonPress()`](/doc/ctx/onGamepadButtonPress) | [`obj.onGamepadButtonPress()`](/doc/GameObjRaw/#GameObjRaw-onGamepadButtonPress) |
| `gamepadButtonRelease` | Runs when a gamepad button is released | [`onGamepadButtonRelease()`](/doc/ctx/onGamepadButtonRelease) | [`obj.onGamepadButtonRelease()`](/doc/GameObjRaw/#GameObjRaw-onGamepadButtonRelease) |
| `gamepadStick` | Runs when a gamepad stick moves | [`onGamepadStick()`](/doc/ctx/onGamepadStick) | [`obj.onGamepadStick()`](/doc/GameObjRaw/#GameObjRaw-onGamepadStick) |
| `gamepadConnect` | Runs when a gamepad connects | [`onGamepadConnect()`](/doc/ctx/onGamepadConnect) | [`obj.onGamepadConnect()`](/doc/GameObjRaw/#GameObjRaw-onGamepadConnect) |
| `gamepadDisconnect` | Runs when a gamepad disconnects | [`onGamepadDisconnect()`](/doc/ctx/onGamepadDisconnect) | [`obj.onGamepadDisconnect()`](/doc/GameObjRaw/#GameObjRaw-onGamepadDisconnect) |
| `buttonDown` | Runs when a button is pressed | [`onButtonDown()`](/doc/ctx/onButtonDown) | [`obj.onButtonDown()`](/doc/GameObjRaw/#GameObjRaw-onButtonDown) |
| `buttonPress` | Runs when a button is held down | [`onButtonPress()`](/doc/ctx/onButtonPress) | [`obj.onButtonPress()`](/doc/GameObjRaw/#GameObjRaw-onButtonPress) |
| `buttonRelease` | Runs when a button is released | [`onButtonRelease()`](/doc/ctx/onButtonRelease) | [`obj.onButtonRelease()`](/doc/GameObjRaw/#GameObjRaw-onButtonRelease) |
| `scroll` | Runs when a scroll event occurs | [`onScroll()`](/doc/ctx/onScroll) | [`obj.onScroll()`](/doc/GameObjRaw/#GameObjRaw-onScroll) |
| `hide` | Runs when an object is hidden | [`onHide()`](/doc/ctx/onHide) | No ❌ |
| `show` | Runs when an object becomes visible | [`onShow()`](/doc/ctx/onShow) | No ❌ |
| `resize` | Runs when a resize event occurs | [`onResize()`](/doc/ctx/onResize) | No ❌ |
| `input` | Runs when the input is processed | No ❌ | No ❌ |
| Event | Description | Global Handler | Object Handler |
| ---------------------- | ----------------------------------------------------- | ------------------------------------------------------------- | ------------------------------------------------------------------------------------ |
| `mouseMove` | Runs continuously while mouse moves | [`onMouseMove()`](/doc/ctx/onMouseMove) | [`obj.onMouseMove()`](/doc/GameObjRaw/#GameObjRaw-onMouseMove) |
| `mouseDown` | Runs continuously while mouse is clicked | [`onMouseDown()`](/doc/ctx/onMouseDown) | [`obj.onMouseDown()`](/doc/GameObjRaw/#GameObjRaw-onMouseDown) |
| `mousePress` | Runs once when mouse button is pressed | [`onMousePress()`](/doc/ctx/onMousePress) | [`obj.onMousePress()`](/doc/GameObjRaw/#GameObjRaw-onMousePress) |
| `mouseRelease` | Runs once when mouse button is released | [`onMouseRelease()`](/doc/ctx/onMouseRelease) | [`obj.onMouseRelease()`](/doc/GameObjRaw/#GameObjRaw-onMouseRelease) |
| `charInput` | Runs continuously while user write in the keyboard | [`onCharInput()`](/doc/ctx/onCharInput) | [`obj.onCharInput()`](/doc/GameObjRaw/#GameObjRaw-onCharInput) |
| `keyPress` | Runs once when a key is pressed | [`onKeyPress()`](/doc/ctx/onKeyPress) | [`obj.onKeyPress()`](/doc/GameObjRaw/#GameObjRaw-onKeyPress) |
| `keyDown` | Runs continuously while a key is held down | [`onKeyDown()`](/doc/ctx/onKeyDown) | [`obj.onKeyDown()`](/doc/GameObjRaw/#GameObjRaw-onKeyDown) |
| `keyPressRepeat` | Runs once when a key is repeatedly pressed | [`onKeyPressRepeat()`](/doc/ctx/onKeyPressRepeat) | [`obj.onKeyPressRepeat()`](/doc/GameObjRaw/#GameObjRaw-onKeyPressRepeat) |
| `keyRelease` | Runs once when a key is released | [`onKeyRelease()`](/doc/ctx/onKeyRelease) | [`obj.onKeyRelease()`](/doc/GameObjRaw/#GameObjRaw-onKeyRelease) |
| `touchStart` | Runs once when a touch starts | [`onTouchStart()`](/doc/ctx/onTouchStart) | [`obj.onTouchStart()`](/doc/GameObjRaw/#GameObjRaw-onTouchStart) |
| `touchMove` | Runs continously while a touch moves | [`onTouchMove()`](/doc/ctx/onTouchMove) | [`obj.onTouchMove()`](/doc/GameObjRaw/#GameObjRaw-onTouchMove) |
| `touchEnd` | Runs once when a touch ends | [`onTouchEnd()`](/doc/ctx/onTouchEnd) | [`obj.onTouchEnd()`](/doc/GameObjRaw/#GameObjRaw-onTouchEnd) |
| `gamepadButtonDown` | Runs continously while a gamepad button is held down | [`onGamepadButtonDown()`](/doc/ctx/onGamepadButtonDown) | [`obj.onGamepadButtonDown()`](/doc/GameObjRaw/#GameObjRaw-onGamepadButtonDown) |
| `gamepadButtonPress` | Runs once when a gamepad button is pressed | [`onGamepadButtonPress()`](/doc/ctx/onGamepadButtonPress) | [`obj.onGamepadButtonPress()`](/doc/GameObjRaw/#GameObjRaw-onGamepadButtonPress) |
| `gamepadButtonRelease` | Runs once when a gamepad button is released | [`onGamepadButtonRelease()`](/doc/ctx/onGamepadButtonRelease) | [`obj.onGamepadButtonRelease()`](/doc/GameObjRaw/#GameObjRaw-onGamepadButtonRelease) |
| `gamepadStick` | Runs continuously while a gamepad stick moves | [`onGamepadStick()`](/doc/ctx/onGamepadStick) | [`obj.onGamepadStick()`](/doc/GameObjRaw/#GameObjRaw-onGamepadStick) |
| `gamepadConnect` | Runs once when a gamepad connects | [`onGamepadConnect()`](/doc/ctx/onGamepadConnect) | [`obj.onGamepadConnect()`](/doc/GameObjRaw/#GameObjRaw-onGamepadConnect) |
| `gamepadDisconnect` | Runs once when a gamepad disconnects | [`onGamepadDisconnect()`](/doc/ctx/onGamepadDisconnect) | [`obj.onGamepadDisconnect()`](/doc/GameObjRaw/#GameObjRaw-onGamepadDisconnect) |
| `buttonDown` | Runs continuously while an input binding is held down | [`onButtonDown()`](/doc/ctx/onButtonDown) | [`obj.onButtonDown()`](/doc/GameObjRaw/#GameObjRaw-onButtonDown) |
| `buttonPress` | Runs once when an input binding is pressed | [`onButtonPress()`](/doc/ctx/onButtonPress) | [`obj.onButtonPress()`](/doc/GameObjRaw/#GameObjRaw-onButtonPress) |
| `buttonRelease` | Runs once when a binding button is released | [`onButtonRelease()`](/doc/ctx/onButtonRelease) | [`obj.onButtonRelease()`](/doc/GameObjRaw/#GameObjRaw-onButtonRelease) |
| `scroll` | Runs continuously while a scroll event occurs | [`onScroll()`](/doc/ctx/onScroll) | [`obj.onScroll()`](/doc/GameObjRaw/#GameObjRaw-onScroll) |
| `hide` | Runs once when the game tab is hidden | [`onHide()`](/doc/ctx/onHide) | No ❌ |
| `show` | Runs once when the game tab is showed | [`onShow()`](/doc/ctx/onShow) | No ❌ |
| `resize` | Runs continously when the game screen is resizing | [`onResize()`](/doc/ctx/onResize) | No ❌ |
| `input` | Runs when the input is processed | No ❌ | No ❌ |

0 comments on commit 26da419

Please sign in to comment.