Add documentation for new coord_point #42303
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
jbytheway
force-pushed
the
coordinates_docs
branch
from
0d35444 to
51235cc
Compare
ZhilkinSerg
added
<Documentation>
|
"ms" and "sm" are dangerously similar. How about "local map" "lm" or "tile map" "tm". |
mlangsdorf
suggested changes
Jul 21, 2020
To help people understand the game's coordinate systems and how to use the new point types, add some documentation Move the description of coordinate systems out of coordinate_conversions.h into a markdown file, and reference that new file from coordinate_conversions.h and coordinates.h.
Definitely don't want to use "local" here; that already means something else. It might make sense to just use "tile" |
jbytheway
force-pushed
the
coordinates_docs
branch
from
51235cc to
a67e0b3
Compare
Add vehicle coordinate system docs, clarify a bunch of stuff.
jbytheway
force-pushed
the
coordinates_docs
branch
from
a67e0b3 to
f88fe08
Compare
mlangsdorf
approved these changes
Jul 21, 2020
|
|
||
| The game is three-dimensional, with the axes oriented as follows: | ||
| * The **x-axis** goes from left to right across the display (in non-isometric | ||
| views). |
There was a problem hiding this comment.
Is it worth specifying that -X is to the left/west and +X is to the right/east or have we held people's hands here enough?
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.
Summary
SUMMARY: Infrastructure "Add documentation for new coord_point"
Purpose of change
To help people understand the game's coordinate systems and how to use the new point types, add some documentation
Describe the solution
Move the description of coordinate systems out of
coordinate_conversions.hinto a markdown file, expand upon it, and reference that new file fromcoordinate_conversions.handcoordinates.h.Describe alternatives you've considered
Putting it all in
coodinates.hrather than markdown.Testing
No code changes.
You can read the rendered markdown here.
Additional context
Feedback welcome. It's hard to know what's obvious and what isn't when I'm the one who created all this infrastructure.