NPC Component (WIP)

SDK/include/Server/Components/NPCs/npcs.hpp

@@ -0,0 +1,69 @@
+#pragma once
+
+#include <sdk.hpp>
+
+enum NPCMoveType
+{
+ NPCMoveType_None,
+ NPCMoveType_Walk,
+ NPCMoveType_Jog,
+ NPCMoveType_Sprint
+};
+
+struct INPC : public IExtensible, public IEntity
+{
+ /// Get player instance of NPC.
+ virtual IPlayer* getPlayer() = 0;
+
+ /// Spawn NPC.
+ virtual void spawn() = 0;
+
+ /// Move NPC to a specified location.
+ virtual bool move(Vector3 position, NPCMoveType moveType) = 0;
+
+ /// Stop NPC from moving.
+ virtual void stopMove() = 0;
+
+ /// Set NPC skin
+ virtual void setSkin(int model) = 0;
+
+ /// Check if a player is streamed in for the current NPC
+ virtual bool isStreamedInForPlayer(const IPlayer& other) const = 0;
+
+ /// Get the NPC which are streamed in for this player
+ virtual const FlatPtrHashSet<IPlayer>& streamedForPlayers() const = 0;
+
+ /// Set NPC interior, it doesn't do much but keeps a record internally to use getter functions later
+ virtual void setInterior(unsigned int interior);
+
+ /// Get NPC interior, just the value that is stored internally
+ virtual unsigned int getInterior() const;
+
+ /// Get NPC velocity
+ virtual Vector3 getVelocity() const = 0;
+
+ /// Set NPC velocity
+ virtual void setVelocity(Vector3 position, bool update = false) = 0;
+};
+
+struct NPCEventHandler
+{
+ virtual void onNPCFinishMove(INPC& npc) {};
+ virtual void onNPCCreate(INPC& npc) {};
+ virtual void onNPCDestroy(INPC& npc) {};
+};
+
+static const UID NPCComponent_UID = UID(0x3D0E59E87F4E90BC);
+struct INPCComponent : public IPool<INPC>, public INetworkComponent
+{
+ PROVIDE_UID(NPCComponent_UID)
+
+ /// Get the npc event dispatcher
+ virtual IEventDispatcher<NPCEventHandler>& getEventDispatcher() = 0;
+
+ /// Create a controllable NPC
+ virtual INPC* create(StringView name) = 0;
+
+ /// Destroy an NPC. We need this because it's more than just an entity removal from a pool
+ virtual void destroy(INPC& npc) = 0;
+};

SDK/include/Server/Components/Pawn/Impl/pawn_impl.hpp

@@ -32,6 +32,7 @@ void setAmxLookups()
  lookups_.vars = components_->queryComponent<IVariablesComponent>();
  lookups_.vehicles = components_->queryComponent<IVehiclesComponent>();
  lookups_.models = components_->queryComponent<ICustomModelsComponent>();
+ lookups_.npcs = components_->queryComponent<INPCComponent>();
  }
 }
 

SDK/include/Server/Components/Pawn/Impl/pawn_natives.hpp

@@ -541,6 +541,7 @@ POOL_PARAM(IObject, objects);
 POOL_PARAM(ITextDraw, textdraws);
 POOL_PARAM(ITextLabel, textlabels);
 POOL_PARAM(IVehicle, vehicles);
+POOL_PARAM(INPC, npcs);
 
 PLAYER_POOL_PARAM(IPlayerObject, IPlayerObjectData);
 PLAYER_POOL_PARAM(IPlayerTextDraw, IPlayerTextDrawData);

SDK/include/Server/Components/Pawn/pawn.hpp

@@ -24,6 +24,7 @@
 #include <Server/Components/Variables/variables.hpp>
 #include <Server/Components/Vehicles/vehicles.hpp>
 #include <Server/Components/CustomModels/custommodels.hpp>
+#include <Server/Components/NPCs/npcs.hpp>
 
 #define SCRIPT_API(name, prototype) PAWN_NATIVE(openmp_scripting, name, prototype)
 #define SCRIPT_API_FAILRET(name, failret, prototype) PAWN_NATIVE_FAILRET(openmp_scripting, failret, name, prototype)
@@ -64,6 +65,7 @@ struct PawnLookup
  IVariablesComponent* vars = nullptr;
  IVehiclesComponent* vehicles = nullptr;
  ICustomModelsComponent* models = nullptr;
+ INPCComponent* npcs = nullptr;
 };
 
 PawnLookup* getAmxLookups();

SDK/include/network.hpp

@@ -46,6 +46,7 @@ enum ENetworkType
 {
  ENetworkType_RakNetLegacy,
  ENetworkType_ENet,
+ ENetworkType_NPCs,
 
  ENetworkType_End
 };

SDK/include/values.hpp

@@ -4,6 +4,7 @@
 
 constexpr int MAX_SEATS = 4;
 constexpr int PLAYER_POOL_SIZE = 1000;
+constexpr int NPC_POOL_SIZE = 1000;
 constexpr int VEHICLE_POOL_SIZE = 2000;
 constexpr int CLASS_POOL_SIZE = 320;
 constexpr int OBJECT_POOL_SIZE = 2000;
@@ -95,4 +96,9 @@ enum Key
 };
 
 constexpr uint16_t INVALID_MODEL_ID = 65535u;
-constexpr int32_t QUESTION_MARK_MODEL_ID = 18631;
+constexpr int32_t QUESTION_MARK_MODEL_ID = 18631;
+
+constexpr float NPC_MOVE_SPEED_AUTO = -1.0f;
+constexpr float NPC_MOVE_SPEED_WALK = 0.1552086f;
+constexpr float NPC_MOVE_SPEED_JOG = 0.56444f;
+constexpr float NPC_MOVE_SPEED_SPRINT = 0.926784f;

Server/Components/CMakeLists.txt

@@ -20,6 +20,7 @@ add_subdirectory(TextLabels)
 add_subdirectory(Timers)
 add_subdirectory(Variables)
 add_subdirectory(Vehicles)
+add_subdirectory(NPCs)
 
 # Pawn
 if(BUILD_PAWN_COMPONENT)

Server/Components/NPCs/CMakeLists.txt

@@ -0,0 +1,2 @@
+get_filename_component(ProjectId ${CMAKE_CURRENT_SOURCE_DIR} NAME)
+add_server_component(${ProjectId})