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