Purge direct includes of mutators/events.qh in favour of the _mod files

[xonotic/xonotic-data.pk3dir.git] / qcsrc / server / resources.qh

diff --git a/qcsrc/server/resources.qh b/qcsrc/server/resources.qh
index 97f49485d90d99bb01cbb1fc6d05b772f0caeed1..6ff3cea67917973eab045526b76d0c6d97b05890 100644 (file)
--- a/qcsrc/server/resources.qh
+++ b/qcsrc/server/resources.qh
@@ -1,26 +1,15 @@
+#pragma once
+
 /// \file
 /// \brief Header file that describes the resource system.
 /// \author Lyberta
-/// \copyright GNU GPLv3 or any later version.
+/// \copyright GNU GPLv2 or any later version.
 
-#pragma once
+#include <common/resources.qh>
 
 /// \brief Unconditional maximum amount of resources the entity can have.
 const int RESOURCE_AMOUNT_HARD_LIMIT = 999;
 
-/// \brief Describes the available resource types.
-enum
-{
-       RESOURCE_HEALTH = 1, ///< Health.
-       RESOURCE_ARMOR, ///< Armor.
-       RESOURCE_SHELLS, ///< Shells (used by shotgun).
-       RESOURCE_BULLETS, ///< Bullets (used by machinegun and rifle)
-       RESOURCE_ROCKETS, ///< Rockets (used by mortar, hagar, devastator, etc).
-       RESOURCE_CELLS, ///< Cells (used by electro, crylink, vortex, etc)
-       RESOURCE_PLASMA, ///< Plasma (unused).
-       RESOURCE_FUEL ///< Fuel (used by jetpack).
-};
-
 // ============================ Public API ====================================
 
 /// \brief Returns the maximum amount of the given resource.
@@ -49,6 +38,15 @@ void SetResourceAmount(entity e, int resource_type, float amount);
 /// \return No return.
 void GiveResource(entity receiver, int resource_type, float amount);
 
+/// \brief Gives an entity some resource but not more than a limit.
+/// \param[in,out] receiver Entity to give resource to.
+/// \param[in] resource_type Type of the resource (a RESOURCE_* constant).
+/// \param[in] amount Amount of resource to give.
+/// \param[in] limit Limit of resources to give.
+/// \return No return.
+void GiveResourceWithLimit(entity receiver, int resource_type, float amount,
+       float limit);
+
 // ===================== Legacy and/or internal API ===========================
 
 /// \brief Converts an entity field to resource type.