Document object lock and some trainer approach

1 files changed, 58 insertions, 41 deletions

diff --git a/src/event_object_lock.c b/src/event_object_lock.c
index 67652a99b..dec2d7906 100644
--- a/src/event_object_lock.c
+++ b/src/event_object_lock.c
@@ -16,18 +16,19 @@ bool8 IsPlayerStandingStill(void)
         return TRUE;
 }
 
-static void sub_80983A4(u8 taskId)
+// Freeze player once their movement is finished
+static void Task_FreezePlayer(u8 taskId)
 {
     if (IsPlayerStandingStill())
     {
-        sub_808B864();
+        PlayerFreeze();
         DestroyTask(taskId);
     }
 }
 
-bool8 sub_80983C4(void)
+bool8 IsFreezePlayerFinished(void)
 {
-    if (FuncIsActiveTask(sub_80983A4))
+    if (FuncIsActiveTask(Task_FreezePlayer))
     {
         return FALSE;
     }
@@ -42,30 +43,35 @@ bool8 sub_80983C4(void)
 void ScriptFreezeObjectEvents(void)
 {
     FreezeObjectEvents();
-    CreateTask(sub_80983A4, 80);
+    CreateTask(Task_FreezePlayer, 80);
 }
 
-static void sub_8098400(u8 taskId)
+#define tPlayerFrozen data[0]
+#define tObjectFrozen data[1]
+#define tObjectId     data[2]
+
+// Freeze selected object and player once their movement is finished
+static void Task_FreezeSelectedObjectAndPlayer(u8 taskId)
 {
     struct Task *task = &gTasks[taskId];
 
-    if (!task->data[0] && IsPlayerStandingStill() == TRUE)
+    if (!task->tPlayerFrozen && IsPlayerStandingStill() == TRUE)
     {
-        sub_808B864();
-        task->data[0] = 1;
+        PlayerFreeze();
+        task->tPlayerFrozen = TRUE;
     }
-    if (!task->data[1] && !gObjectEvents[gSelectedObjectEvent].singleMovementActive)
+    if (!task->tObjectFrozen && !gObjectEvents[gSelectedObjectEvent].singleMovementActive)
     {
         FreezeObjectEvent(&gObjectEvents[gSelectedObjectEvent]);
-        task->data[1] = 1;
+        task->tObjectFrozen = TRUE;
     }
-    if (task->data[0] && task->data[1])
+    if (task->tPlayerFrozen && task->tObjectFrozen)
         DestroyTask(taskId);
 }
 
-bool8 sub_809847C(void)
+bool8 IsFreezeSelectedObjectAndPlayerFinished(void)
 {
-    if (FuncIsActiveTask(sub_8098400))
+    if (FuncIsActiveTask(Task_FreezeSelectedObjectAndPlayer))
     {
         return FALSE;
     }
@@ -80,11 +86,11 @@ void LockSelectedObjectEvent(void)
 {
     u8 taskId;
     FreezeObjectEventsExceptOne(gSelectedObjectEvent);
-    taskId = CreateTask(sub_8098400, 80);
+    taskId = CreateTask(Task_FreezeSelectedObjectAndPlayer, 80);
     if (!gObjectEvents[gSelectedObjectEvent].singleMovementActive)
     {
         FreezeObjectEvent(&gObjectEvents[gSelectedObjectEvent]);
-        gTasks[taskId].data[1] = 1;
+        gTasks[taskId].tObjectFrozen = TRUE;
     }
 }
 
@@ -118,64 +124,71 @@ void Script_ClearHeldMovement(void)
     ObjectEventClearHeldMovementIfActive(&gObjectEvents[gSelectedObjectEvent]);
 }
 
-static void sub_80985BC(u8 taskId)
+// Freeze designated object and player once their movement is finished
+static void Task_FreezeObjectAndPlayer(u8 taskId)
 {
     struct Task *task = &gTasks[taskId];
-    u8 objectEventId = task->data[2];
+    u8 objectEventId = task->tObjectId;
 
-    if (!task->data[0] && IsPlayerStandingStill() == TRUE)
+    if (!task->tPlayerFrozen && IsPlayerStandingStill() == TRUE)
     {
-        sub_808B864();
-        task->data[0] = 1;
+        PlayerFreeze();
+        task->tPlayerFrozen = TRUE;
     }
-    if (!task->data[1] && !gObjectEvents[objectEventId].singleMovementActive)
+    if (!task->tObjectFrozen && !gObjectEvents[objectEventId].singleMovementActive)
     {
         FreezeObjectEvent(&gObjectEvents[objectEventId]);
-        task->data[1] = 1;
+        task->tObjectFrozen = TRUE;
     }
-    if (task->data[0] && task->data[1])
+    if (task->tPlayerFrozen && task->tObjectFrozen)
         DestroyTask(taskId);
 }
 
-void sub_8098630(void)
+void FreezeForApproachingTrainers(void)
 {
     u8 trainerObjectId1, trainerObjectId2, taskId;
     trainerObjectId1 = GetChosenApproachingTrainerObjectEventId(0);
-    if(gNoOfApproachingTrainers == 2)
+
+    if (gNoOfApproachingTrainers == 2)
     {
+        // Get second trainer, freeze all other objects
         trainerObjectId2 = GetChosenApproachingTrainerObjectEventId(1);
-        sub_8098074(trainerObjectId1, trainerObjectId2);
-        taskId = CreateTask(sub_80985BC, 80);
-        gTasks[taskId].data[2] = trainerObjectId1;
-        if(!gObjectEvents[trainerObjectId1].singleMovementActive)
+        FreezeObjectEventsExceptTwo(trainerObjectId1, trainerObjectId2);
+
+        // Start task to freeze trainer 1 (and player) after movement
+        taskId = CreateTask(Task_FreezeObjectAndPlayer, 80);
+        gTasks[taskId].tObjectId = trainerObjectId1;
+        if (!gObjectEvents[trainerObjectId1].singleMovementActive)
         {
             FreezeObjectEvent(&gObjectEvents[trainerObjectId1]);
-            gTasks[taskId].data[1] = 1;
+            gTasks[taskId].tObjectFrozen = TRUE;
         }
-        taskId = CreateTask(sub_80985BC, 81);
-        gTasks[taskId].data[2] = trainerObjectId2;
-        if(!gObjectEvents[trainerObjectId2].singleMovementActive)
+
+        // Start task to freeze trainer 2 after movement
+        taskId = CreateTask(Task_FreezeObjectAndPlayer, 81);
+        gTasks[taskId].tObjectId = trainerObjectId2;
+        if (!gObjectEvents[trainerObjectId2].singleMovementActive)
         {
             FreezeObjectEvent(&gObjectEvents[trainerObjectId2]);
-            gTasks[taskId].data[1] = 1;
+            gTasks[taskId].tObjectFrozen = TRUE;
         }
     }
     else
     {
         FreezeObjectEventsExceptOne(trainerObjectId1);
-        taskId = CreateTask(sub_80985BC, 80);
-        gTasks[taskId].data[2] = trainerObjectId1;
-        if(!gObjectEvents[trainerObjectId1].singleMovementActive)
+        taskId = CreateTask(Task_FreezeObjectAndPlayer, 80);
+        gTasks[taskId].tObjectId = trainerObjectId1;
+        if (!gObjectEvents[trainerObjectId1].singleMovementActive)
         {
             FreezeObjectEvent(&gObjectEvents[trainerObjectId1]);
-            gTasks[taskId].data[1] = 1;
+            gTasks[taskId].tObjectFrozen = TRUE;
         }
     }
 }
 
-bool8 sub_8098734(void)
+bool8 IsFreezeObjectAndPlayerFinished(void)
 {
-    if (FuncIsActiveTask(sub_80985BC))
+    if (FuncIsActiveTask(Task_FreezeObjectAndPlayer))
     {
         return FALSE;
     }
@@ -185,3 +198,7 @@ bool8 sub_8098734(void)
         return TRUE;
     }
 }
+
+#undef tPlayerFrozen
+#undef tObjectFrozen
+#undef tObjectId