Merge pull request #270 from GriffinRichards/doc-oneisland

Document One Island scripts

3 files changed, 49 insertions, 52 deletions

diff --git a/data/maps/OneIsland/map.json b/data/maps/OneIsland/map.json
index 0fa530aa2..cc27f84cb 100644
--- a/data/maps/OneIsland/map.json
+++ b/data/maps/OneIsland/map.json
@@ -49,7 +49,7 @@
       "movement_range_y": 1,
       "trainer_type": 0,
       "trainer_sight_or_berry_tree_id": 0,
-      "script": "OneIsland_EventScript_167517",
+      "script": "OneIsland_EventScript_OldMan",
       "flag": "0"
     },
     {
@@ -62,7 +62,7 @@
       "movement_range_y": 1,
       "trainer_type": 0,
       "trainer_sight_or_berry_tree_id": 0,
-      "script": "OneIsland_EventScript_167549",
+      "script": "OneIsland_EventScript_BaldingMan",
       "flag": "0"
     }
   ],
@@ -103,14 +103,14 @@
       "x": 14,
       "y": 13,
       "elevation": 0,
-      "script": "OneIsland_EventScript_167552"
+      "script": "OneIsland_EventScript_IslandSign"
     },
     {
       "type": "bg_event_type_0",
       "x": 15,
       "y": 6,
       "elevation": 0,
-      "script": "OneIsland_EventScript_16755B"
+      "script": "OneIsland_EventScript_PokemonNetCenterSign"
     }
   ]
 }
diff --git a/data/maps/OneIsland/scripts.inc b/data/maps/OneIsland/scripts.inc
index 545a3d333..a474b19a8 100644
--- a/data/maps/OneIsland/scripts.inc
+++ b/data/maps/OneIsland/scripts.inc
@@ -1,3 +1,5 @@
+.equ LOCALID_BILL, 1
+
 OneIsland_MapScripts:: @ 8167484
 	map_script MAP_SCRIPT_ON_TRANSITION, OneIsland_OnTransition
 	map_script MAP_SCRIPT_ON_FRAME_TABLE, OneIsland_OnFrame
@@ -8,35 +10,34 @@ OneIsland_OnTransition:: @ 816748F
 	end
 
 OneIsland_OnFrame:: @ 8167493
-	map_script_2 VAR_MAP_SCENE_ONE_ISLAND_HARBOR, 2, EventScript_16749D
+	map_script_2 VAR_MAP_SCENE_ONE_ISLAND_HARBOR, 2, OneIsland_EventScript_EnterOneIslandFirstTime
 	.2byte 0
 
-EventScript_16749D:: @ 816749D
+OneIsland_EventScript_EnterOneIslandFirstTime:: @ 816749D
 	lockall
 	textcolor 0
-	applymovement OBJ_EVENT_ID_PLAYER, Movement_167505
+	applymovement OBJ_EVENT_ID_PLAYER, OneIsland_Movement_PlayerExitHarbor
 	waitmovement 0
-	msgbox gUnknown_818161B
+	msgbox OneIsland_Text_BillLetsGoSeeCelio
 	closemessage
-	applymovement 1, Movement_167507
-	applymovement OBJ_EVENT_ID_PLAYER, Movement_1674F4
+	applymovement LOCALID_BILL, OneIsland_Movement_BillWalkToPokeCenter
+	applymovement OBJ_EVENT_ID_PLAYER, OneIsland_Movement_PlayerWalkToPokeCenter
 	waitmovement 0
 	opendoor 14, 5
 	waitdooranim
-	applymovement 1, Movement_167514
-	applymovement OBJ_EVENT_ID_PLAYER, Movement_167501
+	applymovement LOCALID_BILL, OneIsland_Movement_BillEnterPokeCenter
+	applymovement OBJ_EVENT_ID_PLAYER, OneIsland_Movement_PlayerEnterPokeCenter
 	waitmovement 0
 	closedoor 14, 5
 	waitdooranim
-	removeobject 1
+	removeobject LOCALID_BILL
 	setvar VAR_MAP_SCENE_ONE_ISLAND_HARBOR, 3
 	warp MAP_ONE_ISLAND_POKEMON_CENTER_1F, 255, 9, 9
 	waitstate
 	releaseall
 	end
 
-Movement_1674F4:: @ 81674F4
-	walk_up
+	.macro walk_to_pokecenter
 	walk_up
 	walk_up
 	walk_up
@@ -48,65 +49,60 @@ Movement_1674F4:: @ 81674F4
 	walk_up
 	walk_up
 	walk_up
+	.endm
+
+OneIsland_Movement_PlayerWalkToPokeCenter:: @ 81674F4
+	walk_up
+	walk_to_pokecenter
 	step_end
 
-Movement_167501:: @ 8167501
+OneIsland_Movement_PlayerEnterPokeCenter:: @ 8167501
 	walk_up
 	walk_up
 	set_invisible
 	step_end
 
-Movement_167505:: @ 8167505
+OneIsland_Movement_PlayerExitHarbor:: @ 8167505
 	walk_up
 	step_end
 
-Movement_167507:: @ 8167507
-	walk_up
-	walk_up
-	walk_up
-	walk_up
-	walk_right
-	walk_right
-	walk_up
-	walk_up
-	walk_up
-	walk_up
-	walk_up
+OneIsland_Movement_BillWalkToPokeCenter:: @ 8167507
+	walk_to_pokecenter
 	walk_up
 	step_end
 
-Movement_167514:: @ 8167514
+OneIsland_Movement_BillEnterPokeCenter:: @ 8167514
 	walk_up
 	set_invisible
 	step_end
 
-OneIsland_EventScript_167517:: @ 8167517
+OneIsland_EventScript_OldMan:: @ 8167517
 	lock
 	faceplayer
-	goto_if_set FLAG_SYS_CAN_LINK_WITH_RS, EventScript_16753F
-	goto_if_set FLAG_SEVII_DETOUR_FINISHED, EventScript_167535
-	msgbox gUnknown_818174E
+	goto_if_set FLAG_SYS_CAN_LINK_WITH_RS, OneIsland_EventScript_OldManLinkHoenn
+	goto_if_set FLAG_SEVII_DETOUR_FINISHED, OneIsland_EventScript_OldManLinkKanto
+	msgbox OneIsland_Text_LuckyToHaveCelioHere
 	release
 	end
 
-EventScript_167535:: @ 8167535
-	msgbox gUnknown_8181858
+OneIsland_EventScript_OldManLinkKanto:: @ 8167535
+	msgbox OneIsland_Text_HavePCLinkageWithKanto
 	release
 	end
 
-EventScript_16753F:: @ 816753F
-	msgbox gUnknown_8181901
+OneIsland_EventScript_OldManLinkHoenn:: @ 816753F
+	msgbox OneIsland_Text_HavePCLinkageWithHoenn
 	release
 	end
 
-OneIsland_EventScript_167549:: @ 8167549
-	msgbox gUnknown_8181A4A, MSGBOX_NPC
+OneIsland_EventScript_BaldingMan:: @ 8167549
+	msgbox OneIsland_Text_IsntWarmClimateHereGreat, MSGBOX_NPC
 	end
 
-OneIsland_EventScript_167552:: @ 8167552
-	msgbox gUnknown_81819E1, MSGBOX_SIGN
+OneIsland_EventScript_IslandSign:: @ 8167552
+	msgbox OneIsland_Text_IslandSign, MSGBOX_SIGN
 	end
 
-OneIsland_EventScript_16755B:: @ 816755B
-	msgbox gUnknown_8181A0A, MSGBOX_SIGN
+OneIsland_EventScript_PokemonNetCenterSign:: @ 816755B
+	msgbox OneIsland_Text_PokemonNetCenterSign, MSGBOX_SIGN
 	end
diff --git a/data/maps/OneIsland/text.inc b/data/maps/OneIsland/text.inc
index d9a6e376a..5f49a4a5c 100644
--- a/data/maps/OneIsland/text.inc
+++ b/data/maps/OneIsland/text.inc
@@ -1,4 +1,4 @@
-gUnknown_818161B:: @ 818161B
+OneIsland_Text_BillLetsGoSeeCelio:: @ 818161B
     .string "BILL: Here we are!\n"
     .string "This is ONE ISLAND.\p"
     .string "There are several islands around\n"
@@ -14,7 +14,7 @@ Text_WhereDoYouWantToSail:: @ 8181726
     .string "Ahoy, there!\n"
     .string "Where do you want to sail?$"
 
-gUnknown_818174E:: @ 818174E
+OneIsland_Text_LuckyToHaveCelioHere:: @ 818174E
     .string "Here we are on an island smack in\n"
     .string "the middle of nowhere.\p"
     .string "We're lucky to have an upstanding\n"
@@ -26,7 +26,7 @@ gUnknown_818174E:: @ 818174E
     .string "I'm not sure what that means, but\n"
     .string "CELIO is quite the man!$"
 
-gUnknown_8181858:: @ 8181858
+OneIsland_Text_HavePCLinkageWithKanto:: @ 8181858
     .string "My granddaughter was in a tizzy\n"
     .string "over a new breakthrough.\p"
     .string "She said we now have PC linkage\n"
@@ -34,7 +34,7 @@ gUnknown_8181858:: @ 8181858
     .string "I'm not sure what that means, but\n"
     .string "CELIO is quite the man!$"
 
-gUnknown_8181901:: @ 8181901
+OneIsland_Text_HavePCLinkageWithHoenn:: @ 8181901
     .string "My granddaughter was in a tizzy\n"
     .string "over a new breakthrough.\p"
     .string "She said we finally have PC linkage\n"
@@ -44,18 +44,19 @@ gUnknown_8181901:: @ 8181901
     .string "He would make a fine husband for\n"
     .string "my granddaughter!$"
 
-gUnknown_81819E1:: @ 81819E1
+OneIsland_Text_IslandSign:: @ 81819E1
     .string "ONE ISLAND\n"
     .string "Friends Gather at Knot Island$"
 
-gUnknown_8181A0A:: @ 8181A0A
+OneIsland_Text_PokemonNetCenterSign:: @ 8181A0A
     .string "Expanding the POKéMON World!\n"
     .string "POKéMON NET CENTER$"
 
-Text_181A3A:: @ 8181A3A
+@ Unused
+OneIsland_Text_ReturnToCinnabar:: @ 8181A3A
     .string "グレンタウンに　もどりますか？$"
 
-gUnknown_8181A4A:: @ 8181A4A
+OneIsland_Text_IsntWarmClimateHereGreat:: @ 8181A4A
     .string "Hi, sight-seeing, are you?\n"
     .string "Isn't the warm climate here great?$"