data/qcsrc/server/scores.qh

   1 float scores_initialized; // 1 when scores labels/rules have been set
   2 .float scores[MAX_SCORE];
   3 .float teamscores[MAX_TEAMSCORE];
   4
   5 /**
   6  * Attaches a PlayerScore entity to a player. Use that in ClientConnect.
   7  * Remember to detach it in ClientDisconnect!
   8  */
   9 void PlayerScore_Attach(entity player);
  10
  11 /**
  12  * Detaches a PlayerScore entity from the player. Use that in ClientDisconnect.
  13  */
  14 void PlayerScore_Detach(entity player);
  15
  16 /**
  17  * Adds a score to the player's scores.
  18  * NEVER call this if PlayerScore_Attach has not been called yet!
  19  * Means: FIXME make players unable to join the game when not called ClientConnect yet.
  20  * Returns the new score.
  21  */
  22 float PlayerScore_Add(entity player, float scorefield, float score);
  23
  24 /**
  25  * Initialize the score of this player if needed.
  26  * Does nothing in teamplay.
  27  * Use that when a spectator becomes a player.
  28  */
  29 void PlayerScore_Clear(entity player);
  30
  31 /**
  32  * Adds a score to the player's team's scores.
  33  * NEVER call this if team has not been set yet!
  34  * Returns the new score.
  35  */
  36 float TeamScore_Add(entity player, float scorefield, float score);
  37
  38 /**
  39  * Adds a score to the given team.
  40  * NEVER call this if team has not been set yet!
  41  * Returns the new score.
  42  */
  43 float TeamScore_AddToTeam(float t, float scorefield, float score);
  44
  45 /**
  46  * Returns a value indicating the team score (and higher is better).
  47  */
  48 float TeamScore_GetCompareValue(float t);
  49
  50 /**
  51  * Adds a score to both the player and the team. Returns the team score if
  52  * possible, otherwise the player score.
  53  */
  54 float PlayerTeamScore_Add(entity player, float pscorefield, float tscorefield, float score);
  55
  56 /**
  57  * Adds to the generic score fields for both the player and the team.
  58  */
  59 #define PlayerTeamScore_AddScore(p,s) PlayerTeamScore_Add(p, SP_SCORE, ST_SCORE, s)
  60
  61 /**
  62  * Set the label of a team score item, as well as the scoring flags.
  63  */
  64 void ScoreInfo_SetLabel_TeamScore(float i, string label, float scoreflags);
  65
  66 /**
  67  * Set the label of a player score item, as well as the scoring flags.
  68  */
  69 void ScoreInfo_SetLabel_PlayerScore(float i, string label, float scoreflags);
  70
  71 /**
  72  * Initialize the scores info for the given number of teams.
  73  * Set all labels right before this call.
  74  */
  75 void ScoreInfo_Init(float teams);
  76
  77 /**
  78  * Writes the scores info to the given stream. Use this in ClientConnect to
  79  * notify newly connecting players.
  80  */
  81 void ScoreInfo_Write(float targ);
  82
  83 /**
  84  * Clear ALL scores (for ready-restart).
  85  */
  86 void Score_ClearAll();
  87
  88 /**
  89  * Prints the scores to the console of a player.
  90  */
  91 void Score_NicePrint(entity to);
  92
  93 /**
  94  * Sets the following results for the current scores entities.
  95  */
  96 void WinningConditionHelper();
  97 float WinningConditionHelper_topscore;   ///< highest score
  98 float WinningConditionHelper_equality;   ///< 1 if and only if the top two have equal scores
  99 float WinningConditionHelper_winnerteam; ///< the color of the winning team, or -1 if none
 100 entity WinningConditionHelper_winner;    ///< the winning player, or world if none
 101 float WinningConditionHelper_lowerisbetter; ///< lower is better, duh
 102 float WinningConditionHelper_zeroisworst;   ///< zero is worst, duh
 103 #define WINNINGCONDITIONHELPER_LOWERISBETTER_WORST 999999999
 104
 105 /**
 106  * Returns score strings for eventlog etc.
 107  * When called with world, or 0, as argument, they return the labels in the
 108  * same order.
 109  * The strings are comma separated; labels that end with !! designate primary,
 110  * labels that end with ! designate high priority.
 111  * Labels get an appended < if the scores are better if smaller (e.g. deaths).
 112  * High priorities always come first.
 113  * Example label string: score!!,kills,deaths<,suicides<
 114  * If shortString is set, only the sort keys are returned.
 115  */
 116 string GetPlayerScoreString(entity pl, float shortString);
 117 string GetTeamScoreString(float tm, float shortString);
 118
 119 /**
 120  * Sorts the players and stores their place in the given field, starting with
 121  * 1. Non-players get 0 written into that field.
 122  * Returns the beginning of a sorted chain of the non-spectators.
 123  */
 124 entity PlayerScore_Sort(.float field);