2 Copyright (C) 1996-1997 Id Software, Inc.
4 This program is free software; you can redistribute it and/or
5 modify it under the terms of the GNU General Public License
6 as published by the Free Software Foundation; either version 2
7 of the License, or (at your option) any later version.
9 This program is distributed in the hope that it will be useful,
10 but WITHOUT ANY WARRANTY; without even the implied warranty of
11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
13 See the GNU General Public License for more details.
15 You should have received a copy of the GNU General Public License
16 along with this program; if not, write to the Free Software
17 Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
23 typedef struct cmd_state_s cmd_state_t;
27 cvar_t variables are used to hold scalar or string variables that can be changed or displayed at the console or prog code as well as accessed directly
30 it is sufficient to initialize a cvar_t with just the first two fields, or
31 you can add a ,true flag for variables that you want saved to the configuration
32 file when the game is quit:
34 cvar_t r_draworder = {"r_draworder","1"};
35 cvar_t scr_screensize = {"screensize","1",true};
37 Cvars must be registered before use, or they will have a 0 value instead of the float interpretation of the string. Generally, all cvar_t declarations should be registered in the apropriate init function before any console commands are executed:
38 Cvar_RegisterVariable (&host_framerate);
41 C code usually just references a cvar in place:
42 if ( r_draworder.value )
44 It could optionally ask for the value to be looked up for a string name:
45 if (Cvar_VariableValue ("r_draworder"))
47 Interpreted prog code can access cvars with the cvar(name) or
48 cvar_set (name, value) internal functions:
49 teamplay = cvar("teamplay");
50 cvar_set ("registered", "1");
52 The user can access cvars from the console in two ways:
53 r_draworder prints the current value
54 r_draworder 0 sets the current value to 0
55 Cvars are restricted from having the same names as commands to keep this
56 interface from being ambiguous.
66 #define CVAR_READONLY 4
67 #define CVAR_SERVERINFO 8
68 #define CVAR_USERINFO 16
69 // CVAR_PRIVATE means do not $ expand or sendcvar this cvar under any circumstances (rcon_password uses this)
70 #define CVAR_PRIVATE 32
71 // this means that this cvar should update a userinfo key but the name does not correspond directly to the userinfo key to update, and may require additional conversion ("_cl_color" for example should update "topcolor" and "bottomcolor")
72 #define CVAR_NQUSERINFOHACK 64
73 // for engine-owned cvars that must not be reset on gametype switch (e.g. scr_screenshot_name, which otherwise isn't set to the mod name properly)
74 #define CVAR_NORESETTODEFAULTS 128
75 // cvar is accessible in client
76 #define CVAR_CLIENT 256
77 // cvar is accessible in dedicated server
78 #define CVAR_SERVER 512
79 // used to determine if flags is valid
80 #define CVAR_MAXFLAGSVAL 1023
81 // for internal use only!
82 #define CVAR_DEFAULTSET (1<<30)
83 #define CVAR_ALLOCATED (1<<31)
86 // type of a cvar for menu purposes
87 #define CVARMENUTYPE_FLOAT 1
88 #define CVARMENUTYPE_INTEGER 2
89 #define CVARMENUTYPE_SLIDER 3
90 #define CVARMENUTYPE_BOOL 4
91 #define CVARMENUTYPE_STRING 5
92 #define CVARMENUTYPE_OPTION 6
94 // which menu to put a cvar in
95 #define CVARMENU_GRAPHICS 1
96 #define CVARMENU_SOUND 2
97 #define CVARMENU_INPUT 3
98 #define CVARMENU_NETWORK 4
99 #define CVARMENU_SERVER 5
101 #define MAX_CVAROPTIONS 16
103 typedef struct cvaroption_s
110 typedef struct menucvar_s
113 float valuemin, valuemax, valuestep;
115 cvaroption_t optionlist[MAX_CVAROPTIONS];
120 typedef struct cvar_s
127 const char *description;
132 const char *defstring;
134 void (*callback)(char *value);
139 // values at init (for Cvar_RestoreInitState)
140 qboolean initstate; // indicates this existed at init
142 const char *initstring;
143 const char *initdescription;
147 const char *initdefstring;
149 int globaldefindex[3];
150 int globaldefindex_stringno[3];
152 //menucvar_t menuinfo;
156 typedef struct cvar_hash_s
159 struct cvar_hash_s *next;
162 typedef struct cvar_state_s
165 cvar_hash_t *hashtable[CVAR_HASHSIZE];
169 extern cvar_state_t cvars_all;
170 extern cvar_state_t cvars_null; // used by cmd_serverfromclient which intentionally has no cvars available
173 void Cvar_MenuSlider(cvar_t *variable, int menu, float slider_min, float slider_max, float slider_step);
174 void Cvar_MenuBool(cvar_t *variable, int menu, const char *name_false, const char *name_true);
175 void Cvar_MenuFloat(cvar_t *variable, int menu, float range_min, float range_max);
176 void Cvar_MenuInteger(cvar_t *variable, int menu, int range_min, int range_max);
177 void Cvar_MenuString(cvar_t *variable, int menu);
178 void Cvar_MenuOption(cvar_t *variable, int menu, int value[16], const char *name[16]);
182 void Cvar_RegisterAlias(cvar_t *variable, const char *alias );
184 void Cvar_RegisterCallback(cvar_t *variable, void (*callback)(char *));
186 /// registers a cvar that already has the name, string, and optionally the
187 /// archive elements set.
188 void Cvar_RegisterVariable(cvar_t *variable);
190 qboolean Cvar_Readonly (cvar_t *var, const char *cmd_name);
192 /// equivelant to "<name> <variable>" typed at the console
193 void Cvar_Set (cvar_state_t *cvars, const char *var_name, const char *value);
195 /// expands value to a string and calls Cvar_Set
196 void Cvar_SetValue (cvar_state_t *cvars, const char *var_name, float value);
198 void Cvar_SetQuick (cvar_t *var, const char *value);
199 void Cvar_SetValueQuick (cvar_t *var, float value);
201 float Cvar_VariableValueOr (cvar_state_t *cvars, const char *var_name, float def, int neededflags);
202 // returns def if not defined
204 float Cvar_VariableValue (cvar_state_t *cvars, const char *var_name, int neededflags);
205 // returns 0 if not defined or non numeric
207 const char *Cvar_VariableStringOr (cvar_state_t *cvars, const char *var_name, const char *def, int neededflags);
208 // returns def if not defined
210 const char *Cvar_VariableString (cvar_state_t *cvars, const char *var_name, int neededflags);
211 // returns an empty string if not defined
213 const char *Cvar_VariableDefString (cvar_state_t *cvars, const char *var_name, int neededflags);
214 // returns an empty string if not defined
216 const char *Cvar_VariableDescription (cvar_state_t *cvars, const char *var_name, int neededflags);
217 // returns an empty string if not defined
219 const char *Cvar_CompleteVariable (cvar_state_t *cvars, const char *partial, int neededflags);
220 // attempts to match a partial variable name for command line completion
221 // returns NULL if nothing fits
223 void Cvar_PrintHelp(cvar_t *cvar, const char *name, qboolean full);
225 void Cvar_CompleteCvarPrint (cvar_state_t *cvars, const char *partial, int neededflags);
227 qboolean Cvar_Command (cmd_state_t *cmd);
228 // called by Cmd_ExecuteString when Cmd_Argv(cmd, 0) doesn't match a known
229 // command. Returns true if the command was a variable reference that
230 // was handled. (print or change)
232 void Cvar_SaveInitState(cvar_state_t *cvars);
233 void Cvar_RestoreInitState(cvar_state_t *cvars);
235 void Cvar_UnlockDefaults(cmd_state_t *cmd);
236 void Cvar_LockDefaults_f(cmd_state_t *cmd);
237 void Cvar_ResetToDefaults_All_f(cmd_state_t *cmd);
238 void Cvar_ResetToDefaults_NoSaveOnly_f(cmd_state_t *cmd);
239 void Cvar_ResetToDefaults_SaveOnly_f(cmd_state_t *cmd);
241 void Cvar_WriteVariables (cvar_state_t *cvars, qfile_t *f);
242 // Writes lines containing "set variable value" for all variables
243 // with the archive flag set to true.
245 cvar_t *Cvar_FindVar(cvar_state_t *cvars, const char *var_name, int neededflags);
246 cvar_t *Cvar_FindVarAfter(cvar_state_t *cvars, const char *prev_var_name, int neededflags);
248 int Cvar_CompleteCountPossible(cvar_state_t *cvars, const char *partial, int neededflags);
249 const char **Cvar_CompleteBuildList(cvar_state_t *cvars, const char *partial, int neededflags);
250 // Added by EvilTypeGuy - functions for tab completion system
251 // Thanks to Fett erich@heintz.com
254 /// Prints a list of Cvars including a count of them to the user console
255 /// Referenced in cmd.c in Cmd_Init hence it's inclusion here.
256 /// Added by EvilTypeGuy eviltypeguy@qeradiant.com
257 /// Thanks to Matthias "Maddes" Buecher, http://www.inside3d.com/qip/
258 void Cvar_List_f(cmd_state_t *cmd);
260 void Cvar_Set_f(cmd_state_t *cmd);
261 void Cvar_SetA_f(cmd_state_t *cmd);
262 void Cvar_Del_f(cmd_state_t *cmd);
263 // commands to create new cvars (or set existing ones)
264 // seta creates an archived cvar (saved to config)
266 /// allocates a cvar by name and returns its address,
267 /// or merely sets its value if it already exists.
268 cvar_t *Cvar_Get(cvar_state_t *cvars, const char *name, const char *value, int flags, const char *newdescription);
270 extern const char *cvar_dummy_description; // ALWAYS the same pointer
272 void Cvar_UpdateAllAutoCvars(cvar_state_t *cvars); // updates ALL autocvars of the active prog to the cvar values (savegame loading)
274 #ifdef FILLALLCVARSWITHRUBBISH
275 void Cvar_FillAll_f(cmd_state_t *cmd);
276 #endif /* FILLALLCVARSWITHRUBBISH */