Update all usages of WarpPointer to ActorPointer.

Author: atom0s

Event VM Functions.md

@@ -58,10 +58,10 @@ Prepares the entities that are involved with the current event attempting to run
           * If true, then the client checks if the entity is within the current event playing.
             * If this is false, the function hard-exists in failure.
     * `if ( (entity->ServerId & 0xFF000000) == 0 )`
-      * If this is true, the client will call `XiActor::SetCastMagicID` function on the entity and set another value inside of its `WarpPointer` to `0x20202020`
+      * If this is true, the client will call `XiActor::SetCastMagicID` function on the entity and set another value inside of its `ActorPointer` to `0x20202020`
     * `if ( (v8->Render.Flags0 & 0x4000) != 0 || (v8->Render.Flags0 & 0x8000) != 0 )`
       * If this is true, further checks are skipped and go straight to the call to `XiAtelBuff::EventNew`.
-    * `if ( XiActor::IsLockedStatus(entity->WarpPointer) )`
+    * `if ( XiActor::IsLockedStatus(entity->ActorPointer) )`
       * If this is true, the function hard-exists in failure.
   * Once the above has been checked, then the entity is considered valid. The following then happens:
     * `XiAtelBuff::EventNew` is called for this entity.
@@ -98,7 +98,7 @@ The XiEvent object destructor. This cleans up the various allocations and other
 
 This function is fairly straight forward in cleaning things up, but here's a quick rundown of what happens:
 
-  * The entity is obtained, if valid then it's event action is cancelled via: `XiAtelBuff::KillLastAction` 
+  * The entity is obtained, if valid then it's event action is cancelled via: `XiAtelBuff::KillLastAction`
   * The entity is tested for type `XiSkeletonActor::classXiSkeletonActor`
     * If matched, then the entity is told to stop moving its mouth via: `XiAtelBuff::StopMouth` and `XiSkeletonActor::DeleteResp`
     * The entities various flags and animation fields are reset from the event state.
@@ -143,7 +143,7 @@ The second initializer for the XiEvent object. This is used to finalize the init
 
 Sets up the `ReqStack` that will be executed on the current tick then runs `XiEvent::ExecProg` in a loop until `RetFlag` is set.
 
-When this function first starts, it ensures that an entity server id has been set. If not, then it returns 0. 
+When this function first starts, it ensures that an entity server id has been set. If not, then it returns 0.
 
 Next, it determines the `ReqStack` that has the 'highest' `Priority`. The one found most important to run has it's index set into `RunPos`. This looks like:
 
@@ -197,7 +197,7 @@ void __thiscall FUNC_XiEvent_OpCode_0x0000(xievent_t* this)
 }
 ```
 
-Opcode `0x0000` is used to stop/reset the current `ReqStack` object. Since this handler sets `RetFlag` then the loop processing `XiEvent::ExecProg` will break. When this happens, `ExecPointer` is then stored into `ReqStack[RunPos].StackExecPointer`. However, this also sets the `Priority` to 255, which means on next tick, this stack is not considered valid and will fail the check done in `XiEvent::EventIdle` for `Priority`. 
+Opcode `0x0000` is used to stop/reset the current `ReqStack` object. Since this handler sets `RetFlag` then the loop processing `XiEvent::ExecProg` will break. When this happens, `ExecPointer` is then stored into `ReqStack[RunPos].StackExecPointer`. However, this also sets the `Priority` to 255, which means on next tick, this stack is not considered valid and will fail the check done in `XiEvent::EventIdle` for `Priority`.
 
 ## `XiEvent::eventgetcode`
 
@@ -467,7 +467,7 @@ bool __thiscall FUNC_XiEvent_GetActorIndex(xievent_t* this, int32_t lookupValue,
     * These values are used to return the local players party members info (based on their index in the party, 0 is skipped for local player). (Party 0)
   * `0x7FFFFFC6`, `0x7FFFFFC7`, `0x7FFFFFC8`, `0x7FFFFFC9`, `0x7FFFFFCA`, `0x7FFFFFCB`
     * These are intentionally overflowed upward by `+0x44`, resulting in the values: 10, 11, 12, 13, 14, 15
-    * These values are used to return the local players alliance party members info. (Party 1)  
+    * These values are used to return the local players alliance party members info. (Party 1)
   * `0x7FFFFFCC`, `0x7FFFFFCD`, `0x7FFFFFCE`, `0x7FFFFFCF`, `0x7FFFFFD0`, `0x7FFFFFD1`
     * These are intentionally overflowed upward by `+0x48`, resulting in the values: 20, 21, 22, 23, 24, 25
     * These values are used to return the local players alliance party members info. (Party 2)
@@ -479,7 +479,7 @@ bool __thiscall FUNC_XiEvent_GetActorIndex(xievent_t* this, int32_t lookupValue,
   * The default handler tests if the value is a normal entity server id for NPCs. `if ((val & 0xFF000000) != 0)`
     * If true, the return values will be the value given as the server id and `val & 0x3FF` to get the target index.
     * If false, the return values default to the local event entity information. (`EntityServerId[1]` and `EntityTargetIndex[1]`)
-    
+
 When the return values are set (they are put back into the incoming parameters), the function then returns true or false based on if the entity is valid/exists, and if the server id matches what was determined.
 
 ## `XiEvent::GetReqLevel`
@@ -513,7 +513,7 @@ int __thiscall FUNC_XiEvent_GetReqLevel(xievent_t* this, int priority)
 
 **Pattern:** `33 C0 8B 54 24 04 66 8B 81 58 02 00 00 56 C1 E0 05 0F BE 44 08 3A 3B C2 75 ?? 33 C0 5E C2 04 00`
 
-Determines if the given event id (tagnum) is currently running or is queued to run in any `ReqStack` entries. 
+Determines if the given event id (tagnum) is currently running or is queued to run in any `ReqStack` entries.
 
   * Returns 0 if the current `ReqStack[RunPos].TagNum` equals the given event id.
   * Returns 1 if one of the non-currently running `ReqStack` objects contains the given event id.

OpCodes/0x0023.md

@@ -9,11 +9,11 @@
 
 ## Description
 
-Waits for the local player to interact with a dialog message. 
+Waits for the local player to interact with a dialog message.
 
 If a dialog is open and waiting for an interaction, the function will act like a yielding coroutine. Internally, `PTR_CliEventMessOpenFlag` will be set to 2 elsewhere and the `XiEvent::ExecProg` loop will hault until the user has made a selection. However, if `PTR_CliEventMessOpenFlag` is already 2 when this is called, then the state is considered invalid and the event is stopped by force.
 
-If no dialog is opened/present, then the current `MouthIndex` entitiy, if one is set, is updated to stop talking and `MouthIndex` is reset to 0. 
+If no dialog is opened/present, then the current `MouthIndex` entitiy, if one is set, is updated to stop talking and `MouthIndex` is reset to 0.
 
 ## Pseudo Code
 
@@ -46,10 +46,10 @@ void __thiscall FUNC_XiEvent_OpCode_0x0023(xievent_t* this)
             {
                 entity->Unknown0011 = 0;
 
-                if ((entity->Render.Flags0 & 0x200) != 0 && entity->WarpPointer)
+                if ((entity->Render.Flags0 & 0x200) != 0 && entity->ActorPointer)
                 {
-                    if (FUNC_YmObject_IsKindOf(entity->WarpPointer, "XiSkeletonActor")
-                        FUNC_XiSkeletonActor_SpeakStop(entity->WarpPointer);
+                    if (FUNC_YmObject_IsKindOf(entity->ActorPointer, "XiSkeletonActor")
+                        FUNC_XiSkeletonActor_SpeakStop(entity->ActorPointer);
                 }
             }
         }

OpCodes/0x002C.md

@@ -47,7 +47,7 @@ void __thiscall FUNC_XiEvent_OpCode_0x002C(xievent_t* this)
 
         // Note: Potentially the incorrect call, but appears to be correct..
         // Note: May also be: XiSkeletonActor::SetAction instead..
-        FUNC_XiActor_SetAction(entity1->WarpPointer, val3, entity2->WarpPointer, 0);
+        FUNC_XiActor_SetAction(entity1->ActorPointer, val3, entity2->ActorPointer, 0);
     }
 
     this->ExecPointer += 13;

OpCodes/0x002D.md

@@ -46,7 +46,7 @@ void __thiscall FUNC_XiEvent_OpCode_0x002D(xievent_t* this)
         const auto val3 = FUNC_XiEvent_eventgetcode2(this, 9);
 
         // Note: Potentially the incorrect call, but appears to be correct..
-        FUNC_XiZone_SetAction(PTR_Zone, val3, entity1->WarpPointer, entity2->WarpPointer);
+        FUNC_XiZone_SetAction(PTR_Zone, val3, entity1->ActorPointer, entity2->ActorPointer);
     }
 
     this->ExecPointer += 13;

OpCodes/0x0045.md

@@ -59,7 +59,7 @@ void __thiscall FUNC_XiEvent_OpCode_0x0045_(xievent_t* this, int32_t param1)
         if (param1 == 30704)
             val4 = FUNC_DatIdHelper(val4);
 
-        FUNC_LoadStartScheduler(param1 + val4, val3, entity1->WarpPointer, entity2->WarpPointer, FUNC_XiEvent_getworkofs_(this, 15));
+        FUNC_LoadStartScheduler(param1 + val4, val3, entity1->ActorPointer, entity2->ActorPointer, FUNC_XiEvent_getworkofs_(this, 15));
     }
 
     this->ExecPointer += 17;

OpCodes/0x0046.md

@@ -49,7 +49,7 @@ void __thiscall FUNC_XiEvent_OpCode_0x0046(xievent_t* this)
             FUNC_XiActor_EnableUserControlCamera();
 
             FUNC_YmCameraManager_SetAt(FUNC_GetCameraDefaultPos(), PTR_EntityMap[PTR_LoginActIndex]->Movement);
-            FUNC_YmCameraManager_SetCameraPos(FUNC_GetCameraDefaultPos(), PTR_UnknownCameraPos, PTR_EntityMap[PTR_LoginActIndex]->WarpPointer)
+            FUNC_YmCameraManager_SetCameraPos(FUNC_GetCameraDefaultPos(), PTR_UnknownCameraPos, PTR_EntityMap[PTR_LoginActIndex]->ActorPointer)
         }
     }
 

OpCodes/0x0050.md

@@ -47,7 +47,7 @@ void __thiscall FUNC_XiEvent_OpCode_0x0050(xievent_t* this)
 
         // Note: Potentially the incorrect call, but appears to be correct..
         // Note: May also be: XiSkeletonActor::KillAction instead..
-        FUNC_XiActor_KillAction(entity1->WarpPointer, val3, entity2->WarpPointer);
+        FUNC_XiActor_KillAction(entity1->ActorPointer, val3, entity2->ActorPointer);
     }
 
     this->ExecPointer += 13;

OpCodes/0x0051.md

@@ -46,7 +46,7 @@ void __thiscall FUNC_XiEvent_OpCode_0x0051(xievent_t* this)
         const auto val3 = FUNC_XiEvent_eventgetcode2(this, 9);
 
         // Note: Potentially the incorrect call, but appears to be correct..
-        FUNC_XiZone_KillAction(PTR_Zone, val3, entity1->WarpPointer, entity2->WarpPointer);
+        FUNC_XiZone_KillAction(PTR_Zone, val3, entity1->ActorPointer, entity2->ActorPointer);
     }
 
     this->ExecPointer += 13;

OpCodes/0x0052.md

@@ -60,7 +60,7 @@ void __thiscall FUNC_XiEvent_OpCode_0x0052_(xievent_t* this, int32_t param)
             val4 = FUNC_DatIdHelper(val4);
 
         // Note: Potentially the incorrect call, but appears to be correct..
-        FUNC_KillScheduler(param + val4, val3, entity1->WarpPointer, entity2->WarpPointer);
+        FUNC_KillScheduler(param + val4, val3, entity1->ActorPointer, entity2->ActorPointer);
     }
 
     this->ExecPointer += 15;

OpCodes/0x0053.md

@@ -46,8 +46,8 @@ void __thiscall FUNC_XiEvent_OpCode_0x0053_(xievent_t* this, int32_t param1, int
         const auto val3 = FUNC_XiEvent_eventgetcode2(this, 9);
 
         // Note: Potentially the incorrect calls, but appear to be correct..
-        if (param2 ? entity1->IsMovingAction(val3, entity2->WarpPointer)
-                   : entity1->SetAction(val3, entity2->WarpPointer))
+        if (param2 ? entity1->IsMovingAction(val3, entity2->ActorPointer)
+                   : entity1->SetAction(val3, entity2->ActorPointer))
             this->RetFlag = 1;
 
         if (this->RetFlag)

OpCodes/0x0054.md

@@ -46,7 +46,7 @@ void __thiscall FUNC_XiEvent_OpCode_0x0054(xievent_t* this)
         const auto val3 = FUNC_XiEvent_eventgetcode2(this, 9);
 
         // Note: Potentially the incorrect call, but appears to be correct..
-        if (FUNC_XiZone_IsMovingAction(PTR_Zone, val3, entity1->WarpPointer, entity2->WarpPointer))
+        if (FUNC_XiZone_IsMovingAction(PTR_Zone, val3, entity1->ActorPointer, entity2->ActorPointer))
             this->RetFlag = 1;
     }
     else

OpCodes/0x0055.md

@@ -60,7 +60,7 @@ void __thiscall FUNC_XiEvent_OpCode_0x0055_(xievent_t* this, int32_t param1)
             val4 = FUNC_DatIdHelper(val4);
 
         // Note: Potentially the incorrect call, but appears to be correct..
-        if (FUNC_IsMovingScheduler(param1 + val4, val3, entity1->WarpPointer, entity2->WarpPointer))
+        if (FUNC_IsMovingScheduler(param1 + val4, val3, entity1->ActorPointer, entity2->ActorPointer))
             this->RetFlag = 1;
     }
     else

OpCodes/0x0059.md

@@ -65,7 +65,7 @@ void __thiscall FUNC_XiEvent_OpCode_0x0059(xievent_t* this)
             if (FUNC_XiEvent_GetActorIndex(this, val, &serverId, &index))
             {
                 const auto entity = PTR_EntityMap[index];
-                if (entity && entity->WarpPointer)
+                if (entity && entity->ActorPointer)
                     this->ExtData[1]->MainSpeed = FUNC_XiEvent_getworkofs_(this, 6) * 0.1;
             }
 
@@ -94,7 +94,7 @@ void __thiscall FUNC_XiEvent_OpCode_0x0059(xievent_t* this)
                 const auto entity = PTR_EntityMap[index];
 
                 // Note: Potentially the incorrect call, but appears to be correct..
-                if (FUNC_XiActor_SetAction(entity->WarpPointer, entity->EmoteIdString, entity->WarpPointer) == 1)
+                if (FUNC_XiActor_SetAction(entity->ActorPointer, entity->EmoteIdString, entity->ActorPointer) == 1)
                 {
                     this->RetFlag = 1;
                     return;   

OpCodes/0x005B.md

@@ -51,8 +51,8 @@ void __thiscall FUNC_XiEvent_OpCode_0x005B_(xievent_t* this, int32_t param1, int
         return 1;
     }
 
-    if (entity1->ServerId != serverId1 || entity2->ServerId != serverId2 
-        || (entity1->Render.Flags0 & 0x200) == 0 || (entity1->Render.Flags0 & 0x80) == 0 
+    if (entity1->ServerId != serverId1 || entity2->ServerId != serverId2
+        || (entity1->Render.Flags0 & 0x200) == 0 || (entity1->Render.Flags0 & 0x80) == 0
         || (entity2->Render.Flags0 & 0x200) == 0 || (entity2->Render.Flags0 & 0x80) == 0)
     {
         this->ExecPointer += 15;
@@ -74,7 +74,7 @@ void __thiscall FUNC_XiEvent_OpCode_0x005B_(xievent_t* this, int32_t param1, int
             if (param)
             {
                 // Note: Potentially incorrect call..
-                FUNC_XiSkeletonActor_ReadTpcEventMotionRes(entity1->WarpPointer, val);
+                FUNC_XiSkeletonActor_ReadTpcEventMotionRes(entity1->ActorPointer, val);
             }
             else if (v17 < 3072)
             {
@@ -83,31 +83,31 @@ void __thiscall FUNC_XiEvent_OpCode_0x005B_(xievent_t* this, int32_t param1, int
                     if (val < 1024)
                     {
                         if (val < 512)
-                            FUNC_XiSkeletonActor_ReadEventMotionRes(entity1->WarpPointer, &param1, val + 32104);
+                            FUNC_XiSkeletonActor_ReadEventMotionRes(entity1->ActorPointer, &param1, val + 32104);
                         else
-                            FUNC_XiSkeletonActor_ReadEventMotionRes(entity1->WarpPointer, &param1, val + 49135);
+                            FUNC_XiSkeletonActor_ReadEventMotionRes(entity1->ActorPointer, &param1, val + 49135);
                     }
                     else
                     {
-                        FUNC_XiSkeletonActor_ReadEventMotionRes(entity1->WarpPointer, &param1, val + 56345);
+                        FUNC_XiSkeletonActor_ReadEventMotionRes(entity1->ActorPointer, &param1, val + 56345);
                     }
                 }
                 else
                 {
-                    FUNC_XiSkeletonActor_ReadEventMotionRes(entity1->WarpPointer, &param1, val + 59739);
+                    FUNC_XiSkeletonActor_ReadEventMotionRes(entity1->ActorPointer, &param1, val + 59739);
                 }
             }
             else
             {
-                FUNC_XiSkeletonActor_ReadEventMotionRes(entity1->WarpPointer, &param1, val + 66339);
+                FUNC_XiSkeletonActor_ReadEventMotionRes(entity1->ActorPointer, &param1, val + 66339);
             }
 
             this->ExtData[1]->ReadEventMotionResFlag[param] = 1;
         } while (!this->ExtData[1]->ReadEventMotionResFlag[param] );
     }
 
     // Note: Potentially incorrect call..
-    if (!FUNC_XiSkeletonActor_IsReadCompleteResList(entity1->WarpPointer))
+    if (!FUNC_XiSkeletonActor_IsReadCompleteResList(entity1->ActorPointer))
     {
         this->RetFlag = 1;
         return 0;
@@ -120,19 +120,19 @@ void __thiscall FUNC_XiEvent_OpCode_0x005B_(xievent_t* this, int32_t param1, int
         FUNC_XiAtelBuff_KillLastAction(entity1);
 
         *(uint32_t*)&entity1->Unknown0020[0] = val3;
-        *(uint32_t*)&entity1->Unknown0020[8] = entity2->WarpPointer;
+        *(uint32_t*)&entity1->Unknown0020[8] = entity2->ActorPointer;
 
         // Note: Potentially the incorrect call, but appears to be correct..
         // Note: May also be: XiSkeletonActor::SetAction instead..
-        FUNC_XiActor_SetAction(entity1->WarpPointer, val3, entity2->WarpPointer, 0);
+        FUNC_XiActor_SetAction(entity1->ActorPointer, val3, entity2->ActorPointer, 0);
     }
 
     this->ExtData[1]->ReadEventMotionResFlag[param] = 0;
 
     if (param3)
     {
         const auto val = FUNC_XiEvent_getworkofs_(this, 15);
-        FUNC_XiActor_UnknownCall(entity1->WarpPointer, val, val3, entity1->WarpPointer);
+        FUNC_XiActor_UnknownCall(entity1->ActorPointer, val, val3, entity1->ActorPointer);
     }
 
     this->ExecPointer += 15;

OpCodes/0x005E.md

@@ -26,15 +26,15 @@ void __thiscall FUNC_XiEvent_OpCode_0x005E(xievent_t* this)
 
         FUNC_XiAtelBuff_IdleDefMotion(PTR_EntityMap[this->EntityTargetIndex[1]]);
 
-        if (FUNC_YmObject_IsKindOf(PTR_EntityMap[this->EntityTargetIndex[1]]->WarpPointer, "CXiSkeletonActor"))
+        if (FUNC_YmObject_IsKindOf(PTR_EntityMap[this->EntityTargetIndex[1]]->ActorPointer, "CXiSkeletonActor"))
         {
-            PTR_EntityMap[this->EntityTargetIndex[1]]->WarpPointer->Unknown0000 = val;
-            PTR_EntityMap[this->EntityTargetIndex[1]]->WarpPointer->Unknown0001 = 0x20202020;
+            PTR_EntityMap[this->EntityTargetIndex[1]]->ActorPointer->Unknown0000 = val;
+            PTR_EntityMap[this->EntityTargetIndex[1]]->ActorPointer->Unknown0001 = 0x20202020;
 
-            FUNC_XiAtelBuff_UnknownFlagAdjustment(PTR_EntityMap[this->EntityTargetIndex[1]]->WarpPointer, 0);
+            FUNC_XiAtelBuff_UnknownFlagAdjustment(PTR_EntityMap[this->EntityTargetIndex[1]]->ActorPointer, 0);
         }
     }
-    
+
     this->ExecPointer += 5;
 }
 ```

OpCodes/0x006B.md

@@ -26,18 +26,18 @@ void __thiscall FUNC_XiEvent_OpCode_0x006B(xievent_t* this)
         if (entity and (entity->Render.Flags0 & 0x200) != 0)
         {
             FUNC_XiAtelBuff_KillLastAction(entity);
-            
+
             const auto val2 = FUNC_XiEvent_eventgetcode2(this, 1);
             entity->Animations[5] = v5;
 
             FUNC_XiAtelBuff_IdleDefMotion(entity);
 
-            if (FUNC_YmObject_IsKindOf(entity->WarpPointer, "CXiSkeletonActor"))
+            if (FUNC_YmObject_IsKindOf(entity->ActorPointer, "CXiSkeletonActor"))
             {
-                entity->WarpPointer->Unknown0000 = val;
-                entity->WarpPointer->Unknown0001 = 0x20202020;
+                entity->ActorPointer->Unknown0000 = val;
+                entity->ActorPointer->Unknown0001 = 0x20202020;
 
-                FUNC_XiAtelBuff_UnknownFlagAdjustment(entity->WarpPointer, 0);
+                FUNC_XiAtelBuff_UnknownFlagAdjustment(entity->ActorPointer, 0);
             }
         }
     }