Document upgrades #2655
Open
Document upgrades #2655
+298
−149
Conversation
This file contains hidden or 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
mzxrules
reviewed
Aug 3, 2025
| @@ -0,0 +1,163 @@ | |||
| #ifndef UPGRADE_H | |||
There was a problem hiding this comment.
Organization wise, I don't particularly feel that item upgrades are a substantially complex system to where we need to split them from item.h
|
|
||
| static_assert(UPG_DEKU_NUTS_MAX <= 1 << BIT_WIDTH_UPG_DEKU_NUTS, "All deku nut upgrade values should fit in its assigned bitwidth"); | ||
|
|
||
| #define BITS_PER_BYTE 8 |
There was a problem hiding this comment.
I think this has come up before (someone could correct me if I'm wrong or wishes to debate this), but the preference is to just inline the constant value of 8 instead of using CHAR_BIT from <climits> or a custom BITS_PER_BYTE define
| /* 0x08 */ UPG_MAX | ||
| } UpgradeType; | ||
|
|
||
| #define BIT_WIDTH_UPG_QUIVER 3 |
There was a problem hiding this comment.
I think personally I'd prefer it that you have this section organized like...
- enum UpgradeType
- BIT_WIDTH_* all listed in sequence, assert "Upgrades must fit in a u32"
- SHIFT_* all listed in sequence
Then finally enum QuiverUpgrades, assert, enum BombBagUpgrades, assert
| BIT_WIDTH_UPG_WALLET + | ||
| BIT_WIDTH_UPG_BULLET_BAG + | ||
| BIT_WIDTH_UPG_DEKU_STICKS + | ||
| BIT_WIDTH_UPG_DEKU_NUTS < sizeof(u32) * BITS_PER_BYTE, |
There was a problem hiding this comment.
Suggested change
| BIT_WIDTH_UPG_DEKU_NUTS < sizeof(u32) * BITS_PER_BYTE, | |
| BIT_WIDTH_UPG_DEKU_NUTS <= sizeof(u32) * BITS_PER_BYTE, |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.