summaryrefslogtreecommitdiff
path: root/wram.asm
diff options
context:
space:
mode:
Diffstat (limited to 'wram.asm')
-rw-r--r--[-rwxr-xr-x]wram.asm85
1 files changed, 50 insertions, 35 deletions
diff --git a/wram.asm b/wram.asm
index 3c587e0..845a24b 100755..100644
--- a/wram.asm
+++ b/wram.asm
@@ -41,6 +41,7 @@ wc4cc:: ; 0xc4cc
ds $34
wBottomMessageText:: ; 0xc500 WARNING: text loading code may break if this is moved
+; This must be aligned with $100, since there is some logic that depends on the lower byte of the address. (See LoadMonNameIntoEvolutionSelectionList)
ds $100
wBottomMessageBuffer:: ; 0xc600
@@ -144,7 +145,9 @@ wBallTypeCounter:: ; 0xd47f
wBallTypeBackup:: ; 0xd481
ds $1
-wd482:: ; 0xd482
+wCurBonusMultiplier:: ; 0xd482
+; Current value of the bonus multplier. Incremented from achieving various events during the game, or hitting the two bonus multiplier
+; railings. (left one first, then right one). See MAX_BONUS_MULTIPLIER
ds $1
wd483:: ; 0xd483
@@ -175,8 +178,8 @@ wCompletedBonusStage:: ; 0xd49a
; Set to 1 when a bonus stage is successfully cleared.
ds $1
-wCurBonusMultiplier:: ; 0xd49b
-; Current value of the bonus multiplier. See MAX_BONUS_MULTIPLIER.
+wCurBonusMultiplierFromFieldEvents:: ; 0xd49b
+; Current value of the bonus multiplier received from field events, like catching a pokemon or hitting psyduck 3 times. See MAX_BONUS_MULTIPLIER_FIELD_EVENTS.
ds $1
wd49c:: ; 0xd49c
@@ -218,7 +221,9 @@ wNumTimesBallSavedTextWillDisplayBackup:: ; 0xd4a8
wd4a9:: ; 0xd4a9
ds $1
-wd4aa:: ; 0xd4aa
+wDrawBottomMessageBox:: ; 0xd4aa
+; Set to non-zero value if enable drawing the 1-tile high bottom message bar during V-Blank in normal pinball gameplay.
+; Set to 0 to disable.
ds $1
wd4ab:: ; 0xd4ab
@@ -392,28 +397,30 @@ wRightMapMoveCounter:: ; 0xd4f2
ds $1
wLeftMapMoveDiglettAnimationCounter:: ; 0xd4f3
+wLeftMapMovePoliwagAnimationCounter::
ds $1
wLeftMapMoveDiglettFrame:: ; 0xd4f4
+wLeftMapMovePoliwagFrame::
ds $1
wRightMapMoveDiglettAnimationCounter:: ; 0xd4f5
+wRightMapMovePsyduckAnimationCounter::
ds $1
wRightMapMoveDiglettFrame:: ; 0xd4f6
+wRightMapMovePsyduckFrame::
ds $1
-wd4f7:: ; 0xd4f7
- ds $1
-
-wd4f8:: ; 0xd4f8
- ds $1
-
-wd4f9:: ; 0xd4f9
- ds $1
+wLeftMapMoveCounterFramesUntilDecrease:: ; 0xd4f7
+; Holds the number of frames remaining until the wLeftMapMoveCounter
+; counter will decrease by 1.
+ ds $2
-wd4fa:: ; 0xd4fa
- ds $1
+wRightMapMoveCounterFramesUntilDecrease:: ; 0xd4f9
+; Holds the number of frames remaining until the wRightMapMoveCounter
+; counter will decrease by 1.
+ ds $2
wBellsproutCollision:: ; 0xd4fb
; Second byte is set by HandleGameObjectCollision, but is unused
@@ -529,12 +536,15 @@ wRightAlleyCount:: ; 0xd545
wSecondaryLeftAlleyTrigger:: ; 0xd546
ds $2
-wd548:: ; 0xd548
+wPinballIsVisible:: ; 0xd548
+; Set to 1 if the pinball is visible in play.
+; Set to 0 when the pinball disappears in things like the Slot, Slowpoke, Cloyster, Bellsprout, etc.
+; When it's set to 0, it disables tilt effects on the pinball.
ds $1
-wDisableBallGravityAndTilt:: ; 0xd549
-; Set to 1 to disable any affect gravity or tilt has on the pinball.
-; Used for things likes the initial pinball launch or to hold the ball stationary.
+wEnableBallGravityAndTilt:: ; 0xd549
+; Set to 1 to enable the effect of gravity and tilt on the pinball.
+; 0 disables these forces. Used for things likes the initial pinball launch or to hold the ball stationary.
ds $1
wCurrentMap:: ; 0xd54a
@@ -724,16 +734,16 @@ wd5ca:: ; 0xd5ca set to 1 by a commonly called text function that is called at t
wd5cb:: ; 0xd5cb set to 0 if the above is 0 during Func_33e3
ds $1
-wScrollingTextStruct1:: ; 0xd5cc Start of a scrolling struct that contains 8 1 byte vars. wScrollingTextStruct1
-;Byte 1: Toggles if enabled. z is off, nz is on
-;Byte 2: is how many frames until the next scroll
-;Byte 3: holds how long, in frames, it should take for the scroll to move 1 tile
-;Byte 4: is the current position to place the start of the text
-;Byte 5: is where in the scroll the message should stop for an extended period
-;Byte 6: is how many frames the extended stop from Byte 5 has left
-;Byte 7: is a pointer to the source text's position in the buffer
-;Byte 8: is decremented each scroll and scroll denied by the stop
-;scrolling text relies on byte allignment for the text buffer and display area
+wScrollingTextStruct1:: ; 0xd5cc Start of a scrolling message struct that contains 8 1-byte vars.
+; Byte 1: Toggles if enabled. 0 is off, non-0 is on
+; Byte 2: is how many frames until the next scroll
+; Byte 3: holds how long, in frames, it should take for the scroll to move 1 tile
+; Byte 4: is the current position to place the start of the text
+; Byte 5: is where in the scroll the message should stop for an extended period
+; Byte 6: is how many frames the extended stop from Byte 5 has left
+; Byte 7: is a pointer to the source text's position in the buffer
+; Byte 8: is decremented each scroll and scroll denied by the stop
+; Scrolling text relies on byte allignment for the text buffer and display area
ds $8
wScrollingTextStruct2:: ; 0xd5d4 Start of a scrolling struct2
@@ -815,10 +825,12 @@ wWhichBonusMultiplierRailing:: ; 0xd60a
wWhichBonusMultiplierRailingId:: ; 0xd60b
ds $1
-wd60c:: ; 0xd60c
+wBonusMultiplierTensDigit:: ; 0xd60c
+; Holds the tens digit for the current bonus multiplier value. This number is displayed on the left-side bonus multiplier railing.
ds $1
-wd60d:: ; 0xd60d
+wBonusMultiplierOnesDigit:: ; 0xd60d
+; Holds the ones digit for the current bonus multiplier value. This number is displayed on the right-side bonus multiplier railing.
ds $1
wd60e:: ; 0xd60e
@@ -1823,14 +1835,17 @@ wd806:: ; 0xd806
wd807:: ; 0xd807
ds $1
-wd808:: ; 0xd808
+; These three bytes track different joypad states cummulatively, until they are manually cleared.
+; They inherit from their similarly-named counterparts found in hram.asm. (See ReadJoyPad)
+wJoypadStatesPersistent:: ; 0xd808
+wJoypadStatePersistent::
ds $1
-
-wd809:: ; 0xd809
+wNewlyPressedButtonsPersistent:: ; 0xd809
+ ds $1
+wPressedButtonsPersistent:: ; 0xd80a
ds $1
-wd80a:: ; 0xd80a
- ds $2
+ ds $1 ; unused byte
wBGP:: ; 0xd80c
ds $1