DK/ExperienceValueHelper.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
#pragma once

#include <cstdlib>
class EntitySystem;

/**
 * Namespace containing auxiliary functions that help with the management
 * of the experience value component.
 */
namespace ExperienceValueHelper
{
	/**
	 * Brief: Sets the experience value a given entity is worth.
	 * Param: Entity system containing the entity.
	 * Param: ID of the entity.
	 * Param: The new experience value.
	 */
	void set(EntitySystem&, std::size_t, std::size_t);

	/**
	 * Brief: Returns the experience value a given entity is worth.
	 * Param: Entity system containing the entity.
	 * Param: ID of the entity.
	 */
	std::size_t get(EntitySystem&, std::size_t);

	/**
	 * Brief: Increases the experience value a given entity is worth
	 *        by a given value.
	 * Param: Entity system containing the entity.
	 * Param: ID of the entity.
	 * Param: The value to increase by.
	 */
	void increase(EntitySystem&, std::size_t, std::size_t);

	/**
	 * Brief: Decreases the experience value a given entity is worth
	 *        by a given value.
	 * Param: Entity system containing the entity.
	 * Param: ID of the entity.
	 * Param: The value to decrease by.
	 */
	void decrease(EntitySystem&, std::size_t, std::size_t);
}