Document system_vars.c #374
Draft
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
lhearachel
force-pushed
the
system-vars
branch
from
13fae39 to
5da4f56
Compare
|
This is now ready for review. I did not document |
|
Moving this back to draft while #377 is in review; it can be reviewed, but will likely have merge conflicts to address. |
ravepossum
reviewed
Feb 14, 2025
- `resultVar` -> `destVarID` - Clean up member names for `HiddenLocation` and `DistributionEvent` - `Set/Clear` -> `Enable/Disable` for HiddenLocation script macros - `ScrCmd_SetOrClearHiddenLocation` -> `ScrCmd_SetHiddenLocation` - `SYSTEM_VARS_BLOCK_SIZE` -> `NUM_SYSTEM_VARS` - Identify `scripts_unk_0412` -> `scripts_init_new_game` - Add `SCRIPT_ID_OFFSET_INIT_NEW_GAME` constant definition - Add `SCRIPT_ID` functional macro - Use `SCRIPT_ID(INIT_NEW_GAME, 0)` in `FieldSystem_InitNewGameState` - Promote `LCRNG_MULTIPLIER` in `math.c` from private to public - Use private `LCRNG_INCREMENT` in `system_vars.c` for lottery sync
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.
Leaving this one in draft mode until I can finish documenting/decorating where these functions are used in the code.
This chunk of the variables block in the save data is known to have 64 values because this file is the only code file making use of the
(((0 + VARS_START) + 32) + 16)construction. All other references to variables are via scripts, which only use literal values at present. I continued up to0x4070and found that it is the variable used in Twinleaf Town's story progression, which signals to me that0x4030through0x406Fis the range in this chunk.At some point we will want to assess whether moving all of the variables and flags to
metanggeneration is sensible, but this feels out-of-scope at the moment.