cvar_s Struct Reference

This is a cvar definition. Cvars can be user modified and used in our menus e.g. More...

#include <cvar.h>

Data Fields
char *	name
char *	string
char *	latchedString
char *	defaultString
char *	oldString
char *	description
int	flags
bool	modified
float	value
int	integer
bool(*	check )(struct cvar_s *cvar)
cvarChangeListener_t *	changeListener
struct cvar_s *	next
struct cvar_s *	prev
struct cvar_s *	hash_next

Detailed Description

This is a cvar definition. Cvars can be user modified and used in our menus e.g.

Note

nothing outside the Cvar_*() functions should modify these fields!

Definition at line 71 of file cvar.h.

Field Documentation

cvarChangeListener_t* cvar_s::changeListener

Definition at line 83 of file cvar.h.

Referenced by Cvar_Delete(), Cvar_ExecuteChangeListener(), Cvar_RegisterChangeListener(), Cvar_UnRegisterChangeListener(), uiCvarNode::onWindowClosed(), and UI_RemoveCvarListener_f().

bool(* cvar_s::check)(struct cvar_s *cvar)

cvar check function

Definition at line 82 of file cvar.h.

Referenced by Cvar_Set2(), and Cvar_SetCheckFunction().

char* cvar_s::defaultString

default string set on first init - only set for CVAR_CHEAT

Definition at line 75 of file cvar.h.

Referenced by Cvar_Delete(), and Cvar_Get().

char* cvar_s::description

cvar description

Definition at line 77 of file cvar.h.

Referenced by Cvar_Delete(), and Cvar_Get().

int cvar_s::flags

cvar flags CVAR_ARCHIVE|CVAR_NOSET....

Definition at line 78 of file cvar.h.

Referenced by Cvar_Delete(), Cvar_FullSet(), Cvar_Get(), Cvar_Set2(), Cvar_Set_f(), Cvar_Switch_f(), GAMECvarListener::onGameModeChange(), SCR_Init(), SV_InitGame(), and SV_Shutdown().

struct cvar_s* cvar_s::hash_next

Definition at line 86 of file cvar.h.

Referenced by Cvar_Delete(), and Cvar_FindVar().

int cvar_s::integer

value as integer

Definition at line 81 of file cvar.h.

Referenced by actorL_morale(), AI_ActorRun(), AI_CheckRespawn(), AI_CreatePlayer(), AI_HideNeeded(), AI_PlayerRun(), AI_Run(), AIL_select(), AIL_squad(), CL_ActorMouseTrace(), CL_ActorMoveLength(), CL_ActorMoveMode(), CL_ActorMoveMouse(), CL_ActorSelectMouse(), CL_ActorUpdate_f(), CL_ActorVis(), CL_AddActor(), CL_AddActorPathing(), CL_AddPathing(), CL_AddTargeting(), CL_AddTargetingBox(), CL_CameraMove(), CL_CameraRoute(), CL_ChangeSkin_f(), CL_GetWorldCoordsUnderMouse(), CL_Init(), CL_InitAfter(), CL_LevelDown_f(), CL_LevelUp_f(), CL_LogEvent(), CL_ParseFileList(), CL_ParticleRun2(), CL_PrecacheCharacterModels(), CL_QueueHTTPDownload(), CL_SendCommand(), CL_StartHTTPDownload(), CL_Trace(), CL_ViewCalcFieldOfViewX(), CL_ViewRender(), CL_ViewUpdateRenderData(), Com_DPrintf(), Com_ParseMapDefinition(), Com_SetGameType(), Com_UploadCrashDump(), Com_vPrintf(), Con_DrawConsole(), Con_LoadConsoleHistory(), Con_SaveConsoleHistory(), CP_CheckLostCondition(), CP_ChooseMap(), CP_GameTimeStop(), Cvar_AssertValue(), Cvar_FullSet(), Cvar_Get(), Cvar_GetInteger(), Cvar_Mod_f(), Cvar_Set2(), uiRadarNode::draw(), uiGeoscapeNode::draw(), G_ActorSetTU(), G_ActorSpawnIsAllowed(), G_CheckDeathOrKnockout(), G_CheckFlood(), G_CheckForceEndRound(), G_ClientBegin(), G_ClientEndRound(), G_ClientShoot(), G_Damage(), G_GetTeam(), G_Init(), G_IsMoraleEnabled(), G_MoraleBehaviour(), G_RunFrame(), G_Say_f(), G_SendBoundingBoxes(), G_SetTeamForPlayer(), G_SpawnEntities(), G_TestVis(), G_TraceDraw(), GAME_MP_ShowServer(), GAME_MP_StartServer_f(), GEO_Draw(), HTTP_GetURLInternal(), HTTP_PutFile(), HUD_DisplayMessage(), HUD_DrawMouseCursorText(), HUD_MapDebugCursor(), HUD_Update(), HUD_UpdateCursor(), IN_EventEnqueue(), IN_Frame(), IN_JoystickMove(), IN_PrintKey(), IN_StartupJoystick(), INV_UpdateObject_f(), Irc_AppendToBuffer(), Irc_Connect_f(), Irc_Proto_Enqueue(), Irc_Proto_ProcessServerMsg(), LE_AddToScene(), LE_BrushModelAction(), LE_CenterView(), LE_PlayFootStepSound(), LM_AddToSceneOrder(), M_Frame(), M_Init(), Master_Heartbeat(), Master_Shutdown(), MYgluPerspective(), NET_Connect(), NET_DatagramSocketNew(), NET_GetAddrinfoForNode(), Qcommon_Init(), R_AddCorona(), R_AddLightToEntity(), R_BeginBuildingLightmaps(), R_BeginFrame(), R_BindBuffer(), R_BindColorAttachments(), R_CheckErrorDebug(), R_Clear(), R_CreateFramebuffer(), R_CullBox(), R_CullEntity(), R_CullSphere(), R_CvarCheckMaxLightmap(), R_DisableSpotLight(), R_Draw3DGlobe(), R_DrawAliasModel(), R_DrawAliasModelBuffer(), R_DrawBloom(), R_DrawBspNormals(), R_DrawCoronas(), R_DrawEntityEffects(), R_DrawFlareSurfaces(), R_DrawMaterialSurfaces(), R_DrawMeshShadow(), R_DrawModelDirect(), R_DrawModelParticle(), R_DrawParticles(), R_EnableAnimation(), R_EnableBlur(), R_EnableDrawAsGlow(), R_EnableFog(), R_EnableGlowMap(), R_EnableLighting(), R_EnableModelLights(), R_EnableMultisample(), R_EnableRenderbuffer(), R_EnableSpecularMap(), R_EnableTexture(), R_EnableWarp(), R_EnableWorldLights(), R_EndFrame(), R_GetEntityLists(), R_GetLevelSurfaceLists(), R_InitExtensions(), R_InitFBObjects(), R_InitModelProgram(), R_InitPrograms(), R_InitWarpProgram(), R_InitWorldProgram(), R_LoadMaterials(), R_LoadProgram(), R_RenderBspRRefs(), R_RenderFrame(), R_ResetArrayState(), R_RestartPrograms_f(), R_RunThread(), R_ScreenShot(), R_SetArrayState(), R_SetMode(), R_SetupFrustum(), R_SetupSpotLight(), R_ShutdownPrograms(), R_ShutdownThreads(), R_SphereCheckGLSL(), R_SphereInit(), R_StageLighting(), R_UpdateLightList(), R_UploadTexture(), R_UseFramebuffer(), R_UseMaterial(), R_UseModelProgram(), R_UseViewport(), R_UseWarpProgram(), R_UseWorldProgram(), R_VerifyDriver(), S_Init(), S_MumbleLink(), S_MumbleUnlink(), S_MumbleUpdate(), SAV_GameSave(), Schedule_Timer(), SCR_DrawCursor(), SCR_TouchPics(), SCR_UpdateScreen(), SEQ_SetCamera(), RandomMapAssemblyTest::SetUpTestCase(), SP_alien_start(), SP_civilian_start(), SP_player_start(), SP_worldspawn(), SV_AddMapTiles(), SV_AddMissingTiles_r(), SV_BroadcastPrintf(), SV_BuildMapStrings(), SV_CheckStartMatch(), SV_CheckTimeouts(), SV_DoMapAssemble(), SV_FilterPacket(), SV_Frame(), SV_GetNextClient(), SV_InitGame(), SV_InitGameProgs(), SV_ParallelSearch(), SV_ParseAssembly(), SV_SetMaster_f(), SVC_Info(), SVCmd_WriteIP_f(), TEST_F(), tick_timer(), UI_ContainerNodeAutoPlace(), UI_DebugMode(), UI_Draw(), UI_Init(), UI_PlaySound(), UI_RadarNodeGetActorColor(), UP_Article(), VID_GetModeInfo(), WEB_CGameDelete(), WEB_CGameListForUser(), and WEB_ListCGameFilesCallback().

char* cvar_s::latchedString

for CVAR_LATCH vars

Definition at line 74 of file cvar.h.

Referenced by Cvar_Delete(), and Cvar_Set2().

bool cvar_s::modified

set each time the cvar is changed

Definition at line 79 of file cvar.h.

Referenced by CheckNeedPass(), CL_Frame(), CL_LanguageTryToSet(), CL_SlowFrame(), CL_StartGame(), Cvar_FullSet(), Cvar_Get(), Cvar_Set2(), G_ClientStartMatch(), G_Init(), G_RunFrame(), GAME_MP_CallbacksInit(), GAME_MP_RunFrame(), GAME_MP_StartBattlescape(), HUD_InitStartup(), HUD_Update(), IN_Frame(), IN_JoystickMove(), IN_StartupJoystick(), Irc_Init(), Irc_Input_Deactivate_f(), Irc_Logic_Frame(), M_Frame(), M_Init(), M_PlayRandomByCategory(), Qcommon_Init(), R_BeginFrame(), R_EndFrame(), R_InitExtensions(), R_InitPrograms(), R_RegisterSystemVars(), R_SetArrayState(), R_SetMode(), R_UpdateVidDef(), S_Frame(), S_Init(), SCR_DrawCursor(), SV_Frame(), and SV_NextMapcycle().

char* cvar_s::name

cvar name

Definition at line 72 of file cvar.h.

Referenced by Cvar_AssertValue(), Cvar_Command(), Cvar_Delete(), Cvar_ExecuteChangeListener(), Cvar_Get(), Cvar_Reset(), uiTextEntryNode::onFocusGained(), GAMECvarListener::onGameModeChange(), R_CvarCheckMaxLightmap(), R_CvarPostProcess(), R_CvarPrograms(), SV_GetCvarToken(), tick_timer(), UI_AbstractOption_SetCvar(), UI_TextEntryNodeAbortEdition(), and UI_TextEntryNodeEdit().

struct cvar_s* cvar_s::next

Definition at line 84 of file cvar.h.

Referenced by CL_Init(), CL_Shutdown(), Cvar_BitInfo(), Cvar_ClearVars(), Cvar_CompleteVariable(), Cvar_Delete(), Cvar_FixCheatVars(), Cvar_Get(), Cvar_List_f(), Cvar_PendingCvars(), Cvar_UpdateLatchedVars(), and Cvar_WriteVariables().

char* cvar_s::oldString

value of the cvar before we changed it

Definition at line 76 of file cvar.h.

Referenced by Cvar_Delete(), Cvar_ExecuteChangeListener(), Cvar_FullSet(), Cvar_Get(), Cvar_Reset(), Cvar_Set2(), Cvar_SetOld_f(), and Cvar_VariableStringOld().

struct cvar_s* cvar_s::prev

Definition at line 85 of file cvar.h.

Referenced by Cvar_Delete(), and Cvar_Get().

char* cvar_s::string

value as string

Definition at line 73 of file cvar.h.

Referenced by B_BuildBase_f(), CheckNeedPass(), CL_Init(), CL_LanguageInit(), CL_LanguageInitMenu(), CL_LanguageTest(), CL_QueryMasterServer(), CL_SlowFrame(), CL_StartHTTPDownload(), Com_SetGameType(), Cvar_Command(), Cvar_Delete(), Cvar_ExecuteChangeListener(), Cvar_FullSet(), Cvar_Get(), Cvar_GetString(), Cvar_GetValue(), Cvar_Set2(), G_ClientConnect(), GAME_MP_Rcon(), GAME_MP_Rcon_f(), GAME_MP_RunFrame(), HTTP_GetURLInternal(), HUD_CheckCLHud(), HUD_DisplayMessage(), HUD_InitUI(), Irc_Client_CmdKick(), Irc_Client_CmdNick(), Irc_Client_CmdPrivmsg(), Irc_Client_Invite_f(), Irc_Client_Msg_f(), Irc_Connect_f(), Irc_GetExternalIP(), Irc_Input_Activate_f(), Irc_Logic_Connect(), Irc_Logic_Frame(), Irc_Proto_ProcessServerMsg(), Irc_UserClick_f(), M_Frame(), Master_HeartbeatThread(), Master_Shutdown(), uiTextEntryNode::onFocusGained(), uiTextEntryNode::onKeyPressed(), Qcommon_Init(), R_BeginFrame(), R_CvarGLSLVersionCheck(), R_LoadMaterials(), R_ScreenShot(), Rcon_Validate(), Rimp_Init(), SAV_GameContinue_f(), SP_worldspawn(), SV_GetCvarToken(), SV_InitGame(), SV_SetMaster_f(), SVC_DirectConnect(), SVC_Info(), UI_CloseWindowByRef(), UI_GenInjectedString(), UI_GetStringFromExpression(), UI_TextEntryNodeEdit(), WEB_Auth(), WEB_CGameDelete(), WEB_CGameDownloadFromUser(), WEB_CGameListForUser(), WEB_CGameUpload(), WEB_CheckAuth(), WEB_GetToFile(), WEB_GetURL(), WEB_InitStartup(), and WEB_PutFile().

float cvar_s::value

value as float

Definition at line 80 of file cvar.h.

Referenced by AIL_difficulty(), CL_CameraMove(), CL_CameraZoomIn(), CL_CameraZoomOut(), CL_CamSetZoom_f(), CL_ViewCalcFieldOfViewX(), Cvar_Add_f(), Cvar_AssertValue(), Cvar_FullSet(), Cvar_Get(), Cvar_Set2(), uiGeoscapeNode::draw(), G_CheckFlood(), G_ClientMove(), G_Damage(), G_Morale(), G_MoraleBehaviour(), G_MoraleStopPanic(), G_MoraleStopRage(), G_ShootSingle(), IN_JoystickMove(), Irc_Proto_Connect(), Irc_Proto_DrainBucket(), Irc_Proto_RefillBucket(), ReactionFire::isEnemy(), R_ArraysMask(), R_DrawFlareSurfaces(), R_DrawMeshShadow(), R_EnableBumpmap(), R_EndFrame(), R_InitializeShader(), R_SetSurfaceBumpMappingParameters(), R_SphereInit(), R_UpdateDefaultMaterial(), R_UploadTexture(), R_UseMaterial(), S_LoopSample(), S_MumbleUpdate(), S_PlaySample(), S_SpatializeChannel(), SCR_RunConsole(), UI_GetFloatFromExpression(), and UI_GetFloatFromNodeProperty().

---

The documentation for this struct was generated from the following file:

• src/common/cvar.h