Improved docs regarding custom events usage #842
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
lajbel
suggested changes
Apr 5, 2024
There was a problem hiding this comment.
You should add a mention here about that there's no only custom events, there's also default events, ground is one, and there's others. So maybe I would change it and also mention what are the defaults events.
It's a fact that we don't expose the events very well, maybe another PR for the repo
|
I opted to just add to the existing doc that you can have custom events with an example instead of removing what was there before. |
lajbel
suggested changes
Apr 5, 2024
src/types.ts
Outdated
| * on("talk", (message, posX, posY) => { | ||
| * add([text(message), pos(posX, posY - 100)]) | ||
| * }) | ||
| * onKeyPress("Space", () => { |
|
@lajbel Addressed feedback and fixed spacing issues. |
|
Thank you for your contribution to documentation! 🔥 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
In the Kaboom.js docs, it's not clear how to use the
on()function used to define custom events.I tried to improve the docs to make usage more clear.