Commit Graph

215 Commits

Author SHA1 Message Date
scbroede
cb6665c7c4
document scroll prompts (#689) 2025-08-16 21:55:39 -07:00
Rachel
2acb462a64
Document misc script commands (#678) 2025-08-15 10:29:05 -07:00
Metallicity
d01d612d0f Document TrySaveGame command 2025-08-11 22:43:37 -07:00
Metallicity
eab8c16229 Rename ScrCmd_31E to TryRevertPokemonForm 2025-08-11 22:43:36 -07:00
scbroede
9572c95106
document some underground inventory and spheres code (#671)
Some checks failed
build / build (push) Has been cancelled
2025-08-09 15:35:39 -07:00
h2o-DS
2daed9b09e
Move Egg Moves and Icon Palettes to Species Data (#635) 2025-07-28 10:17:07 -07:00
Eduardo Quezada
1e12b147c6
Misc. renaming (#607) 2025-07-11 16:44:07 -07:00
Yako
a054b8a113
Partially document field moves that cause the player to ride a pokemon (#594)
Some checks failed
build / build (push) Has been cancelled
2025-07-04 13:02:45 -07:00
Rachel
a747c6f5d1
Extract shareable graphics-related constants to a single header (#592)
Some checks are pending
build / build (push) Waiting to run
2025-07-02 13:20:42 -07:00
Yako
8c4207da34
Document script_message.c (#573) 2025-06-25 22:21:23 -07:00
Lucie
1639941e95
Poketch standardization (#557) 2025-06-22 12:58:33 -07:00
Eduardo Quezada
cbaf319838
Rename NarcID fields (#560) 2025-06-22 12:48:26 -07:00
Rachel
cdb963bc78
Document the size contest (module ov5_021EE7D4) (#558) 2025-06-22 11:13:28 -07: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
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
Lucie
1f4d79b156
Started documenting the rest of OV25 (#426)
* started documenting

* base docs for 5540.c

* formating

* more doc of 540

* documented more funcs

* more docs

* finishied 090 base

* more docs

* mostly finished 560

* mostly finished 540

* Updated file names

* merged header files

* Added some polish

* more polish

* split out the structs header

* added NARC idx macros

* Resolved some change requests

* changed some macros

* renamed: sprite -> cell

* poketch palette doc
2025-06-08 15:58:30 -07:00
cbt6
a205a4b0eb Partially document src/unk_020655F4.c 2025-06-05 06:07:50 +08:00
Eduardo Quezada
fc03351879
Standarized OverlayManager names (#524)
* Standarized OverlayManager names

* Most "overlay" to "application"

* Other renames

* Last rename

* undo ov97_0222D30C.c changes
2025-05-26 12:50:57 -07:00
Eduardo Quezada
2fe369009d
Finish documenting ScrCmd for daycare (#485) 2025-04-24 03:47:40 -07:00
Eduardo Quezada
e7d42fb976
Heap ID breadcrums: Revengeance (#463)
* Heap_AllocFromHeapAtEnd Heap ID breadcrums

* Consistent heapID capitalization

* More Heap IDs

* A little bit more Heap IDs

* More and more Heap IDs

* Stopping for today

* MOAR

* more and more

* Back from the Heap ID mines

* A couple more
2025-04-20 12:50:46 -07:00
Zatsu
c8d41bc96a
Document field moves (#430)
* initial documentation of unk_0207070C->field moves

* changes for PR suggestions + menu taskdata

* symbols in FieldMoveTaskData + fieldMoveMon done

* function name changes, document badges, cleanup

* Use enum FieldMoveError as return type for FieldMoveErrContext functions

* badge enum and bool constants

---------

Co-authored-by: Rachel <lhearachel@proton.me>
2025-04-11 19:47:01 -07:00
Gudf
baa9533401 Currency windows
Includes a rename of `ScriptManager::coinWindow` and
`SCRIPT_MANAGER_COIN_WINDOW` to reflect the fact that the game uses
the same pointer for both special currency windows (coins & BP), and
normalization to `CoinWindow` instead of `CoinsWindow` in
`overlay005/field_menu`
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
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
b39948b1f2 Identify functions related to dynamic map features
This renames the init/free and collision check functions related to
dynamic map features, according to the maps where they are used.

Signed-off-by: Kuruyia <github@kuruyia.net>
2025-03-24 10:11:14 +01:00
Kuruyia
5306770fd4 Document dynamic terrain height
Some checks failed
build / build (push) Has been cancelled
This documents the `ov5_021EF250.c` file, which is in charge of managing
terrain features whose height can change.

Examples include the water floor of Pastoria Gym, and the various lift
platforms in the game (in Iron Island, the Pokémon League...).

Signed-off-by: Kuruyia <github@kuruyia.net>
2025-03-22 10:26:50 +00: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
9eb354e48a Sync BDHC terminology with Markdown documentation
This synchonizes the terminology used in BDHC-related code with the new
terminology specified in the Markdown BDHC and file format spec
documents.

In particular:

- rename `xSize` to `xCount` for the various fields of the BDHC file
  header
- rename the strip's `lowerBound` to `scanline`
- rename the plate's `height` to `constant`
- rename the plate's `slope` to `normal`
- rename the point's `y` to `z`

Signed-off-by: Kuruyia <github@kuruyia.net>
2025-03-20 12:49:09 +01:00
Kuruyia
8eda7bb52a Rename Id to ID in map-related code
This simply capitalizes the "D" in "ID" in map-related code.

Signed-off-by: Kuruyia <github@kuruyia.net>
2025-03-19 18:27:22 +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
9b91475cd8 Document Egg Moves 2025-03-12 22:41:33 -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
Eduardo Quezada
5cdbbdbae5 Merge branch 'main' into document7 2025-03-05 16:16:53 -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
85b106badc Document params used with Heap_AllocFromHeap - Part 5 2025-03-04 18:50:21 -03:00
Eduardo Quezada
6596c34172 Document params used with Heap_AllocFromHeap - Part 3 2025-03-04 14:31:49 -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
f7f2ade2b6 Document params used with Heap_AllocFromHeap - Part 1 2025-03-03 19:12:57 -03:00
Eduardo Quezada
8015a9a6aa Merge branch 'main' into document5 2025-03-02 21:27:02 -03:00
Viperio
6dc1195eab
Merge branch 'main' into document-scripts 2025-03-02 04:55:06 +01:00
Eduardo Quezada
59213ab697 BoxPokemon param renames and documentation 2025-03-02 00:32:11 -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
14ccaa6fa3
Merge pull request #389 from Gudf/generic-menu
Document `ov5_021DC018` -> `field_menu`
2025-02-28 19:26:40 -08:00
Gudf
1baf1a25a4 Hopefully last round of cleanup & constants 2025-02-28 13:00:14 +01: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
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
954b515c5f Remove old header file from git 2025-02-26 20:44:57 +01:00