ref: 098903fc971fdb4fbaec1c72de2b6b2414c5ad90
parent: 4ef556cbc83659683454f0bf4415af52e4371d56
author: Rangi <remy.oukaour+rangi42@gmail.com>
date: Mon Dec 7 08:32:08 EST 2020
FarString -> PlaceFarString, and document a BrokenPlaceFarString bug
--- a/docs/bugs_and_glitches.md
+++ b/docs/bugs_and_glitches.md
@@ -84,6 +84,7 @@
- [Magikarp lengths can be miscalculated](#magikarp-lengths-can-be-miscalculated)
- [`CheckOwnMon` only checks the first five letters of OT names](#checkownmon-only-checks-the-first-five-letters-of-ot-names)
- [`CheckOwnMonAnywhere` does not check the Day-Care](#checkownmonanywhere-does-not-check-the-day-care)
+ - [The unused `phonecall` script command may crash](#the-unused-phonecall-script-command-may-crash)
- [Internal engine routines](#internal-engine-routines)
- [Saves corrupted by mid-save shutoff are not handled](#saves-corrupted-by-mid-save-shutoff-are-not-handled)
- [`ScriptCall` can overflow `wScriptStack` and crash](#scriptcall-can-overflow-wscriptstack-and-crash)
@@ -2024,6 +2025,28 @@
+ call CheckOwnMon
+ ret c ; found!
```
+
+
+### The unused `phonecall` script command may crash
+
+The `phonecall` script command calls the `PhoneCall` routine, which calls the `BrokenPlaceFarString` routine; this switches banks without being in bank 0, so it would start running arbitrary data as code.
+
+**Fix:** Edit `PhoneCall.CallerTextboxWithName` in [engine/phone/phone.asm](https://github.com/pret/pokecrystal/blob/master/engine/phone/phone.asm):
+
+```diff
+- ld a, [wPhoneScriptBank]
+- ld b, a
+ ld a, [wPhoneCaller]
+ ld e, a
+ ld a, [wPhoneCaller + 1]
+ ld d, a
+- call BrokenPlaceFarString
++ ld a, [wPhoneScriptBank]
++ call PlaceFarString
+ ret
+```
+
+You can also delete the now-unused `BrokenPlaceFarString` routine.
## Internal engine routines
--- a/engine/phone/phone.asm
+++ b/engine/phone/phone.asm
@@ -93,7 +93,8 @@
INCLUDE "data/phone/permanent_numbers.asm"
-FarPlaceString:
+BrokenPlaceFarString:
+; This routine is not in bank 0 and will fail or crash if called.
ldh a, [hROMBank]
push af
ld a, b
@@ -455,14 +456,14 @@
.Ring:
call Phone_StartRinging
call Phone_Wait20Frames
- call Phone_CallerTextboxWithName
+ call .CallerTextboxWithName
call Phone_Wait20Frames
call Phone_CallerTextbox
call Phone_Wait20Frames
- call Phone_CallerTextboxWithName
+ call .CallerTextboxWithName
ret
-Phone_CallerTextboxWithName:
+.CallerTextboxWithName:
ld a, [wCurCaller]
ld b, a
call Phone_TextboxWithName
@@ -475,22 +476,22 @@
ld [wPhoneCaller], a
ld a, d
ld [wPhoneCaller + 1], a
- call Phone_FirstOfTwoRings
- call Phone_FirstOfTwoRings
+ call .Ring
+ call .Ring
farcall StubbedTrainerRankings_PhoneCalls
ret
-Phone_FirstOfTwoRings:
+.Ring:
call Phone_StartRinging
call Phone_Wait20Frames
- call Phone_CallerTextboxWithName2
+ call .CallerTextboxWithName
call Phone_Wait20Frames
call Phone_CallerTextbox
call Phone_Wait20Frames
- call Phone_CallerTextboxWithName2
+ call .CallerTextboxWithName
ret
-Phone_CallerTextboxWithName2:
+.CallerTextboxWithName:
call Phone_CallerTextbox
hlcoord 1, 2
ld [hl], "☎"
@@ -502,7 +503,7 @@
ld e, a
ld a, [wPhoneCaller + 1]
ld d, a
- call FarPlaceString
+ call BrokenPlaceFarString
ret
Phone_NoSignal:
--- a/engine/pokedex/pokedex_2.asm
+++ b/engine/pokedex/pokedex_2.asm
@@ -86,7 +86,7 @@
ld a, b
push af
hlcoord 9, 5
- call FarString ; dex species
+ call PlaceFarString ; dex species
ld h, b
ld l, c
push de
@@ -182,7 +182,7 @@
pop af
hlcoord 2, 11
push af
- call FarString
+ call PlaceFarString
pop bc
ld a, [wPokedexStatus]
or a ; check for page 2
@@ -211,7 +211,7 @@
inc de
pop af
hlcoord 2, 11
- call FarString
+ call PlaceFarString
ret
POKeString: ; unreferenced
--- a/engine/printer/print_party.asm
+++ b/engine/printer/print_party.asm
@@ -37,7 +37,7 @@
pop af
ld a, b
hlcoord 1, 11, wPrinterTilemapBuffer
- call nz, FarString
+ call nz, PlaceFarString
hlcoord 19, 0, wPrinterTilemapBuffer
ld [hl], $35
ld de, SCREEN_WIDTH
@@ -86,7 +86,7 @@
pop af
hlcoord 1, 1, wPrinterTilemapBuffer
ld a, b
- call nz, FarString
+ call nz, PlaceFarString
ret
.FillColumn:
--- a/engine/printer/printer.asm
+++ b/engine/printer/printer.asm
@@ -567,7 +567,7 @@
ld d, [hl]
hlcoord 1, 7
ld a, BANK(GBPrinterStrings)
- call FarString
+ call PlaceFarString
hlcoord 2, 15
ld de, String_PressBToCancel
call PlaceString
@@ -600,7 +600,7 @@
ld d, [hl]
hlcoord 4, 7
ld a, BANK(GBPrinterStrings)
- call FarString
+ call PlaceFarString
hlcoord 4, 15
ld de, String_PressBToCancel
call PlaceString
--- a/home/text.asm
+++ b/home/text.asm
@@ -640,7 +640,7 @@
ldcoord_a 18, 17
ret
-FarString::
+PlaceFarString::
ld b, a
ldh a, [hROMBank]
push af