summaryrefslogtreecommitdiff
path: root/sourcemod-1.5-dev/scripting/include/sdktools_gamerules.inc
blob: 6a5f7baf96b442c655b410ff404c8120fc82f0b7 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
/**
 * vim: set ts=4 :
 * =============================================================================
 * SourceMod (C)2004-2011 AlliedModders LLC.  All rights reserved.
 * =============================================================================
 *
 * This file is part of the SourceMod/SourcePawn SDK.
 *
 * This program is free software; you can redistribute it and/or modify it under
 * the terms of the GNU General Public License, version 3.0, as published by the
 * Free Software Foundation.
 * 
 * This program is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
 * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
 * details.
 *
 * You should have received a copy of the GNU General Public License along with
 * this program.  If not, see <http://www.gnu.org/licenses/>.
 *
 * As a special exception, AlliedModders LLC gives you permission to link the
 * code of this program (as well as its derivative works) to "Half-Life 2," the
 * "Source Engine," the "SourcePawn JIT," and any Game MODs that run on software
 * by the Valve Corporation.  You must obey the GNU General Public License in
 * all respects for all other code used.  Additionally, AlliedModders LLC grants
 * this exception to all derivative works.  AlliedModders LLC defines further
 * exceptions, found in LICENSE.txt (as of this writing, version JULY-31-2007),
 * or <http://www.sourcemod.net/license.php>.
 *
 * Version: $Id$
 */

#if defined _sdktools_gamerules_included
  #endinput
#endif
#define _sdktools_gamerules_included

enum RoundState {
	// initialize the game, create teams
	RoundState_Init,
	
	//Before players have joined the game. Periodically checks to see if enough players are ready
	//to start a game. Also reverts to this when there are no active players
	RoundState_Pregame,
	
	//The game is about to start, wait a bit and spawn everyone
	RoundState_StartGame,
	
	//All players are respawned, frozen in place
	RoundState_Preround,
	
	//Round is on, playing normally
	RoundState_RoundRunning,
	
	//Someone has won the round
	RoundState_TeamWin,
	
	//Noone has won, manually restart the game, reset scores
	RoundState_Restart,
	
	//Noone has won, restart the game
	RoundState_Stalemate,
	
	//Game is over, showing the scoreboard etc
	RoundState_GameOver,
	
	//Game is over, doing bonus round stuff
	RoundState_Bonus,
	
	//Between rounds
	RoundState_BetweenRounds,
};

/**
 * Retrieves an integer value from a property of the gamerules entity.
 * 
 * @param prop			Property name.
 * @param size			Number of bytes to read (valid values are 1, 2, or 4).
 *						This value is auto-detected, and the size parameter is 
 *						only used as a fallback in case detection fails.
 * @param element		Element # (starting from 0) if property is an array.
 * @return				Value at the given property offset.
 * @error				Not supported.
 */
native GameRules_GetProp(const String:prop[], size=4, element=0);

/**
 * Sets an integer value for a property of the gamerules entity.
 *
 * @param prop			Property name.
 * @param value			Value to set.
 * @param size			Number of bytes to write (valid values are 1, 2, or 4).
 *						This value is auto-detected, and the size parameter is 
 *						only used as a fallback in case detection fails.
 * @param element		Element # (starting from 0) if property is an array.
 * @param changeState	If true, change will be sent over the network.
 * @error				Not supported.
 * @noreturn
 */
native GameRules_SetProp(const String:prop[], any:value, size=4, element=0, bool:changeState=false);

/**
 * Retrieves a float value from a property of the gamerules entity.
 * 
 * @param prop			Property name.
 * @param element		Element # (starting from 0) if property is an array.
 * @return				Value at the given property offset.
 * @error				Not supported.
 */
native Float:GameRules_GetPropFloat(const String:prop[], element=0);

/**
 * Sets a float value for a property of the gamerules entity.
 * 
 * @param prop			Property name.
 * @param value			Value to set.
 * @param element		Element # (starting from 0) if property is an array.
 * @param changeState	If true, change will be sent over the network.
 * @noreturn
 * @error				Not supported.
 */
native GameRules_SetPropFloat(const String:prop[], Float:value, element=0, bool:changeState=false);

/**
 * Retrieves a entity index from a property of the gamerules entity.
 * 
 * @param prop			Property name.
 * @param element		Element # (starting from 0) if property is an array.
 * @return				Entity index at the given property.
 *						If there is no entity, or the entity is not valid, 
 *						then -1 is returned.
 * @error				Not supported.
 */
native GameRules_GetPropEnt(const String:prop[], element=0);

/**
 * Sets an entity index for a property of the gamerules entity.
 * 
 * @param prop			Property name.
 * @param other			Entity index to set, or -1 to unset.
 * @param element		Element # (starting from 0) if property is an array.
 * @param changeState	If true, change will be sent over the network.
 * @noreturn
 * @error				Not supported.
 */
native GameRules_SetPropEnt(const String:prop[], other, element=0, bool:changeState=false);

/**
 * Retrieves a vector of floats from the gamerules entity, given a named network property.
 * 
 * @param prop			Property name.
 * @param vec			Vector buffer to store data in.
 * @param element		Element # (starting from 0) if property is an array.
 * @noreturn
 * @error				Not supported.
 */
native GameRules_GetPropVector(const String:prop[], Float:vec[3], element=0);

/**
 * Sets a vector of floats in the gamerules entity, given a named network property.
 *
 * @param prop			Property name.
 * @param vec			Vector to set.
 * @param element		Element # (starting from 0) if property is an array.
 * @param changeState	If true, change will be sent over the network.
 * @noreturn
 * @error				Not supported.
 */
native GameRules_SetPropVector(const String:prop[], const Float:vec[3], element=0, bool:changeState=false);

/**
 * Gets a gamerules property as a string.
 * 
 * @param prop			Property to use.
 * @param buffer		Destination string buffer.
 * @param maxlen		Maximum length of output string buffer.
 * @return				Number of non-null bytes written.
 * @error				Not supported.
 */
native GameRules_GetPropString(const String:prop[], String:buffer[], maxlen);

/**
 * Sets a gamerules property as a string.
 *
 * @param prop			Property to use.
 * @param buffer		String to set.		
 * @param changeState	If true, change will be sent over the network.
 * @return				Number of non-null bytes written.
 * @error				Not supported.
 */
native GameRules_SetPropString(const String:prop[], const String:buffer[], bool:changeState=false);

/**
 * Gets the current round state.
 *
 * @return				Round state.
 * @error				Game doesn't support round state.
 */
stock RoundState:GameRules_GetRoundState()
{
	return RoundState:GameRules_GetProp("m_iRoundState");
}