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