DK/ManaCrystalHelper.hpp at master · halbich/DK · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
#pragma once

#include <cstdlib>
class EntitySystem;

/**
 * Auxiliary namespace that contains functions that help with the management
 * of the mana crystal component.
 */
namespace ManaCrystalHelper
{
	/**
	 * Brief: Sets the amount of max mana this entity adds
	 *        to the player's mana capacity.
	 * Param: EntitySystem that contains the entity.
	 * Param: ID of the entity.
	 * Param: The new capacity value.
	 */
	void set_capacity(EntitySystem&, std::size_t, std::size_t);

	/**
	 * Brief: Returns the amount of max mana this entity adds
	 *        to the player's mana capacity.
	 * Param: EntitySystem that contains the entity.
	 * Param: ID of the entity.
	 */
	std::size_t get_capacity(EntitySystem&, std::size_t);

	/**
	 * Brief: Sets the amount of mana regen this entity adds
	 *        to the player's total mana regen.
	 * Param: EntitySystem that contains the entity.
	 * Param: ID of the entity.
	 * Param: The new capacity value.
	 */
	void set_regen(EntitySystem&, std::size_t, std::size_t);

	/**
	 * Brief: Sets the amount of mana regen this entity adds
	 *        to the player's total mana regen.
	 * Param: EntitySystem that contains the entity.
	 * Param: ID of the entity.
	 */
	std::size_t get_regen(EntitySystem&, std::size_t);
}