Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs: "Manual" draw order -> "Index Order" #4157

Open
wants to merge 3 commits into
base: master
Choose a base branch
from

Conversation

eishiya
Copy link
Contributor

@eishiya eishiya commented Jan 26, 2025

At some point, the Manual object draw order was renamed to Index Order, but the docs were not updated.

This PR updates the Working with Objects and Keyboard Shortcuts manual pages. I'm not sure why the Keyboard Shortcuts page even mentions the draw order, as the shortcuts work to reorder Objects regardless of draw order, the order just doesn't impact rendering in Top Down mode.

I also updated the wording "Drawing Order" to "Draw Order", the latter being the wording used within Tiled itself. I left the "drawing order" as-is in the keyboard shortcuts list since there it's not capitalised and appears to describe function rather than naming the property.

I did not update the mention of the manual draw order in the scripting docs, as there it is unclear whether "manual" refers to the name of the mode or its function. Perhaps that should be updated too though.

At some point, the Manual draw order was renamed, but the docs were not updated.
Sorry for the commit spam, GitHub's web editor doesn't let me group edits to multiple files.
For consistency with the Tiled GUI.
@bjorn
Copy link
Member

bjorn commented Jan 26, 2025

Hmm, this rename happened by accident while implementing the new Properties view. I think we should rather just rename it back to "Manual" before the 1.12 release.

I'm not sure why the Keyboard Shortcuts page even mentions the draw order, as the shortcuts work to reorder Objects regardless of draw order, the order just doesn't impact rendering in Top Down mode.

Indeed they can change the order, but if Manual object drawing order wasn't mentioned there, then I'm sure people would be confused about not seeing any visible difference. Maybe it just needs a slight rewording.

@eishiya
Copy link
Contributor Author

eishiya commented Jan 26, 2025

Ah. I did think about checking whether 1.11 had this wording but got lazy. I think it's better as "Manual". I'll leave this PR open until you change it back in Tiled, feel free to close it when you're ready.

As for the keyboard shortcuts, perhaps remove the parentheticals, but add a note above or below the list that the Object order is visible in the Objects view and that it affects Object draw(ing) order in Manual mode.

The Changing Stacking Order section of the Objects page has a similar issue with implying those shortcuts only work in Manual mode. That whole page also doesn't mention the Objects view, which seems an odd omission. While it's not necessary to work with Objects, it is useful in some scenarios and worth knowing about. Even the neglected Tile Stamps view gets more love from the docs!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants