]> de.git.xonotic.org Git - xonotic/xonotic-data.pk3dir.git/blob - qcsrc/common/mutators/mutator/random_items/sv_random_items.qh
Merge remote-tracking branch 'origin/terencehill/bot_waypoints' into terencehill...
[xonotic/xonotic-data.pk3dir.git] / qcsrc / common / mutators / mutator / random_items / sv_random_items.qh
1 #pragma once
2
3 /// \file
4 /// \brief Header file that describes the random items mutator.
5 /// \author Lyberta
6 /// \copyright GNU GPLv2 or any later version.
7
8 bool autocvar_g_random_items; ///< Whether to enable random items.
9
10 /// \brief Returns a random classname of the item.
11 /// \param[in] prefix Prefix of the cvars that hold probabilities.
12 /// \return Random classname of the item.
13 /// \note This function will automatically detect gamemode and use cvars from
14 /// that gamemode.
15 string RandomItems_GetRandomItemClassName(string prefix);
16
17 /// \brief Returns a random classname of the vanilla item.
18 /// \param[in] prefix Prefix of the cvars that hold probabilities.
19 /// \return Random classname of the vanilla item.
20 /// \note This includes mutator items that don't change gameplay a lot such as
21 /// jetpack and new toys.
22 string RandomItems_GetRandomVanillaItemClassName(string prefix);
23
24 /// \brief Returns a random classname of the instagib item.
25 /// \param[in] prefix Prefix of the cvars that hold probabilities.
26 /// \return Random classname of the instagib item.
27 string RandomItems_GetRandomInstagibItemClassName(string prefix);
28
29 /// \brief Returns a random classname of the overkill item.
30 /// \param[in] prefix Prefix of the cvars that hold probabilities.
31 /// \return Random classname of the overkill item.
32 string RandomItems_GetRandomOverkillItemClassName(string prefix);