X-Git-Url: http://git.xonotic.org/?a=blobdiff_plain;f=qcsrc%2Fserver%2Fresources.qh;h=b5e188b62062b8bba29cd4049f818485a346a766;hb=5d929ee0b1dc587e3154a4fa4b56e83b9ba9100b;hp=dd9dfc232a46f0ac7d0421d869967fde82b07325;hpb=a9c8e78b3bd0db89cb261c7b7f7e94a7903240e0;p=xonotic%2Fxonotic-data.pk3dir.git diff --git a/qcsrc/server/resources.qh b/qcsrc/server/resources.qh index dd9dfc232..b5e188b62 100644 --- a/qcsrc/server/resources.qh +++ b/qcsrc/server/resources.qh @@ -5,54 +5,82 @@ /// \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; +#include // ============================ 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 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] res_type Type of the resource (a RES_* constant). /// \param[in] amount Amount of resource to set. /// \return No return. -void SetResourceAmount(entity e, int resource_type, float amount); +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 resource_type, float amount); +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] 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. /// \param[in] limit Limit of resources to give. /// \return No return. -void GiveResourceWithLimit(entity receiver, int resource_type, float amount, - float limit); +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 TakeResourceWithLimit(entity receiver, int res_type, float amount, float limit); + +/// \brief Gives to or takes from an entity resource. +/// \param[in,out] receiver Entity to give or take resource. +/// \param[in] res_type Type of the resource (a RES_* constant). +/// \param[in] amount Amount of resource to give or take. +/// \return No return. +void GiveOrTakeResource(entity receiver, int res_type, float amount); + +/// \brief Gives to or takes from an entity resource but not more/less than a limit. +/// \param[in,out] receiver Entity to give or take resource. +/// \param[in] res_type Type of the resource (a RES_* constant). +/// \param[in] amount Amount of resource to give or take. +/// \param[in] limit Limit of resources to give or take. +/// \return No return. +void GiveOrTakeResourceWithLimit(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);