Migrate many in-game console (con_*) cvars

Using migration script.

Author: slipher

src/engine/client/cl_console.cpp

@@ -49,10 +49,9 @@ console_t consoleState;
 
 Console::Field g_consoleField(INT_MAX);
 
-cvar_t    *con_animationSpeed;
-cvar_t    *con_animationType;
+Cvar::Range<Cvar::Cvar<float>> con_animationSpeed("con_animationSpeed", "speed of console fade in/out and scrolling", Cvar::NONE, 3, 0.1, 100);
 
-cvar_t    *con_autoclear;
+Cvar::Cvar<bool> con_autoclear("con_autoclear", "drop input upon closing console", Cvar::NONE, true);
 Cvar::Cvar<bool> con_persistOnMapChange( "con_persistOnMapChange", "Current console input will be saved when changing map", Cvar::NONE, false );
 
 /**
@@ -61,9 +60,11 @@ Cvar::Cvar<bool> con_persistOnMapChange( "con_persistOnMapChange", "Current cons
  * 2: lock scrolling if in scrollback, even for own output
  * 3: always lock scrolling
  */
-cvar_t    *con_scrollLock;
+Cvar::Range<Cvar::Cvar<int>> con_scrollLock("con_scrollLock",
+	"go to end of console buffer upon (0) any output (1) pressing enter (2) new output when already at end (3) none of the above",
+	Cvar::NONE, 2, 0, 3);
 
-cvar_t	  *con_prompt;
+Cvar::Cvar<std::string> con_prompt("con_prompt", "text at start of console input line", Cvar::NONE, "^3->");
 
 cvar_t    *con_borderWidth;
 cvar_t    *con_borderColorAlpha;
@@ -84,12 +85,16 @@ cvar_t    *con_colorGreen;
  * allows for debugging the console without using the consoles scrollback,
  * which might otherwise end in loops or unnecessary verbose output
  */
-cvar_t    *con_debug;
+Cvar::Cvar<bool> con_debug("con_debug", "show stats about console drawing", Cvar::NONE, false);
 
 static const int ANIMATION_TYPE_NONE   = 0;
 static const int ANIMATION_TYPE_SCROLL_DOWN = 1;
 static const int ANIMATION_TYPE_FADE   = 2;
 
+Cvar::Range<Cvar::Cvar<int>> con_animationType("con_animationType",
+	"show console open/close with (0) nothing (1) grow/shrink (2) fade in/out (3) both",
+	Cvar::NONE, ANIMATION_TYPE_FADE, 0, ANIMATION_TYPE_SCROLL_DOWN | ANIMATION_TYPE_FADE);
+
 /*
 ================
 Con_ToggleConsole_f
@@ -98,7 +103,7 @@ Con_ToggleConsole_f
 void Con_ToggleConsole_f()
 {
 	// ydnar: persistent console input is more useful
-	if ( con_autoclear->integer && !( con_persistOnMapChange.Get() && consoleState.changedMap ) )
+	if ( con_autoclear.Get() && !( con_persistOnMapChange.Get() && consoleState.changedMap ) )
 	{
 		g_consoleField.Clear();
 	}
@@ -372,10 +377,9 @@ bool Con_CheckResize()
 		consoleState.scrollLineIndex = consoleState.lines.size() - 1;
 	}
 
-	if ( con_prompt )
 	{
 		// 8 spaces for clock, 1 for cursor
-		g_console_field_width = consoleState.textWidthInChars - 9 - Color::StrlenNocolor( con_prompt->string );
+		g_console_field_width = consoleState.textWidthInChars - 9 - Color::StrlenNocolor( con_prompt.Get().c_str() );
 		g_consoleField.SetWidth(g_console_field_width);
 	}
 
@@ -389,13 +393,6 @@ Con_Init
 */
 void Con_Init()
 {
-	con_animationSpeed = Cvar_Get( "con_animationSpeed", "3", 0 );
-	con_animationType = Cvar_Get( "con_animationType", "2", 0 );
-
-	con_autoclear = Cvar_Get( "con_autoclear", "1", 0 );
-	con_scrollLock = Cvar_Get( "con_scrollLock", "2", 0 );
-
-	con_prompt = Cvar_Get( "con_prompt", "^3->", 0 );
 
 	con_height = Cvar_Get( "con_height", "55", 0 );
 	con_colorRed = Cvar_Get( "con_colorRed", "0", 0 );
@@ -412,8 +409,6 @@ void Con_Init()
 	con_borderColorGreen = Cvar_Get( "con_borderColorGreen", "1", 0 );
 	con_borderColorAlpha = Cvar_Get( "con_borderColorAlpha", "0.2", 0 );
 
-	con_debug = Cvar_Get( "con_debug", "0", 0 );
-
 	// Done defining cvars for console colors
 
 	if ( !con_persistOnMapChange.Get() ) {
@@ -436,7 +431,7 @@ Con_Linefeed
 */
 void Con_Linefeed()
 {
-	const int scrollLockMode = con_scrollLock ? con_scrollLock->integer : 0;
+	const int scrollLockMode = con_scrollLock.Get();
 
 	//fall down to input line if scroll lock is configured to do so
 	if(scrollLockMode <= 0)
@@ -644,7 +639,7 @@ void Con_DrawInput( int linePosition, float overrideAlpha )
 	qtime_t realtime;
 
 	Com_RealTime( &realtime );
-	Com_sprintf( prompt,  sizeof( prompt ), "^0[^3%02d%c%02d^0]^* %s", realtime.tm_hour, ( realtime.tm_sec & 1 ) ? ':' : ' ', realtime.tm_min, con_prompt->string );
+	Com_sprintf( prompt,  sizeof( prompt ), "^0[^3%02d%c%02d^0]^* %s", realtime.tm_hour, ( realtime.tm_sec & 1 ) ? ':' : ' ', realtime.tm_min, con_prompt.Get().c_str() );
 
 	Color::Color color = console_color;
 	color.SetAlpha( consoleState.currentAlphaFactor * overrideAlpha );
@@ -769,7 +764,7 @@ void Con_DrawConsoleScrollbar()
 		SCR_FillRect( scrollBarX, scrollBarY, scrollBarWidth, scrollHandleLength, color );
 	}
 
-	if(con_debug->integer) {
+	if(con_debug.Get()) {
 		Con_DrawRightFloatingTextLine( 6, Color::White, va( "Scrollbar (px): Size %d HandleSize %d Position %d", (int) scrollBarLength, (int) scrollHandleLength, (int) scrollHandlePostition ) );
 	}
 }
@@ -848,7 +843,7 @@ void Con_DrawConsoleContent()
 		return;
 	}
 
-	if(con_debug->integer) {
+	if(con_debug.Get()) {
 		Con_DrawRightFloatingTextLine( 3, Color::White, va( "Buffer (lines): ScrollbackLength %d", (int) consoleState.lines.size() ) );
 		Con_DrawRightFloatingTextLine( 4, Color::White, va( "Display (lines): From %d to %d (%d a %i px)",
 			0, consoleState.scrollLineIndex, consoleState.visibleAmountOfLines, charHeight ) );
@@ -941,7 +936,7 @@ void Con_DrawAnimatedConsole()
 	//build info, projectname/copyrights, meta information or similar
 	Con_DrawAboutText();
 
-	if(con_debug->integer) {
+	if(con_debug.Get()) {
 			Con_DrawRightFloatingTextLine( 8, Color::White, va( "Animation: target %d current fraction %f alpha %f", (int) consoleState.isOpened, consoleState.currentAnimationFraction, consoleState.currentAlphaFactor) );
 	}
 
@@ -1014,7 +1009,7 @@ void Con_UpdateConsoleState()
 	 * calculate global alpha factor
 	 * apply the fade animation if the type is set, otherwise remain completely visible
 	 */
-	consoleState.currentAlphaFactor = ( con_animationType->integer & ANIMATION_TYPE_FADE ) ? consoleState.currentAnimationFraction : 1.0f;
+	consoleState.currentAlphaFactor = ( con_animationType.Get() & ANIMATION_TYPE_FADE ) ? consoleState.currentAnimationFraction : 1.0f;
 
 	/*
 	 * calculate current console height
@@ -1033,7 +1028,7 @@ void Con_UpdateConsoleState()
 
 
 	//animate via scroll animation if the type is set
-	if ( con_animationType->integer & ANIMATION_TYPE_SCROLL_DOWN)
+	if ( con_animationType.Get() & ANIMATION_TYPE_SCROLL_DOWN)
 	{
 		consoleState.height *= consoleState.currentAnimationFraction;
 	}
@@ -1067,10 +1062,6 @@ void Con_RunAnimatedConsole()
 	{
 		Cvar_Reset(con_height->name);
 	}
-	if (con_animationSpeed->value <= 0.0f)
-	{
-		Cvar_Reset(con_animationSpeed->name);
-	}
 
 	Con_UpdateConsoleState( );
 
@@ -1136,19 +1127,19 @@ void Con_RunConsole()
 
 	if ( !consoleState.isOpened && consoleState.currentAnimationFraction >= 0.0f )
 	{
-		consoleState.currentAnimationFraction -= con_animationSpeed->value * cls.realFrametime * 0.001f;
+		consoleState.currentAnimationFraction -= con_animationSpeed.Get() * cls.realFrametime * 0.001f;
 
-		if ( consoleState.currentAnimationFraction <= 0.0f  || con_animationType->integer == ANIMATION_TYPE_NONE )
+		if ( consoleState.currentAnimationFraction <= 0.0f  || con_animationType.Get() == ANIMATION_TYPE_NONE )
 		{	//we are closed, do some last onClose work
 			consoleState.currentAnimationFraction = 0.0f;
 			consoleState.lastReadLineIndex = consoleState.lines.size()-1;
 		}
 	}
 	else if ( consoleState.isOpened && consoleState.currentAnimationFraction <= 1.0f)
 	{
-		consoleState.currentAnimationFraction += con_animationSpeed->value * cls.realFrametime * 0.001f;
+		consoleState.currentAnimationFraction += con_animationSpeed.Get() * cls.realFrametime * 0.001f;
 
-		if ( consoleState.currentAnimationFraction > 1.0f  || con_animationType->integer == ANIMATION_TYPE_NONE  )
+		if ( consoleState.currentAnimationFraction > 1.0f  || con_animationType.Get() == ANIMATION_TYPE_NONE  )
 		{
 			consoleState.currentAnimationFraction = 1.0f;
 		}
@@ -1159,16 +1150,16 @@ void Con_RunConsole()
 		const float scrollDifference = std::max( 0.5f, fabsf( consoleState.bottomDisplayedLine - consoleState.scrollLineIndex ) );
 		if( consoleState.bottomDisplayedLine < consoleState.scrollLineIndex )
 		{
-			consoleState.bottomDisplayedLine += con_animationSpeed->value * cls.realFrametime * 0.005f * scrollDifference;
-			if( consoleState.bottomDisplayedLine > consoleState.scrollLineIndex || con_animationType->integer == ANIMATION_TYPE_NONE )
+			consoleState.bottomDisplayedLine += con_animationSpeed.Get() * cls.realFrametime * 0.005f * scrollDifference;
+			if( consoleState.bottomDisplayedLine > consoleState.scrollLineIndex || con_animationType.Get() == ANIMATION_TYPE_NONE )
 			{
 				consoleState.bottomDisplayedLine = consoleState.scrollLineIndex;
 			}
 		}
 		else if ( consoleState.bottomDisplayedLine > consoleState.scrollLineIndex )
 		{
-			consoleState.bottomDisplayedLine -= con_animationSpeed->value * cls.realFrametime * 0.005f * scrollDifference;
-			if( consoleState.bottomDisplayedLine < consoleState.scrollLineIndex || con_animationType->integer == ANIMATION_TYPE_NONE )
+			consoleState.bottomDisplayedLine -= con_animationSpeed.Get() * cls.realFrametime * 0.005f * scrollDifference;
+			if( consoleState.bottomDisplayedLine < consoleState.scrollLineIndex || con_animationType.Get() == ANIMATION_TYPE_NONE )
 			{
 				consoleState.bottomDisplayedLine = consoleState.scrollLineIndex;
 			}

src/engine/client/cl_keys.cpp

@@ -331,7 +331,7 @@ static void Console_Key( Keyboard::Key key )
 	if (key == Key(K_ENTER) or key == Key(K_KP_ENTER)) {
 
 		//scroll lock state 1 or smaller will scroll down on own output
-		if (con_scrollLock->integer <= 1) {
+		if (con_scrollLock.Get() <= 1) {
 			consoleState.scrollLineIndex = consoleState.lines.size() - 1;
 		}
 

src/engine/client/client.h

@@ -430,7 +430,7 @@ extern cvar_t *cl_consoleFontScaling;
 extern cvar_t *cl_consoleFontKerning;
 extern cvar_t *cl_consoleCommand;
 
-extern cvar_t *con_scrollLock;
+extern Cvar::Range<Cvar::Cvar<int>> con_scrollLock;
 
 // XreaL BEGIN
 extern cvar_t *cl_aviFrameRate;