1 entity scores_initialized; // non-world when scores labels/rules have been set
2 .float scores[MAX_SCORE];
3 .float teamscores[MAX_TEAMSCORE];
6 * Attaches a PlayerScore entity to a player. Use that in ClientConnect.
7 * Remember to detach it in ClientDisconnect!
9 void PlayerScore_Attach(entity player);
12 * Detaches a PlayerScore entity from the player. Use that in ClientDisconnect.
14 void PlayerScore_Detach(entity player);
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.
22 float PlayerScore_Add(entity player, float scorefield, float score);
25 * Initialize the score of this player if needed.
26 * Does nothing in teamplay.
27 * Use that when a spectator becomes a player.
29 void PlayerScore_Clear(entity player);
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.
36 float TeamScore_Add(entity player, float scorefield, float score);
39 * Adds a score to the given team.
40 * NEVER call this if team has not been set yet!
41 * Returns the new score.
43 float TeamScore_AddToTeam(float t, float scorefield, float score);
46 * Returns a value indicating the team score (and higher is better).
48 float TeamScore_GetCompareValue(float t);
51 * Adds a score to both the player and the team. Returns the team score if
52 * possible, otherwise the player score.
54 float PlayerTeamScore_Add(entity player, float pscorefield, float tscorefield, float score);
57 * Adds to the generic score fields for both the player and the team.
59 #define PlayerTeamScore_AddScore(p,s) PlayerTeamScore_Add(p, SP_SCORE, ST_SCORE, s)
62 * Set the label of a team score item, as well as the scoring flags.
64 void ScoreInfo_SetLabel_TeamScore(float i, string label, float scoreflags);
67 * Set the label of a player score item, as well as the scoring flags.
69 void ScoreInfo_SetLabel_PlayerScore(float i, string label, float scoreflags);
72 * Initialize the scores info for the given number of teams.
73 * Set all labels right before this call.
75 void ScoreInfo_Init(float teams);
78 * Clear ALL scores (for ready-restart).
80 void Score_ClearAll();
83 * Prints the scores to the console of a player.
85 void Score_NicePrint(entity to);
88 * Sets the following results for the current scores entities.
90 void WinningConditionHelper();
91 float WinningConditionHelper_topscore; ///< highest score
92 float WinningConditionHelper_secondscore; ///< second highest score
93 float WinningConditionHelper_winnerteam; ///< the color of the winning team, or -1 if none
94 float WinningConditionHelper_secondteam; ///< the color of the second team, or -1 if none
95 float WinningConditionHelper_equality; ///< we have no winner
96 entity WinningConditionHelper_winner; ///< the winning player, or world if none
97 entity WinningConditionHelper_second; ///< the second player, or world if none
98 float WinningConditionHelper_lowerisbetter; ///< lower is better, duh
99 float WinningConditionHelper_zeroisworst; ///< zero is worst, duh
100 #define WINNINGCONDITIONHELPER_LOWERISBETTER_WORST 999999999
103 * Returns score strings for eventlog etc.
104 * When called with world, or 0, as argument, they return the labels in the
106 * The strings are comma separated; labels that end with !! designate primary,
107 * labels that end with ! designate high priority.
108 * Labels get an appended < if the scores are better if smaller (e.g. deaths).
109 * High priorities always come first.
110 * Example label string: score!!,kills,deaths<,suicides<
111 * If shortString is set, only the sort keys are returned.
113 string GetPlayerScoreString(entity pl, float shortString);
114 string GetTeamScoreString(float tm, float shortString);
117 * Sorts the players and stores their place in the given field, starting with
118 * 1. Non-players get 0 written into that field.
119 * Returns the beginning of a sorted chain of the non-spectators.
121 entity PlayerScore_Sort(.float field);