Merge pull request #225 from GriffinRichards/doc-questlog

Document some quest log

asm/cable_club.s

@@ -1926,7 +1926,7 @@ sub_8081668: @ 8081668
 	bl sub_8055DB8
 	bl LoadPlayerParty
 	bl SavePlayerBag
-	bl sub_81134B8
+	bl Special_UpdateTrainerFansAfterLinkBattle
 	ldr r0, _080816B8 @ =gSpecialVar_0x8004
 	ldrh r0, [r0]
 	cmp r0, 0x5

asm/field_control_avatar.s

@@ -100,7 +100,7 @@ _0806C914:
 	orrs r0, r1
 	strb r0, [r5]
 _0806C940:
-	ldr r0, _0806CA18 @ =gUnknown_203ADFA
+	ldr r0, _0806CA18 @ =gQuestLogState
 	ldrb r0, [r0]
 	subs r0, 0x2
 	lsls r0, 24
@@ -158,7 +158,7 @@ _0806C996:
 	orrs r0, r1
 	strb r0, [r5, 0x1]
 _0806C9AC:
-	ldr r0, _0806CA18 @ =gUnknown_203ADFA
+	ldr r0, _0806CA18 @ =gQuestLogState
 	ldrb r0, [r0]
 	subs r0, 0x2
 	lsls r0, 24
@@ -198,7 +198,7 @@ _0806C9E6:
 	orrs r0, r1
 	strb r0, [r5]
 _0806C9F6:
-	ldr r0, _0806CA18 @ =gUnknown_203ADFA
+	ldr r0, _0806CA18 @ =gQuestLogState
 	ldrb r0, [r0]
 	subs r0, 0x2
 	lsls r0, 24
@@ -214,7 +214,7 @@ _0806C9F6:
 	b _0806CA3E
 	.align 2, 0
 _0806CA14: .4byte gPlayerAvatar
-_0806CA18: .4byte gUnknown_203ADFA
+_0806CA18: .4byte gQuestLogState
 _0806CA1C:
 	movs r0, 0x80
 	ands r0, r1
@@ -1787,7 +1787,7 @@ sub_806D698: @ 806D698
 	bl InUnionRoom
 	cmp r0, 0x1
 	beq _0806D72C
-	ldr r0, _0806D6E0 @ =gUnknown_203ADFA
+	ldr r0, _0806D6E0 @ =gQuestLogState
 	ldrb r0, [r0]
 	cmp r0, 0x2
 	beq _0806D72C
@@ -1813,7 +1813,7 @@ sub_806D698: @ 806D698
 	bl ScriptContext1_SetupScript
 	b _0806D730
 	.align 2, 0
-_0806D6E0: .4byte gUnknown_203ADFA
+_0806D6E0: .4byte gQuestLogState
 _0806D6E4: .4byte gPlayerAvatar
 _0806D6E8: .4byte gUnknown_81A8CED
 _0806D6EC:

asm/field_effect.s

@@ -7227,7 +7227,7 @@ _08086BA4: .4byte sub_8086990
 	thumb_func_start sub_8086BA8
 sub_8086BA8: @ 8086BA8
 	push {lr}
-	ldr r0, _08086BC8 @ =gUnknown_203ADFA
+	ldr r0, _08086BC8 @ =gQuestLogState
 	ldrb r0, [r0]
 	cmp r0, 0x1
 	bne _08086BBA
@@ -7242,7 +7242,7 @@ _08086BBA:
 	pop {r1}
 	bx r1
 	.align 2, 0
-_08086BC8: .4byte gUnknown_203ADFA
+_08086BC8: .4byte gQuestLogState
 _08086BCC: .4byte sub_8086BD0
 	thumb_func_end sub_8086BA8
 

asm/field_message_box.s

@@ -53,7 +53,7 @@ _08069398:
 	beq _080693EA
 	b _08069402
 _0806939E:
-	ldr r0, _080693BC @ =gUnknown_203ADFA
+	ldr r0, _080693BC @ =gQuestLogState
 	ldrb r0, [r0]
 	cmp r0, 0x2
 	bne _080693C4
@@ -68,7 +68,7 @@ _0806939E:
 	bl TextWindow_LoadTilesStdFrame1
 	b _080693E2
 	.align 2, 0
-_080693BC: .4byte gUnknown_203ADFA
+_080693BC: .4byte gQuestLogState
 _080693C0: .4byte gTextFlags
 _080693C4:
 	bl IsMsgSignPost

asm/macros/event.inc

@@ -1627,9 +1627,9 @@
 	call EventScript_SetGymTrainers
 	.endm
 
-	@ Appears frequently at start of NPC scripts. Should be used once named/understood
-	.macro unk_questlog
-	special sub_8110AB4
+	@ Jumps to dest if the Quest Log is currently showing playback scenes (dest is usually a release/end)
+	.macro goto_if_questlog dest:req
+	special Special_GetQuestLogState
 	compare VAR_RESULT, 2
-	goto_if_eq EventScript_1A7AE0
+	goto_if_eq \dest
 	.endm

asm/overworld.s

@@ -3360,7 +3360,7 @@ sub_8056534: @ 8056534
 	lsrs r0, 24
 	cmp r0, 0x1
 	beq _08056554
-	ldr r0, _08056564 @ =gUnknown_203ADFA
+	ldr r0, _08056564 @ =gQuestLogState
 	ldrb r0, [r0]
 	cmp r0, 0x2
 	bne _08056568
@@ -3370,7 +3370,7 @@ _08056554:
 	.align 2, 0
 _0805655C: .4byte gMain
 _08056560: .4byte sub_80565B4
-_08056564: .4byte gUnknown_203ADFA
+_08056564: .4byte gQuestLogState
 _08056568:
 	ldrh r0, [r4, 0x2E]
 	ldrh r1, [r4, 0x2C]
@@ -4145,7 +4145,7 @@ _08056BFA:
 _08056BFE:
 	bl mli4_mapscripts_and_other
 	bl sub_8057114
-	ldr r0, _08056C1C @ =gUnknown_203ADFA
+	ldr r0, _08056C1C @ =gQuestLogState
 	ldrb r0, [r0]
 	cmp r0, 0x2
 	beq _08056C16
@@ -4155,7 +4155,7 @@ _08056C16:
 	bl sub_812B35C
 	b _08056CCA
 	.align 2, 0
-_08056C1C: .4byte gUnknown_203ADFA
+_08056C1C: .4byte gQuestLogState
 _08056C20:
 	bl InitCurrentFlashLevelScanlineEffect
 	bl sub_8056F1C

asm/pokemon_storage_system.s

@@ -8649,7 +8649,7 @@ _0808FF62:
 	strb r6, [r1, 0x5]
 _0808FF64:
 	adds r0, r2, 0
-	bl sub_8113550
+	bl SetQuestLogEvent
 _0808FF6A:
 	pop {r4-r7}
 	pop {r0}

asm/union_room.s

@@ -7565,7 +7565,7 @@ InitUnionRoom: @ 811999C
 	adds r6, r0, 0
 	movs r0, 0xFF
 	strb r0, [r5]
-	ldr r0, _081199EC @ =gUnknown_203ADFA
+	ldr r0, _081199EC @ =gQuestLogState
 	ldrb r0, [r0]
 	subs r0, 0x2
 	lsls r0, 24
@@ -7596,7 +7596,7 @@ _081199E0:
 	bx r0
 	.align 2, 0
 _081199E8: .4byte gUnknown_203B04C
-_081199EC: .4byte gUnknown_203ADFA
+_081199EC: .4byte gQuestLogState
 _081199F0: .4byte sub_81199FC
 _081199F4: .4byte gUnknown_203B05C
 _081199F8: .4byte gUnknown_300202C

asm/union_room_chat.s

@@ -165,7 +165,7 @@ _08128554:
 	bl SetMainCallback2
 	movs r0, 0x11
 	movs r1, 0
-	bl sub_8113550
+	bl SetQuestLogEvent
 	ldr r0, _081285A8 @ =sub_81285E8
 	movs r1, 0x8
 	bl CreateTask