Commit Graph

72 Commits

Author SHA1 Message Date
Lucie
1639941e95
Poketch standardization (#557) 2025-06-22 12:58:33 -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
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
97744b9c0b Bag.h adjacent documentation 2025-04-03 12:16:53 -03: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
ff1189973c Identify field system generic map data pointer
This identifies the generic pointer declared in the field system struct
used by map with dynamic features to store their own data about the
state of those features.

Signed-off-by: Kuruyia <github@kuruyia.net>
2025-03-24 10:41:37 +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
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
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
Viperio
6dc1195eab
Merge branch 'main' into document-scripts 2025-03-02 04:55:06 +01: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
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
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
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
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
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
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
TheSylphIsIn
faae53c119 Merge branch 'main' of https://github.com/pret/pokeplatinum 2025-02-04 17:06:09 -05:00
TheSylphIsIn
5cfa8894af Finish documenting special_encounter
Documents the last unknown components of SpecialEncounter. Also some other things, sorry.
2025-02-04 16:52:48 -05:00
Kuruyia
6c3b457001 Expose map matrix structs
Signed-off-by: Kuruyia <github@kuruyia.net>
2025-02-04 10:07:38 +01:00
TheSylphIsIn
f8f514931e Merge branch 'main' of https://github.com/pret/pokeplatinum 2025-02-03 22:59:00 -05:00
TheSylphIsIn
b4229dbac1 Honey Trees
Documents honey_tree. Mostly. There are some functions related to the overworld tree shaking animation that I didn't document, but it's at least contextually obvious what the end result is.

Also might have a bit of roamer stuff, idk, this commit was sitting for 2 weeks
2025-02-03 22:44:28 -05:00
Kuruyia
817e8e4a53 Document map matrix
Signed-off-by: Kuruyia <github@kuruyia.net>
2025-02-03 12:35:18 +01:00
Estellar
7c4a85d24a removed struct_02055CBC_decl 2025-01-28 00:57:35 -03:00
Estellar
1f5f12a9d9 More documentation in ov5_021DD6FC 2025-01-08 01:50:23 -03:00
Viperio19
4796c315ba More WIP journal documentation 2024-11-21 07:53:55 +01:00
Rachel
479178fa05 Replace UnkStruct_0209C370* refs with u8* 2024-11-09 20:08:53 -08:00
Rachel
9fe570f579 Document BagCursor structs and functions 2024-11-09 20:08:53 -08:00
Rachel
acb1645d2c Unify terminology: taskManager -> task 2024-11-03 16:08:01 -08:00
Rachel
b83538a1c5 Identify unk_020508D4 -> field_task; rename FieldTask -> FieldTaskFunc, TaskManager -> FieldTask 2024-11-03 16:08:01 -08:00
Rachel
119135dde3 Document location.c, TryLoadingSave, StartNewSave 2024-11-01 11:03:29 -07:00
Rachel
7112921468 Clean up and document extern functions in field_system.c 2024-11-01 11:03:28 -07:00
Rachel
6588099ab1 Document FieldProcessManager and static routines in field_system.c 2024-11-01 10:46:18 -07:00
RavePossum
97ba5d059e Mass rename FieldSystem unk_10 -> taskManager 2024-10-28 11:25:44 -04:00
RavePossum
ce56de29ce Mass rename FieldSystem unk_08 -> bgConfig 2024-10-28 11:03:03 -04:00
Rachel
8f6b317313 Identify UnkStruct_02018340_t -> BgConfig and document fields 2024-10-22 10:15:00 -07:00
Rachel
163050584a Identify unk_02018340 -> bg_window 2024-10-20 11:59:06 -07:00
Adrienn Tindall
d41abd35bb Fix nitpicks 2024-10-07 02:43:49 -04:00
Adrienn Tindall
b21c778ada Requested Changes + Much more documentation 2024-10-01 23:20:30 -04:00
Adrienn Tindall
bef2da552a TerrainCollisionManager
Name is open to suggestions
2024-08-06 14:16:58 -04:00
Adrienn Tindall
a844494a36 Name FieldSystem->mapLoadMode, Journal 2024-08-05 11:29:01 -04:00
Adrienn Tindall
7fc0839301 Map Load Type Constants 2024-07-31 16:44:23 -04:00
Rachel
36045f723b Format the source tree 2024-07-06 14:40:34 -07:00
Trainer Riley
24df9d1866 Rename all PoketchSystem variables in the codebase 2024-06-21 12:33:03 -07:00
Rachel
a015d5d476
Merge pull request #229 from Fexty12573/bag
Document Bag Logic
2024-06-21 07:38:03 -07:00