Merge pull request #618 from huderlem/objMovement

Document event object movement

1 files changed, 24 insertions, 24 deletions

diff --git a/src/scrcmd.c b/src/scrcmd.c
index 29c1f982e..3ad433fb7 100644
--- a/src/scrcmd.c
+++ b/src/scrcmd.c
@@ -22,7 +22,7 @@
 #include "fieldmap.h"
 #include "item.h"
 #include "main.h"
-#include "map_obj_lock.h"
+#include "event_obj_lock.h"
 #include "menu.h"
 #include "money.h"
 #include "mystery_event_script.h"
@@ -1012,7 +1012,7 @@ bool8 ScrCmd_removeobject(struct ScriptContext *ctx)
 {
     u16 localId = VarGet(ScriptReadHalfword(ctx));
 
-    RemoveFieldObjectByLocalIdAndMap(localId, gSaveBlock1.location.mapNum, gSaveBlock1.location.mapGroup);
+    RemoveEventObjectByLocalIdAndMap(localId, gSaveBlock1.location.mapNum, gSaveBlock1.location.mapGroup);
     return FALSE;
 }
 
@@ -1022,7 +1022,7 @@ bool8 ScrCmd_removeobject_at(struct ScriptContext *ctx)
     u8 mapGroup = ScriptReadByte(ctx);
     u8 mapNum = ScriptReadByte(ctx);
 
-    RemoveFieldObjectByLocalIdAndMap(objectId, mapNum, mapGroup);
+    RemoveEventObjectByLocalIdAndMap(objectId, mapNum, mapGroup);
     return FALSE;
 }
 
@@ -1060,7 +1060,7 @@ bool8 ScrCmd_setobjectxyperm(struct ScriptContext *ctx)
     u16 x = VarGet(ScriptReadHalfword(ctx));
     u16 y = VarGet(ScriptReadHalfword(ctx));
 
-    Overworld_SetMapObjTemplateCoords(localId, x, y);
+    Overworld_SetEventObjTemplateCoords(localId, x, y);
     return FALSE;
 }
 
@@ -1068,7 +1068,7 @@ bool8 ScrCmd_moveobjectoffscreen(struct ScriptContext *ctx)
 {
     u16 localId = VarGet(ScriptReadHalfword(ctx));
 
-    sub_805C78C(localId, gSaveBlock1.location.mapNum, gSaveBlock1.location.mapGroup);
+    TryOverrideTemplateCoordsForEventObject(localId, gSaveBlock1.location.mapNum, gSaveBlock1.location.mapGroup);
     return FALSE;
 }
 
@@ -1115,10 +1115,10 @@ bool8 ScrCmd_resetobjectpriority(struct ScriptContext *ctx)
 
 bool8 ScrCmd_faceplayer(struct ScriptContext *ctx)
 {
-    if (gMapObjects[gSelectedMapObject].active)
+    if (gEventObjects[gSelectedEventObject].active)
     {
-        FieldObjectFaceOppositeDirection(&gMapObjects[gSelectedMapObject],
-          player_get_direction_lower_nybble());
+        EventObjectFaceOppositeDirection(&gEventObjects[gSelectedEventObject],
+          GetPlayerFacingDirection());
     }
     return FALSE;
 }
@@ -1128,7 +1128,7 @@ bool8 ScrCmd_turnobject(struct ScriptContext *ctx)
     u16 localId = VarGet(ScriptReadHalfword(ctx));
     u8 direction = ScriptReadByte(ctx);
 
-    FieldObjectTurnByLocalIdAndMap(localId, gSaveBlock1.location.mapNum, gSaveBlock1.location.mapGroup, direction);
+    EventObjectTurnByLocalIdAndMap(localId, gSaveBlock1.location.mapNum, gSaveBlock1.location.mapGroup, direction);
     return FALSE;
 }
 
@@ -1137,7 +1137,7 @@ bool8 ScrCmd_setobjectmovementtype(struct ScriptContext *ctx)
     u16 localId = VarGet(ScriptReadHalfword(ctx));
     u8 movementType = ScriptReadByte(ctx);
 
-    Overworld_SetMapObjTemplateMovementType(localId, movementType);
+    Overworld_SetEventObjTemplateMovementType(localId, movementType);
     return FALSE;
 }
 
@@ -1156,10 +1156,10 @@ bool8 ScrCmd_createvobject(struct ScriptContext *ctx)
 
 bool8 ScrCmd_turnvobject(struct ScriptContext *ctx)
 {
-    u8 v1 = ScriptReadByte(ctx);
+    u8 eventObjectId = ScriptReadByte(ctx);
     u8 direction = ScriptReadByte(ctx);
 
-    sub_8064990(v1, direction);
+    TurnEventObject(eventObjectId, direction);
     return FALSE;
 }
 
@@ -1171,7 +1171,7 @@ bool8 ScrCmd_lockall(struct ScriptContext *ctx)
     }
     else
     {
-        ScriptFreezeMapObjects();
+        ScriptFreezeEventObjects();
         SetupNativeScript(ctx, sub_8064CFC);
         return TRUE;
     }
@@ -1185,14 +1185,14 @@ bool8 ScrCmd_lock(struct ScriptContext *ctx)
     }
     else
     {
-        if (gMapObjects[gSelectedMapObject].active)
+        if (gEventObjects[gSelectedEventObject].active)
         {
-            LockSelectedMapObject();
+            LockSelectedEventObject();
             SetupNativeScript(ctx, sub_8064DB4);
         }
         else
         {
-            ScriptFreezeMapObjects();
+            ScriptFreezeEventObjects();
             SetupNativeScript(ctx, sub_8064CFC);
         }
         return TRUE;
@@ -1204,10 +1204,10 @@ bool8 ScrCmd_releaseall(struct ScriptContext *ctx)
     u8 objectId;
 
     HideFieldMessageBox();
-    objectId = GetFieldObjectIdByLocalIdAndMap(0xFF, 0, 0);
-    FieldObjectClearAnimIfSpecialAnimFinished(&gMapObjects[objectId]);
+    objectId = GetEventObjectIdByLocalIdAndMap(0xFF, 0, 0);
+    EventObjectClearHeldMovementIfFinished(&gEventObjects[objectId]);
     sub_80A2178();
-    UnfreezeMapObjects();
+    UnfreezeEventObjects();
     return FALSE;
 }
 
@@ -1216,12 +1216,12 @@ bool8 ScrCmd_release(struct ScriptContext *ctx)
     u8 objectId;
 
     HideFieldMessageBox();
-    if (gMapObjects[gSelectedMapObject].active)
-        FieldObjectClearAnimIfSpecialAnimFinished(&gMapObjects[gSelectedMapObject]);
-    objectId = GetFieldObjectIdByLocalIdAndMap(0xFF, 0, 0);
-    FieldObjectClearAnimIfSpecialAnimFinished(&gMapObjects[objectId]);
+    if (gEventObjects[gSelectedEventObject].active)
+        EventObjectClearHeldMovementIfFinished(&gEventObjects[gSelectedEventObject]);
+    objectId = GetEventObjectIdByLocalIdAndMap(0xFF, 0, 0);
+    EventObjectClearHeldMovementIfFinished(&gEventObjects[objectId]);
     sub_80A2178();
-    UnfreezeMapObjects();
+    UnfreezeEventObjects();
     return FALSE;
 }