X-Git-Url: http://de.git.xonotic.org/?a=blobdiff_plain;f=qcsrc%2Fclient%2Fresources.qh;h=4b0eaa8e75efaa3250a235d6229178682d7ee15a;hb=3c08561fdbb39a6aed38b984faa131aa04282aff;hp=196ccf05dbaa1c87b150edddcea48b6ec100a2a2;hpb=e2f4f38f2e54bf029483fbc0d3b8090d035b6e2d;p=xonotic%2Fxonotic-data.pk3dir.git diff --git a/qcsrc/client/resources.qh b/qcsrc/client/resources.qh index 196ccf05d..4b0eaa8e7 100644 --- a/qcsrc/client/resources.qh +++ b/qcsrc/client/resources.qh @@ -10,32 +10,51 @@ /// \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] 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 Boolean for whether the ammo amount was changed -bool SetResourceAmountExplicit(entity e, int resource_type, float amount); +bool SetResourceExplicit(entity e, int res_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). +/// \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 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); // ===================== 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); + +/// \brief Legacy fields for the resources. To be removed. +.float health; +.float armorvalue;