qcsrc/server/teamplay.qh

   1 #pragma once
   2
   3 bool lockteams;
   4
   5 // ========================== Global teams API ================================
   6
   7 /// \brief Returns the global team entity at the given index.
   8 /// \param[in] index Index of the team.
   9 /// \return Global team entity at the given index.
  10 entity Team_GetTeamFromIndex(int index);
  11
  12 /// \brief Returns the global team entity that corresponds to the given TEAM_NUM
  13 /// value.
  14 /// \param[in] team_num Team value. See TEAM_NUM constants.
  15 /// \return Global team entity that corresponds to the given TEAM_NUM value.
  16 entity Team_GetTeam(int team_num);
  17
  18 // ========================= Team specific API ================================
  19
  20 /// \brief Returns the score of the team.
  21 /// \param[in] team_ent Team entity.
  22 /// \return Score of the team.
  23 float Team_GetTeamScore(entity team_ent);
  24
  25 /// \brief Sets the score of the team.
  26 /// \param[in,out] team_ent Team entity.
  27 /// \param[in] score Score to set.
  28 void Team_SetTeamScore(entity team_ent, float score);
  29
  30 /// \brief Returns the number of alive players in a team.
  31 /// \param[in] team_ent Team entity.
  32 /// \return Number of alive players in a team.
  33 int Team_GetNumberOfAlivePlayers(entity team_ent);
  34
  35 /// \brief Sets the number of alive players in a team.
  36 /// \param[in,out] team_ent Team entity.
  37 /// \param[in] number Number of players to set.
  38 void Team_SetNumberOfAlivePlayers(entity team_ent, int number);
  39
  40 /// \brief Returns the number of alive teams.
  41 /// \return Number of alive teams.
  42 int Team_GetNumberOfAliveTeams();
  43
  44 /// \brief Returns the number of control points owned by a team.
  45 /// \param[in] team_ent Team entity.
  46 /// \return Number of control points owned by a team.
  47 int Team_GetNumberOfControlPoints(entity team_ent);
  48
  49 /// \brief Sets the number of control points owned by a team.
  50 /// \param[in,out] team_ent Team entity.
  51 /// \param[in] number Number of control points to set.
  52 void Team_SetNumberOfControlPoints(entity team_ent, int number);
  53
  54 /// \brief Returns the number of teams that own control points.
  55 /// \return Number of teams that own control points.
  56 int Team_GetNumberOfTeamsWithControlPoints();
  57
  58 // ======================= Entity specific API ================================
  59
  60 void setcolor(entity this, int clr);
  61
  62 /// \brief Returns whether the given entity belongs to a valid team.
  63 /// \param[in] this Entity to check.
  64 /// \return True if entity belongs to a valid team, false otherwise.
  65 bool Entity_HasValidTeam(entity this);
  66
  67 /// \brief Returns the team index of the given entity.
  68 /// \param[in] this Entity to check.
  69 /// \return Team index of the entity.
  70 int Entity_GetTeamIndex(entity this);
  71
  72 /// \brief Returns the team entity of the given entity.
  73 /// \param[in] this Entity to check.
  74 /// \return Team entity of the given entity or NULL if the entity doesn't belong
  75 /// to any team.
  76 entity Entity_GetTeam(entity this);
  77
  78 void SetPlayerColors(entity player, float _color);
  79
  80 /// \brief Sets the team of the player using its index.
  81 /// \param[in,out] player Player to adjust.
  82 /// \param[in] index Index of the team to set.
  83 /// \return True if team switch was successful, false otherwise.
  84 bool Player_SetTeamIndex(entity player, int index);
  85
  86 enum
  87 {
  88         TEAM_CHANGE_AUTO = 2, ///< The team was selected by autobalance.
  89         TEAM_CHANGE_MANUAL = 3, ///< Player has manually selected their team.
  90         TEAM_CHANGE_SPECTATOR = 4 ///< Player is joining spectators. //TODO: Remove?
  91 };
  92
  93 /// \brief Sets the team of the player.
  94 /// \param[in,out] player Player to adjust.
  95 /// \param[in] team_index Index of the team to set.
  96 /// \param[in] type Type of the team change. See TEAM_CHANGE constants.
  97 /// \return True if team switch was successful, false otherwise.
  98 bool SetPlayerTeam(entity player, int team_index, int type);
  99
 100 /// \brief Sets the team of the player with all sanity checks.
 101 /// \param[in,out] player Player to adjust.
 102 /// \param[in] team_index Index of the team to set.
 103 void Player_SetTeamIndexChecked(entity player, int team_index);
 104
 105 /// \brief Moves player to the specified team.
 106 /// \param[in,out] client Client to move.
 107 /// \param[in] team_index Index of the team.
 108 /// \param[in] type ???
 109 /// \return True on success, false otherwise.
 110 bool MoveToTeam(entity client, int team_index, int type);
 111
 112 enum
 113 {
 114         TEAM_FORCE_SPECTATOR = -1, ///< Force the player to spectator team.
 115         TEAM_FORCE_DEFAULT = 0 ///< Don't force any team.
 116 };
 117
 118 /// \brief Returns whether player has real forced team. Spectator team is
 119 /// ignored.
 120 /// \param[in] player Player to check.
 121 /// \return True if player has real forced team, false otherwise.
 122 bool Player_HasRealForcedTeam(entity player);
 123
 124 /// \brief Returns the index of the forced team of the given player.
 125 /// \param[in] player Player to check.
 126 /// \return Index of the forced team.
 127 int Player_GetForcedTeamIndex(entity player);
 128
 129 /// \brief Sets the index of the forced team of the given player.
 130 /// \param[in,out] player Player to adjust.
 131 /// \param[in] team_index Index of the team to set.
 132 void Player_SetForcedTeamIndex(entity player, int team_index);
 133
 134 /// \brief Determines the forced team of the player using current global config.
 135 /// \param[in,out] player Player to adjust.
 136 void Player_DetermineForcedTeam(entity player);
 137
 138 // ========================= Team balance API =================================
 139
 140 /// \brief Assigns the given player to a team that will make the game most
 141 /// balanced.
 142 /// \param[in,out] player Player to assign.
 143 void TeamBalance_JoinBestTeam(entity player);
 144
 145 /// \brief Checks whether the player can join teams according to global
 146 /// configuration and mutator settings.
 147 /// \param[in] for_whom Player to check for. Pass NULL for global rules.
 148 /// \return Team balance entity that holds information about teams. This entity
 149 /// will be automatically destroyed on the next frame but you are encouraged to
 150 /// manually destroy it by calling TeamBalance_Destroy for performance reasons.
 151 entity TeamBalance_CheckAllowedTeams(entity for_whom);
 152
 153 /// \brief Destroy the team balance entity.
 154 /// \param[in,out] balance Team balance entity to destroy.
 155 /// \note Team balance entity is allowed to be NULL.
 156 void TeamBalance_Destroy(entity balance);
 157
 158 /// \brief Returns the bitmask of allowed teams.
 159 /// \param[in] balance Team balance entity.
 160 /// \return Bitmask of allowed teams.
 161 int TeamBalance_GetAllowedTeams(entity balance);
 162
 163 /// \brief Returns whether the team change to the specified team is allowed.
 164 /// \param[in] balance Team balance entity.
 165 /// \param[in] index Index of the team.
 166 /// \return True if team change to the specified team is allowed, false
 167 /// otherwise.
 168 bool TeamBalance_IsTeamAllowed(entity balance, int index);
 169
 170 /// \brief Counts the number of players and various other information about
 171 /// each team.
 172 /// \param[in,out] balance Team balance entity.
 173 /// \param[in] ignore Player to ignore. This is useful if you plan to switch the
 174 /// player's team. Pass NULL for global information.
 175 /// \note This function updates the internal state of the team balance entity.
 176 void TeamBalance_GetTeamCounts(entity balance, entity ignore);
 177
 178 /// \brief Returns the number of players (both humans and bots) in a team.
 179 /// \param[in] balance Team balance entity.
 180 /// \param[in] index Index of the team.
 181 /// \return Number of player (both humans and bots) in a team.
 182 /// \note You need to call TeamBalance_GetTeamCounts before calling this
 183 /// function.
 184 int TeamBalance_GetNumberOfPlayers(entity balance, int index);
 185
 186 /// \brief Finds the team that will make the game most balanced if the player
 187 /// joins it.
 188 /// \param[in] balance Team balance entity.
 189 /// \param[in] player Player to check.
 190 /// \param[in] ignore_player ???
 191 /// \return Index of the team that will make the game most balanced if the
 192 /// player joins it. If there are several equally good teams available, the
 193 /// function will pick a random one.
 194 int TeamBalance_FindBestTeam(entity balance, entity player, bool ignore_player);
 195
 196 /// \brief Returns the bitmask of the teams that will make the game most
 197 /// balanced if the player joins any of them.
 198 /// \param[in] balance Team balance entity.
 199 /// \param[in] player Player to check.
 200 /// \param[in] use_score Whether to take into account team scores.
 201 /// \return Bitmask of the teams that will make the game most balanced if the
 202 /// player joins any of them.
 203 /// \note You need to call TeamBalance_GetTeamCounts before calling this
 204 /// function.
 205 int TeamBalance_FindBestTeams(entity balance, entity player, bool use_score);
 206
 207 /// \brief Describes the result of comparing teams.
 208 enum
 209 {
 210         TEAMS_COMPARE_INVALID, ///< One or both teams are invalid.
 211         TEAMS_COMPARE_LESS, ///< First team is less than the second one.
 212         TEAMS_COMPARE_EQUAL, ///< Both teams are equal.
 213         TEAMS_COMPARE_GREATER ///< First team the greater than the second one.
 214 };
 215
 216 /// \brief Compares two teams for the purposes of game balance.
 217 /// \param[in] balance Team balance entity.
 218 /// \param[in] team_index_a Index of the first team.
 219 /// \param[in] team_index_b Index of the second team.
 220 /// \param[in] player Player to check.
 221 /// \param[in] use_score Whether to take into account team scores.
 222 /// \return TEAMS_COMPARE value. See above.
 223 /// \note You need to call TeamBalance_GetTeamCounts before calling this
 224 /// function.
 225 int TeamBalance_CompareTeams(entity balance, int team_index_a, int team_index_b,
 226         entity player, bool use_score);
 227
 228 /// \brief Switches a bot from one team to another if teams are not balanced.
 229 void TeamBalance_AutoBalanceBots();
 230
 231 /// \brief Returns the index of the team with most players that is contained in
 232 /// the given bitmask of teams.
 233 /// \param[in] balance Team balance entity.
 234 /// \param[in] teams Bitmask of teams to search in.
 235 /// \return Index of the team with most players.
 236 int TeamBalance_GetLargestTeamIndex(entity balance, int teams);
 237
 238 /// \brief Returns the player who is the most suitable for switching between
 239 /// the given teams.
 240 /// \param[in] source_team_index Index of the team to search in.
 241 /// \param[in] destination_team_index Index of the team to switch to.
 242 /// \param[in] is_bot True to search for bot, false for human.
 243 /// \return Player who is the most suitable for switching between the given
 244 /// teams or NULL if not found.
 245 entity TeamBalance_GetPlayerForTeamSwitch(int source_team_index,
 246         int destination_team_index, bool is_bot);
 247
 248 // ============================ Internal API ==================================
 249
 250 void LogTeamChange(float player_id, float team_number, int type);
 251
 252 /// \brief Kills player as a result of team change.
 253 /// \param[in,out] player Player to kill.
 254 void KillPlayerForTeamChange(entity player);
 255
 256 /// \brief Returns whether the team change to the specified team is allowed.
 257 /// \param[in] balance Team balance entity.
 258 /// \param[in] index Index of the team.
 259 /// \return True if team change to the specified team is allowed, false
 260 /// otherwise.
 261 /// \note This function bypasses all the sanity checks.
 262 bool TeamBalance_IsTeamAllowedInternal(entity balance, int index);
 263
 264 /// \brief Bans team change to all teams except the given one.
 265 /// \param[in,out] balance Team balance entity.
 266 /// \param[in] index Index of the team.
 267 void TeamBalance_BanTeamsExcept(entity balance, int index);
 268
 269 /// \brief Returns the team entity of the team balance entity at the given
 270 /// index.
 271 /// \param[in] balance Team balance entity.
 272 /// \param[in] index Index of the team.
 273 /// \return Team entity of the team balance entity at the given index.
 274 entity TeamBalance_GetTeamFromIndex(entity balance, int index);
 275
 276 /// \brief Returns the team entity of the team balance entity that corresponds
 277 /// to the given TEAM_NUM value.
 278 /// \param[in] balance Team balance entity.
 279 /// \param[in] team_num Team value. See TEAM_NUM constants.
 280 /// \return Team entity of the team balance entity that corresponds to the given
 281 /// TEAM_NUM value.
 282 entity TeamBalance_GetTeam(entity balance, int team_num);
 283
 284 /// \brief Returns whether the team is allowed.
 285 /// \param[in] team_ent Team entity.
 286 /// \return True if team is allowed, false otherwise.
 287 bool TeamBalanceTeam_IsAllowed(entity team_ent);
 288
 289 /// \brief Returns the number of players (both humans and bots) in a team.
 290 /// \param[in] team_ent Team entity.
 291 /// \return Number of player (both humans and bots) in a team.
 292 /// \note You need to call TeamBalance_GetTeamCounts before calling this
 293 /// function.
 294 int TeamBalanceTeam_GetNumberOfPlayers(entity team_ent);
 295
 296 /// \brief Returns the number of bots in a team.
 297 /// \param[in] team_ent Team entity.
 298 /// \return Number of bots in a team.
 299 /// \note You need to call TeamBalance_GetTeamCounts before calling this
 300 /// function.
 301 int TeamBalanceTeam_GetNumberOfBots(entity team_ent);
 302
 303 /// \brief Compares two teams for the purposes of game balance.
 304 /// \param[in] team_a First team.
 305 /// \param[in] team_b Second team.
 306 /// \param[in] player Player to check.
 307 /// \param[in] use_score Whether to take into account team scores.
 308 /// \return TEAMS_COMPARE value. See above.
 309 /// \note You need to call TeamBalance_GetTeamCounts before calling this
 310 /// function.
 311 int TeamBalance_CompareTeamsInternal(entity team_a, entity team_index_b,
 312         entity player, bool use_score);
 313
 314 /// \brief Called when the player connects or when they change their color with
 315 /// the "color" command.
 316 /// \param[in,out] player Player that requested a new color.
 317 /// \param[in] new_color Requested color.
 318 void SV_ChangeTeam(entity player, int new_color);