Commit Graph

259 Commits

Author SHA1 Message Date
Kuruyia
be823a26bb Document area data
This documents the `ov5_021EF75C.c` file, which is in charge of loading
various "area data" NARCs that, in the end, contain the textures of
maps, the textures and models of map props, and lighting information.

Also, renamed `MapProp.id` to `MapProp.modelID` for more clarity
(especially when interacting with the new area data functions).

Signed-off-by: Kuruyia <github@kuruyia.net>
2025-02-22 13:38:54 +01:00
RavePossum
eb7c3f5bf6 Address PR feedback 2025-02-16 15:48:52 -05:00
RavePossum
da77879094 Summary button anim clean-up + misc constants 2025-02-16 15:46:28 -05: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
Rachel
5168755542 Document script commands that use system variables 2025-02-16 12:24:32 -08:00
Rachel
7d4eae3ff1 Document system_vars.c 2025-02-16 12:15:56 -08:00
Rachel
a1cade4fab Label extern routines in system_vars.c 2025-02-16 12:15:56 -08:00
Rachel
decc172f34
Merge pull request #377 from Viperio19/document-scripts
Some checks are pending
build / build (push) Waiting to run
Document `scripts_pokemon_center_daily_trainers.s`
2025-02-15 18:20:01 -08:00
Viperio19
bd24337a60 Documenting sub_02040824 and small naming / formatting improvements 2025-02-15 01:02:45 +01:00
Rachel
7b2b89d513
Merge pull request #378 from lucie-sharpe/PrePoketchDisplay
Pre poketch display
2025-02-14 13:04:07 -08:00
Lucie
84d8f10920 updated constants 2025-02-14 20:29:02 +00:00
Viperio19
b44ad88210 Improve names and move flag constants to vars_flags.h 2025-02-14 11:56:28 +01:00
Kuruyia
d8e584d990 Document map props
This mainly documents the `ov5_021E15F4.c` file, which is in charge of
reading map props from the land data NARC, managing them, and rendering
them.

A "map prop" is defined here as a 3D model that is separate from the map
3D model, and that can be positioned, rotated, and scaled independently.
For instance, they are usually used to place buildings on the various
maps.

Signed-off-by: Kuruyia <github@kuruyia.net>
2025-02-13 21:31:15 -08:00
Viperio19
b033c06e26 format fix 2025-02-13 23:37:18 +01:00
Viperio19
e8e190034d Rename "reporters" to "reporter" 2025-02-13 23:30:04 +01:00
Viperio19
eef5a361b2 Finish documentation for scripts_pokemon_center_daily_trainers.s 2025-02-13 23:19:39 +01:00
Viperio19
57328992ed Move enums with system flags from vars_flags.h to generated files 2025-02-12 17:35:56 +01:00
Rachel
c1d0ee5000 Document system.c 2025-02-07 22:54:11 -08:00
Rachel
f1ac42f387
Merge pull request #361 from lhearachel/sprite-util
Some checks failed
build / build (push) Has been cancelled
Document sprite_util.c
2025-02-05 21:27:40 -08:00
Rachel
10c283da33
Merge pull request #362 from Kuruyia/feat/document-bdhc-loading
Some checks are pending
build / build (push) Waiting to run
Document BDHC file loading
2025-02-05 10:38:23 -08:00
Kuruyia
3f8301106c Document BDHC file loading
This documents the loading of BDHC files that are embedded in files of
the land data NARC.

Credits goes to Mikelan98, HiroTDK and HumanGamer for their resources
(listed below). It would have been a lot more painful having to reverse
this file format.

Resources used:
* https://hirotdk.neocities.org/FileSpecs#Terrain
* https://www.pokecommunity.com/threads/i-solved-the-final-piece-of-the-terrain-bdhc-files-in-gen-4-inclines.424428/

Signed-off-by: Kuruyia <github@kuruyia.net>
2025-02-05 19:27:30 +01:00
TheSylphIsIn
b9e12c1f2d format
lol
2025-02-05 01:21:52 -05:00
TheSylphIsIn
38a4eed067 wild_encounter PR cleanup 2025-02-05 01:16:46 -05:00
Rachel
60b5a3f35a Document render_oam.c 2025-02-04 20:32:09 -08:00
Kuruyia
817e8e4a53 Document map matrix
Signed-off-by: Kuruyia <github@kuruyia.net>
2025-02-03 12:35:18 +01:00
Rachel
26db7b2f7e Migrate constants used by battle and AI scripting to metang 2025-01-27 20:46:35 -08:00
Rachel
92cd212dea Integrate metang as a subproject + migrate species data constants 2025-01-21 22:46:38 -08:00
Rachel
2e09fce6a2 Extract species-related structs to species.h 2025-01-21 22:46:38 -08:00
Rachel
50eae5bf1c Document and clean up learnset-related functions 2025-01-21 22:46:38 -08:00
Rachel
465d8cae75 Document and clean-up Pokemon_GetEvolutionTargetSpecies 2025-01-21 22:46:38 -08:00
Rachel
90df678467 Terminology shift: PokemonPersonalData -> SpeciesData + struct cleanup 2025-01-21 22:46:37 -08:00
Adrienn Tindall
089afc8e94
Merge branch 'main' into main 2025-01-17 23:24:34 -05:00
Adrienn Tindall
69425c07e7 run make format 2025-01-14 08:17:01 -05:00
Adrienn Tindall
856e02c669 Merge branch 'main' of https://github.com/pret/pokeplatinum 2025-01-09 13:36:22 -05:00
Viperio19
0fa801b670 More documentation centered around map_object.c and map_object_move.c 2024-12-29 16:37:02 +01:00
Viperio19
5fd11e8086 Documenting journal_controller.c (function names etc.), renaming UnkStruct_020BCC8 and UnkStruct_0202BFCC to ...LocationEvent and ...OnlineEvent and documenting those (struct member names, enums, etc.) 2024-12-07 00:44:11 +01:00
Adrienn Tindall
c64cf90f0e Merge branch 'main' of https://github.com/pret/pokeplatinum 2024-12-04 20:53:38 -05:00
Adrienn Tindall
b97f79cb72 Update Consts, Remove "Data" notation 2024-12-04 20:52:55 -05:00
cbt6
650e797595 Document some map object functions 2024-12-01 09:00:43 +08:00
Rachel
f172250fae
Merge pull request #305 from ravepossum/more_summary_screen
Some checks failed
build / build (push) Has been cancelled
Summary screen documentation pt. 2
2024-11-25 09:20:07 -06:00
Viperio19
e7e7f44497 Improving on previous commits (concise declarations, removing unnecessary return; and scoping, more renaming) 2024-11-19 11:15:16 +01:00
RavePossum
33bdcfeacc Summary screen - misc cleanup and todos 2024-11-17 13:05:21 -05:00
RavePossum
1b8ac2189b Finish documenting summary screen 3d gfx 2024-11-17 12:02:17 -05:00
Rachel
dc4b6670ca Create constants for tile behaviors and normalize names 2024-11-09 20:08:53 -08:00
Rachel
9fe570f579 Document BagCursor structs and functions 2024-11-09 20:08:53 -08:00
RavePossum
30367d1d21 Summary screen documentation todo clean-up 2024-11-05 18:20:56 -05:00
RavePossum
3bbc11109a document a chunk of the summary screen, add max level const 2024-11-05 18:19:15 -05:00
RavePossum
27d8e851d6 Start to document summary screen. rename bgl member -> bgConfig 2024-11-05 18:19:15 -05:00
Rachel
5aa97bc404 Fix format hook 2024-11-03 16:08:01 -08:00
Rachel
7be948e872 Document system_flags.c 2024-11-03 16:08:01 -08:00