Implement W3DWaypointBuffer (#795)

Author: jonwil

src/CMakeLists.txt

@@ -305,6 +305,7 @@ set(GAMEENGINE_SRC
     platform/w3dengine/client/w3dmouse.cpp
     platform/w3dengine/client/w3dterrainlogic.cpp
     platform/w3dengine/client/w3dterraintracks.cpp
+    platform/w3dengine/client/w3dwaypointbuffer.cpp
     platform/w3dengine/common/thing/w3dmodulefactory.cpp
     w3d/lib/buff.cpp
     w3d/lib/bufffileclass.cpp

src/game/client/ingameui.h

@@ -185,6 +185,7 @@ class InGameUI : public SubsystemInterface, public SnapShot
     int Get_Drawable_Caption_Size() const { return m_drawableCaptionPointSize; }
     Utf8String Get_Drawable_Caption_Font() const { return m_drawableCaptionFont; }
     int Get_Drawable_Caption_Color() const { return m_drawableCaptionColor; }
+    bool Is_In_Waypoint_Mode() const { return m_waypointMode; }
 
 protected:
     struct MoveHintStruct
@@ -301,7 +302,7 @@ class InGameUI : public SubsystemInterface, public SnapShot
     float m_floatingTextMoveVanishRate;
     PopupMessageData *m_popupMessageData;
     int m_popupMessageColor;
-    bool m_unk1; // not 100% identified yet
+    bool m_waypointMode;
     bool m_unk2; // not 100% identified yet
     bool m_unk3; // not 100% identified yet
     bool m_unk4; // not 100% identified yet

src/game/logic/ai/aistates.cpp

@@ -53,3 +53,12 @@ bool Out_Of_Weapon_Range_Object(State *state, void *user_data)
     return false;
 #endif
 }
+
+const Coord3D *AIStateMachine::Get_Goal_Path_Position(int i) const
+{
+    if (i < 0 || i >= static_cast<int>(m_goalPath.size())) {
+        return nullptr;
+    }
+
+    return &m_goalPath[i];
+}

src/game/logic/ai/aistates.h

@@ -16,6 +16,52 @@
 #include "always.h"
 #include "statemachine.h"
 
+enum AIStateType
+{
+    AI_IDLE = 0,
+    AI_MOVE_TO = 1,
+    AI_FOLLOW_WAYPOINT_PATH_AS_TEAM = 2,
+    AI_FOLLOW_WAYPOINT_PATH_AS_INDIVIDUALS = 3,
+    AI_FOLLOW_WAYPOINT_PATH_EXACT_AS_TEAM = 4,
+    AI_FOLLOW_WAYPOINT_PATH_EXACT_AS_INDIVIDUALS = 5,
+    AI_FOLLOW_PATH = 6,
+    AI_FOLLOW_EXITPRODUCTION_PATH = 7,
+    AI_WAIT = 8,
+    AI_ATTACK_POSITION = 9,
+    AI_ATTACK_OBJECT = 10,
+    AI_FORCE_ATTACK_OBJECT = 11,
+    AI_ATTACK_AND_FOLLOW_OBJECT = 12,
+    AI_DEAD = 13,
+    AI_DOCK = 14,
+    AI_ENTER = 15,
+    AI_GUARD = 16,
+    AI_HUNT = 17,
+    AI_WANDER = 18,
+    AI_PANIC = 19,
+    AI_ATTACK_SQUAD = 20,
+    AI_GUARD_TUNNEL_NETWORK = 21,
+    AI_MOVE_OUT_OF_THE_WAY = 23,
+    AI_MOVE_AND_TIGHTEN = 24,
+    AI_MOVE_AND_EVACUATE = 25,
+    AI_MOVE_AND_EVACUATE_AND_EXIT = 26,
+    AI_MOVE_AND_DELETE = 27,
+    AI_ATTACK_AREA = 28,
+    AI_ATTACK_MOVE_TO = 30,
+    AI_ATTACKFOLLOW_WAYPOINT_PATH_AS_INDIVIDUALS = 31,
+    AI_ATTACKFOLLOW_WAYPOINT_PATH_AS_TEAM = 32,
+    AI_FACE_POSITION = 33,
+    AI_FACE_OBJECT = 34,
+    AI_RAPPEL = 35,
+    AI_EXIT = 37,
+    AI_PICK_UP_CRATE = 38,
+    AI_MOVE_AWAY_FROM_REPULSORS = 39,
+    AI_WANDER_IN_PLACE = 40,
+    AI_BUSY = 41,
+    AI_EXIT_INSTANTLY = 42,
+    AI_GUARD_RETALIATE = 43,
+    NUM_AI_STATES = 44,
+};
+
 class Squad;
 
 class AIStateMachine : public StateMachine
@@ -32,6 +78,9 @@ class AIStateMachine : public StateMachine
     virtual Utf8String Get_Current_State_Name() override;
 #endif
 
+    int Get_Goal_Path_Count() const { return m_goalPath.size(); }
+    const Coord3D *Get_Goal_Path_Position(int i) const;
+
 private:
     std::vector<Coord3D> m_goalPath;
     Waypoint *m_goalWaypoint;

src/game/logic/object/contain/opencontain.h

@@ -96,3 +96,38 @@ class ContainModuleInterface
     virtual unsigned int Get_Weapon_Bonus_Passed_To_Passengers() const = 0;
     virtual bool Get_Container_Pips_To_Show(int &max, int &count);
 };
+
+enum ExitDoorType
+{
+    EXIT_DOOR_UNK,
+};
+
+class ExitInterface
+{
+public:
+    virtual bool Is_Exit_Busy() const = 0;
+    virtual ExitDoorType Reserve_Door_For_Exit(const ThingTemplate *tmplate, Object *obj) = 0;
+    virtual void Exit_Object_Via_Door(Object *obj, ExitDoorType type) = 0;
+    virtual void Exit_Object_Via_Budding(Object *obj, Object *obj2) = 0;
+    virtual void Unreserve_Door_For_Exit(ExitDoorType type) = 0;
+    virtual void Exit_Object_In_A_Hurry(Object *obj) {}
+    virtual void Set_Rally_Point(const Coord3D *point) = 0;
+    virtual const Coord3D *Get_Rally_Point() = 0;
+    virtual bool Use_Spawn_Rally_Point() { return false; }
+
+    virtual bool Get_Natural_Rally_Point(Coord3D &coord, bool b)
+    {
+        coord.x = 0.0f;
+        coord.y = 0.0f;
+        coord.z = 0.0f;
+        return false;
+    }
+
+    virtual bool Get_Exit_Position(Coord3D &coord)
+    {
+        coord.x = 0.0f;
+        coord.y = 0.0f;
+        coord.z = 0.0f;
+        return false;
+    }
+};

src/game/logic/object/object.cpp

@@ -19,6 +19,7 @@
 #include "experiencetracker.h"
 #include "gamelogic.h"
 #include "globaldata.h"
+#include "opencontain.h"
 #include "playerlist.h"
 #include "team.h"
 #include "updatemodule.h"
@@ -286,6 +287,29 @@ void Object::On_Collide(Object *other, const Coord3D *loc, const Coord3D *normal
     }
 }
 
+ExitInterface *Object::Get_Object_Exit_Interface() const
+{
+    ExitInterface *exit = nullptr;
+
+    for (BehaviorModule **module = m_allModules; *module != nullptr; module++) {
+        exit = (*module)->Get_Update_Exit_Interface();
+
+        if (exit != nullptr) {
+            break;
+        }
+    }
+
+    if (exit == nullptr) {
+        ContainModuleInterface *contain = Get_Contain();
+
+        if (contain != nullptr) {
+            return contain->Get_Contain_Exit_Interface();
+        }
+    }
+
+    return exit;
+}
+
 void Object::Set_Disabled(DisabledType type)
 {
     Set_Disabled_Until(type, 0x3FFFFFFF);

src/game/logic/object/update/aiupdate.cpp

@@ -86,3 +86,27 @@ void AIUpdateInterface::Reset_Next_Mood_Check_Time()
     Call_Method<void, AIUpdateInterface>(PICK_ADDRESS(0x005D6030, 0x007FBAB5), this);
 #endif
 }
+
+AIStateType AIUpdateInterface::Get_AI_State_Type() const
+{
+    return static_cast<AIStateType>(Get_State_Machine()->Get_Current_State_ID());
+}
+
+int AIUpdateInterface::Friend_Get_Waypoint_Goal_Path_Size() const
+{
+    if (Get_AI_State_Type() != AI_FOLLOW_PATH) {
+        return 0;
+    }
+
+    return Get_State_Machine()->Get_Goal_Path_Count();
+}
+
+const Coord3D *AIUpdateInterface::Get_Goal_Path_Position(int i) const
+{
+    return Get_State_Machine()->Get_Goal_Path_Position(i);
+}
+
+const Coord3D *AIUpdateInterface::Get_Goal_Position() const
+{
+    return Get_State_Machine()->Get_Goal_Position();
+}

src/game/logic/object/update/aiupdate.h

@@ -248,6 +248,10 @@ class AIUpdateInterface : public UpdateModule, public AICommandInterface
     void Reset_Next_Mood_Check_Time();
 
     bool Has_Locomotor_For_Surface(LocomotorSurfaceType t);
+    int Friend_Get_Waypoint_Goal_Path_Size() const;
+    AIStateType Get_AI_State_Type() const;
+    const Coord3D *Get_Goal_Path_Position(int i) const;
+    const Coord3D *Get_Goal_Position() const;
 
     const Locomotor *Get_Cur_Locomotor() const { return m_curLocomotor; }
     Locomotor *Get_Cur_Locomotor() { return m_curLocomotor; }
@@ -270,6 +274,7 @@ class AIUpdateInterface : public UpdateModule, public AICommandInterface
     void Set_Current_Turret(WhichTurretType t) { m_currentTurret = t; }
 
     bool Are_Turrets_Linked() const { return Get_AI_Update_Module_Data()->m_turretsLinked; }
+    int Get_Current_Goal_Path_Index() const { return m_currentGoalPathIndex; }
 
 private:
     unsigned char unk[0x8];
@@ -278,7 +283,9 @@ class AIUpdateInterface : public UpdateModule, public AICommandInterface
     Path *m_path;
     unsigned char unk3[0x20];
     ObjectID m_ignoreObstacleID;
-    unsigned char unk4[0x48];
+    unsigned char unk4[0x3C];
+    int m_currentGoalPathIndex;
+    unsigned char unk5[0x8];
     LocomotorSet m_locomotorSet;
     Locomotor *m_curLocomotor;
     LocomotorSetType m_curLocomotorSet;
@@ -288,6 +295,6 @@ class AIUpdateInterface : public UpdateModule, public AICommandInterface
     WhichTurretType m_currentTurret;
     AttitudeType m_attitude;
     unsigned int m_nextMoodCheckTime;
-    unsigned char unk5[0x16];
+    unsigned char unk6[0x16];
     bool m_isRecruitable;
 };

src/hooker/setuphooks_zh.cpp

@@ -181,6 +181,7 @@
 #include "w3dview.h"
 #include "w3dvolumetricshadow.h"
 #include "w3dwater.h"
+#include "w3dwaypointbuffer.h"
 #include "weapon.h"
 #include "win32gameengine.h"
 #include "win32localfilesystem.h"
@@ -2437,4 +2438,10 @@ void Setup_Hooks()
     Hook_Any(0x00797A20, W3DPropBuffer::Remove_Props_For_Construction);
     Hook_Any(0x00797B60, W3DPropBuffer::Notify_Shroud_Changed);
     Hook_Any(0x00797BA0, W3DPropBuffer::Draw_Props);
+
+    // w3dwaypointbuffer.h
+    Hook_Any(0x00789CB0, W3DWaypointBuffer::Hook_Ctor);
+    Hook_Any(0x00789DA0, W3DWaypointBuffer::Hook_Dtor);
+    Hook_Any(0x00789DE0, W3DWaypointBuffer::Draw_Waypoints);
+
 }