Toggle: Difference between revisions

From Valve Developer Community
Jump to navigation Jump to search
No edit summary
No edit summary
Line 1: Line 1:
{{Console command}}
{{Console command}}
'''Toggle''' a <code>cvar</code> on and off, or cycle it between a set of values.
'''Toggle''' a [[ConVar]] on and off, or cycle it between a set of values.


==Syntax==
==Syntax==
  toggle CVAR VALUE1 VALUE2 VALUE3 ... VALUEN
{{Code|toggle <cvar> <value 1> <value 2> <value 3> ...}}
"Toggling" past the last argument will loop around, ''i.e.'' <code>cvar</code> is set <code>VALUE1</code> once again. Repeating the last value will prevent looping.
 
"Toggling" past the last argument will loop around, ''i.e.'' the variable is set to its first value once again. Repeating the last value will prevent looping.
==Examples==
==Examples==
If values are omitted <code>cvar</code> is toggled between 0 and 1
If values are omitted, the cvar is toggled between 0 and 1
  toggle cl_showpos
 
{{Code|toggle cl_showpos}}
 
Step 0 to 4
Step 0 to 4
  toggle cl_showfps 0 1 2 3 4
 
{{Code|toggle cl_showfps 0 1 2 3 4}}
 
Step 0 to 4 and stop at 4
Step 0 to 4 and stop at 4
  toggle cl_showfps 0 1 2 3 4 4
 
{{Code|toggle cl_showfps 0 1 2 3 4 4}}
 
Cycle values
Cycle values
  toggle viewmodel_fov 54 57 59 65 71 98
 
{{Code|toggle viewmodel_fov 54 57 59 65 71 98}}
==See also==
==See also==
*{{ent|BindToggle}}
*{{ent|BindToggle}}
*{{ent|setinfo}}, create an arbitrary console variable.
*{{ent|setinfo}}, create an arbitrary console variable.

Revision as of 19:01, 1 August 2023

Template:Console command Toggle a ConVar on and off, or cycle it between a set of values.

Syntax

toggle <cvar> <value 1> <value 2> <value 3> ...

"Toggling" past the last argument will loop around, i.e. the variable is set to its first value once again. Repeating the last value will prevent looping.

Examples

If values are omitted, the cvar is toggled between 0 and 1

toggle cl_showpos

Step 0 to 4

toggle cl_showfps 0 1 2 3 4

Step 0 to 4 and stop at 4

toggle cl_showfps 0 1 2 3 4 4

Cycle values

toggle viewmodel_fov 54 57 59 65 71 98

See also