1/* 2Copyright (C) 1996-1997 Id Software, Inc. 3 4This program is free software; you can redistribute it and/or 5modify it under the terms of the GNU General Public License 6as published by the Free Software Foundation; either version 2 7of the License, or (at your option) any later version. 8 9This program is distributed in the hope that it will be useful, 10but WITHOUT ANY WARRANTY; without even the implied warranty of 11MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. 12 13See the GNU General Public License for more details. 14 15You should have received a copy of the GNU General Public License 16along with this program; if not, write to the Free Software 17Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. 18 19*/ 20// cvar.h 21 22/* 23 24cvar_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 25in C code. 26 27it is sufficient to initialize a cvar_t with just the first two fields, or 28you can add a ,true flag for variables that you want saved to the configuration 29file when the game is quit: 30 31cvar_t r_draworder = {"r_draworder","1"}; 32cvar_t scr_screensize = {"screensize","1",true}; 33 34Cvars 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: 35Cvar_RegisterVariable (&host_framerate); 36 37 38C code usually just references a cvar in place: 39if ( r_draworder.value ) 40 41It could optionally ask for the value to be looked up for a string name: 42if (Cvar_VariableValue ("r_draworder")) 43 44Interpreted prog code can access cvars with the cvar(name) or 45cvar_set (name, value) internal functions: 46teamplay = cvar("teamplay"); 47cvar_set ("registered", "1"); 48 49The user can access cvars from the console in two ways: 50r_draworder prints the current value 51r_draworder 0 sets the current value to 0 52Cvars are restricted from having the same names as commands to keep this 53interface from being ambiguous. 54*/ 55 56typedef struct cvar_s 57{ 58 char *name; 59 char *string; 60 qboolean archive; // set to true to cause it to be saved to vars.rc 61 qboolean info; // added to serverinfo or userinfo when changed 62 float value; 63 struct cvar_s *next; 64} cvar_t; 65 66// Helper macro to avoid missing initializer warnings 67#define CVAR2(NAME, STRING) {(NAME),(STRING), 0, 0, 0.0f, (struct cvar_s*) 0} 68#define CVAR3(NAME, STRING, ARCHIVE) {(NAME), (STRING), (ARCHIVE), 0, 0.0f, (struct cvar_s*) 0} 69#define CVAR4(NAME, STRING, ARCHIVE, INFO) {(NAME), (STRING), (ARCHIVE), (INFO), 0.0f, (struct cvar_s*) 0} 70 71void Cvar_RegisterVariable (cvar_t *variable); 72// registers a cvar that allready has the name, string, and optionally the 73// archive elements set. 74 75void Cvar_Set (char *var_name, char *value); 76// equivelant to "<name> <variable>" typed at the console 77 78void Cvar_SetValue (char *var_name, float value); 79// expands value to a string and calls Cvar_Set 80 81float Cvar_VariableValue (char *var_name); 82// returns 0 if not defined or non numeric 83 84char *Cvar_VariableString (char *var_name); 85// returns an empty string if not defined 86 87char *Cvar_CompleteVariable (char *partial); 88// attempts to match a partial variable name for command line completion 89// returns NULL if nothing fits 90 91qboolean Cvar_Command (void); 92// called by Cmd_ExecuteString when Cmd_Argv(0) doesn't match a known 93// command. Returns true if the command was a variable reference that 94// was handled. (print or change) 95 96void Cvar_WriteVariables (FILE *f); 97// Writes lines containing "set variable value" for all variables 98// with the archive flag set to true. 99 100cvar_t *Cvar_FindVar (char *var_name); 101 102extern cvar_t *cvar_vars; 103