docs: Added many examples for on events #477
Conversation
commit: |
| * @example | ||
| * ```js | ||
| * // This will run when the object is added. | ||
| * onAdd("addTag", () => { |
There was a problem hiding this comment.
addTag looks as bad example, maybe bomb, enemy or any real world name
| * @example | ||
| * ```js | ||
| * // This will run when the object is destroyed. | ||
| * onDestroy("destroyTag", () => { |
| * debug.log("ohbye") | ||
| * }) | ||
| * | ||
| * let objectToDestroy = add([ |
There was a problem hiding this comment.
the same as onAdd, should be generic names like enemy or bullet
| * if (m == `left`) | ||
| * cookies++ |
There was a problem hiding this comment.
please use our format with brackets or change to inline if(m == "left") cookies++;
| * let player = add([ | ||
| * pos(center()), | ||
| * anchor(`center`), | ||
| * sprite(`bean`), | ||
| * area(), | ||
| * body(), | ||
| * { |
There was a problem hiding this comment.
Example doesn't need all this components, with pos and sprite is already understable
| @@ -1717,6 +2140,40 @@ export interface KAPLAYCtx< | |||
| ): KEventController; | |||
| /** | |||
| * Register an event that runs when user releases any gamepad button. | |||
| * | |||
There was a problem hiding this comment.
Complicated, but looks good
| * // gamepad player controls | ||
| * setGravity(200) | ||
| * | ||
| * let player = add([ |
There was a problem hiding this comment.
The same, not that much comps needed
| * // gamepad player jump | ||
| * setGravity(200) | ||
| * | ||
| * let player = add([ |
| * @example | ||
| * ```js | ||
| * // basic car with brakes | ||
| * let car = add([ |
There was a problem hiding this comment.
Same about comps, I think we should mantain simple the ones in controller, I like these examples but can be real examples, not the example of the function, should be simpler
| * | ||
| * @since v3001.0 | ||
| * @group Events | ||
| */ | ||
| onShow(action: () => void): KEventController; | ||
| /** | ||
| * Register an event that runs every frame when certain gamepad buttons are held down. | ||
| * | ||
| * @example |
Added examples for the following events:
onAdd()onDestroy()onLoading()onError()onResize()onCleanup()onGamepadConnect()onGamepadDisconnect()onKeyRelease()onMouseDown()onMousePress()onMouseRelease()onMouseMove()onHide()onShow()onGamepadButtonDown()onGamepadButtonPress()onGamepadButtonRelease()onGamepadStick()