Commit Graph

410 Commits

Author SHA1 Message Date
Eduardo Quezada
26df8623d5
Some Villa documentation (#487)
* Start documenting Villa

* Stopping for now
2025-04-24 16:49:49 -07:00
Eduardo Quezada
ecb0f0c119
Almost finished documenting ScrCmd for sound (#486)
Some checks are pending
build / build (push) Waiting to run
* ScrCmd_IsSequencePlaying

* ScrCmd_SetSpecialBGM

* `sub_02055554` -> `Sound_TryFadeOutToBGM`

also `sub_020555CC` -> `Sound_GetBGMFadeOutAndWaitFrames`

* ScrCmd_FadeInBGM

* FadeOutMusic -> FadeOutBGM for consistency

* ScrCmd_SetBGMPlayerPaused

* ScrCmd_SetBGMFixed

* Constant uses

* ScrCmd_CheckRecordedChatotCryIsPlayable

* ScrCmd_TryRecordChatotCry

* ScrCmd_StopRecordingChatotCry

* ScrCmd_StopFanfare

* sdatID -> seqID

* ScrCmd_StoreRecordedChatotCry

* ScrCmd_SetSubScene63

* ScrCmd_SetInitialVolumeForSequence

* ScrCmd_SetScene22

* ScrCmd_SetFieldScene, ScrCmd_GetCurrentBGM

* ScrCmd_057 seqID

* Rename file

* Format
2025-04-24 03:51:56 -07:00
Eduardo Quezada
2fe369009d
Finish documenting ScrCmd for daycare (#485) 2025-04-24 03:47:40 -07:00
Eduardo Quezada
b460742636 Finish documenting ScrCmd for items 2025-04-23 14:17:56 -04:00
Eduardo Quezada
34369649a5
Amity Square map script documentation + Scr commands (#481)
Some checks failed
build / build (push) Has been cancelled
* Messages

* scrcmd_amity_square

* BufferItemNamePlural

* BufferAccessoryName

* CanFitAccessory

* FLAG_AMITY_SQUARE_MAN_GIFT_RECEIVED

* VAR_FOLLOWER_MON_PARTY_ID

* VAR_AMITY_SQUARE_GIFT_ID

* VAR_FOLLOWER_MON_SPECIES

* VAR_FOLLOWER_MON_NEXT_PICKUP_TYPE

* VAR_FOLLOWER_MON_PICKUP_ITEM_ID

* Organized sMonFindableAccessories

* VAR_FOLLOWER_MON_PICKUP_ACCESSORY_ID

* LOCALID_HAS_NATIONAL_DEX

* LOCALID_ITEM_OR_ACCESSORY_ID

* LOCALID_COUNT

* PICKUP_TYPE_ITEM

* PICKUP_TYPE_ACCESORY

* Gift Man

* Species-specific cases

* Static NPCs

* Party has species

* Follower messages

* Follower Pickup

* Receptionists

* GetSetNationalDexEnabled

* VAR_FOLLOWER_MON_ACTIVE

* Triggers

* National dex macros
2025-04-21 08:25:41 -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
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
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
Gudf
9626f1d005 Document unk_0204B830 as scrcmd_mystery_gift 2025-04-13 23:44:37 +02:00
Eduardo Quezada
a7a218da2c
Sound documentation followup (#466)
* Start polishing sound documentation

* Sound_SetScene consts

* Surfing theme

* Sound_GetBGMByMapID

* Trainer encounter bgm doc

* A couple of more constants

* Review suggestions

* TrainerId -> TrainerID
2025-04-13 13:21:31 -07:00
Eduardo Quezada
4dc33aeff4
Document multiple map scripts commands (#469)
Some checks are pending
build / build (push) Waiting to run
* CheckPartyHasFatefulEncounterRegigigas

* SetPartyGiratinaForm

* WaitCry

* GetUnownFormsSeenCount

* CheckPartyCombeeGenderCount

* GetHour

* Review changes
2025-04-12 12:30:17 -07:00
narf0708@gmail.com
9b83baf1dc Generating and documenting accessories constants 2025-04-10 23:55:36 -04:00
Rachel
083c68cd64
Merge pull request #457 from AsparagusEduardo/canfititem
Some checks failed
build / build (push) Has been cancelled
Document functions and script commands adjacent to CanFitItem
2025-04-02 20:52:54 -07:00
Eduardo Quezada
bebd201102 GoToIfCannotFitItem macro 2025-04-01 14:14:18 -03: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
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
Gudf
cc1a3ce09a Elevator floor-related script commands 2025-04-01 11:32:46 +02:00
Eduardo Quezada
a7fa5b9ade Document functions and script commands adjacent to CanFitItem 2025-03-31 16:11:08 -03:00
Rachel
eb620655e1
Merge pull request #451 from FrozenMetroid/game_corner_prizes
Update Game Corner Prizes
2025-03-31 11:21:36 -07:00
Rachel
d37cbc9b4b
Merge pull request #450 from Kuruyia/feat/document-platform-lift
Document platform lift
2025-03-31 10:52:16 -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
Senate
61c358240e Fix Syntactic and Other Issues 2025-03-30 15:56:59 -04:00
Kuruyia
acbc7fe3a1 Document platform lift-related map script commands
This documents the `ScrCmd_25C` map script command, that is used on maps
containing a platform lift to trigger it going up or down. It is
intended to be used in a script that is called on a coord event.

This also documents the `ScrCmd_25D` map script command, that is used on
the Pokémon League elevator rooms to check if the platform lift has
already been used (i.e. it is on the top floor) when the player entered
the map. This is used to disable the coord event that triggers the
platform lift.

Signed-off-by: Kuruyia <github@kuruyia.net>
2025-03-30 17:15:03 +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
Senate
a591615cb5 Update Game Corner Prizes 2025-03-29 19:47:15 -04:00
Kuruyia
d5ee4064f7 Document persisted map features initializer script commands
This documents the map script commands related to the persisted map
features initializers.

Signed-off-by: Kuruyia <github@kuruyia.net>
2025-03-24 10:41:37 +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
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
Rachel
c6e8651e00 Document system-variable 0x404C 2025-03-08 14:58:47 -08: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
mudskipper13
11831c80cb Document Accessory Shop (ov7_0224BE9C) 2025-03-02 15:12:03 +07:00
Viperio19
a015349fb7 Use macros to combine signpost script commands and rename functions and constants 2025-03-02 04:47:11 +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
mudskipper13
e55f2159b4 apply review 2 2025-02-26 08:33:39 +07:00
mudskipper13
008b0963b9 shop_menu/script: create generated mart ids 2025-02-26 08:33:38 +07:00
mudskipper13
ba5cdc14ed shop_menu/script: document shop-related scrcmds 2025-02-26 08:33:37 +07:00
Viperio19
eefd278424 Document signpost script commands 2025-02-24 16:08:39 +01:00
narf0708@gmail.com
87a71f6728 PR feedback 2025-02-23 16:42:04 -05:00
narf0708@gmail.com
34f1d81aae Document unk_020480A8 as the JubilifeLottery 2025-02-23 16:31:42 -05: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
Viperio19
7b8ab80544 Using constants for poketch apps and removing unused variable for PlayCry 2025-02-22 22:12:10 +01:00
Viperio19
0a03b1624d Renaming script commands and using constants for PlayCry 2025-02-22 16:06:47 +01:00
Rachel
0ba0d64eee Use a flag to forbid using ScriptEntry after ScriptEntryEnd 2025-02-21 11:06:49 -08:00
Viperio19
913d67dd10 Document lake trio caverns 2025-02-20 18:14:04 +01:00
Viperio19
b9ce1ae906 Use pocket constants, true/false, and trainer constants for tag battles / first battle 2025-02-19 00:24:29 +01:00
Viperio19
01c0e43473 Use gender and yes/no constants in scripts 2025-02-18 23:17:52 +01:00
RavePossum
9940057810 Start documenting how summary screen is accessed, move deleter scrcmds 2025-02-16 15:48:52 -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