Commit Graph

24 Commits

Author SHA1 Message Date
Eduardo Quezada
e041f3d6bc
Merge pull request #473 from AsparagusEduardo/followerPartners
Some checks failed
build / build (push) Has been cancelled
Document Follower Partners
2025-04-15 08:03:38 -07:00
Gudf
e487e86f9f Menu builder commands documentation
Also documents script manager member 0 as
`SCRIPT_MANAGER_FIELD_MENU_MANAGER`.
2025-04-01 11:32:46 +02:00
Gudf
baa9533401 Currency windows
Includes a rename of `ScriptManager::coinWindow` and
`SCRIPT_MANAGER_COIN_WINDOW` to reflect the fact that the game uses
the same pointer for both special currency windows (coins & BP), and
normalization to `CoinWindow` instead of `CoinsWindow` in
`overlay005/field_menu`
2025-04-01 11:32:46 +02:00
Rachel
b7863ca6f5
Merge pull request #412 from AsparagusEduardo/document6
Heap ID documentation - Part 1
2025-03-05 11:09:29 -08:00
Eduardo Quezada
f7f2ade2b6 Document params used with Heap_AllocFromHeap - Part 1 2025-03-03 19:12:57 -03:00
Viperio
6dc1195eab
Merge branch 'main' into document-scripts 2025-03-02 04:55:06 +01:00
Gudf
1baf1a25a4 Hopefully last round of cleanup & constants 2025-02-28 13:00:14 +01:00
Viperio19
ba39f7c6ba Finish signpost script command documentation 2025-02-28 01:08:39 +01:00
Gudf
35179eff1b Finish documenting function names, rename module 2025-02-26 19:49:27 +01:00
Gudf
0636f98c87 Remove struct decl header, document functions
This finally moves the struct to the module's header, and documents
functions acting on said struct.
2025-02-25 18:47:31 +01:00
Gudf
0dc4feadc3 Cleanup and basic renaming
Cleanup forward declarations, unnecessary returns, duplicate function
declarations and replace literals with constants/enum variants where
applicable.

Rename struct members based on `overlay005/scrcmd_move_tutor`, some
simple functions, and give a temporary name to the struct.
2025-02-25 16:36:29 +01:00
Rachel
1b03304755 Address PR feedback:
- `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
2025-02-16 12:26:47 -08:00
Viperio19
eef5a361b2 Finish documentation for scripts_pokemon_center_daily_trainers.s 2025-02-13 23:19:39 +01:00
Rachel
756c5b0087 Document extern functions in encounter.c and associated script commands 2024-11-16 13:01:15 -08:00
Rachel
b83538a1c5 Identify unk_020508D4 -> field_task; rename FieldTask -> FieldTaskFunc, TaskManager -> FieldTask 2024-11-03 16:08:01 -08:00
RavePossum
3dc2858e34 ov5_021E1D20 -> save_info_window 2024-10-27 19:46:19 -04:00
RavePossum
3e7e1e2e5c mass rename save info window struct and functions, a bit of surrounding documentation 2024-10-27 19:46:19 -04:00
RavePossum
68c31be0e3 Make field save structs transparent 2024-10-27 19:43:10 -04:00
Rachel
aed4502ad7 Document struct members for Menu[Template] 2024-10-25 21:49:52 -07:00
Rachel
34c5755ede Identify unk_02001AF4 -> menu 2024-10-25 20:32:03 -07:00
Rachel
163050584a Identify unk_02018340 -> bg_window 2024-10-20 11:59:06 -07:00
RavePossum
5efa0aaece Document battle result scrcmds, rename script manager playerWonBattle -> battleResult 2024-08-10 13:47:32 -04:00
Rachel
36045f723b Format the source tree 2024-07-06 14:40:34 -07:00
RavePossum
b8b63a7ae0 Rename unk_0203E880 -> script_manager 2024-06-27 23:02:21 -04:00