X-Git-Url: http://git.xonotic.org/?p=xonotic%2Fxonotic-data.pk3dir.git;a=blobdiff_plain;f=qcsrc%2Fserver%2Fresources.qh;h=c228b6ec4c04b3512fa3d0190a99861d486d8c44;hp=ce8e1e8e5daaa3f023cfe169f814a5aa5c8ba89c;hb=HEAD;hpb=678127044857fb9b89f06faf7a3313bdeb43205c diff --git a/qcsrc/server/resources.qh b/qcsrc/server/resources.qh deleted file mode 100644 index ce8e1e8e5..000000000 --- a/qcsrc/server/resources.qh +++ /dev/null @@ -1,70 +0,0 @@ -#pragma once -/// \file -/// \brief Header file that describes the resource system. -/// \author Lyberta -/// \copyright GNU GPLv2 or any later version. - -/// \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. -/// \param[in] e Entity to check. -/// \param[in] resource_type Type of the resource (a RESOURCE_* constant). -/// \return Maximum amount of the given resource. -float GetResourceLimit(entity e, int resource_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). -/// \return Current amount of resource the given entity has. -float GetResourceAmount(entity e, int resource_type); - -/// \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). -/// \param[in] amount Amount of resource to set. -/// \return No return. -void SetResourceAmount(entity e, int resource_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] amount Amount of resource to give. -/// \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. -/// \param[in] resource_field Entity field to convert. -/// \return Resource type (a RESOURCE_* constant). -int GetResourceType(.float resource_field); - -/// \brief Converts resource type (a RESOURCE_* constant) to entity field. -/// \param[in] resource_type Type of the resource. -/// \return Entity field for that resource. -.float GetResourceField(int resource_type);