From b0e2e7aef34be52654d31d377626998955a11b05 Mon Sep 17 00:00:00 2001 From: xCrystal Date: Fri, 20 Oct 2023 20:16:10 +0200 Subject: [PATCH] Rename wCurSpaceData and wTempSpaceData to *SpaceStruct and create space_struct macro --- docs/develop/index.md | 8 ++++---- home/map.asm | 6 +++--- macros/ram.asm | 7 +++++++ ram/wram.asm | 16 ++++------------ 4 files changed, 18 insertions(+), 19 deletions(-) diff --git a/docs/develop/index.md b/docs/develop/index.md index c8dfef521..df90251e2 100755 --- a/docs/develop/index.md +++ b/docs/develop/index.md @@ -348,20 +348,20 @@ $~~~~$then always returns PLAYERMOVEMENT_FINISH but often is overwritten by c - Addresses within *wCurMapData* ~ *wCurMapDataEnd*: preserved on save. - **wCurTurn** - **wCurSpace** - - **wCurSpaceData**: + - **wCurSpaceStruct**: - **wCurSpaceXCoord** - **wCurSpaceYCoord** - **wCurSpaceEffect** - **wCurSpaceNextSpace**. -- **wTempSpaceData**: shares memory region with string buffers from *wStringBuffer3* onwards. Temporary scope. Same structure as *wCurSpaceData* +- **wTempSpaceStruct**: shares memory region with string buffers from *wStringBuffer3* onwards. Temporary scope. Same structure as *wCurSpaceStruct* ### Workflow 1) ``OverworldLoop`` is called from ``GameMenu_WorldMap`` with either ``hMapEntryMethod`` = ``MAPSETUP_ENTERLEVEL`` or ``hMapEntryMethod`` = ``MAPSETUP_CONTINUE``. 2) ``StartMap`` resets ``wCurTurn`` and ``wCurSpace`` if ``MAPSETUP_ENTERLEVEL``. ``StartMap`` sets ``hCurBoardEvent`` to ``BOARDEVENT_DISPLAY_MENU``. ``wScriptFlags2`` is cleared. ``wMapStatus`` is set to ``MAPSTATUS_HANDLE`` causing ``HandleMap`` to be called. 3) ``MapEvents`` (from ``HandleMap``) calls ``PlayerEvents``. ``CheckBoardEvent`` queues ``BoardMenuScript`` which is executed by ``ScriptEvents``. -4) ``BoardMenuScript``.``Upkeep`` saves the game, clears ``wTurnData[]``, increases ``wCurTurn``, and loads current space to ``wCurSpaceData[]``. +4) ``BoardMenuScript``.``Upkeep`` saves the game, clears ``wTurnData[]``, increases ``wCurTurn``, and loads current space to ``wCurSpaceStruct[]``. - If player exits, the ``exitoverworld`` script sets ``wMapStatus`` to ``MAPSTATUS_DONE``. This causes ``OverworldLoop`` to return back to the game menu. **Exit this workflow**. 5) Player rolls die and the animation plays. After the animation, ``wDisplaySecondarySprites``.``SECONDARYSPRITES_SPACES_LEFT_F`` is set and ``hCurBoardEvent`` is set to ``BOARDEVENT_HANDLE_BOARD``. At the end of this ``HandleMap`` iteration, ``CheckPlayerState`` sets ``wMapEventStatus`` to ``MAPEVENTS_ON`` (``wScriptFlags2`` is not touched so it remains cleared). 6) In the next ``HandleMap`` iteration, ``CheckBoardEvent`` from ``PlayerEvents`` jumps to ``.board`` and then to ``.no_space_effect`` due to ``wScriptFlags2[4]`` not being set. @@ -371,7 +371,7 @@ $~~~~$then always returns PLAYERMOVEMENT_FINISH but often is overwritten by c 10) In the next ``HandleMap`` iteration, ``CheckBoardEvent.board`` is called with ``wScriptFlags2[4]`` set. - If player is not above a tile (``wPlayerTile``) with a space collision: ``wScriptFlags2[4]`` is reset. **Go back to 7)**. - If player is above a tile, the corresponding space script is queued to be executed by ``ScriptEvents`` in the current ``HandleMap`` iteration. ``wScriptFlags2[4]`` is reset. **Continue to 11)**. -11) The space script loads the value of ``wCurSpaceNextSpace`` into ``wCurSpace``, loads the new space data to ``wCurSpaceData[]``, and decreases ``wSpacesLeft``. +11) The space script loads the value of ``wCurSpaceNextSpace`` into ``wCurSpace``, loads the new space data to ``wCurSpaceStruct[]``, and decreases ``wSpacesLeft``. - If ``wSpacesLeft`` is non-0, **go back to 6)**. 12) ``hCurBoardEvent`` is set to ``BOARDEVENT_END_TURN``. ``CheckBoardEvent`` does nothing in this state. In the first subsequent ``HandleMap`` iteration where no other kind of event triggers causing ``PlayerEvents`` to return early, ``hCurBoardEvent`` is set to ``BOARDEVENT_DISPLAY_MENU``. 13) **Go back to 3)** \ No newline at end of file diff --git a/home/map.asm b/home/map.asm index 174e7d744..13bc1d343 100644 --- a/home/map.asm +++ b/home/map.asm @@ -2301,11 +2301,11 @@ LoadMapTileset:: ; a: which space to load LoadTempSpaceData:: - ld de, wTempSpaceData + ld de, wTempSpaceStruct jr LoadSpaceData LoadCurSpaceData:: - ld de, wCurSpaceData + ld de, wCurSpaceStruct ld a, [wCurSpace] ; fallthrough @@ -2318,7 +2318,7 @@ LoadSpaceData:: ld a, [hli] ld h, [hl] ld l, a - ld bc, wCurSpaceDataEnd - wCurSpaceData ; wTempSpaceDataEnd - wTempSpaceData + ld bc, wCurSpaceStructEnd - wCurSpaceStruct ; wTempSpaceStructEnd - wTempSpaceStruct pop af call AddNTimes pop de diff --git a/macros/ram.asm b/macros/ram.asm index aa05d8325..2495ab148 100644 --- a/macros/ram.asm +++ b/macros/ram.asm @@ -406,3 +406,10 @@ MACRO battle_bg_effect \1BattleTurn:: db \1Param:: db ENDM + +MACRO space_struct +\1XCoord:: db +\1YCoord:: db +\1Effect:: db +\1NextSpace:: db +ENDM diff --git a/ram/wram.asm b/ram/wram.asm index 75a49e1b7..e16f4d69a 100644 --- a/ram/wram.asm +++ b/ram/wram.asm @@ -1678,12 +1678,8 @@ wStringBuffer4:: ds STRING_BUFFER_LENGTH wStringBuffer5:: ds STRING_BUFFER_LENGTH NEXTU -wTempSpaceData:: -wTempSpaceXCoord:: db -wTempSpaceYCoord:: db -wTempSpaceEffect:: db -wTempSpaceNextSpace:: db -wTempSpaceDataEnd:: +wTempSpaceStruct:: space_struct wTempSpace +wTempSpaceStructEnd:: ENDU wBattleMenuCursorPosition:: @@ -2513,12 +2509,8 @@ wScreenSave:: ds SCREEN_META_WIDTH * SCREEN_META_HEIGHT wCurTurn:: db wCurSpace:: db -wCurSpaceData:: -wCurSpaceXCoord:: db -wCurSpaceYCoord:: db -wCurSpaceEffect:: db -wCurSpaceNextSpace:: db -wCurSpaceDataEnd:: +wCurSpaceStruct:: space_struct wCurSpace +wCurSpaceStructEnd:: wCurMapDataEnd::