4 /// \brief Header file that describes the resource system.
6 /// \copyright GNU GPLv2 or any later version.
8 #include <common/resources.qh>
10 // ============================ Public API ====================================
12 /// \brief Returns the maximum amount of the given resource.
13 /// \param[in] e Entity to check.
14 /// \param[in] res_type Type of the resource (a RES_* constant).
15 /// \return Maximum amount of the given resource.
16 float GetResourceLimit(entity e, int res_type);
18 /// \brief Returns the current amount of resource the given entity has.
19 /// \param[in] e Entity to check.
20 /// \param[in] res_type Type of the resource (a RES_* constant).
21 /// \return Current amount of resource the given entity has.
22 float GetResource(entity e, int res_type);
24 /// \brief Sets the resource amount of an entity without calling any hooks.
25 /// \param[in,out] e Entity to adjust.
26 /// \param[in] res_type Type of the resource (a RES_* constant).
27 /// \param[in] amount Amount of resource to set.
28 /// \return Boolean for whether the ammo amount was changed
29 bool SetResourceExplicit(entity e, int res_type, float amount);
31 /// \brief Sets the current amount of resource the given entity will have.
32 /// \param[in,out] e Entity to adjust.
33 /// \param[in] res_type Type of the resource (a RES_* constant).
34 /// \param[in] amount Amount of resource to set.
35 /// \return No return.
36 void SetResource(entity e, int res_type, float amount);
38 /// \brief Gives an entity some resource.
39 /// \param[in,out] receiver Entity to give resource to.
40 /// \param[in] res_type Type of the resource (a RES_* constant).
41 /// \param[in] amount Amount of resource to give.
42 /// \return No return.
43 void GiveResource(entity receiver, int res_type, float amount);
45 /// \brief Gives an entity some resource but not more than a limit.
46 /// \param[in,out] receiver Entity to give resource to.
47 /// \param[in] res_type Type of the resource (a RES_* constant).
48 /// \param[in] amount Amount of resource to give.
49 /// \param[in] limit Limit of resources to give.
50 /// \return No return.
51 void GiveResourceWithLimit(entity receiver, int res_type, float amount, float limit);
53 /// \brief Takes an entity some resource.
54 /// \param[in,out] receiver Entity to take resource from.
55 /// \param[in] res_type Type of the resource (a RES_* constant).
56 /// \param[in] amount Amount of resource to take.
57 /// \return No return.
58 void TakeResource(entity receiver, int res_type, float amount);
60 /// \brief Takes an entity some resource but not less than a limit.
61 /// \param[in,out] receiver Entity to take resource from.
62 /// \param[in] res_type Type of the resource (a RES_* constant).
63 /// \param[in] amount Amount of resource to take.
64 /// \param[in] limit Limit of resources to take.
65 /// \return No return.
66 void TakeResourceWithLimit(entity receiver, int res_type, float amount, float limit);
68 /// \brief Gives to or takes from an entity resource.
69 /// \param[in,out] receiver Entity to give or take resource.
70 /// \param[in] res_type Type of the resource (a RES_* constant).
71 /// \param[in] amount Amount of resource to give or take.
72 /// \return No return.
73 void GiveOrTakeResource(entity receiver, int res_type, float amount);
75 /// \brief Gives to or takes from an entity resource but not more/less than a limit.
76 /// \param[in,out] receiver Entity to give or take resource.
77 /// \param[in] res_type Type of the resource (a RES_* constant).
78 /// \param[in] amount Amount of resource to give or take.
79 /// \param[in] limit Limit of resources to give or take.
80 /// \return No return.
81 void GiveOrTakeResourceWithLimit(entity receiver, int res_type, float amount, float limit);
83 // ===================== Legacy and/or internal API ===========================
85 /// \brief Converts an entity field to resource type.
86 /// \param[in] res_field Entity field to convert.
87 /// \return Resource type (a RES_* constant).
88 int GetResourceType(.float res_field);
90 /// \brief Converts resource type (a RES_* constant) to entity field.
91 /// \param[in] res_type Type of the resource.
92 /// \return Entity field for that resource.
93 .float GetResourceField(int res_type);