Skip to content

Make the priority flag description clearer by explicitly referring to "color IDs" instead of "colors" #595

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

Merged
merged 3 commits into from
Apr 2, 2025

Conversation

RaoulLuque
Copy link
Contributor

@RaoulLuque RaoulLuque commented Mar 27, 2025

When reading the description of byte 3 in the OAM section and more precisely, the priority flag, I was confused whether the sentence
"Priority: 0 = No, 1 = BG and Window colors 1–3 are drawn over this OBJ"
was referring to colors, as in actual colors values (0: White, ...) or whether it was referring to color IDs (which might be mapped by the palette to other color values then their ID might suggest). I suppose it refers to color IDs, which is why I would make that more explicit.

If that is wrong I would suggest changing it to make it clear that color IDs are not meant and instead color values. I was not able to find a conclusive source on this.

Note that the link that is used for the color IDs is the same as used in the palettes section.

Copy link
Member

@ISSOtm ISSOtm left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for the contribution! It does indeed refer to colour IDs, your guess was correct!

Would you mind checking the corresponding flag in the BG attributes description (Tile_Maps.md)? I believe it's more or less a copy-paste.

@RaoulLuque RaoulLuque requested a review from ISSOtm April 2, 2025 07:44
Copy link
Member

@avivace avivace left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If we go for this nomenclature change, there are some usages of "Color IDs" in src/Graphics.md as well

@RaoulLuque
Copy link
Contributor Author

Good catch, I'll search for more occurrences and change all of them accordingly 👍

@avivace avivace merged commit 529270a into gbdev:master Apr 2, 2025
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.

3 participants