This repository has been archived by the owner on Aug 6, 2023. It is now read-only.
Add minor doc suggestions. #22
Open
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
amir-kt
reviewed
Jun 12, 2023
| @@ -55,6 +55,7 @@ your destination target if you decide to by calling the same action: | |||
| - tick 3: `{}` | |||
| - tick 4: `{"path": [250,300]}` | |||
|
|
|||
| In the example above, the client initially chose to travel to the coordinate point `[100,100]`, then the client took no | |||
| action for 2 ticks and in the 4th tick they decided to interrupt their previous journey, change their destination and | |||
There was a problem hiding this comment.
It's important to emphasise here that the client "took no action for two ticks" (wording could be better). The point of this example is to clarify that you choose your path once and you don't have to keep telling the server where to go once you've chosen a coordinate point to travel to.
| Before the main communication cycle starts between the game and your players, a few messages will be sent from the game | ||
| to you in, one-way. These messages are some initial information about the game and the map that you will need to | ||
| Before the main communication cycle starts between the game and your players, | ||
| a few "one-way" messages will be sent from the game to you. |
There was a problem hiding this comment.
Thanks for improving the wording, it would be good if we could touch on what a "one-way message" is too.
| @@ -41,4 +41,4 @@ boundary. For more information on the map, please refer to [Map](../game_logic/m | |||
| velocity of its corresponding wall of the boundary. (i.e. `[x_speed, y_speed]`). Please note that the velocity for game | |||
| boundary will always be zero. | |||
|
|
|||
| * `boundary-id` is the id of this boundary. | |||
| * Where `boundary-id` is mentioned, this will be replace with the id of this boundary. | |||
There was a problem hiding this comment.
I think the wording of this dot point adds to the complexity of understanding the docs.
| @@ -23,4 +23,4 @@ please refer to [Map](../game_logic/map.md). | |||
|
|
|||
| * `damage`: This is how much damage this particular bullet will deal. This value can change if a tank collects a powerup. | |||
|
|
|||
| * `bullet-id` is the id of this bullet. | |||
| * Where `bullet-id` is mentioned, this will be replace with the id of this bullet. | |||
There was a problem hiding this comment.
I think the wording of this dot point adds to the complexity of understanding the docs.
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
No description provided.