Commit Graph

341 Commits

Author SHA1 Message Date
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
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
Eduardo Quezada
3fc25ff466
Pal Park map script documentation (#491) 2025-06-22 10:50:03 -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
a5f92c80ab Document the mystery gift app: ov97_0222D30C
This is the main module for the mystery gift application, although
wireless functionality is mostly handled by other modules, as are some
miscellaneous functions.
2025-06-15 21:03:51 +02:00
Yako
fbb209a4b9
Merge pull request #537 from YakosWG/type-rendering
Document type_icon.c
2025-06-07 22:50:24 -07:00
cbt6
a205a4b0eb Partially document src/unk_020655F4.c 2025-06-05 06:07:50 +08:00
Rachel
6e9b4c3adb
Document screen fades and hardware windows (#529)
* Identify palette_fade and hardware_window modules

* Document hardware_window.c

* Document palette_fade.c

* Terminology shift: PaletteFade -> ScreenFade

* Decorate screen fade calls with appropriate constants

* PR feedback
2025-05-27 20:56:46 -07:00
Morglom
b0f4990576
Document battle bag utility (#512)
* Rename and document functions

* Rename files.

* Remove redundant array

* Renames.

* Last renames.

* Small fix

* Remove unnecessary brackets.

* Pull Request changes.

* Forgot these fields.

* Further changes.
2025-05-23 22:38:57 -07:00
Gudf
5676ee375a
Clean up and finish documenting unk_02096420 -> item_use_pokemon (#509)
* Clean up and finish documenting `unk_02096420`

* Rename `unk_02096420` -> `party_use_item`

* Use macros, rename functions to match first arg

* Rename `party_use_item` -> `item_use_pokemon`
2025-05-18 11:22:53 -07:00
narf0708@gmail.com
14d687540f correct name of MON_DATA_MAIL_ID to MON_DATA_BALL_CAPSULE_ID 2025-05-10 18:25:16 -04:00
Rachel
8c968ab381
refactor: Clean up data tables in item.c (#501)
Some checks failed
build / build (push) Has been cancelled
2025-05-06 09:36:21 -07:00
Gudf
3d3ff0ba37
Document the wonder cards application (#494)
* Document the Wonder Cards application

* Rename module and text bank

Text bank `unk_0421` -> `mystery_gift_menu`
Module `ov97_02230410` -> `wonder_cards_app`
2025-05-03 15:41:55 -07:00
Eduardo Quezada
b157da484e
Use flag defines in map object event JSON files (#475)
* Generate vars and flags

* Convert Event flags map data

* Convert numbers to flags

* Fix type
2025-04-21 08:00:31 -07:00
Eduardo Quezada
6ef937a8eb
Define and use Var constants (#474)
* Missing uses of defined vars

* Vars 0x4000 to 0x402F with Var macros

* Vars 0x4000 to 0x402F with other macros

^ Conflicts:
^	res/field/scripts/scripts_amity_square.s
^	res/field/scripts/scripts_veilstone_city_southwest_house.s

* Other vars

* Special Flags

* Unk vars

* NUM_VARS

* `SPECIAL_VARS_START` -> `SCRIPT_LOCAL_VARS_START`

* `VAR_0x800C` -> `VAR_RESULT`

* `VAR_0x800D` -> `VAR_LAST_TALKED`

* Format

* VAR_MAP_LOCAL

* VAR_OBJ_GFX_ID

* STORY_VARS
2025-04-20 17:38:03 -07:00
Gudf
541fca37db
Tag previously untagged enums (#477)
This leaves out undocumented enums and a few enums I couldn't find a
name for and feel would fit better as `#define`s instead.
2025-04-20 12:49:54 -07:00
Eduardo Quezada
f353a4b7e8
Document Game Corner map script + Coins and Money Scr Commands (#476)
* Coins scr commands

* Game Corner messages

* GoToIfCannotAddCoins macro

* CheckMoney

* Using GoToIfNotEnoughMoney

* Most of Game Corner script documented

* Some slot machine documentation

* AddToGameRecord

* Last scr commands but 1

* Format

* Fix typo
2025-04-20 12:48:22 -07:00
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
RavePossum
dac456a0e4
Merge pull request #471 from CharlesFolz4/Accessories
Some checks are pending
build / build (push) Waiting to run
Generating and documenting accessories constants
2025-04-14 09:20:22 -04:00
narf0708@gmail.com
9485e2aca7 Document accessory related functions 2025-04-13 21:08:13 -04:00
Eduardo Quezada
cb256f45b5
Document location data (#472)
* Initial location names + Journal exited buildings

* Map header flags

* Map header battle BG

* Location names

* Weather

* Music IDs

* Format

* IsLeapYear

* Yearly weather
2025-04-13 13:23:49 -07:00
Eduardo Quezada
d65c7da61c MailBox 2025-04-12 10:42:30 -04: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
Kuruyia
7596c9c676 Rename 2D Y coordinate component to Z
This simply renames the `y` component in 2D coordinates to `z` in
the names of variables, constants, function parameters and struct
members.

Most common examples include:
- `tileY` -> `tileZ`
- `mapMatrixY` -> `mapMatrixZ`
- `sizeY` -> `sizeZ`

Signed-off-by: Kuruyia <github@kuruyia.net>
2025-03-31 20:01:11 +02:00
Rachel
d37cbc9b4b
Merge pull request #450 from Kuruyia/feat/document-platform-lift
Document platform lift
2025-03-31 10:52:16 -07:00
Rachel
eb19742b3a
Merge pull request #447 from Kuruyia/feat/document-terrain-attributes-loader
Document terrain attributes loader
2025-03-31 10:49:49 -07:00
Eduardo Quezada
c1670bf494
Merge pull request #441 from AsparagusEduardo/forms
Forms/Species-related functions and scripts
2025-03-31 10:47:58 -07:00
Kuruyia
f03c5fb067 Document terrain attributes module
This documents the `unk_02054BD0.c` file, which is in charge of loading
the terrain attributes from the land data NARC for some map load modes,
separately from the land data manager.

Signed-off-by: Kuruyia <github@kuruyia.net>
2025-03-30 17:27:27 +02:00
Kuruyia
9e8482aec4 Document map object flag for disabling height calculation and related script command
This documents the `MAP_OBJ_STATUS_23` map object status flag that
affects whether height is calculated for a map object using the terrain
collision manager.

This also documents the `ScrCmd_211` map script commands, that allows
setting this status flag from map scripts.

Signed-off-by: Kuruyia <github@kuruyia.net>
2025-03-30 17:15:03 +02:00
Kuruyia
7329ad4784 Document platform lift
This documents the `unk_0207160C.c` file, which is in charge of setting
up and managing the platform lift dynamic map feature for maps that
contains platform lifts (Iron Island and the Pokémon League).

This does not manage platform lifts used by gyms.

Signed-off-by: Kuruyia <github@kuruyia.net>
2025-03-30 17:14:21 +02:00
Eduardo Quezada
f25d3f4fff Removed redundant defines 2025-03-30 00:29:05 -03:00
Eduardo Quezada
dc4954da53 Add flag constants 2025-03-28 16:24:18 -03:00
Kuruyia
bb21d0d576 Document persisted map features
This documents the `unk_02027F50.c` file, which is in charge of managing
data used by some maps to be more dynamic, and that needs to be
persisted in the save file. Examples include Sunyshore Gym's bridges
rotation, Pastoria Gym's water level, Canalave Gym's platform
positions...

This also documents related code in the save data module, and names
constants used as IDs for identifying the map that is currently using
dynamic features.

Signed-off-by: Kuruyia <github@kuruyia.net>
2025-03-24 07:43:55 +01:00
Kuruyia
ce5b675d40 Add more well-known map prop model IDs
This identifies the following map prop models:

-  `34`: generic ship, found in Canalave City for instance.
- `123`: the healing machine found in Pokémon Centers.
- `239`: the blue button found in the Pastoria City Gym, used to set the
         water to its highest level.
- `240`: the green button found in the Pastoria City Gym, used to set
         the water to half its highest level.
- `241`: the orange button found in the Pastoria City Gym, used to set
         the water to its lowest level.
- `303`: the muddy slope found in the overworld that needs a bike to
         traverse.
- `304`: the interior variant of the muddy slope.
- `502`: the lift platform found only in the Pokémon League.
- `507`: the "healing machine"-type machine that registers the Pokémons
         in the Hall of Fame.
- `538`: the S.S. Spiral (aka S.S. Sinnoh) ship used to travel between
         Snowpoint City and the Fight Area.

Signed-off-by: Kuruyia <github@kuruyia.net>
2025-03-22 13:48:04 +01:00
Kuruyia
607e8f4bf9 Document terrain collision manager
This documents the `unk_02054D00.c` file, which is in charge of managing
height, collision and tile behavior between the terrain and the
player/map objects.

Signed-off-by: Kuruyia <github@kuruyia.net>
2025-03-22 13:48:02 +01:00
Eduardo Quezada
18ecf16d74
Document Daycare (#436)
* Identified Daycare struct + incense baby table

* Daycare params

* Daycare_CreateEgg

* TryGiveVoltTackle

* Better names

* DetermineEggSpeciesAndParentSlots

* Format

* GetParentsCompatibility

* Party_GetFirstEgg

* GetEggCyclesToSubtract

* Egg cycles

* Nature inheritence

* DaycareMon

* Better name for FieldSystem_GetDay

* Cleaner struct defs

* Store into daycare

* Daycare levels and price

* Daycare mon count

* DaycareMail

* Mail struct def

* MON_DATA_MAIL and Take mon from daycare

* IVs and Moves

* Utility functions

* More utility functions

* Review changes

* Renamed files
2025-03-22 03:16:18 -07:00
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