ConVars (SourceMod Scripting) - Revision history

Joinedsenses: /* Change Callbacks */ Update highlighting

2020-03-29T23:22:46Z

‎Change Callbacks: Update highlighting

2020-03-29T23:22:15Z

‎Flags: Update highlighting

2020-03-29T23:21:55Z

‎Using/Changing Values: Update highlighting

2020-03-29T23:21:37Z

‎Creating ConVars: Update highlighting

2020-03-29T23:21:15Z

‎Finding ConVars: Update highlighting

2015-08-14T02:31:04Z

2015-08-14T02:28:22Z

‎Finding ConVars

2015-03-08T18:53:46Z

‎Using/Changing Values

2015-03-08T18:52:27Z

‎Creating ConVars

2015-03-08T18:49:03Z

@@ Line 102: / Line 102: @@
 For example, let's say you want to detect when <tt>bot_quota</tt> changes and to prevent it from going below 2:
-<pawn>ConVar g_hBotQuota;
+<sourcepawn>ConVar g_hBotQuota;
 public void OnPluginStart()
@@ Line 119: / Line 119: @@
 		convar.IntValue = 2;
+	}
-}</pawn>
+}</sourcepawn>
 '''Note 1:''' You do not need to explicitly unhook ConVarChange functions on shutdown.  These hooks are removed when your plugin unloads.

@@ Line 83: / Line 83: @@
 Let's say we wanted to toggle whether a cvar had FCVAR_CHEAT.  The following two functions could be used:
-<pawn>void UnsetCheatVar(ConVar convar)
+<sourcepawn>void UnsetCheatVar(ConVar convar)
+{
 	int flags = convar.Flags;
@@ Line 95: / Line 95: @@
 	flags |= FCVAR_CHEAT;
 	convar.Flags = flags;
-}</pawn>
+}</sourcepawn>
 = Change Callbacks =

@@ Line 49: / Line 49: @@
 Managing ConVars is very simple.  For example, let's say we want to change <tt>mp_startmoney</tt>, but save the old value and restore it later.  Re-using our <tt>mp_startmoney</tt> code from <tt>[[ConVars_(SourceMod_Scripting)#Finding _ConVars|FindConVar]]</tt>:
-<pawn>int g_oldmoney;
+<sourcepawn>int g_oldmoney;
 void SetStartMoney(int newmoney)
@@ Line 60: / Line 60: @@
+{
 	g_cvStartMoney.IntValue = g_oldmoney;
-}</pawn>
+}</sourcepawn>
 Although there are different functions for value types (float, string, et cetera), the internal data is always stored the same way.  For example, this code will work:
-<pawn>public int GetStartMoney()
+<sourcepawn>public int GetStartMoney()
+{
 	char buffer[128];
@@ Line 71: / Line 71: @@
 	return StringToInt(buffer);
-}</pawn>
+}</sourcepawn>
 Even though <tt>mp_startmoney</tt> is an integer, it can still be retrieved as a string.

@@ Line 22: / Line 22: @@
 A simple ConVar only requires two parameters, a name and a default value. However, it's a good idea to include a description:
-<pawn>ConVar g_cvEnabled;
+<sourcepawn>ConVar g_cvEnabled;
 public void OnPluginStart()
+{
 	g_cvEnabled = CreateConVar("myplugin_enabled", "1", "Sets whether my plugin is enabled");
-}</pawn>
+}</sourcepawn>
 You can also specify value constraints. For example, let's create a cvar called <tt>myplugin_ratio</tt> which cannot go above 1.0 or below 0.1.
-<pawn>ConVar g_cvRatio;
+<sourcepawn>ConVar g_cvRatio;
 public void OnPluginStart()
@@ Line 42: / Line 42: @@
 			true,	/* Has a maximum */
 .0);
-}</pawn>
+}</sourcepawn>
 The default value can be any type of data, and it does not restrict future data types that can be used.  However, the minimum and maximum constraints always interpret the value as a float.

@@ Line 10: / Line 10: @@
 Finding ConVars is very simple. For example, let's say you want to use <tt>mp_startmoney</tt> from Counter-Strike:Source:
-<pawn>ConVar g_cvStartMoney;
+<sourcepawn>ConVar g_cvStartMoney;
 public void OnPluginStart()
+{
 	g_cvStartMoney = FindConVar("mp_startmoney");
-}</pawn>
+}</sourcepawn>
 ''Note: FindConVar() will return ''<tt>null</tt>'' if the ConVar is not found.  Keep this in mind if you are trying to read ConVars from other plugins.''

@@ Line 47: / Line 47: @@
 = Using/Changing Values =
-Managing ConVars is very simple.  For example, let's say we want to change <tt>mp_startmoney</tt>, but save the old value and restore it later.  Re-using our <tt>mp_startmoney</tt> code from <tt>FindConVar</tt>:
+Managing ConVars is very simple.  For example, let's say we want to change <tt>mp_startmoney</tt>, but save the old value and restore it later.  Re-using our <tt>mp_startmoney</tt> code from <tt>[[ConVars_(SourceMod_Scripting)#Finding _ConVars|FindConVar]]</tt>:
 <pawn>int g_oldmoney

@@ Line 32: / Line 32: @@
 <pawn>ConVar g_cvRatio
-public OnPluginStart()
+public void OnPluginStart()
+{
 	g_cvRatio = CreateConVar("myplugin_ratio",