Toggle: Difference between revisions

From Valve Developer Community
Jump to navigation Jump to search
mNo edit summary
m (clearer language)
Line 1: Line 1:
{{ent|Toggle}} a <code>cvar</code> on or off, or cycle it between a set of values.
{{ent|Toggle}} a <code>cvar</code> on and off, or cycle it between a set of values.


==Syntax==
==Syntax==
   toggle CVAR VALUE1 VALUE2 VALUE3 ... VALUEN
   toggle CVAR VALUE1 VALUE2 VALUE3 ... VALUEN
"Toggling" past the last argument will loop around, ''i.e.'' cause the <code>cvar</code> to be set <code>VALUE1</code> once again. Repeating the last value will prevent looping.
"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.
==Examples==
==Examples==
If values are omitted <code>cvar</code> is toggled between 0 and 1
If values are omitted <code>cvar</code> is toggled between 0 and 1
   toggle cl_showpos
   toggle cl_showpos
Toggle 0 to 4 and stop at 4
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
   toggle cl_showfps 0 1 2 3 4 4
Cycle values
Cycle values

Revision as of 15:59, 22 October 2021

Toggle a cvar on and off, or cycle it between a set of values.

Syntax

 toggle CVAR VALUE1 VALUE2 VALUE3 ... VALUEN

"Toggling" past the last argument will loop around, i.e. cvar is set VALUE1 once again. Repeating the last value will prevent looping.

Examples

If values are omitted 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