X-Git-Url: https://de.git.xonotic.org/?p=xonotic%2Fxonotic-data.pk3dir.git;a=blobdiff_plain;f=qcsrc%2Fserver%2Fresources.qh;h=c228b6ec4c04b3512fa3d0190a99861d486d8c44;hp=d81b6ac6adc9ee5d6a5663c869b1d1458548aa45;hb=e0012447bfce1b551df3dc01b043655aa93dafad;hpb=b53f83be7a4bd0fe234af6dc68671497f432b768

diff --git a/qcsrc/server/resources.qh b/qcsrc/server/resources.qh
index d81b6ac6ad..c228b6ec4c 100644
--- a/qcsrc/server/resources.qh
+++ b/qcsrc/server/resources.qh
@@ -1,50 +1,79 @@
 #pragma once
 
-/// \brief Unconditional maximum amount of resources the player 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).
-};
+/// \file
+/// \brief Header file that describes the resource system.
+/// \author Lyberta
+/// \copyright GNU GPLv2 or any later version.
+
+#include <common/resources.qh>
 
 // ============================ Public API ====================================
 
 /// \brief Returns the maximum amount of the given resource.
 /// \param[in] e Entity to check.
-/// \param[in] resource_type Type of the resource (a RESOURCE_* constant).
+/// \param[in] res_type Type of the resource (a RES_* constant).
 /// \return Maximum amount of the given resource.
-float GetResourceLimit(entity e, int resource_type);
+float GetResourceLimit(entity e, int res_type);
 
 /// \brief Returns the current amount of resource the given entity has.
 /// \param[in] e Entity to check.
-/// \param[in] resource_type Type of the resource (a RESOURCE_* constant).
+/// \param[in] res_type Type of the resource (a RES_* constant).
 /// \return Current amount of resource the given entity has.
-float GetResourceAmount(entity e, int resource_type);
+float GetResource(entity e, int res_type);
+
+/// \brief Sets the resource amount of an entity without calling any hooks.
+/// \param[in,out] e Entity to adjust.
+/// \param[in] res_type Type of the resource (a RES_* constant).
+/// \param[in] amount Amount of resource to set.
+/// \return Boolean for whether the ammo amount was changed
+bool SetResourceExplicit(entity e, int res_type, float amount);
+
+/// \brief Sets the current amount of resource the given entity will have
+/// but limited to the max amount allowed for the resource type.
+/// \param[in,out] e Entity to adjust.
+/// \param[in] res_type Type of the resource (a RES_* constant).
+/// \param[in] amount Amount of resource to set.
+/// \return No return.
+void SetResource(entity e, int res_type, float amount);
 
 /// \brief Gives an entity some resource.
 /// \param[in,out] receiver Entity to give resource to.
-/// \param[in] resource_type Type of the resource (a RESOURCE_* constant).
+/// \param[in] res_type Type of the resource (a RES_* constant).
+/// \param[in] amount Amount of resource to give.
+/// \return No return.
+void GiveResource(entity receiver, int res_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] res_type Type of the resource (a RES_* 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 res_type, float amount, float limit);
+
+/// \brief Takes an entity some resource.
+/// \param[in,out] receiver Entity to take resource from.
+/// \param[in] res_type Type of the resource (a RES_* constant).
+/// \param[in] amount Amount of resource to take.
+/// \return No return.
+void TakeResource(entity receiver, int res_type, float amount);
+
+/// \brief Takes an entity some resource but not less than a limit.
+/// \param[in,out] receiver Entity to take resource from.
+/// \param[in] res_type Type of the resource (a RES_* constant).
+/// \param[in] amount Amount of resource to take.
+/// \param[in] limit Limit of resources to take.
 /// \return No return.
-void GiveResource(entity receiver, int resource_type, float amount);
+void TakeResourceWithLimit(entity receiver, int res_type, float amount, float limit);
 
 // ===================== Legacy and/or internal API ===========================
 
 /// \brief Converts an entity field to resource type.
-/// \param[in] resource_field Entity field to convert.
-/// \return Resource type (a RESOURCE_* constant).
-int GetResourceType(.float resource_field);
+/// \param[in] res_field Entity field to convert.
+/// \return Resource type (a RES_* constant).
+int GetResourceType(.float res_field);
 
-/// \brief Converts resource type (a RESOURCE_* constant) to entity field.
-/// \param[in] resource_type Type of the resource.
+/// \brief Converts resource type (a RES_* constant) to entity field.
+/// \param[in] res_type Type of the resource.
 /// \return Entity field for that resource.
-.float GetResourceField(int resource_type);
+.float GetResourceField(int res_type);