X-Git-Url: http://git.xonotic.org/?a=blobdiff_plain;ds=sidebyside;f=qcsrc%2Fserver%2Fteamplay.qh;h=e589a176f139890b69610505eaa87641b97d03e9;hb=8e3930dd6ce711211188ec1783293033d434fca7;hp=1813db04d8d111387a6a1667c6033e9b2e890f6c;hpb=20ccc31755c6fb06ac47ab99105a6d6ab35beee2;p=xonotic%2Fxonotic-data.pk3dir.git diff --git a/qcsrc/server/teamplay.qh b/qcsrc/server/teamplay.qh index 1813db04d..e589a176f 100644 --- a/qcsrc/server/teamplay.qh +++ b/qcsrc/server/teamplay.qh @@ -3,34 +3,29 @@ string cache_mutatormsg; string cache_lastmutatormsg; -// The following variables are used for balancing. They are not updated -// automatically. You need to call CheckAllowedTeams and GetTeamCounts to get -// proper values. - -// These four have 2 different states. If they are equal to -1, it means that -// the player can't join the team. Zero or positive value means that player can -// join the team and means the number of players on that team. -float c1; -float c2; -float c3; -float c4; -float num_bots_team1; ///< Number of bots in the first team. -float num_bots_team2; ///< Number of bots in the second team. -float num_bots_team3; ///< Number of bots in the third team. -float num_bots_team4; ///< Number of bots in the fourth team. -entity lowest_human_team1; ///< Human with the lowest score in the first team. -entity lowest_human_team2; ///< Human with the lowest score in the second team. -entity lowest_human_team3; ///< Human with the lowest score in the third team. -entity lowest_human_team4; ///< Human with the lowest score in the fourth team. -entity lowest_bot_team1; ///< Bot with the lowest score in the first team. -entity lowest_bot_team2; ///< Bot with the lowest score in the second team. -entity lowest_bot_team3; ///< Bot with the lowest score in the third team. -entity lowest_bot_team4; ///< Bot with the lowest score in the fourth team. +/// \brief Returns the global team entity at the given index. +/// \param[in] index Index of the team. +/// \return Global team entity at the given index. +entity Team_GetTeamFromIndex(int index); + +/// \brief Returns the global team entity that corresponds to the given TEAM_NUM +/// value. +/// \param[in] team_num Team value. See TEAM_NUM constants. +/// \return Global team entity that corresponds to the given TEAM_NUM value. +entity Team_GetTeam(int team_num); + +/// \brief Returns the score of the team. +/// \param[in] team_ Team entity. +/// \return Score of the team. +float Team_GetTeamScore(entity team_); + +/// \brief Sets the score of the team. +/// \param[in,out] team_ Team entity. +/// \param[in] score Score to set. +void Team_SetTeamScore(entity team_, float score); int redowned, blueowned, yellowowned, pinkowned; -//float audit_teams_time; - void TeamchangeFrags(entity e); void LogTeamchange(float player_id, float team_number, float type); @@ -43,11 +38,12 @@ string GetClientVersionMessage(entity this); string getwelcomemessage(entity this); +void setcolor(entity this, int clr); + void SetPlayerColors(entity player, float _color); /// \brief Kills player as a result of team change. /// \param[in,out] player Player to kill. -/// \return No return. void KillPlayerForTeamChange(entity player); /// \brief Sets the team of the player. @@ -58,63 +54,180 @@ bool SetPlayerTeamSimple(entity player, int team_num); /// \brief Sets the team of the player. /// \param[in,out] player Player to adjust. -/// \param[in] destination_team Team to set. -/// \param[in] source_team Previous team of the player. +/// \param[in] destination_team_index Index of the team to set. +/// \param[in] source_team_index Previous index of the team of the player. /// \param[in] no_print Whether to print this event to players' console. /// \return True if team switch was successful, false otherwise. -bool SetPlayerTeam(entity player, int destination_team, int source_team, - bool no_print); - -// set c1...c4 to show what teams are allowed -void CheckAllowedTeams(entity for_whom); - -float PlayerValue(entity p); - -// c1...c4 should be set to -1 (not allowed) or 0 (allowed). -// teams that are allowed will now have their player counts stored in c1...c4 -void GetTeamCounts(entity ignore); - -/// \brief Returns whether one team is smaller than the other. -/// \param[in] team_a First team. -/// \param[in] team_b Second team. +bool SetPlayerTeam(entity player, int destination_team_index, + int source_team_index, bool no_print); + +// ========================= Team balance API ================================= + +/// \brief Checks whether the player can join teams according to global +/// configuration and mutator settings. +/// \param[in] for_whom Player to check for. Pass NULL for global rules. +/// \return Team balance entity that holds information about teams. This entity +/// must be manually destroyed by calling TeamBalance_Destroy. +entity TeamBalance_CheckAllowedTeams(entity for_whom); + +/// \brief Destroy the team balance entity. +/// \param[in,out] balance Team balance entity to destroy. +/// \note Team balance entity is allowed to be NULL. +void TeamBalance_Destroy(entity balance); + +/// \brief Returns the bitmask of allowed teams. +/// \param[in] balance Team balance entity. +/// \return Bitmask of allowed teams. +int TeamBalance_GetAllowedTeams(entity balance); + +/// \brief Returns whether the team change to the specified team is allowed. +/// \param[in] balance Team balance entity. +/// \param[in] index Index of the team. +/// \return True if team change to the specified team is allowed, false +/// otherwise. +bool TeamBalance_IsTeamAllowed(entity balance, int index); + +/// \brief Counts the number of players and various other information about +/// each team. +/// \param[in,out] balance Team balance entity. +/// \param[in] ignore Player to ignore. This is useful if you plan to switch the +/// player's team. Pass NULL for global information. +/// \note This function updates the internal state of the team balance entity. +void TeamBalance_GetTeamCounts(entity balance, entity ignore); + +/// \brief Returns the number of players (both humans and bots) in a team. +/// \param[in] balance Team balance entity. +/// \param[in] index Index of the team. +/// \return Number of player (both humans and bots) in a team. +/// \note You need to call TeamBalance_GetTeamCounts before calling this +/// function. +int TeamBalance_GetNumberOfPlayers(entity balance, int index); + +/// \brief Finds the team that will make the game most balanced if the player +/// joins it. +/// \param[in] balance Team balance entity. /// \param[in] player Player to check. -/// \param[in] use_score Whether to take into account team scores. -/// \return True if first team is smaller than the second one, false otherwise. -/// \note This function assumes that CheckAllowedTeams and GetTeamCounts have -/// been called. -bool IsTeamSmallerThanTeam(int team_a, int team_b, entity player, - bool use_score); - -/// \brief Returns whether one team is equal to the other. -/// \param[in] team_a First team. -/// \param[in] team_b Second team. +/// \param[in] ignore_player ??? +/// \return Index of the team that will make the game most balanced if the +/// player joins it. If there are several equally good teams available, the +/// function will pick a random one. +int TeamBalance_FindBestTeam(entity balance, entity player, bool ignore_player); + +/// \brief Returns the bitmask of the teams that will make the game most +/// balanced if the player joins any of them. +/// \param[in] balance Team balance entity. /// \param[in] player Player to check. /// \param[in] use_score Whether to take into account team scores. -/// \return True if first team is equal to the second one, false otherwise. -/// \note This function assumes that CheckAllowedTeams and GetTeamCounts have -/// been called. -bool IsTeamEqualToTeam(int team_a, int team_b, entity player, bool use_score); - -/// \brief Returns the bitmask of the best teams for the player to join. +/// \return Bitmask of the teams that will make the game most balanced if the +/// player joins any of them. +/// \note You need to call TeamBalance_GetTeamCounts before calling this +/// function. +int TeamBalance_FindBestTeams(entity balance, entity player, bool use_score); + +void TeamBalance_JoinBestTeam(entity this, bool force_best_team); + +/// \brief Describes the result of comparing teams. +enum +{ + TEAMS_COMPARE_INVALID, ///< One or both teams are invalid. + TEAMS_COMPARE_LESS, ///< First team is less than the second one. + TEAMS_COMPARE_EQUAL, ///< Both teams are equal. + TEAMS_COMPARE_GREATER ///< First team the greater than the second one. +}; + +/// \brief Compares two teams for the purposes of game balance. +/// \param[in] balance Team balance entity. +/// \param[in] team_index_a Index of the first team. +/// \param[in] team_index_b Index of the second team. /// \param[in] player Player to check. /// \param[in] use_score Whether to take into account team scores. -/// \return Bitmask of the best teams for the player to join. -/// \note This function assumes that CheckAllowedTeams and GetTeamCounts have -/// been called. -int FindBestTeams(entity player, bool use_score); - -// returns # of smallest team (1, 2, 3, 4) -// NOTE: Assumes CheckAllowedTeams has already been called! -int FindSmallestTeam(entity player, float ignore_player); - -int JoinBestTeam(entity this, bool only_return_best, bool force_best_team); +/// \return TEAMS_COMPARE value. See above. +/// \note You need to call TeamBalance_GetTeamCounts before calling this +/// function. +int TeamBalance_CompareTeams(entity balance, int team_index_a, int team_index_b, + entity player, bool use_score); /// \brief Auto balances bots in teams after the player has changed team. -/// \param[in] source_team Previous team of the player (1, 2, 3, 4). -/// \param[in] destination_team Current team of the player (1, 2, 3, 4). -/// \return No return. -/// \note This function assumes that CheckAllowedTeams and GetTeamCounts have -/// been called. -void AutoBalanceBots(int source_team, int destination_team); - -void setcolor(entity this, int clr); +/// \param[in] balance Team balance entity. +/// \param[in] source_team_index Previous index of the team of the player. +/// \param[in] destination_team_index Current index of the team of the player. +/// \note You need to call CheckAllowedTeams and GetTeamCounts before calling +/// this function. +void TeamBalance_AutoBalanceBots(entity balance, int source_team_index, + int destination_team_index); + +// ============================ Internal API ================================== + +/// \brief Returns whether the team change to the specified team is allowed. +/// \param[in] balance Team balance entity. +/// \param[in] index Index of the team. +/// \return True if team change to the specified team is allowed, false +/// otherwise. +/// \note This function bypasses all the sanity checks. +bool TeamBalance_IsTeamAllowedInternal(entity balance, int index); + +/// \brief Bans team change to all teams except the given one. +/// \param[in,out] balance Team balance entity. +/// \param[in] index Index of the team. +void TeamBalance_BanTeamsExcept(entity balance, int index); + +/// \brief Returns the team entity of the team balance entity at the given +/// index. +/// \param[in] balance Team balance entity. +/// \param[in] index Index of the team. +/// \return Team entity of the team balance entity at the given index. +entity TeamBalance_GetTeamFromIndex(entity balance, int index); + +/// \brief Returns the team entity of the team balance entity that corresponds +/// to the given TEAM_NUM value. +/// \param[in] balance Team balance entity. +/// \param[in] team_num Team value. See TEAM_NUM constants. +/// \return Team entity of the team balance entity that corresponds to the given +/// TEAM_NUM value. +entity TeamBalance_GetTeam(entity balance, int team_num); + +/// \brief Returns whether the team is allowed. +/// \param[in] team_ Team entity. +/// \return True if team is allowed, false otherwise. +bool TeamBalanceTeam_IsAllowed(entity team_); + +/// \brief Returns the number of players (both humans and bots) in a team. +/// \param[in] team_ Team entity. +/// \return Number of player (both humans and bots) in a team. +/// \note You need to call TeamBalance_GetTeamCounts before calling this +/// function. +int TeamBalanceTeam_GetNumberOfPlayers(entity team_); + +/// \brief Returns the number of bots in a team. +/// \param[in] team_ Team entity. +/// \return Number of bots in a team. +/// \note You need to call TeamBalance_GetTeamCounts before calling this +/// function. +int TeamBalanceTeam_GetNumberOfBots(entity team_); + +/// \brief Returns the human with the lowest score in a team or NULL if there is +/// none. +/// \param[in] team_ Team entity. +/// \return Human with the lowest score in a team or NULL if there is none. +/// \note You need to call TeamBalance_GetTeamCounts before calling this +/// function. +entity TeamBalanceTeam_GetLowestHuman(entity team_); + +/// \brief Returns the bot with the lowest score in a team or NULL if there is +/// none. +/// \param[in] team_ Team entity. +/// \return Bot with the lowest score in a team or NULL if there is none. +/// \note You need to call TeamBalance_GetTeamCounts before calling this +/// function. +entity TeamBalanceTeam_GetLowestBot(entity team_); + +/// \brief Compares two teams for the purposes of game balance. +/// \param[in] team_a First team. +/// \param[in] team_b Second team. +/// \param[in] player Player to check. +/// \param[in] use_score Whether to take into account team scores. +/// \return TEAMS_COMPARE value. See above. +/// \note You need to call TeamBalance_GetTeamCounts before calling this +/// function. +int TeamBalance_CompareTeamsInternal(entity team_a, entity team_index_b, + entity player, bool use_score);