X-Git-Url: https://de.git.xonotic.org/?a=blobdiff_plain;f=qcsrc%2Fserver%2Fresources.qh;h=e4631ab5605ad30d7953826cdaddf6ef78ea7bd7;hb=4ecd2a1d3e7f830c132dc5c6bf58100ed984d11a;hp=3189fde95a29c61d2252d2df0847a89ff23cdde9;hpb=81073691003a3c4405ec28a1dc01e9fe516e3f9f;p=xonotic%2Fxonotic-data.pk3dir.git diff --git a/qcsrc/server/resources.qh b/qcsrc/server/resources.qh index 3189fde95..e4631ab56 100644 --- a/qcsrc/server/resources.qh +++ b/qcsrc/server/resources.qh @@ -1,25 +1,11 @@ +#pragma once + /// \file /// \brief Header file that describes the resource system. /// \author Lyberta /// \copyright GNU GPLv2 or any later version. -#pragma once - -/// \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). -}; +#include // ============================ Public API ==================================== @@ -35,6 +21,13 @@ float GetResourceLimit(entity e, int resource_type); /// \return Current amount of resource the given entity has. float GetResourceAmount(entity e, int resource_type); +/// \brief Sets the resource amount of an entity without calling any hooks. +/// \param[in,out] e Entity to adjust. +/// \param[in] resource_type Type of the resource (a RESOURCE_* constant). +/// \param[in] amount Amount of resource to set. +/// \return Boolean for whether the ammo amount was changed +bool SetResourceAmountExplicit(entity e, int resource_type, float amount); + /// \brief Sets the current amount of resource the given entity will have. /// \param[in,out] e Entity to adjust. /// \param[in] resource_type Type of the resource (a RESOURCE_* constant). @@ -58,6 +51,22 @@ void GiveResource(entity receiver, int resource_type, float amount); void GiveResourceWithLimit(entity receiver, int resource_type, float amount, float limit); +/// \brief Takes an entity some resource. +/// \param[in,out] receiver Entity to take resource from. +/// \param[in] resource_type Type of the resource (a RESOURCE_* constant). +/// \param[in] amount Amount of resource to take. +/// \return No return. +void TakeResource(entity receiver, int resource_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] resource_type Type of the resource (a RESOURCE_* constant). +/// \param[in] amount Amount of resource to take. +/// \param[in] limit Limit of resources to take. +/// \return No return. +void TakeResourceWithLimit(entity receiver, int resource_type, float amount, + float limit); + // ===================== Legacy and/or internal API =========================== /// \brief Converts an entity field to resource type.