Second pass on documenting union room

6 files changed, 63 insertions, 63 deletions

diff --git a/data/maps/BattleFrontier_BattleTowerLobby/scripts.inc b/data/maps/BattleFrontier_BattleTowerLobby/scripts.inc
index 79e000bd3..14e5afb11 100644
--- a/data/maps/BattleFrontier_BattleTowerLobby/scripts.inc
+++ b/data/maps/BattleFrontier_BattleTowerLobby/scripts.inc
@@ -884,26 +884,26 @@ BattleFrontier_BattleTowerLobby_EventScript_ChooseLeader:: @ 823F3F3
 
 BattleFrontier_BattleTowerLobby_EventScript_TryBecomeLeader:: @ 823F430
 	call CableClub_EventScript_TryBecomeLinkLeader
-	compare VAR_RESULT, 1
+	compare VAR_RESULT, LINKUP_SUCCESS
 	goto_if_eq BattleFrontier_BattleTowerLobby_EventScript_WirelessLinkSuccessful
-	compare VAR_RESULT, 5
+	compare VAR_RESULT, LINKUP_FAILED
 	goto_if_eq BattleFrontier_BattleTowerLobby_EventScript_ChooseLeader
-	compare VAR_RESULT, 8
+	compare VAR_RESULT, LINKUP_RETRY_ROLE_ASSIGN
 	goto_if_eq BattleFrontier_BattleTowerLobby_EventScript_TryBecomeLeader
-	compare VAR_RESULT, 11
+	compare VAR_RESULT, LINKUP_FAILED_BATTLE_TOWER
 	goto_if_eq BattleFrontier_BattleTowerLobby_EventScript_AbortLink
 	release
 	return
 
 BattleFrontier_BattleTowerLobby_EventScript_TryJoinGroup:: @ 823F463
 	call CableClub_EventScript_TryJoinLinkGroup
-	compare VAR_RESULT, 1
+	compare VAR_RESULT, LINKUP_SUCCESS
 	goto_if_eq BattleFrontier_BattleTowerLobby_EventScript_WirelessLinkSuccessful
-	compare VAR_RESULT, 5
+	compare VAR_RESULT, LINKUP_FAILED
 	goto_if_eq BattleFrontier_BattleTowerLobby_EventScript_ChooseLeader
-	compare VAR_RESULT, 8
+	compare VAR_RESULT, LINKUP_RETRY_ROLE_ASSIGN
 	goto_if_eq BattleFrontier_BattleTowerLobby_EventScript_TryJoinGroup
-	compare VAR_RESULT, 11
+	compare VAR_RESULT, LINKUP_FAILED_BATTLE_TOWER
 	goto_if_eq BattleFrontier_BattleTowerLobby_EventScript_AbortLink
 	release
 	return
diff --git a/data/maps/LilycoveCity_ContestLobby/scripts.inc b/data/maps/LilycoveCity_ContestLobby/scripts.inc
index 70d4c106d..af123388d 100644
--- a/data/maps/LilycoveCity_ContestLobby/scripts.inc
+++ b/data/maps/LilycoveCity_ContestLobby/scripts.inc
@@ -889,22 +889,22 @@ LilycoveCity_ContestLobby_EventScript_DecideLinkLeader:: @ 821ABA6
 
 LilycoveCity_ContestLobby_EventScript_TryLeadGroup:: @ 821ABE3
 	call LilycoveCity_ContestLobby_EventScript_TryBecomeLinkLeader
-	compare VAR_RESULT, 1
+	compare VAR_RESULT, LINKUP_SUCCESS
 	goto_if_eq LilycoveCity_ContestLobby_EventScript_LinkLeaderDecided
-	compare VAR_RESULT, 5
+	compare VAR_RESULT, LINKUP_FAILED
 	goto_if_eq LilycoveCity_ContestLobby_EventScript_DecideLinkLeader
-	compare VAR_RESULT, 8
+	compare VAR_RESULT, LINKUP_RETRY_ROLE_ASSIGN
 	goto_if_eq LilycoveCity_ContestLobby_EventScript_TryLeadGroup
 	release
 	end
 
 LilycoveCity_ContestLobby_EventScript_TryJoinGroup:: @ 821AC0B
 	call LilycoveCity_ContestLobby_EventScript_TryJoinLinkGroup
-	compare VAR_RESULT, 1
+	compare VAR_RESULT, LINKUP_SUCCESS
 	goto_if_eq LilycoveCity_ContestLobby_EventScript_LinkLeaderDecided
-	compare VAR_RESULT, 5
+	compare VAR_RESULT, LINKUP_FAILED
 	goto_if_eq LilycoveCity_ContestLobby_EventScript_DecideLinkLeader
-	compare VAR_RESULT, 8
+	compare VAR_RESULT, LINKUP_RETRY_ROLE_ASSIGN
 	goto_if_eq LilycoveCity_ContestLobby_EventScript_TryJoinGroup
 	release
 	end
diff --git a/data/maps/UnionRoom/scripts.inc b/data/maps/UnionRoom/scripts.inc
index eac27fb5c..5a478970d 100644
--- a/data/maps/UnionRoom/scripts.inc
+++ b/data/maps/UnionRoom/scripts.inc
@@ -20,7 +20,7 @@ UnionRoom_OnResume: @ 823D1B1
 	removeobject 5
 	removeobject 4
 	removeobject 3
-	special UnionRoomSpecial
+	special RunUnionRoom
 	end
 
 UnionRoom_OnTransition: @ 823D1E5
@@ -29,7 +29,7 @@ UnionRoom_OnTransition: @ 823D1E5
 UnionRoom_EventScript_Player1:: @ 823D1E6
 	lock
 	faceplayer
-	setvar VAR_RESULT, 1
+	setvar VAR_RESULT, UR_INTERACT_PLAYER_1
 	waitstate
 	release
 	end
@@ -37,7 +37,7 @@ UnionRoom_EventScript_Player1:: @ 823D1E6
 UnionRoom_EventScript_Player2:: @ 823D1F0
 	lock
 	faceplayer
-	setvar VAR_RESULT, 2
+	setvar VAR_RESULT, UR_INTERACT_PLAYER_2
 	waitstate
 	release
 	end
@@ -45,7 +45,7 @@ UnionRoom_EventScript_Player2:: @ 823D1F0
 UnionRoom_EventScript_Player3:: @ 823D1FA
 	lock
 	faceplayer
-	setvar VAR_RESULT, 3
+	setvar VAR_RESULT, UR_INTERACT_PLAYER_3
 	waitstate
 	release
 	end
@@ -53,7 +53,7 @@ UnionRoom_EventScript_Player3:: @ 823D1FA
 UnionRoom_EventScript_Player4:: @ 823D204
 	lock
 	faceplayer
-	setvar VAR_RESULT, 4
+	setvar VAR_RESULT, UR_INTERACT_PLAYER_4
 	waitstate
 	release
 	end
@@ -61,7 +61,7 @@ UnionRoom_EventScript_Player4:: @ 823D204
 UnionRoom_EventScript_Player5:: @ 823D20E
 	lock
 	faceplayer
-	setvar VAR_RESULT, 5
+	setvar VAR_RESULT, UR_INTERACT_PLAYER_5
 	waitstate
 	release
 	end
@@ -69,7 +69,7 @@ UnionRoom_EventScript_Player5:: @ 823D20E
 UnionRoom_EventScript_Player6:: @ 823D218
 	lock
 	faceplayer
-	setvar VAR_RESULT, 6
+	setvar VAR_RESULT, UR_INTERACT_PLAYER_6
 	waitstate
 	release
 	end
@@ -77,7 +77,7 @@ UnionRoom_EventScript_Player6:: @ 823D218
 UnionRoom_EventScript_Player7:: @ 823D222
 	lock
 	faceplayer
-	setvar VAR_RESULT, 7
+	setvar VAR_RESULT, UR_INTERACT_PLAYER_7
 	waitstate
 	release
 	end
@@ -85,7 +85,7 @@ UnionRoom_EventScript_Player7:: @ 823D222
 UnionRoom_EventScript_Player8:: @ 823D22C
 	lock
 	faceplayer
-	setvar VAR_RESULT, 8
+	setvar VAR_RESULT, UR_INTERACT_PLAYER_8
 	waitstate
 	release
 	end
@@ -93,14 +93,14 @@ UnionRoom_EventScript_Player8:: @ 823D22C
 UnionRoom_EventScript_Attendant:: @ 823D236
 	lock
 	faceplayer
-	setvar VAR_RESULT, 9
+	setvar VAR_RESULT, UR_INTERACT_ATTENDANT
 	waitstate
 	release
 	end
 
 UnionRoom_EventScript_Unused:: @ 823D240
 	lockall
-	setvar VAR_RESULT, 10
+	setvar VAR_RESULT, UR_INTERACT_UNUSED
 	waitstate
 	releaseall
 	end
diff --git a/data/scripts/berry_blender.inc b/data/scripts/berry_blender.inc
index 6501ce129..28c3d6de7 100644
--- a/data/scripts/berry_blender.inc
+++ b/data/scripts/berry_blender.inc
@@ -712,22 +712,22 @@ BerryBlender_EventScript_DecideLinkLeader: @ 82941F8
 
 BerryBlender_EventScript_TryLeadGroup: @ 8294235
 	call BerryBlender_EventScript_TryBecomeLinkLeader
-	compare VAR_RESULT, 1
+	compare VAR_RESULT, LINKUP_SUCCESS
 	goto_if_eq BerryBlender_EventScript_LinkLeaderDecided
-	compare VAR_RESULT, 5
+	compare VAR_RESULT, LINKUP_FAILED
 	goto_if_eq BerryBlender_EventScript_DecideLinkLeader
-	compare VAR_RESULT, 8
+	compare VAR_RESULT, LINKUP_RETRY_ROLE_ASSIGN
 	goto_if_eq BerryBlender_EventScript_TryLeadGroup
 	release
 	end
 
 BerryBlender_EventScript_TryJoinGroup: @ 829425D
 	call BerryBlender_EventScript_TryJoinLinkGroup
-	compare VAR_RESULT, 1
+	compare VAR_RESULT, LINKUP_SUCCESS
 	goto_if_eq BerryBlender_EventScript_LinkLeaderDecided
-	compare VAR_RESULT, 5
+	compare VAR_RESULT, LINKUP_FAILED
 	goto_if_eq BerryBlender_EventScript_DecideLinkLeader
-	compare VAR_RESULT, 8
+	compare VAR_RESULT, LINKUP_RETRY_ROLE_ASSIGN
 	goto_if_eq BerryBlender_EventScript_TryJoinGroup
 	release
 	end
diff --git a/data/scripts/cable_club.inc b/data/scripts/cable_club.inc
index df14800cc..66cf74f0a 100644
--- a/data/scripts/cable_club.inc
+++ b/data/scripts/cable_club.inc
@@ -349,17 +349,17 @@ CableClub_EventScript_TryEnterColosseum:: @ 8276F60
 	waitmessage
 	special TryBattleLinkup
 	waitstate
-	compare VAR_RESULT, 1
+	compare VAR_RESULT, LINKUP_SUCCESS
 	goto_if_eq CableClub_EventScript_EnterColosseum
-	compare VAR_RESULT, 2
+	compare VAR_RESULT, LINKUP_SOMEONE_NOT_READY
 	goto_if_eq CableClub_EventScript_AbortLinkSomeoneNotReady
-	compare VAR_RESULT, 3
+	compare VAR_RESULT, LINKUP_DIFF_SELECTIONS
 	goto_if_eq CableClub_EventScript_AbortLinkDifferentSelections
-	compare VAR_RESULT, 4
+	compare VAR_RESULT, LINKUP_WRONG_NUM_PLAYERS
 	goto_if_eq CableClub_EventScript_AbortLinkIncorrectNumberOfBattlers
-	compare VAR_RESULT, 5
+	compare VAR_RESULT, LINKUP_FAILED
 	goto_if_eq CableClub_EventScript_AbortLink
-	compare VAR_RESULT, 6
+	compare VAR_RESULT, LINKUP_CONNECTION_ERROR
 	goto_if_eq CableClub_EventScript_AbortLinkConnectionError
 	end
 
@@ -972,7 +972,7 @@ CableClub_EventScript_EnterUnionRoom:: @ 827759F
 	special SetCableClubWarp
 	warpteleport2 MAP_UNION_ROOM, 255, 7, 11
 	waitstate
-	special UnionRoomSpecial
+	special RunUnionRoom
 	waitstate
 	end
 
@@ -1181,22 +1181,22 @@ CableClub_EventScript_ChooseLinkLeaderFrom2:: @ 8277989
 
 CableClub_EventScript_TryLeadGroup2Players:: @ 82779C6
 	call CableClub_EventScript_TryBecomeLinkLeader
-	compare VAR_RESULT, 1
+	compare VAR_RESULT, LINKUP_SUCCESS
 	goto_if_eq CableClub_EventScript_EnterWirelessLinkRoom
-	compare VAR_RESULT, 5
+	compare VAR_RESULT, LINKUP_FAILED
 	goto_if_eq CableClub_EventScript_ChooseLinkLeaderFrom2
-	compare VAR_RESULT, 8
+	compare VAR_RESULT, LINKUP_RETRY_ROLE_ASSIGN
 	goto_if_eq CableClub_EventScript_TryLeadGroup2Players
 	release
 	return
 
 CableClub_EventScript_TryJoinGroup2Players:: @ 82779EE
 	call CableClub_EventScript_TryJoinLinkGroup
-	compare VAR_RESULT, 1
+	compare VAR_RESULT, LINKUP_SUCCESS
 	goto_if_eq CableClub_EventScript_EnterWirelessLinkRoom
-	compare VAR_RESULT, 5
+	compare VAR_RESULT, LINKUP_FAILED
 	goto_if_eq CableClub_EventScript_ChooseLinkLeaderFrom2
-	compare VAR_RESULT, 8
+	compare VAR_RESULT, LINKUP_RETRY_ROLE_ASSIGN
 	goto_if_eq CableClub_EventScript_TryJoinGroup2Players
 	release
 	return
@@ -1214,22 +1214,22 @@ CableClub_EventScript_ChooseLinkLeaderFrom4:: @ 8277A16
 
 CableClub_EventScript_TryLeadGroup4Players:: @ 8277A53
 	call CableClub_EventScript_TryBecomeLinkLeader
-	compare VAR_RESULT, 1
+	compare VAR_RESULT, LINKUP_SUCCESS
 	goto_if_eq CableClub_EventScript_EnterWirelessLinkRoom
-	compare VAR_RESULT, 5
+	compare VAR_RESULT, LINKUP_FAILED
 	goto_if_eq CableClub_EventScript_ChooseLinkLeaderFrom4
-	compare VAR_RESULT, 8
+	compare VAR_RESULT, LINKUP_RETRY_ROLE_ASSIGN
 	goto_if_eq CableClub_EventScript_TryLeadGroup4Players
 	release
 	return
 
 CableClub_EventScript_TryJoinGroup4Players:: @ 8277A7B
 	call CableClub_EventScript_TryJoinLinkGroup
-	compare VAR_RESULT, 1
+	compare VAR_RESULT, LINKUP_SUCCESS
 	goto_if_eq CableClub_EventScript_EnterWirelessLinkRoom
-	compare VAR_RESULT, 5
+	compare VAR_RESULT, LINKUP_FAILED
 	goto_if_eq CableClub_EventScript_ChooseLinkLeaderFrom4
-	compare VAR_RESULT, 8
+	compare VAR_RESULT, LINKUP_RETRY_ROLE_ASSIGN
 	goto_if_eq CableClub_EventScript_TryJoinGroup4Players
 	release
 	return
@@ -1247,22 +1247,22 @@ CableClub_EventScript_ChooseLinkLeader:: @ 8277AA3
 
 CableClub_EventScript_TryLeadGroupXPlayers:: @ 8277AE0
 	call CableClub_EventScript_TryBecomeLinkLeader
-	compare VAR_RESULT, 1
+	compare VAR_RESULT, LINKUP_SUCCESS
 	goto_if_eq CableClub_EventScript_EnterWirelessLinkRoom
-	compare VAR_RESULT, 5
+	compare VAR_RESULT, LINKUP_FAILED
 	goto_if_eq CableClub_EventScript_ChooseLinkLeader
-	compare VAR_RESULT, 8
+	compare VAR_RESULT, LINKUP_RETRY_ROLE_ASSIGN
 	goto_if_eq CableClub_EventScript_TryLeadGroupXPlayers
 	release
 	return
 
 CableClub_EventScript_TryJoinGroupXPlayers:: @ 8277B08
 	call CableClub_EventScript_TryJoinLinkGroup
-	compare VAR_RESULT, 1
+	compare VAR_RESULT, LINKUP_SUCCESS
 	goto_if_eq CableClub_EventScript_EnterWirelessLinkRoom
-	compare VAR_RESULT, 5
+	compare VAR_RESULT, LINKUP_FAILED
 	goto_if_eq CableClub_EventScript_ChooseLinkLeader
-	compare VAR_RESULT, 8
+	compare VAR_RESULT, LINKUP_RETRY_ROLE_ASSIGN
 	goto_if_eq CableClub_EventScript_TryJoinGroupXPlayers
 	release
 	return
@@ -1453,22 +1453,22 @@ MossdeepCity_GameCorner_1F_EventScript_ChooseLinkLeader:: @ 8277D81
 
 MossdeepCity_GameCorner_1F_EventScript_TryBecomeLinkLeader:: @ 8277DBE
 	call CableClub_EventScript_TryBecomeLinkLeader
-	compare VAR_RESULT, 1
+	compare VAR_RESULT, LINKUP_SUCCESS
 	goto_if_eq MossdeepCity_GameCorner_1F_EventScript_EnterMinigameRoom
-	compare VAR_RESULT, 5
+	compare VAR_RESULT, LINKUP_FAILED
 	goto_if_eq MossdeepCity_GameCorner_1F_EventScript_ChooseLinkLeader
-	compare VAR_RESULT, 8
+	compare VAR_RESULT, LINKUP_RETRY_ROLE_ASSIGN
 	goto_if_eq MossdeepCity_GameCorner_1F_EventScript_TryBecomeLinkLeader
 	release
 	return
 
 MossdeepCity_GameCorner_1F_EventScript_TryJoinLinkGroup:: @ 8277DE6
 	call CableClub_EventScript_TryJoinLinkGroup
-	compare VAR_RESULT, 1
+	compare VAR_RESULT, LINKUP_SUCCESS
 	goto_if_eq MossdeepCity_GameCorner_1F_EventScript_EnterMinigameRoom
-	compare VAR_RESULT, 5
+	compare VAR_RESULT, LINKUP_FAILED
 	goto_if_eq MossdeepCity_GameCorner_1F_EventScript_ChooseLinkLeader
-	compare VAR_RESULT, 8
+	compare VAR_RESULT, LINKUP_RETRY_ROLE_ASSIGN
 	goto_if_eq MossdeepCity_GameCorner_1F_EventScript_TryJoinLinkGroup
 	release
 	return
diff --git a/data/specials.inc b/data/specials.inc
index 5d48e62f9..d973a6a94 100644
--- a/data/specials.inc
+++ b/data/specials.inc
@@ -426,7 +426,7 @@ gSpecials:: @ 81DBA64
 	def_special IsWirelessAdapterConnected
 	def_special TryBecomeLinkLeader
 	def_special TryJoinLinkGroup
-	def_special UnionRoomSpecial
+	def_special RunUnionRoom
 	def_special ShowWirelessCommunicationScreen
 	def_special InitUnionRoom
 	def_special BufferUnionRoomPlayerName