shithub: pokecrystal

Info  •  Files  •  Log  •  Branches

Document WaitPressAorB_BlinkCursor a bit

This is one weird function I'll never understand the purpose of.
It could use a better name, but I have no clue what.

--- a/home/joypad.asm

+++ b/home/joypad.asm

@@ -338,6 +338,12 @@

 	ret

 WaitPressAorB_BlinkCursor::

+; Show a blinking cursor in the lower right-hand

+; corner of a textbox and wait until A or B is

+; pressed.

+;

+; NOTE: The cursor has to be shown before calling

+; this function or no cursor will be shown at all.

 	ldh a, [hMapObjectIndexBuffer]

 	push af

 	ldh a, [hObjectStructIndexBuffer]

@@ -373,6 +379,9 @@

 	ret

 PromptButton::

+; Show a blinking cursor in the lower right-hand

+; corner of a textbox and wait until A or B is

+; pressed, afterwards, play a sound.

 	ld a, [wLinkMode]

 	and a

 	jr nz, .link