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 // values at init (for Cvar_RestoreInitState)
85 qbool initstate; // indicates this existed at init
87 const char *initstring;
88 const char *initdescription;
92 const char *initdefstring;
94 int globaldefindex[3];
95 int globaldefindex_stringno[3];
100 typedef struct cvar_hash_s
103 struct cvar_hash_s *next;
106 typedef struct cvar_state_s
109 cvar_hash_t *hashtable[CVAR_HASHSIZE];
113 extern cvar_state_t cvars_all;
114 extern cvar_state_t cvars_null; // used by cmd_serverfromclient which intentionally has no cvars available
116 void Cvar_RegisterAlias(cvar_t *variable, const char *alias );
118 void Cvar_RegisterCallback(cvar_t *variable, void (*callback)(cvar_t *));
120 /// registers a cvar that already has the name, string, and optionally the
121 /// archive elements set.
122 void Cvar_RegisterVariable(cvar_t *variable);
124 qbool Cvar_Readonly (cvar_t *var, const char *cmd_name);
126 /// equivelant to "<name> <variable>" typed at the console
127 void Cvar_Set (cvar_state_t *cvars, const char *var_name, const char *value);
129 /// expands value to a string and calls Cvar_Set
130 void Cvar_SetValue (cvar_state_t *cvars, const char *var_name, float value);
132 void Cvar_SetQuick (cvar_t *var, const char *value);
133 void Cvar_SetValueQuick (cvar_t *var, float value);
135 float Cvar_VariableValueOr (cvar_state_t *cvars, const char *var_name, float def, int neededflags);
136 // returns def if not defined
138 float Cvar_VariableValue (cvar_state_t *cvars, const char *var_name, int neededflags);
139 // returns 0 if not defined or non numeric
141 const char *Cvar_VariableStringOr (cvar_state_t *cvars, const char *var_name, const char *def, int neededflags);
142 // returns def if not defined
144 const char *Cvar_VariableString (cvar_state_t *cvars, const char *var_name, int neededflags);
145 // returns an empty string if not defined
147 const char *Cvar_VariableDefString (cvar_state_t *cvars, const char *var_name, int neededflags);
148 // returns an empty string if not defined
150 const char *Cvar_VariableDescription (cvar_state_t *cvars, const char *var_name, int neededflags);
151 // returns an empty string if not defined
153 const char *Cvar_CompleteVariable (cvar_state_t *cvars, const char *partial, int neededflags);
154 // attempts to match a partial variable name for command line completion
155 // returns NULL if nothing fits
157 void Cvar_PrintHelp(cvar_t *cvar, const char *name, qbool full);
159 void Cvar_CompleteCvarPrint (cvar_state_t *cvars, const char *partial, int neededflags);
161 qbool Cvar_Command (struct cmd_state_s *cmd);
162 // called by Cmd_ExecuteString when Cmd_Argv(cmd, 0) doesn't match a known
163 // command. Returns true if the command was a variable reference that
164 // was handled. (print or change)
166 void Cvar_SaveInitState(cvar_state_t *cvars);
167 void Cvar_RestoreInitState(cvar_state_t *cvars);
169 void Cvar_UnlockDefaults(struct cmd_state_s *cmd);
170 void Cvar_LockDefaults_f(struct cmd_state_s *cmd);
171 void Cvar_ResetToDefaults_All_f(struct cmd_state_s *cmd);
172 void Cvar_ResetToDefaults_NoSaveOnly_f(struct cmd_state_s *cmd);
173 void Cvar_ResetToDefaults_SaveOnly_f(struct cmd_state_s *cmd);
175 void Cvar_WriteVariables (cvar_state_t *cvars, struct qfile_s *f);
176 // Writes lines containing "set variable value" for all variables
177 // with the archive flag set to true.
179 cvar_t *Cvar_FindVar(cvar_state_t *cvars, const char *var_name, int neededflags);
180 cvar_t *Cvar_FindVarAfter(cvar_state_t *cvars, const char *prev_var_name, int neededflags);
182 int Cvar_CompleteCountPossible(cvar_state_t *cvars, const char *partial, int neededflags);
183 const char **Cvar_CompleteBuildList(cvar_state_t *cvars, const char *partial, int neededflags);
184 // Added by EvilTypeGuy - functions for tab completion system
185 // Thanks to Fett erich@heintz.com
188 /// Prints a list of Cvars including a count of them to the user console
189 /// Referenced in cmd.c in Cmd_Init hence it's inclusion here.
190 /// Added by EvilTypeGuy eviltypeguy@qeradiant.com
191 /// Thanks to Matthias "Maddes" Buecher, http://www.inside3d.com/qip/
192 void Cvar_List_f(struct cmd_state_s *cmd);
194 void Cvar_Set_f(struct cmd_state_s *cmd);
195 void Cvar_SetA_f(struct cmd_state_s *cmd);
196 void Cvar_Del_f(struct cmd_state_s *cmd);
197 // commands to create new cvars (or set existing ones)
198 // seta creates an archived cvar (saved to config)
200 /// allocates a cvar by name and returns its address,
201 /// or merely sets its value if it already exists.
202 cvar_t *Cvar_Get(cvar_state_t *cvars, const char *name, const char *value, int flags, const char *newdescription);
204 extern const char *cvar_dummy_description; // ALWAYS the same pointer
206 void Cvar_UpdateAllAutoCvars(cvar_state_t *cvars); // updates ALL autocvars of the active prog to the cvar values (savegame loading)
208 #ifdef FILLALLCVARSWITHRUBBISH
209 void Cvar_FillAll_f(cmd_state_t *cmd);
210 #endif /* FILLALLCVARSWITHRUBBISH */