]> de.git.xonotic.org Git - xonotic/xonotic-data.pk3dir.git/blob - qcsrc/server/teamplay.qh
Better team balance function names.
[xonotic/xonotic-data.pk3dir.git] / qcsrc / server / teamplay.qh
1 #pragma once
2
3 string cache_mutatormsg;
4 string cache_lastmutatormsg;
5
6 /// \brief Returns the global team entity at the given index.
7 /// \param[in] index Index of the team.
8 /// \return Global team entity at the given index.
9 entity Team_GetTeamFromIndex(int index);
10
11 /// \brief Returns the global team entity that corresponds to the given TEAM_NUM
12 /// value.
13 /// \param[in] team_num Team value. See TEAM_NUM constants.
14 /// \return Global team entity that corresponds to the given TEAM_NUM value.
15 entity Team_GetTeam(int team_num);
16
17 /// \brief Returns the score of the team.
18 /// \param[in] team_ Team entity.
19 /// \return Score of the team.
20 float Team_GetTeamScore(entity team_);
21
22 /// \brief Sets the score of the team.
23 /// \param[in,out] team_ Team entity.
24 /// \param[in] score Score to set.
25 void Team_SetTeamScore(entity team_, float score);
26
27 /// \brief Checks whether the player can join teams according to global
28 /// configuration and mutator settings.
29 /// \param[in] for_whom Player to check for. Pass NULL for global rules.
30 /// \note This function sets various internal variables and is required to be
31 /// called before several other functions.
32 void CheckAllowedTeams(entity for_whom);
33
34 /// \brief Returns the bitmask of allowed teams.
35 /// \return Bitmask of allowed teams.
36 /// \note You need to call CheckAllowedTeams before calling this function.
37 int GetAllowedTeams();
38
39 /// \brief Returns whether the team is allowed.
40 /// \param[in] team_ Team entity.
41 /// \return True if team is allowed, false otherwise.
42 /// \note You need to call CheckAllowedTeams before calling this function.
43 bool Team_IsAllowed(entity team_);
44
45 /// \brief Counts the number of players and various other information about
46 /// each team.
47 /// \param[in] ignore Player to ignore. This is useful if you plan to switch the
48 /// player's team. Pass NULL for global information.
49 /// \note You need to call CheckAllowedTeams before calling this function.
50 /// \note This function sets many internal variables and is required to be
51 /// called before several other functions.
52 void GetTeamCounts(entity ignore);
53
54 /// \brief Returns the number of players (both humans and bots) in a team.
55 /// \param[in] team_ Team entity.
56 /// \return Number of player (both humans and bots) in a team.
57 /// \note You need to call CheckAllowedTeams and GetTeamCounts before calling
58 /// this function.
59 int Team_GetNumberOfPlayers(entity team_);
60
61 /// \brief Returns the number of bots in a team.
62 /// \param[in] team_ Team entity.
63 /// \return Number of bots in a team.
64 /// \note You need to call CheckAllowedTeams and GetTeamCounts before calling
65 /// this function.
66 int Team_GetNumberOfBots(entity team_);
67
68 /// \brief Returns the human with the lowest score in a team or NULL if there is
69 /// none.
70 /// \param[in] team_ Team entity.
71 /// \return Human with the lowest score in a team or NULL if there is none.
72 /// \note You need to call CheckAllowedTeams and GetTeamCounts before calling
73 /// this function.
74 entity Team_GetLowestHuman(entity team_);
75
76 /// \brief Returns the bot with the lowest score in a team or NULL if there is
77 /// none.
78 /// \param[in] team_ Team entity.
79 /// \return Bot with the lowest score in a team or NULL if there is none.
80 /// \note You need to call CheckAllowedTeams and GetTeamCounts before calling
81 /// this function.
82 entity Team_GetLowestBot(entity team_);
83
84 int redowned, blueowned, yellowowned, pinkowned;
85
86 void TeamchangeFrags(entity e);
87
88 void LogTeamchange(float player_id, float team_number, float type);
89
90 void default_delayedinit(entity this);
91
92 void InitGameplayMode();
93
94 string GetClientVersionMessage(entity this);
95
96 string getwelcomemessage(entity this);
97
98 void setcolor(entity this, int clr);
99
100 void SetPlayerColors(entity player, float _color);
101
102 /// \brief Kills player as a result of team change.
103 /// \param[in,out] player Player to kill.
104 void KillPlayerForTeamChange(entity player);
105
106 /// \brief Sets the team of the player.
107 /// \param[in,out] player Player to adjust.
108 /// \param[in] team_num Team number to set. See TEAM_NUM constants.
109 /// \return True if team switch was successful, false otherwise.
110 bool SetPlayerTeamSimple(entity player, int team_num);
111
112 /// \brief Sets the team of the player.
113 /// \param[in,out] player Player to adjust.
114 /// \param[in] destination_team_index Index of the team to set.
115 /// \param[in] source_team_index Previous index of the team of the player.
116 /// \param[in] no_print Whether to print this event to players' console.
117 /// \return True if team switch was successful, false otherwise.
118 bool SetPlayerTeam(entity player, int destination_team_index,
119         int source_team_index, bool no_print);
120
121 /// \brief Returns the bitmask of the teams that will make the game most
122 /// balanced if the player joins any of them.
123 /// \param[in] player Player to check.
124 /// \param[in] use_score Whether to take into account team scores.
125 /// \return Bitmask of the teams that will make the game most balanced if the
126 /// player joins any of them.
127 /// \note You need to call CheckAllowedTeams and GetTeamCounts before calling
128 /// this function.
129 int FindBestTeamsForBalance(entity player, bool use_score);
130
131 /// \brief Finds the team that will make the game most balanced if the player
132 /// joins it.
133 /// \param[in] player Player to check.
134 /// \param[in] ignore_player ???
135 /// \return Index of the team that will make the game most balanced if the
136 /// player joins it. If there are several equally good teams available, the
137 /// function will pick a random one.
138 int FindBestTeamForBalance(entity player, float ignore_player);
139
140 void JoinBestTeamForBalance(entity this, bool force_best_team);
141
142 /// \brief Returns whether one team is smaller than the other.
143 /// \param[in] team_index_a Index of the first team.
144 /// \param[in] team_index_b Index of the second team.
145 /// \param[in] player Player to check.
146 /// \param[in] use_score Whether to take into account team scores.
147 /// \return True if first team is smaller than the second one, false otherwise.
148 /// \note You need to call CheckAllowedTeams and GetTeamCounts before calling
149 /// this function.
150 bool IsTeamSmallerThanTeam(int team_index_a, int team_index_b, entity player,
151         bool use_score);
152
153 /// \brief Returns whether one team is equal to the other.
154 /// \param[in] team_index_a Index of the first team.
155 /// \param[in] team_index_b Index of the second team.
156 /// \param[in] player Player to check.
157 /// \param[in] use_score Whether to take into account team scores.
158 /// \return True if first team is equal to the second one, false otherwise.
159 /// \note You need to call CheckAllowedTeams and GetTeamCounts before calling
160 /// this function.
161 bool IsTeamEqualToTeam(int team_index_a, int team_index_b, entity player,
162         bool use_score);
163
164 /// \brief Auto balances bots in teams after the player has changed team.
165 /// \param[in] source_team_index Previous index of the team of the player.
166 /// \param[in] destination_team_index Current index of the team of the player.
167 /// \note You need to call CheckAllowedTeams and GetTeamCounts before calling
168 /// this function.
169 void AutoBalanceBots(int source_team_index, int destination_team_index);