Commit Graph

277 Commits

Author SHA1 Message Date
Eduardo Quezada
1193fbb0e6 GBA SaveBlock2 documentation 2025-03-01 21:18:14 -03:00
Eduardo Quezada
f0f45642c1 PalParkTransfer documentation 2025-03-01 20:40:14 -03:00
Rachel
4f909463df
Merge pull request #408 from AsparagusEduardo/pr/pret/document3
Some checks are pending
build / build (push) Waiting to run
Pal Park documentation - Part 1
2025-02-28 19:33:43 -08:00
Rachel
14ccaa6fa3
Merge pull request #389 from Gudf/generic-menu
Document `ov5_021DC018` -> `field_menu`
2025-02-28 19:26:40 -08:00
Eduardo Quezada
78c306d957 Format 2025-02-28 14:20:21 -03:00
Eduardo Quezada
6bf28c88fb GBA_NUM_MOVES 2025-02-28 14:17:56 -03:00
Eduardo Quezada
4deb208333 Review changes 2025-02-28 14:12:26 -03:00
Gudf
1baf1a25a4 Hopefully last round of cleanup & constants 2025-02-28 13:00:14 +01:00
Eduardo Quezada
c039b91814 A bunch of documentation 2025-02-27 22:25:13 -03:00
RavePossum
97174d322e
Merge pull request #400 from Kuruyia/feat/document-model-attributes
Some checks failed
build / build (push) Has been cancelled
Document model attributes
2025-02-27 12:27:15 -05:00
Kuruyia
3c903a6649 Document model attributes
This documents the `ov5_021D5878.c` file, which manages a data structure
containing various attributes used when rendering 3D models.

Those attributes directly map to polygon attributes/parameters that are
exposed by the NDS 3D hardware.

Signed-off-by: Kuruyia <github@kuruyia.net>
2025-02-27 17:25:22 +01:00
Gudf
fb18db2c62 Cleanup: constants & minor struct member rename 2025-02-26 20:30:17 +01:00
mudskipper13
008b0963b9 shop_menu/script: create generated mart ids 2025-02-26 08:33:38 +07:00
h2o-DS
d137ce45a6 pokedex_main
ov21_021D0D80 -> pokedex_main
unk_0209ACBC-> pokedex_memory
struct_ov21_021D3320 -> pokedex_sort_data
UnkStruct_ov21_021D13FC -> PokedexGraphicData
UnkStruct_ov21_021D0F60 -> PokedexApp
enum HeapId HEAP_ID_POKEDEX
2025-02-25 07:59:10 -05:00
Rachel
4763b753c0
Merge pull request #397 from Kuruyia/feat/document-map-prop-animation
Document map prop animation
2025-02-24 19:50:30 -08:00
Kuruyia
207f789689 Document map prop animation
This documents the `ov5_021D37AC.c` file, which is in charge of managing
the animations on map props.

The map prop animation code is actually split into two separate
managers:
* The `MapPropAnimationManager`, which is in charge of loading animation
  data from the two related NARC files, and managing long-running
  animations (e.g. Valley Windworks windmills, Fuego Ironworks furnace,
  Veilstone Game Corner lights...)
* The `MapPropOneShotAnimationManager`, which is in charge of loading
  and playing "one shot" animations (e.g. any door opening/closing, the
  Pokémon Center stairs...)

Signed-off-by: Kuruyia <github@kuruyia.net>
2025-02-24 11:53:11 +01:00
Rachel
dc5440a466
Merge pull request #393 from Viperio19/document-scripts
Some checks failed
build / build (push) Has been cancelled
Document lake trio cavern scripts
2025-02-23 12:38:27 -08:00
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
Viperio19
913d67dd10 Document lake trio caverns 2025-02-20 18:14:04 +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