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_ Team entity.
  22 /// \return Score of the team.
  23 float Team_GetTeamScore(entity team_);
  24
  25 /// \brief Sets the score of the team.
  26 /// \param[in,out] team_ Team entity.
  27 /// \param[in] score Score to set.
  28 void Team_SetTeamScore(entity team_, float score);
  29
  30 /// \brief Returns the number of alive players in a team.
  31 /// \param[in] team_ Team entity.
  32 /// \return Number of alive players in a team.
  33 int Team_GetNumberOfAlivePlayers(entity team_);
  34
  35 /// \brief Sets the number of alive players in a team.
  36 /// \param[in,out] team_ Team entity.
  37 /// \param[in] number Number of players to set.
  38 void Team_SetNumberOfAlivePlayers(entity team_, 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_ Team entity.
  46 /// \return Number of control points owned by a team.
  47 int Team_GetNumberOfControlPoints(entity team_);
  48
  49 /// \brief Sets the number of control points owned by a team.
  50 /// \param[in,out] team_ Team entity.
  51 /// \param[in] number Number of control points to set.
  52 void Team_SetNumberOfControlPoints(entity team_, 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.
  75 entity Entity_GetTeam(entity this);
  76
  77 void SetPlayerColors(entity player, float _color);
  78
  79 /// \brief Sets the team of the player using its index.
  80 /// \param[in,out] player Player to adjust.
  81 /// \param[in] index Index of the team to set.
  82 /// \return True if team switch was successful, false otherwise.
  83 bool Player_SetTeamIndex(entity player, int index);
  84
  85 /// \brief Sets the team of the player.
  86 /// \param[in,out] player Player to adjust.
  87 /// \param[in] destination_team_index Index of the team to set.
  88 /// \param[in] source_team_index Previous index of the team of the player.
  89 /// \param[in] no_print Whether to print this event to players' console.
  90 /// \return True if team switch was successful, false otherwise.
  91 bool SetPlayerTeam(entity player, int destination_team_index,
  92         int source_team_index, bool no_print);
  93
  94 /// \brief Moves player to the specified team.
  95 /// \param[in,out] client Client to move.
  96 /// \param[in] team_index Index of the team.
  97 /// \param[in] type ???
  98 /// \return True on success, false otherwise.
  99 bool MoveToTeam(entity client, int team_index, int type);
 100
 101 /// \brief Kills player as a result of team change.
 102 /// \param[in,out] player Player to kill.
 103 void KillPlayerForTeamChange(entity player);
 104
 105 enum
 106 {
 107         TEAM_CHANGE_CONNECT = 1,
 108         TEAM_CHANGE_AUTO = 2,
 109         TEAM_CHANGE_MANUAL = 3,
 110         TEAM_CHANGE_SPECTATOR = 4,
 111         TEAM_CHANGE_AUTO_RELAXED = 99
 112 };
 113
 114 void LogTeamchange(float player_id, float team_number, int type);
 115
 116 // ========================= Team balance API =================================
 117
 118 /// \brief Checks whether the player can join teams according to global
 119 /// configuration and mutator settings.
 120 /// \param[in] for_whom Player to check for. Pass NULL for global rules.
 121 /// \return Team balance entity that holds information about teams. This entity
 122 /// must be manually destroyed by calling TeamBalance_Destroy.
 123 entity TeamBalance_CheckAllowedTeams(entity for_whom);
 124
 125 /// \brief Destroy the team balance entity.
 126 /// \param[in,out] balance Team balance entity to destroy.
 127 /// \note Team balance entity is allowed to be NULL.
 128 void TeamBalance_Destroy(entity balance);
 129
 130 /// \brief Returns the bitmask of allowed teams.
 131 /// \param[in] balance Team balance entity.
 132 /// \return Bitmask of allowed teams.
 133 int TeamBalance_GetAllowedTeams(entity balance);
 134
 135 /// \brief Returns whether the team change to the specified team is allowed.
 136 /// \param[in] balance Team balance entity.
 137 /// \param[in] index Index of the team.
 138 /// \return True if team change to the specified team is allowed, false
 139 /// otherwise.
 140 bool TeamBalance_IsTeamAllowed(entity balance, int index);
 141
 142 /// \brief Counts the number of players and various other information about
 143 /// each team.
 144 /// \param[in,out] balance Team balance entity.
 145 /// \param[in] ignore Player to ignore. This is useful if you plan to switch the
 146 /// player's team. Pass NULL for global information.
 147 /// \note This function updates the internal state of the team balance entity.
 148 void TeamBalance_GetTeamCounts(entity balance, entity ignore);
 149
 150 /// \brief Returns the number of players (both humans and bots) in a team.
 151 /// \param[in] balance Team balance entity.
 152 /// \param[in] index Index of the team.
 153 /// \return Number of player (both humans and bots) in a team.
 154 /// \note You need to call TeamBalance_GetTeamCounts before calling this
 155 /// function.
 156 int TeamBalance_GetNumberOfPlayers(entity balance, int index);
 157
 158 /// \brief Finds the team that will make the game most balanced if the player
 159 /// joins it.
 160 /// \param[in] balance Team balance entity.
 161 /// \param[in] player Player to check.
 162 /// \param[in] ignore_player ???
 163 /// \return Index of the team that will make the game most balanced if the
 164 /// player joins it. If there are several equally good teams available, the
 165 /// function will pick a random one.
 166 int TeamBalance_FindBestTeam(entity balance, entity player, bool ignore_player);
 167
 168 /// \brief Returns the bitmask of the teams that will make the game most
 169 /// balanced if the player joins any of them.
 170 /// \param[in] balance Team balance entity.
 171 /// \param[in] player Player to check.
 172 /// \param[in] use_score Whether to take into account team scores.
 173 /// \return Bitmask of the teams that will make the game most balanced if the
 174 /// player joins any of them.
 175 /// \note You need to call TeamBalance_GetTeamCounts before calling this
 176 /// function.
 177 int TeamBalance_FindBestTeams(entity balance, entity player, bool use_score);
 178
 179 void TeamBalance_JoinBestTeam(entity this, bool force_best_team);
 180
 181 /// \brief Describes the result of comparing teams.
 182 enum
 183 {
 184         TEAMS_COMPARE_INVALID, ///< One or both teams are invalid.
 185         TEAMS_COMPARE_LESS, ///< First team is less than the second one.
 186         TEAMS_COMPARE_EQUAL, ///< Both teams are equal.
 187         TEAMS_COMPARE_GREATER ///< First team the greater than the second one.
 188 };
 189
 190 /// \brief Compares two teams for the purposes of game balance.
 191 /// \param[in] balance Team balance entity.
 192 /// \param[in] team_index_a Index of the first team.
 193 /// \param[in] team_index_b Index of the second team.
 194 /// \param[in] player Player to check.
 195 /// \param[in] use_score Whether to take into account team scores.
 196 /// \return TEAMS_COMPARE value. See above.
 197 /// \note You need to call TeamBalance_GetTeamCounts before calling this
 198 /// function.
 199 int TeamBalance_CompareTeams(entity balance, int team_index_a, int team_index_b,
 200         entity player, bool use_score);
 201
 202 /// \brief Auto balances bots in teams after the player has changed team.
 203 /// \param[in] balance Team balance entity.
 204 /// \param[in] source_team_index Previous index of the team of the player.
 205 /// \param[in] destination_team_index Current index of the team of the player.
 206 /// \note You need to call CheckAllowedTeams and GetTeamCounts before calling
 207 /// this function.
 208 void TeamBalance_AutoBalanceBots(entity balance, int source_team_index,
 209         int destination_team_index);
 210
 211 // ============================ Internal API ==================================
 212
 213 /// \brief Returns whether the team change to the specified team is allowed.
 214 /// \param[in] balance Team balance entity.
 215 /// \param[in] index Index of the team.
 216 /// \return True if team change to the specified team is allowed, false
 217 /// otherwise.
 218 /// \note This function bypasses all the sanity checks.
 219 bool TeamBalance_IsTeamAllowedInternal(entity balance, int index);
 220
 221 /// \brief Bans team change to all teams except the given one.
 222 /// \param[in,out] balance Team balance entity.
 223 /// \param[in] index Index of the team.
 224 void TeamBalance_BanTeamsExcept(entity balance, int index);
 225
 226 /// \brief Returns the team entity of the team balance entity at the given
 227 /// index.
 228 /// \param[in] balance Team balance entity.
 229 /// \param[in] index Index of the team.
 230 /// \return Team entity of the team balance entity at the given index.
 231 entity TeamBalance_GetTeamFromIndex(entity balance, int index);
 232
 233 /// \brief Returns the team entity of the team balance entity that corresponds
 234 /// to the given TEAM_NUM value.
 235 /// \param[in] balance Team balance entity.
 236 /// \param[in] team_num Team value. See TEAM_NUM constants.
 237 /// \return Team entity of the team balance entity that corresponds to the given
 238 /// TEAM_NUM value.
 239 entity TeamBalance_GetTeam(entity balance, int team_num);
 240
 241 /// \brief Returns whether the team is allowed.
 242 /// \param[in] team_ Team entity.
 243 /// \return True if team is allowed, false otherwise.
 244 bool TeamBalanceTeam_IsAllowed(entity team_);
 245
 246 /// \brief Returns the number of players (both humans and bots) in a team.
 247 /// \param[in] team_ Team entity.
 248 /// \return Number of player (both humans and bots) in a team.
 249 /// \note You need to call TeamBalance_GetTeamCounts before calling this
 250 /// function.
 251 int TeamBalanceTeam_GetNumberOfPlayers(entity team_);
 252
 253 /// \brief Returns the number of bots in a team.
 254 /// \param[in] team_ Team entity.
 255 /// \return Number of bots in a team.
 256 /// \note You need to call TeamBalance_GetTeamCounts before calling this
 257 /// function.
 258 int TeamBalanceTeam_GetNumberOfBots(entity team_);
 259
 260 /// \brief Returns the human with the lowest score in a team or NULL if there is
 261 /// none.
 262 /// \param[in] team_ Team entity.
 263 /// \return Human with the lowest score in a team or NULL if there is none.
 264 /// \note You need to call TeamBalance_GetTeamCounts before calling this
 265 /// function.
 266 entity TeamBalanceTeam_GetLowestHuman(entity team_);
 267
 268 /// \brief Returns the bot with the lowest score in a team or NULL if there is
 269 /// none.
 270 /// \param[in] team_ Team entity.
 271 /// \return Bot with the lowest score in a team or NULL if there is none.
 272 /// \note You need to call TeamBalance_GetTeamCounts before calling this
 273 /// function.
 274 entity TeamBalanceTeam_GetLowestBot(entity team_);
 275
 276 /// \brief Compares two teams for the purposes of game balance.
 277 /// \param[in] team_a First team.
 278 /// \param[in] team_b Second team.
 279 /// \param[in] player Player to check.
 280 /// \param[in] use_score Whether to take into account team scores.
 281 /// \return TEAMS_COMPARE value. See above.
 282 /// \note You need to call TeamBalance_GetTeamCounts before calling this
 283 /// function.
 284 int TeamBalance_CompareTeamsInternal(entity team_a, entity team_index_b,
 285         entity player, bool use_score);