X-Git-Url: http://de.git.xonotic.org/?a=blobdiff_plain;f=qcsrc%2Fserver%2Fresources.qh;h=05cb602c37b803a21360a5ad06440738be3bd3bd;hb=HEAD;hp=f93db58fc324387b97b50e69da7e8f3319049a9d;hpb=a3a388a32d0ea11fe79341ef44edc21c5ba460f4;p=xonotic%2Fxonotic-data.pk3dir.git diff --git a/qcsrc/server/resources.qh b/qcsrc/server/resources.qh deleted file mode 100644 index f93db58fc..000000000 --- a/qcsrc/server/resources.qh +++ /dev/null @@ -1,93 +0,0 @@ -#pragma once - -/// \file -/// \brief Header file that describes the resource system. -/// \author Lyberta -/// \copyright GNU GPLv2 or any later version. - -#include - -// ============================ Public API ==================================== - -/// \brief Returns the maximum amount of the given resource. -/// \param[in] e Entity to check. -/// \param[in] res_type Type of the resource (a RES_* constant). -/// \return Maximum amount of the given resource. -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] res_type Type of the resource (a RES_* constant). -/// \return Current amount of resource the given entity has. -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. -/// \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] 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 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] res_field Entity field to convert. -/// \return Resource type (a RES_* constant). -int GetResourceType(.float res_field); - -/// \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 res_type);