Commit Graph

3131 Commits

Author SHA1 Message Date
RavePossum
2d745a3645 Start documenting Distortion World and its camera (#464)
Some checks are pending
build / build (push) Waiting to run
2025-06-30 17:00:30 -04:00
Kuruyia
d649ae0222 Document map script command to reset persisted camera angles in the Distortion World
This documents the `ScrCmd_31F` map script command, that is only used in
the Giratina Room map of the Distortion World to reset the camera angles
that are present in the persisted map features data.

Signed-off-by: Kuruyia <github@kuruyia.net>
2025-06-30 18:19:10 +02:00
Kuruyia
53ef036ce1 Start documenting Distortion World and its camera
This begins the documentation of overlay009, which is in charge of
managing stuff related to the Distortion World.

For now, the scope of this commit has been limited to the following:

- start documenting structures used throughout this overlay, more
  specifically the `DistortionWorldSystem` struct
- start documenting the structures found inside the files of the
  `tw_arc.narc` NARC
- document functions and structures related to camera management inside
  the Distortion Word, including the templates found inside the
  `tw_arc.narc` NARC

Signed-off-by: Kuruyia <github@kuruyia.net>
2025-06-30 18:19:07 +02:00
Eduardo Quezada
1a2b0ff744 Rename heap ID and item param arguments (#582)
Some checks are pending
build / build (push) Waiting to run
2025-06-29 13:35:06 -07:00
scbroede
a16b4fdda9 document some underground code (#581) 2025-06-29 13:31:56 -07:00
ellieplayswow
7721ebb259 document PalPad (#580) 2025-06-29 13:30:46 -07:00
Eduardo Quezada
ac7abab019 Rename object event movement type symbols (#567)
Some checks are pending
build / build (push) Waiting to run
2025-06-29 23:30:09 +08:00
ellieplayswow
5782f85be0 save_data: document OverworldMapHistory (#578)
Some checks failed
build / build (push) Has been cancelled
2025-06-27 20:55:59 -07:00
Rachel
b96901ce5c Document the main menu (#577)
Some checks failed
build / build (push) Has been cancelled
2025-06-26 19:00:31 -07:00
Gudf
c2388be9ac Document the main menu alerts strings 2025-06-26 13:20:10 +02:00
Gudf
1ce372fdcf Rename text bank main_menu > main_menu_options
Prevents clang-format from treating `res/text/bank/main_menu.h` as the
"main" header for `overlary097/main_menu.c` and moving it to the top of
the file.
2025-06-26 13:20:10 +02:00
Gudf
7a29ad3b0c Rename ov97_0222AE60 -> main_menu 2025-06-26 13:20:10 +02:00
Gudf
4d30cea537 Main menu: document the application code 2025-06-26 13:20:02 +02:00
Eduardo Quezada
6bdafd01a5 Small GBA migrator doc (#576)
Some checks are pending
build / build (push) Waiting to run
2025-06-25 22:24:31 -07:00
Eduardo Quezada
762ef04902 Same-line declaration/definition cleanup (#575) 2025-06-25 22:24:05 -07:00
Eduardo Quezada
3131eb23d8 Identified multiple text banks (#574) 2025-06-25 22:21:44 -07:00
Yako
8c4207da34 Document script_message.c (#573) 2025-06-25 22:21:23 -07:00
Gudf
a47c00d046 Document the GBA Pokémon game header struct (#571)
Some checks failed
build / build (push) Has been cancelled
2025-06-23 18:50:14 -07:00
ellieplayswow
ce802f128e documenting some trainer appearance functions (#570) 2025-06-23 18:49:23 -07:00
Eduardo Quezada
2ae4fee4b8 Standarized PCBoxes struct name for symbols (#569)
Some checks are pending
build / build (push) Waiting to run
2025-06-23 12:44:32 -07:00
Eduardo Quezada
17619d9ebb Standarized TVBroadcast stuct names for symbols (#568) 2025-06-23 12:43:10 -07:00
ellieplayswow
79c0f3649b save_data: document implicit padding in PlayerSave (#566) 2025-06-23 12:41:41 -07:00
Bilel MEDIMEGH
038b78ca41 Added debug logging functionality (#548) 2025-06-23 12:41:08 -07:00
Eduardo Quezada
278894baa5 Some documentation of BgLayer uses (#565)
Some checks are pending
build / build (push) Waiting to run
2025-06-22 15:15:05 -07:00
Eduardo Quezada
abf620052d Some Start menu documentation (#561)
Co-authored-by: Rachel <lhearachel@proton.me>
2025-06-22 15:02:43 -07:00
CharlesFolz4
8bbd22ef3e Document box user input handling (#533)
Co-authored-by: narf0708@gmail.com <narf0708@gmail.com>
2025-06-22 13:59:52 -07:00
ellieplayswow
c2b903fb6c save_data: playTimestamp -> firstCompletionTimestamp (#562) 2025-06-22 13:57:33 -07:00
CharlesFolz4
9709c5f76c Document some underground record data and functions (#559) 2025-06-22 13:01:21 -07:00
Lucie
1639941e95 Poketch standardization (#557) 2025-06-22 12:58:33 -07:00
ellieplayswow
47da5cdef3 docs(install): on debian/ubuntu, install nasm (#564) 2025-06-22 12:56:30 -07:00
Eduardo Quezada
cbaf319838 Rename NarcID fields (#560) 2025-06-22 12:48:26 -07:00
Eduardo Quezada
2aa4190007 Misc. renaming (#563) 2025-06-22 12:26:05 -07:00
Eduardo Quezada
72a1bfa7ce Slight Ball Capsule documentation (#554) 2025-06-22 11:57:16 -07:00
Morglom
37768513c9 Merge battle-bag-context into battle-bag (#556) 2025-06-22 11:13:46 -07:00
Rachel
cdb963bc78 Document the size contest (module ov5_021EE7D4) (#558) 2025-06-22 11:13:28 -07:00
Morglom
1edc47c0e6 Document battle party (#553) 2025-06-22 10:56:26 -07:00
Eduardo Quezada
e1874d99c1 Renamed option struct elements (#550) 2025-06-22 10:55:07 -07:00
Eduardo Quezada
029f949448 Mailbox documentation (#549) 2025-06-22 10:53:21 -07:00
Morglom
91634f85a8 Document battle bag buttons (#543) 2025-06-22 10:51:00 -07:00
Eduardo Quezada
3fc25ff466 Pal Park map script documentation (#491) 2025-06-22 10:50:03 -07:00
Gudf
ce54785d2d Size contest: Route 222 East House scripts & text 2025-06-22 00:23:45 +02:00
Gudf
0dd2d4c588 Size contest: document the script commands 2025-06-22 00:23:45 +02:00
Gudf
30f384723e Size contest: document the size contest functions
Renames `ov5_021EE7D4` to `size_contest`.
2025-06-22 00:23:38 +02:00
Eduardo Quezada
294fc259bd Some heap ID renaming (#552)
Some checks failed
build / build (push) Has been cancelled
2025-06-20 19:14:18 -07:00
Eduardo Quezada
73b919a295 Fix instances of Id to ID (#551) 2025-06-20 19:11:09 -07:00
Gudf
60b193144a Document unk_0201CED8 as gfx_box_test (#546) 2025-06-19 16:19:55 -07:00
Rachel
84e0b260a6 Merge pull request #545 from Gudf/mystery-gift-app
Document the mystery gift application
2025-06-19 16:19:02 -07:00
Gudf
eb70f6bf37 Document field system camera creation/deletion (#547)
Documents `ov5_021D5B40`.
This module contains the functions used to create and delete the field
system's camera, as well as the camera presets (or types) used by the
different maps (see `include/data/map_headers.h`).

Also moves `CameraAngle` from `overlay115/camera_angle.h` to `camera.h`.
2025-06-19 16:01:43 -07:00
Gudf
e62e05c3f1 Unify 2D 32-bit float vectors into Vec2F32 2025-06-15 21:09:07 +02:00
Gudf
9d8a55f6cf Rename ov97_02237520 -> distribution_cartridge 2025-06-15 21:03:58 +02:00