cvar.h

Go to the documentation of this file.

/*
Copyright (C) 1997-2001 Id Software, Inc.

This program is free software; you can redistribute it and/or
modify it under the terms of the GNU General Public License
as published by the Free Software Foundation; either version 2
of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.

See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.

*/

#ifndef COMMON_CVAR
#define COMMON_CVAR

#define CVAR_ARCHIVE    1       
#define CVAR_USERINFO   2       
#define CVAR_SERVERINFO 4       
#define CVAR_NOSET      8       
#define CVAR_LATCH      16      
#define CVAR_DEVELOPER  32      
#define CVAR_CHEAT      64      
#define CVAR_R_IMAGES   128     
#define CVAR_R_CONTEXT    256     
#define CVAR_R_PROGRAMS 512     
#define CVAR_R_MASK (CVAR_R_IMAGES | CVAR_R_CONTEXT | CVAR_R_PROGRAMS)

typedef void (*cvarChangeListenerFunc_t) (const char *cvarName, const char *oldValue, const char *newValue);

typedef struct cvarListener_s {
    cvarChangeListenerFunc_t exec;
    struct cvarListener_s *next;
} cvarChangeListener_t;

typedef struct cvar_s {
    char *name;             
    char *string;           
    char *latchedString;    
    char *defaultString;    
    char *oldString;        
    char *description;      
    int flags;              
    qboolean modified;      
    float value;            
    int integer;            
    qboolean (*check) (struct cvar_s* cvar);    
    cvarChangeListener_t *changeListener;
    struct cvar_s *next;
    struct cvar_s *prev;
    struct cvar_s *hash_next;
} cvar_t;

typedef struct cvarList_s {
    const char *name;
    const char *value;
    cvar_t *var;
} cvarList_t;

cvar_t *Cvar_Get(const char *varName, const char *value, int flags, const char* desc);

cvar_t *Cvar_Set(const char *varName, const char *value);

cvar_t *Cvar_ForceSet(const char *varName, const char *value);

cvar_t *Cvar_FullSet(const char *varName, const char *value, int flags);

void Cvar_SetValue(const char *varName, float value);

int Cvar_GetInteger(const char *varName);

float Cvar_GetValue(const char *varName);

const char *Cvar_GetString(const char *varName);

const char *Cvar_VariableStringOld(const char *varName);

int Cvar_CompleteVariable(const char *partial, const char **match);

void Cvar_UpdateLatchedVars(void);

qboolean Cvar_Command(void);

void Cvar_Init(void);
void Cvar_Shutdown(void);

const char *Cvar_Userinfo(void);

const char *Cvar_Serverinfo(void);

qboolean Cvar_AssertValue(cvar_t * cvar, float minVal, float maxVal, qboolean shouldBeIntegral);

qboolean Cvar_AssertString(cvar_t * cvar, char **array, int arraySize);

qboolean Cvar_SetCheckFunction(const char *varName, qboolean (*check) (cvar_t* cvar));

void Cvar_RegisterChangeListener(const char *varName, cvarChangeListenerFunc_t listenerFunc);
void Cvar_UnRegisterChangeListener(const char *varName, cvarChangeListenerFunc_t listenerFunc);

void Cvar_FixCheatVars(void);

qboolean Cvar_Delete(const char *varName);

cvar_t *Cvar_FindVar(const char *varName);

qboolean Cvar_PendingCvars(int flags);

void Com_SetUserinfoModified(qboolean modified);

qboolean Com_IsUserinfoModified(void);

void Com_SetRenderModified(qboolean modified);

qboolean Com_IsRenderModified(void);

void Cvar_ClearVars(int flags);

#ifdef DEBUG
void Cvar_PrintDebugCvars(void);
#endif

#endif