SetUserCVar

From ZDoom Wiki
Jump to: navigation, search

bool SetUserCVar (int playernumber, str cvar, int value); (New from 2.7.1)

Usage

Sets the console variable of a particular player. Only mod-defined console variables through CVARINFO can be changed by using this function. Engine's built-in ones cannot be.

Parameters

  • player: player number of the player .
  • cvar: name of a console variable.
  • value: value to apply to said console variable.

Return value

Returns FALSE if cvar is invalid, it is not writable, or the player doesn't exist. Returns TRUE if the cvar is set successfully.

Examples

Nuvolachalk.png Note: This article lists no examples. If you make use of this feature in your own project(s) or know of any basic examples that could be shared, please add them. This will make it easier to understand for future authors seeking assistance. Your contibutions are greatly appreciated.


See also

Console variable functions
GetCVar SetCVar
GetCVarString SetCVarString
GetUserCVar SetUserCVar
GetUserCVarString SetCVarString
CVARINFO