added Cvar_UnlockDefaults function (not console accessible)
[divverent/darkplaces.git] / cvar.h
1 /*
2 Copyright (C) 1996-1997 Id Software, Inc.
3
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.
8
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.
12
13 See the GNU General Public License for more details.
14
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.
18
19 */
20 // cvar.h
21
22 /*
23
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
25 in C code.
26
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:
30
31 cvar_t  r_draworder = {"r_draworder","1"};
32 cvar_t  scr_screensize = {"screensize","1",true};
33
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);
36
37
38 C code usually just references a cvar in place:
39 if ( r_draworder.value )
40
41 It could optionally ask for the value to be looked up for a string name:
42 if (Cvar_VariableValue ("r_draworder"))
43
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");
48
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.
54 */
55
56 #ifndef CVAR_H
57 #define CVAR_H
58
59 // cvar flags
60
61 #define CVAR_SAVE 1
62 #define CVAR_NOTIFY 2
63 #define CVAR_READONLY 4
64 #define CVAR_SERVERINFO 8
65 #define CVAR_USERINFO 16
66 // CVAR_PRIVATE means do not $ expand or sendcvar this cvar under any circumstances (rcon_password uses this)
67 #define CVAR_PRIVATE 32
68 // used to determine if flags is valid
69 #define CVAR_MAXFLAGSVAL 63
70 // for internal use only!
71 #define CVAR_DEFAULTSET (1<<30)
72 #define CVAR_ALLOCATED (1<<31)
73
74 /*
75 // type of a cvar for menu purposes
76 #define CVARMENUTYPE_FLOAT 1
77 #define CVARMENUTYPE_INTEGER 2
78 #define CVARMENUTYPE_SLIDER 3
79 #define CVARMENUTYPE_BOOL 4
80 #define CVARMENUTYPE_STRING 5
81 #define CVARMENUTYPE_OPTION 6
82
83 // which menu to put a cvar in
84 #define CVARMENU_GRAPHICS 1
85 #define CVARMENU_SOUND 2
86 #define CVARMENU_INPUT 3
87 #define CVARMENU_NETWORK 4
88 #define CVARMENU_SERVER 5
89
90 #define MAX_CVAROPTIONS 16
91
92 typedef struct cvaroption_s
93 {
94         int value;
95         const char *name;
96 }
97 cvaroption_t;
98
99 typedef struct menucvar_s
100 {
101         int type;
102         float valuemin, valuemax, valuestep;
103         int numoptions;
104         cvaroption_t optionlist[MAX_CVAROPTIONS];
105 }
106 menucvar_t;
107 */
108
109 typedef struct cvar_s
110 {
111         int flags;
112
113         char *name;
114
115         char *string;
116         char *description;
117         int integer;
118         float value;
119         float vector[3];
120
121         char *defstring;
122
123         //menucvar_t menuinfo;
124         struct cvar_s *next;
125         struct cvar_s *nextonhashchain;
126 } cvar_t;
127
128 /*
129 void Cvar_MenuSlider(cvar_t *variable, int menu, float slider_min, float slider_max, float slider_step);
130 void Cvar_MenuBool(cvar_t *variable, int menu, const char *name_false, const char *name_true);
131 void Cvar_MenuFloat(cvar_t *variable, int menu, float range_min, float range_max);
132 void Cvar_MenuInteger(cvar_t *variable, int menu, int range_min, int range_max);
133 void Cvar_MenuString(cvar_t *variable, int menu);
134 void Cvar_MenuOption(cvar_t *variable, int menu, int value[16], const char *name[16]);
135 */
136
137 void Cvar_RegisterVariable (cvar_t *variable);
138 // registers a cvar that already has the name, string, and optionally the
139 // archive elements set.
140
141 void Cvar_Set (const char *var_name, const char *value);
142 // equivelant to "<name> <variable>" typed at the console
143
144 void Cvar_SetValue (const char *var_name, float value);
145 // expands value to a string and calls Cvar_Set
146
147 void Cvar_SetQuick (cvar_t *var, const char *value);
148 void Cvar_SetValueQuick (cvar_t *var, float value);
149
150 float Cvar_VariableValue (const char *var_name);
151 // returns 0 if not defined or non numeric
152
153 const char *Cvar_VariableString (const char *var_name);
154 // returns an empty string if not defined
155
156 const char *Cvar_VariableDefString (const char *var_name);
157 // returns an empty string if not defined
158
159 const char *Cvar_CompleteVariable (const char *partial);
160 // attempts to match a partial variable name for command line completion
161 // returns NULL if nothing fits
162
163 void Cvar_CompleteCvarPrint (const char *partial);
164
165 qboolean Cvar_Command (void);
166 // called by Cmd_ExecuteString when Cmd_Argv(0) doesn't match a known
167 // command.  Returns true if the command was a variable reference that
168 // was handled. (print or change)
169
170 void Cvar_UnlockDefaults (void);
171 void Cvar_LockDefaults_f (void);
172 void Cvar_ResetToDefaults_All_f (void);
173 void Cvar_ResetToDefaults_NoSaveOnly_f (void);
174 void Cvar_ResetToDefaults_SaveOnly_f (void);
175
176 void Cvar_WriteVariables (qfile_t *f);
177 // Writes lines containing "set variable value" for all variables
178 // with the archive flag set to true.
179
180 cvar_t *Cvar_FindVar (const char *var_name);
181 cvar_t *Cvar_FindVarAfter (const char *prev_var_name, int neededflags);
182
183 int Cvar_CompleteCountPossible (const char *partial);
184 const char **Cvar_CompleteBuildList (const char *partial);
185 // Added by EvilTypeGuy - functions for tab completion system
186 // Thanks to Fett erich@heintz.com
187 // Thanks to taniwha
188
189 void Cvar_List_f (void);
190 // Prints a list of Cvars including a count of them to the user console
191 // Referenced in cmd.c in Cmd_Init hence it's inclusion here
192 // Added by EvilTypeGuy eviltypeguy@qeradiant.com
193 // Thanks to Matthias "Maddes" Buecher, http://www.inside3d.com/qip/
194
195 void Cvar_Set_f (void);
196 void Cvar_SetA_f (void);
197 // commands to create new cvars (or set existing ones)
198 // seta creates an archived cvar (saved to config)
199
200 cvar_t *Cvar_Get (const char *name, const char *value, int flags);
201 // allocates a cvar by name and returns its address,
202 // or merely sets its value if it already exists.
203
204 #endif
205