quakeforge/doc/cshifts.dox

//unfortunately, have to wrap the docs in a C comment for doxygen
// vim:tw=74:formatoptions-=l
/**
\page cshift_cvars cshift control

New cvars:
\li cl_cshift_bonus: Set to 0 to disable bonus flashes.
\li cl_cshift_contents: Set to 0 to disable content blends.
\li cl_cshift_damage: Set to 0 to disable damage blends.
\li cl_cshift_powerup: Set to 0 to disable powerup (quad, pent, etc) blends.

All of these cvars work for both GL and software, and all of them check
the value of the "cshifts" serverinfo. cshifts is a bit field, with the
following bits defined:

\li bonus: 1
\li contents: 2
\li damage: 4
\li powerup: 8

An admin can force any of these to be respected by choosing the numbers of
the cshifts to be enforced, and adding them up.

examples:
\verbatim
serverinfo cshifts 15
\endverbatim
turns them all on.

\verbatim
serverinfo cshifts 10
\endverbatim
turns on powerup and contents shifts.
*/
link the existing documentation into the doxygen docs 2010-08-19 11:03:50 +00:00			`//unfortunately, have to wrap the docs in a C comment for doxygen`
Put my text editing vim settings into the docs. Vim's autoformating doesn't like our style of comments, so I have to force it to do what I want. Having to set the appropriate options every time I edit a file got to be a RPITA, so time to get the computer to do it for me :) 2011-09-08 01:17:58 +00:00			`// vim:tw=74:formatoptions-=l`
link the existing documentation into the doxygen docs 2010-08-19 11:03:50 +00:00			`/**`
			`\page cshift_cvars cshift control`

this is a little more useful here than in the cvs logs 2001-08-08 20:31:20 +00:00			`New cvars:`
link the existing documentation into the doxygen docs 2010-08-19 11:03:50 +00:00			`\li cl_cshift_bonus: Set to 0 to disable bonus flashes.`
			`\li cl_cshift_contents: Set to 0 to disable content blends.`
			`\li cl_cshift_damage: Set to 0 to disable damage blends.`
			`\li cl_cshift_powerup: Set to 0 to disable powerup (quad, pent, etc) blends.`
this is a little more useful here than in the cvs logs 2001-08-08 20:31:20 +00:00
			`All of these cvars work for both GL and software, and all of them check`
			`the value of the "cshifts" serverinfo. cshifts is a bit field, with the`
			`following bits defined:`

link the existing documentation into the doxygen docs 2010-08-19 11:03:50 +00:00			`\li bonus: 1`
			`\li contents: 2`
			`\li damage: 4`
			`\li powerup: 8`
this is a little more useful here than in the cvs logs 2001-08-08 20:31:20 +00:00
			`An admin can force any of these to be respected by choosing the numbers of`
			`the cshifts to be enforced, and adding them up.`

			`examples:`
link the existing documentation into the doxygen docs 2010-08-19 11:03:50 +00:00			`\verbatim`
this is a little more useful here than in the cvs logs 2001-08-08 20:31:20 +00:00			`serverinfo cshifts 15`
link the existing documentation into the doxygen docs 2010-08-19 11:03:50 +00:00			`\endverbatim`
this is a little more useful here than in the cvs logs 2001-08-08 20:31:20 +00:00			`turns them all on.`

link the existing documentation into the doxygen docs 2010-08-19 11:03:50 +00:00			`\verbatim`
this is a little more useful here than in the cvs logs 2001-08-08 20:31:20 +00:00			`serverinfo cshifts 10`
link the existing documentation into the doxygen docs 2010-08-19 11:03:50 +00:00			`\endverbatim`
this is a little more useful here than in the cvs logs 2001-08-08 20:31:20 +00:00			`turns on powerup and contents shifts.`
link the existing documentation into the doxygen docs 2010-08-19 11:03:50 +00:00			`*/`