Commit Graph

303 Commits

Author SHA1 Message Date
Kuruyia
00a7c5dd3d Move some map-related constant files to the field sub-directory
This moves the files holding constants for the BDHC, map matrix and map
prop subsystems to the `include/constants/field` directory.

Signed-off-by: Kuruyia <github@kuruyia.net>
2025-03-19 18:46:19 +01:00
Eduardo Quezada
db41c75d26
Ribbon Documentation + Footstep House scripts (#427)
Some checks failed
build / build (push) Has been cancelled
* Footstep house types and script commands

* Generated ribbons + messages

* Get Friendship + Get/Set Ribbon map scripts

* First non egg in party

* Standarized "ribbonID" as "monDataParam" and "ribbonNum" as "ribbonID"
2025-03-15 09:16:21 -04:00
Eduardo Quezada
1d33088d8c Merge branch 'main' into document12 2025-03-09 22:11:08 -03:00
Rachel
32f976c986
Merge pull request #422 from lhearachel/var-404C
Document system-variable 0x404C
2025-03-09 15:55:42 -07:00
Eduardo Quezada
e376079fc6 Format 2025-03-09 12:05:40 -03:00
Eduardo Quezada
e21d48040f Additional finds 2025-03-09 12:03:50 -03:00
Eduardo Quezada
698ed9262e Review Changes 1 2025-03-09 11:44:55 -03:00
Kuruyia
4bea4a8462 Document land data
This documents the `ov5_021E779C.c` file, which is in charge of loading
map data from the `land_data.narc` archive, dynamically load and unload
maps as the player moves, and render the map base models and their
props.

Also, for the viewer's pleasure, it includes a ton of Distortion
World-specific functions.

This also documents the `ov5_021EEAC8.c` file, which is in charge of
managing buffer allocation for the map base model and BDHC data.

Signed-off-by: Kuruyia <github@kuruyia.net>
2025-03-09 09:50:09 +01:00
Rachel
c6e8651e00 Document system-variable 0x404C 2025-03-08 14:58:47 -08:00
Eduardo Quezada
1d737177da GBA migrator labeling - Part 1 2025-03-06 19:49:45 -03: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
dfbdf582df
Heap enum 0 2025-03-04 11:00:18 -03:00
Rachel
d5519faf3a
Merge pull request #398 from Viperio19/document-scripts
Some checks failed
build / build (push) Has been cancelled
Document signpost script commands
2025-03-03 23:04:00 -08:00
Eduardo Quezada
9f49a9b488 BgConfig_New heap IDs 2025-03-03 12:15:18 -03:00
Eduardo Quezada
f0cbb470c3 Heap_AllocFromHeap heap IDs 2025-03-03 11:53:52 -03:00
Eduardo Quezada
c2e5ee93bb Pokemon_New heap IDs 2025-03-03 11:53:43 -03:00
Rachel
cfbb0e1760
Merge pull request #410 from AsparagusEduardo/document4
Some checks are pending
build / build (push) Waiting to run
Pal Park Documentation - Part 2
2025-03-02 14:26:28 -08:00
Eduardo Quezada
e8f0e81152 Grouped struct files together 2025-03-02 12:27:28 -03:00
Eduardo Quezada
ef61bdd7a6 Review changes 2025-03-02 11:35:05 -03:00
mudskipper13
11831c80cb Document Accessory Shop (ov7_0224BE9C) 2025-03-02 15:12:03 +07:00
Viperio
6dc1195eab
Merge branch 'main' into document-scripts 2025-03-02 04:55:06 +01:00
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
a9565fe6e1
Merge pull request #409 from Kuruyia/feat/document-area-light
Some checks are pending
build / build (push) Waiting to run
Document area light
2025-03-01 11:58:23 -08:00
Kuruyia
e7e595250a Document area light
This documents the `ov5_021D521C.c` file, which is in charge of managing
lighting according to the currently loaded map area and the current
wall-clock time.

Signed-off-by: Kuruyia <github@kuruyia.net>
2025-03-01 11:17:58 +01: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
Viperio
1fb5227a22
Merge branch 'main' into document-scripts 2025-02-28 01:14:18 +01:00
Viperio19
ba39f7c6ba Finish signpost script command documentation 2025-02-28 01:08:39 +01: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
Viperio19
eefd278424 Document signpost script commands 2025-02-24 16:08:39 +01: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