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.
24 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
27 it is sufficient to initialize a cvar_t with just the first two fields, or
28 you can add a ,true flag for variables that you want saved to the configuration
29 file when the game is quit:
31 cvar_t r_draworder = {"r_draworder","1"};
32 cvar_t scr_screensize = {"screensize","1",true};
34 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:
35 Cvar_RegisterVariable (&host_framerate);
38 C code usually just references a cvar in place:
39 if ( r_draworder.value )
41 It could optionally ask for the value to be looked up for a string name:
42 if (Cvar_VariableValue ("r_draworder"))
44 Interpreted prog code can access cvars with the cvar(name) or
45 cvar_set (name, value) internal functions:
46 teamplay = cvar("teamplay");
47 cvar_set ("registered", "1");
49 The user can access cvars from the console in two ways:
50 r_draworder prints the current value
51 r_draworder 0 sets the current value to 0
52 Cvars are restricted from having the same names as commands to keep this
53 interface from being ambiguous.
71 const char *description;
76 const char *defstring;
78 void (*callback)(struct cvar_s *var);
79 qbool ignore_callback;
84 struct cvar_s *initstate; // snapshot of cvar during init
86 int globaldefindex[3];
87 int globaldefindex_stringno[3];
92 typedef struct cvar_hash_s
95 struct cvar_hash_s *next;
98 typedef struct cvar_state_s
101 cvar_hash_t *hashtable[CVAR_HASHSIZE];
105 extern cvar_state_t cvars_all;
106 extern cvar_state_t cvars_null; // used by cmd_serverfromclient which intentionally has no cvars available
108 void Cvar_RegisterAlias(cvar_t *variable, const char *alias );
110 void Cvar_RegisterCallback(cvar_t *variable, void (*callback)(cvar_t *));
112 /// registers a cvar that already has the name, string, and optionally the
113 /// archive elements set.
114 void Cvar_RegisterVariable(cvar_t *variable);
116 qbool Cvar_Readonly (cvar_t *var, const char *cmd_name);
118 /// equivelant to "<name> <variable>" typed at the console
119 void Cvar_Set (cvar_state_t *cvars, const char *var_name, const char *value);
121 /// expands value to a string and calls Cvar_Set
122 void Cvar_SetValue (cvar_state_t *cvars, const char *var_name, float value);
124 void Cvar_SetQuick (cvar_t *var, const char *value);
125 void Cvar_SetValueQuick (cvar_t *var, float value);
127 float Cvar_VariableValueOr (cvar_state_t *cvars, const char *var_name, float def, int neededflags);
128 // returns def if not defined
130 float Cvar_VariableValue (cvar_state_t *cvars, const char *var_name, int neededflags);
131 // returns 0 if not defined or non numeric
133 const char *Cvar_VariableStringOr (cvar_state_t *cvars, const char *var_name, const char *def, int neededflags);
134 // returns def if not defined
136 const char *Cvar_VariableString (cvar_state_t *cvars, const char *var_name, int neededflags);
137 // returns an empty string if not defined
139 const char *Cvar_VariableDefString (cvar_state_t *cvars, const char *var_name, int neededflags);
140 // returns an empty string if not defined
142 const char *Cvar_VariableDescription (cvar_state_t *cvars, const char *var_name, int neededflags);
143 // returns an empty string if not defined
145 const char *Cvar_CompleteVariable (cvar_state_t *cvars, const char *partial, int neededflags);
146 // attempts to match a partial variable name for command line completion
147 // returns NULL if nothing fits
149 void Cvar_PrintHelp(cvar_t *cvar, const char *name, qbool full);
151 void Cvar_CompleteCvarPrint (cvar_state_t *cvars, const char *partial, int neededflags);
153 qbool Cvar_Command (struct cmd_state_s *cmd);
154 // called by Cmd_ExecuteString when Cmd_Argv(cmd, 0) doesn't match a known
155 // command. Returns true if the command was a variable reference that
156 // was handled. (print or change)
158 void Cvar_SaveInitState(cvar_state_t *cvars);
159 void Cvar_RestoreInitState(cvar_state_t *cvars);
161 void Cvar_UnlockDefaults(struct cmd_state_s *cmd);
162 void Cvar_LockDefaults_f(struct cmd_state_s *cmd);
163 void Cvar_ResetToDefaults_All_f(struct cmd_state_s *cmd);
164 void Cvar_ResetToDefaults_NoSaveOnly_f(struct cmd_state_s *cmd);
165 void Cvar_ResetToDefaults_SaveOnly_f(struct cmd_state_s *cmd);
167 void Cvar_WriteVariables (cvar_state_t *cvars, struct qfile_s *f);
168 // Writes lines containing "set variable value" for all variables
169 // with the archive flag set to true.
171 cvar_t *Cvar_FindVar(cvar_state_t *cvars, const char *var_name, int neededflags);
172 cvar_t *Cvar_FindVarAfter(cvar_state_t *cvars, const char *prev_var_name, int neededflags);
174 int Cvar_CompleteCountPossible(cvar_state_t *cvars, const char *partial, int neededflags);
175 const char **Cvar_CompleteBuildList(cvar_state_t *cvars, const char *partial, int neededflags);
176 // Added by EvilTypeGuy - functions for tab completion system
177 // Thanks to Fett erich@heintz.com
180 /// Prints a list of Cvars including a count of them to the user console
181 /// Referenced in cmd.c in Cmd_Init hence it's inclusion here.
182 /// Added by EvilTypeGuy eviltypeguy@qeradiant.com
183 /// Thanks to Matthias "Maddes" Buecher, http://www.inside3d.com/qip/
184 void Cvar_List_f(struct cmd_state_s *cmd);
186 void Cvar_Set_f(struct cmd_state_s *cmd);
187 void Cvar_SetA_f(struct cmd_state_s *cmd);
188 void Cvar_Del_f(struct cmd_state_s *cmd);
189 // commands to create new cvars (or set existing ones)
190 // seta creates an archived cvar (saved to config)
192 /// allocates a cvar by name and returns its address,
193 /// or merely sets its value if it already exists.
194 cvar_t *Cvar_Get(cvar_state_t *cvars, const char *name, const char *value, int flags, const char *newdescription);
196 extern const char *cvar_dummy_description; // ALWAYS the same pointer
198 void Cvar_UpdateAllAutoCvars(cvar_state_t *cvars); // updates ALL autocvars of the active prog to the cvar values (savegame loading)
200 #ifdef FILLALLCVARSWITHRUBBISH
201 void Cvar_FillAll_f(cmd_state_t *cmd);
202 #endif /* FILLALLCVARSWITHRUBBISH */