feat: Add isolated and simplified path to add components

dGame/Entity.h

@@ -66,7 +66,7 @@ class Entity {
 
 	eGameMasterLevel GetGMLevel() const { return m_GMLevel; }
 
-	uint8_t GetCollectibleID() const { return uint8_t(m_CollectibleID); }
+	uint8_t GetCollectibleID() const;
 
 	Entity* GetParentEntity() const { return m_ParentEntity; }
 
@@ -274,6 +274,9 @@ class Entity {
 	template<typename T>
 	T GetVarAs(const std::u16string& name) const;
 
+	template<typename ComponentType, typename... VaArgs>
+	ComponentType* AddComponent(VaArgs... args);
+
 	/**
 	 * Get the LDF data.
 	 */
@@ -501,3 +504,35 @@ T Entity::GetNetworkVar(const std::u16string& name) {
 
 	return LDFData<T>::Default;
 }
+
+/**
+ * @brief Adds a component of type ComponentType to this entity and forwards the arguments to the constructor.
+ *
+ * @tparam ComponentType The component class type to add. Must derive from Component.
+ * @tparam VaArgs The argument types to forward to the constructor.
+ * @param args The arguments to forward to the constructor. The first argument passed to the ComponentType constructor will be this entity.
+ * @return ComponentType* The added component. Will never return null.
+ */
+template<typename ComponentType, typename... VaArgs>
+inline ComponentType* Entity::AddComponent(VaArgs... args) {
+	static_assert(std::is_base_of_v<Component, ComponentType>, "ComponentType must be a Component");
+
+	// Get the component if it already exists, or default construct a nullptr
+	auto*& componentToReturn = m_Components[ComponentType::ComponentType];
+
+	// If it doesn't exist, create it and forward the arguments to the constructor
+	if (!componentToReturn) {
+		componentToReturn = new ComponentType(this, std::forward<VaArgs>(args)...);
+	} else {
+		// In this case the block is already allocated and ready for use
+		// so we use a placement new to construct the component again as was requested by the caller.
+		// Placement new means we already have memory allocated for the object, so this just calls its constructor again.
+		// This is useful for when we want to create a new object in the same memory location as an old one.
+		new(componentToReturn) ComponentType(this, std::forward<VaArgs>(args)...);
+	}
+
+	// Finally return the created or already existing component.
+	// Because of the assert above, this should always be a ComponentType* but I need a way to guarantee the map cannot be modifed outside this function
+	// To allow a static cast here instead of a dynamic one.
+	return dynamic_cast<ComponentType*>(componentToReturn);
+}

dGame/dComponents/BaseCombatAIComponent.h

@@ -47,7 +47,7 @@ struct AiSkillEntry
  */
 class BaseCombatAIComponent : public Component {
 public:
-	static const eReplicaComponentType ComponentType = eReplicaComponentType::BASE_COMBAT_AI;
+	inline static const eReplicaComponentType ComponentType = eReplicaComponentType::BASE_COMBAT_AI;
 
 	BaseCombatAIComponent(Entity* parentEntity, uint32_t id);
 	~BaseCombatAIComponent() override;

dGame/dComponents/BouncerComponent.h

@@ -12,7 +12,7 @@
  */
 class BouncerComponent : public Component {
 public:
-	static const eReplicaComponentType ComponentType = eReplicaComponentType::BOUNCER;
+	inline static const eReplicaComponentType ComponentType = eReplicaComponentType::BOUNCER;
 
 	BouncerComponent(Entity* parentEntity);
 	~BouncerComponent() override;

dGame/dComponents/BuffComponent.h

@@ -42,7 +42,7 @@ struct Buff
  */
 class BuffComponent : public Component {
 public:
-	static const eReplicaComponentType ComponentType = eReplicaComponentType::BUFF;
+	inline static const eReplicaComponentType ComponentType = eReplicaComponentType::BUFF;
 
 	explicit BuffComponent(Entity* parent);
 

dGame/dComponents/BuildBorderComponent.h

@@ -16,7 +16,7 @@
   */
 class BuildBorderComponent : public Component {
 public:
-	static const eReplicaComponentType ComponentType = eReplicaComponentType::BUILD_BORDER;
+	inline static const eReplicaComponentType ComponentType = eReplicaComponentType::BUILD_BORDER;
 
 	BuildBorderComponent(Entity* parent);
 	~BuildBorderComponent() override;

dGame/dComponents/CMakeLists.txt

@@ -3,11 +3,13 @@ set(DGAME_DCOMPONENTS_SOURCES "BaseCombatAIComponent.cpp"
 	"BuffComponent.cpp"
 	"BuildBorderComponent.cpp"
 	"CharacterComponent.cpp"
+	"CollectibleComponent.cpp"
 	"Component.cpp"
 	"ControllablePhysicsComponent.cpp"
 	"DestroyableComponent.cpp"
 	"DonationVendorComponent.cpp"
 	"InventoryComponent.cpp"
+	"ItemComponent.cpp"
 	"LevelProgressionComponent.cpp"
 	"LUPExhibitComponent.cpp"
 	"MissionComponent.cpp"
@@ -42,4 +44,7 @@ set(DGAME_DCOMPONENTS_SOURCES "BaseCombatAIComponent.cpp"
 	"SwitchComponent.cpp"
 	"TriggerComponent.cpp"
 	"VehiclePhysicsComponent.cpp"
-	"VendorComponent.cpp" PARENT_SCOPE)
+	"VendorComponent.cpp"
+	"ZoneControlComponent.cpp"
+	PARENT_SCOPE
+)

dGame/dComponents/CharacterComponent.h

@@ -62,7 +62,7 @@ enum StatisticID {
  */
 class CharacterComponent : public Component {
 public:
-	static const eReplicaComponentType ComponentType = eReplicaComponentType::CHARACTER;
+	inline static const eReplicaComponentType ComponentType = eReplicaComponentType::CHARACTER;
 
 	CharacterComponent(Entity* parent, Character* character);
 	~CharacterComponent() override;

dGame/dComponents/CollectibleComponent.cpp

@@ -0,0 +1,5 @@
+#include "CollectibleComponent.h"
+
+void CollectibleComponent::Serialize(RakNet::BitStream* outBitStream, bool isConstruction) {
+	outBitStream->Write(GetCollectibleId());
+}

dGame/dComponents/CollectibleComponent.h

@@ -0,0 +1,18 @@
+#ifndef __COLLECTIBLECOMPONENT__H__
+#define __COLLECTIBLECOMPONENT__H__
+
+#include "Component.h"
+#include "eReplicaComponentType.h"
+
+class CollectibleComponent : public Component {
+public:
+	inline static const eReplicaComponentType ComponentType = eReplicaComponentType::COLLECTIBLE;
+	CollectibleComponent(Entity* parentEntity, int32_t collectibleId) : Component(parentEntity), m_CollectibleId(collectibleId) {}
+
+	int16_t GetCollectibleId() const { return m_CollectibleId; }
+	void Serialize(RakNet::BitStream* outBitStream, bool isConstruction) override;
+private:
+	int16_t m_CollectibleId = 0;
+};
+
+#endif  //!__COLLECTIBLECOMPONENT__H__

dGame/dComponents/ControllablePhysicsComponent.h

@@ -21,7 +21,7 @@ enum class eStateChangeType : uint32_t;
  */
 class ControllablePhysicsComponent : public PhysicsComponent {
 public:
-	static const eReplicaComponentType ComponentType = eReplicaComponentType::CONTROLLABLE_PHYSICS;
+	inline static const eReplicaComponentType ComponentType = eReplicaComponentType::CONTROLLABLE_PHYSICS;
 
 	ControllablePhysicsComponent(Entity* entity);
 	~ControllablePhysicsComponent() override;

dGame/dComponents/DestroyableComponent.h

@@ -19,7 +19,7 @@ enum class eStateChangeType : uint32_t;
  */
 class DestroyableComponent : public Component {
 public:
-	static const eReplicaComponentType ComponentType = eReplicaComponentType::DESTROYABLE;
+	inline static const eReplicaComponentType ComponentType = eReplicaComponentType::DESTROYABLE;
 
 	DestroyableComponent(Entity* parentEntity);
 	~DestroyableComponent() override;

dGame/dComponents/InventoryComponent.h

@@ -38,7 +38,7 @@ enum class eItemType : int32_t;
 class InventoryComponent : public Component
 {
 public:
-	static const eReplicaComponentType ComponentType = eReplicaComponentType::INVENTORY;
+	inline static const eReplicaComponentType ComponentType = eReplicaComponentType::INVENTORY;
 	explicit InventoryComponent(Entity* parent, tinyxml2::XMLDocument* document = nullptr);
 
 	void Update(float deltaTime) override;

dGame/dComponents/ItemComponent.cpp

@@ -0,0 +1,5 @@
+#include "ItemComponent.h"
+
+void ItemComponent::Serialize(RakNet::BitStream* outBitStream, bool isConstruction) {
+	outBitStream->Write0();
+}

dGame/dComponents/ItemComponent.h

@@ -0,0 +1,16 @@
+#ifndef __ITEMCOMPONENT__H__
+#define __ITEMCOMPONENT__H__
+
+#include "Component.h"
+#include "eReplicaComponentType.h"
+
+class ItemComponent : public Component {
+public:
+	inline static const eReplicaComponentType ComponentType = eReplicaComponentType::ITEM;
+
+	ItemComponent(Entity* entity) : Component(entity) {}
+
+	void Serialize(RakNet::BitStream* bitStream, bool isConstruction) override;
+};
+
+#endif  //!__ITEMCOMPONENT__H__

dGame/dComponents/LUPExhibitComponent.h

@@ -11,7 +11,7 @@
 class LUPExhibitComponent : public Component
 {
 public:
-	static const eReplicaComponentType ComponentType = eReplicaComponentType::EXHIBIT;
+	inline static const eReplicaComponentType ComponentType = eReplicaComponentType::EXHIBIT;
 
 	LUPExhibitComponent(Entity* parent);
 	~LUPExhibitComponent();

dGame/dComponents/LevelProgressionComponent.h

@@ -13,7 +13,7 @@
 
 class LevelProgressionComponent : public Component {
 public:
-	static const eReplicaComponentType ComponentType = eReplicaComponentType::LEVEL_PROGRESSION;
+	inline static const eReplicaComponentType ComponentType = eReplicaComponentType::LEVEL_PROGRESSION;
 
 	/**
 	 * Constructor for this component

dGame/dComponents/MissionComponent.h

@@ -27,7 +27,7 @@ class AchievementCacheKey;
 class MissionComponent : public Component
 {
 public:
-	static const eReplicaComponentType ComponentType = eReplicaComponentType::MISSION;
+	inline static const eReplicaComponentType ComponentType = eReplicaComponentType::MISSION;
 
 	explicit MissionComponent(Entity* parent);
 	~MissionComponent() override;

dGame/dComponents/MissionOfferComponent.h

@@ -61,7 +61,7 @@ struct OfferedMission {
  */
 class MissionOfferComponent : public Component {
 public:
-	static const eReplicaComponentType ComponentType = eReplicaComponentType::MISSION_OFFER;
+	inline static const eReplicaComponentType ComponentType = eReplicaComponentType::MISSION_OFFER;
 
 	MissionOfferComponent(Entity* parent, LOT parentLot);
 	~MissionOfferComponent() override;

dGame/dComponents/ModelComponent.h

@@ -13,7 +13,7 @@ class Entity;
  */
 class ModelComponent : public Component {
 public:
-	static const eReplicaComponentType ComponentType = eReplicaComponentType::MODEL;
+	inline static const eReplicaComponentType ComponentType = eReplicaComponentType::MODEL;
 
 	ModelComponent(Entity* parent);
 

dGame/dComponents/ModuleAssemblyComponent.h

@@ -12,7 +12,7 @@
  */
 class ModuleAssemblyComponent : public Component {
 public:
-	static const eReplicaComponentType ComponentType = eReplicaComponentType::MODULE_ASSEMBLY;
+	inline static const eReplicaComponentType ComponentType = eReplicaComponentType::MODULE_ASSEMBLY;
 
 	ModuleAssemblyComponent(Entity* parent);
 	~ModuleAssemblyComponent() override;

dGame/dComponents/MovementAIComponent.h

@@ -57,7 +57,7 @@ struct MovementAIInfo {
  */
 class MovementAIComponent : public Component {
 public:
-	static const eReplicaComponentType ComponentType = eReplicaComponentType::MOVEMENT_AI;
+	inline static const eReplicaComponentType ComponentType = eReplicaComponentType::MOVEMENT_AI;
 
 	MovementAIComponent(Entity* parentEntity, MovementAIInfo info);
 

dGame/dComponents/MovingPlatformComponent.h

@@ -106,7 +106,7 @@ class MoverSubComponent {
  */
 class MovingPlatformComponent : public Component {
 public:
-	static const eReplicaComponentType ComponentType = eReplicaComponentType::MOVING_PLATFORM;
+	inline static const eReplicaComponentType ComponentType = eReplicaComponentType::MOVING_PLATFORM;
 
 	MovingPlatformComponent(Entity* parent, const std::string& pathName);
 	~MovingPlatformComponent() override;

dGame/dComponents/MultiZoneEntranceComponent.h

@@ -10,7 +10,7 @@
  */
 class MultiZoneEntranceComponent : public Component {
 public:
-	static const eReplicaComponentType ComponentType = eReplicaComponentType::MULTI_ZONE_ENTRANCE;
+	inline static const eReplicaComponentType ComponentType = eReplicaComponentType::MULTI_ZONE_ENTRANCE;
 
 	/**
 	 * Constructor for this component, builds the m_LUPWorlds vector

dGame/dComponents/PetComponent.h

@@ -21,7 +21,7 @@ enum class PetAbilityType
 class PetComponent : public Component
 {
 public:
-	static const eReplicaComponentType ComponentType = eReplicaComponentType::PET;
+	inline static const eReplicaComponentType ComponentType = eReplicaComponentType::PET;
 
 	explicit PetComponent(Entity* parentEntity, uint32_t componentId);
 	~PetComponent() override;

dGame/dComponents/PhantomPhysicsComponent.h

@@ -27,7 +27,7 @@ enum class ePhysicsEffectType : uint32_t ;
  */
 class PhantomPhysicsComponent : public PhysicsComponent {
 public:
-	static const eReplicaComponentType ComponentType = eReplicaComponentType::PHANTOM_PHYSICS;
+	inline static const eReplicaComponentType ComponentType = eReplicaComponentType::PHANTOM_PHYSICS;
 
 	PhantomPhysicsComponent(Entity* parent);
 	~PhantomPhysicsComponent() override;

dGame/dComponents/PlayerForcedMovementComponent.h

@@ -10,7 +10,7 @@
  */
 class PlayerForcedMovementComponent : public Component {
 public:
-	static const eReplicaComponentType ComponentType = eReplicaComponentType::PLAYER_FORCED_MOVEMENT;
+	inline static const eReplicaComponentType ComponentType = eReplicaComponentType::PLAYER_FORCED_MOVEMENT;
 
 	/**
 	 * Constructor for this component

dGame/dComponents/PossessableComponent.h

@@ -14,7 +14,7 @@
  */
 class PossessableComponent : public Component {
 public:
-	static const eReplicaComponentType ComponentType = eReplicaComponentType::POSSESSABLE;
+	inline static const eReplicaComponentType ComponentType = eReplicaComponentType::POSSESSABLE;
 
 	PossessableComponent(Entity* parentEntity, uint32_t componentId);
 

dGame/dComponents/PossessorComponent.h

@@ -18,7 +18,7 @@ enum class ePossessionType : uint8_t {
  */
 class PossessorComponent : public Component {
 public:
-	static const eReplicaComponentType ComponentType = eReplicaComponentType::POSSESSOR;
+	inline static const eReplicaComponentType ComponentType = eReplicaComponentType::POSSESSOR;
 
 	PossessorComponent(Entity* parent);
 	~PossessorComponent() override;

dGame/dComponents/PropertyComponent.h

@@ -22,7 +22,7 @@ struct PropertyState {
  */
 class PropertyComponent : public Component {
 public:
-	static const eReplicaComponentType ComponentType = eReplicaComponentType::PROPERTY;
+	inline static const eReplicaComponentType ComponentType = eReplicaComponentType::PROPERTY;
 	explicit PropertyComponent(Entity* parentEntity);
 	~PropertyComponent() override;
 	[[nodiscard]] PropertyState* GetPropertyState() const { return m_PropertyState; };

dGame/dComponents/PropertyEntranceComponent.cpp

@@ -15,7 +15,7 @@
 #include "eObjectBits.h"
 #include "eGameMasterLevel.h"
 
-PropertyEntranceComponent::PropertyEntranceComponent(uint32_t componentID, Entity* parent) : Component(parent) {
+PropertyEntranceComponent::PropertyEntranceComponent(Entity* parent, uint32_t componentID) : Component(parent) {
 	this->propertyQueries = {};
 
 	auto table = CDClientManager::Instance().GetTable<CDPropertyEntranceComponentTable>();

dGame/dComponents/PropertyEntranceComponent.h

@@ -13,8 +13,8 @@
  */
 class PropertyEntranceComponent : public Component {
 public:
-	static const eReplicaComponentType ComponentType = eReplicaComponentType::PROPERTY_ENTRANCE;
-	explicit PropertyEntranceComponent(uint32_t componentID, Entity* parent);
+	explicit PropertyEntranceComponent(Entity* parent, uint32_t componentID);
+	inline static const eReplicaComponentType ComponentType = eReplicaComponentType::PROPERTY_ENTRANCE;
 
 	/**
 	 * Handles an OnUse request for some other entity, rendering the property browse menu

dGame/dComponents/PropertyManagementComponent.h

@@ -32,7 +32,7 @@ enum class PropertyPrivacyOption
 class PropertyManagementComponent : public Component
 {
 public:
-	static const eReplicaComponentType ComponentType = eReplicaComponentType::PROPERTY_MANAGEMENT;
+	inline static const eReplicaComponentType ComponentType = eReplicaComponentType::PROPERTY_MANAGEMENT;
 	PropertyManagementComponent(Entity* parent);
 	static PropertyManagementComponent* Instance();
 

dGame/dComponents/PropertyVendorComponent.h

@@ -10,7 +10,7 @@
 class PropertyVendorComponent : public Component
 {
 public:
-	static const eReplicaComponentType ComponentType = eReplicaComponentType::PROPERTY_VENDOR;
+	inline static const eReplicaComponentType ComponentType = eReplicaComponentType::PROPERTY_VENDOR;
 	explicit PropertyVendorComponent(Entity* parent);
 
 	/**

dGame/dComponents/ProximityMonitorComponent.h

@@ -19,7 +19,7 @@
   */
 class ProximityMonitorComponent : public Component {
 public:
-	static const eReplicaComponentType ComponentType = eReplicaComponentType::PROXIMITY_MONITOR;
+	inline static const eReplicaComponentType ComponentType = eReplicaComponentType::PROXIMITY_MONITOR;
 
 	ProximityMonitorComponent(Entity* parentEntity, int smallRadius = -1, int largeRadius = -1);
 	~ProximityMonitorComponent() override;

dGame/dComponents/RacingControlComponent.h

@@ -105,7 +105,7 @@ struct RacingPlayerInfo {
  */
 class RacingControlComponent : public Component {
 public:
-	static const eReplicaComponentType ComponentType = eReplicaComponentType::RACING_CONTROL;
+	inline static const eReplicaComponentType ComponentType = eReplicaComponentType::RACING_CONTROL;
 
 	RacingControlComponent(Entity* parentEntity);
 	~RacingControlComponent();