SourcePawn Basics - Customization through ConVars - Revision history

NgBUCKWANGS at 12:25, 5 November 2016

2016-11-05T12:25:53Z

2013-10-18T21:15:00Z

‎Reading and Setting ConVars

2013-10-18T21:03:45Z

‎Catching that a ConVar changed

2013-10-18T21:02:32Z

‎Catching that a ConVar changed

2013-10-18T21:02:15Z

‎Catching that a ConVar changed

2013-10-18T20:58:07Z

‎Standard ConVars

2013-10-18T20:48:33Z

‎Catching that a ConVar changed

2013-10-18T20:48:22Z

2013-10-18T20:40:57Z

2013-10-18T20:34:29Z

← Older revision		Revision as of 12:25, 5 November 2016
Line 149:		Line 149:

	'''Make sure you hook the ConVar in the same function you Create or Find it.''' It's also a good idea to check the return value of FindConVar before hooking it, as a game that doesn't support a ConVar will return <tt>INVALID_HANDLE</tt>		'''Make sure you hook the ConVar in the same function you Create or Find it.''' It's also a good idea to check the return value of FindConVar before hooking it, as a game that doesn't support a ConVar will return <tt>INVALID_HANDLE</tt>
		+
		+	== Reading ConVars from server.cfg ASAP ==
		+	On server first launch, ConVars in server.cfg are loaded later than OnPluginStart (e.g, see <strong>Q: Can I get cvar values in OnPluginStart?</strong> on this page http://www.sourcemod.net/devlog/?p=126). A working example of how to read from server.cfg ASAP but falling back to a default value in case it doesn't exist follows.
		+
		+	ConVar g_YourConVar;
		+	new g_YourGlobalVar;
		+
		+	public OnPluginStart() {
		+	g_YourConVar = CreateConVar("your_convar", "your_default_value");
		+	g_YourGlobalVar = g_YourConVar.IntValue;
		+	HookConVarChange(g_YourConVar, YourGlobalVarHook);
		+	}
		+
		+	public YourGlobalVarHook(Handle:convar, const String:oldValue[], const String:newValue[]) {
		+	g_YourGlobalVar = GetConVarInt(g_YourConVar);
		+	PrintToServer("g_YourGlobalVar Has Changed: %d", g_YourGlobalVar);
		+	}

	[[Category:SourcePawn Basics]]		[[Category:SourcePawn Basics]]

@@ Line 99: / Line 99: @@
 Here is how you read a bool ConVar:
-       new bool:value = GetConVarInt(g_hAutoTeamBalance);
+       new bool:value = GetConVarBool(g_hAutoTeamBalance);
 and to set the same ConVar:
-       SetConVarInt(g_hAutoTeamBalance, true);
+       SetConVarBool(g_hAutoTeamBalance, true);
 Int and Floats work roughly the same way with <tt>GetConVarInt</tt> / <tt>GetConVarFloat</tt> / <tt>SetConVarInt</tt> / <tt>SetConVarFloat</tt>.

@@ Line 118: / Line 118: @@
 In addition to just reading and changing ConVar values, you can also catch when a ConVar's value is changed.
-This is done through a ConVarChange hook.
+This is done through a ConVarChange hook.  ConVarChange hooks only fire when the value changes from one state to another.  So, if a ConVar is already set to 1 and a config changes it to 1 (the same value), the ConVarChange hook will '''not''' fire.
 You can add a ConVarChange hook like this:

@@ Line 148: / Line 148: @@
 There is also an <tt>UnhookConVarChange</tt>, but it is largely unnecessary as these hooks are automatically released when your plugin unloads.
-'''Make sure you hook the ConVar in the same function you Create or Find it.'''  It's also a good idea to check the return value of FindConVar before hooking it, an a game that doesn't support a ConVar will return <tt>INVALID_HANDLE</tt>
+'''Make sure you hook the ConVar in the same function you Create or Find it.'''  It's also a good idea to check the return value of FindConVar before hooking it, as a game that doesn't support a ConVar will return <tt>INVALID_HANDLE</tt>
 [[Category:SourcePawn Basics]]

← Older revision		Revision as of 21:02, 18 October 2013
Line 147:		Line 147:

	There is also an <tt>UnhookConVarChange</tt>, but it is largely unnecessary as these hooks are automatically released when your plugin unloads.		There is also an <tt>UnhookConVarChange</tt>, but it is largely unnecessary as these hooks are automatically released when your plugin unloads.
		+
		+	'''Make sure you hook the ConVar in the same function you Create or Find it.''' It's also a good idea to check the return value of FindConVar before hooking it, an a game that doesn't support a ConVar will return <tt>INVALID_HANDLE</tt>
		+
	[[Category:SourcePawn Basics]]		[[Category:SourcePawn Basics]]

@@ Line 51: / Line 51: @@
+   }
-VERSION is defined here so that it can be used in the plugin's myinfo struct as well.
+<tt>|FCVAR_PLUGIN|FCVAR_SPONLY</tt> is not strictly required here, but it is fairly common to see them set.
 A second common ConVar is the enable ConVar.

@@ Line 131: / Line 131: @@
+   {
        new enabled = GetConVarBool(g_hEnabled);
-−
        if (enabled)
+       {

← Older revision		Revision as of 20:48, 18 October 2013
Line 112:		Line 112:
	This pattern is common for functions that do String manipulations.		This pattern is common for functions that do String manipulations.

		+	== Catching that a ConVar changed ==
		+
		+	In addition to just reading and changing ConVar values, you can also catch when a ConVar's value is changed.
		+
		+	This is done through a ConVarChange hook.
		+
		+	You can add a ConVarChange hook like this:
		+
		+	new Handle:g_hEnabled;
		+
		+	public OnPluginStart()
		+	{
		+	g_hEnabled = CreateConVar("test_enable", "1", "Test Plugin Enable", FCVAR_NOTIFY\|FCVAR_DONTRECORD, true, 0.0, true, 1.0);
		+	HookConVarChange(g_hEnabled, ConVar_EnableChange);
		+	}
		+
		+	public ConVar_EnableChange(Handle:convar, const String:oldValue[], const String:newValue[])
		+	{
		+	new enabled = GetConVarBool(g_hEnabled);
		+
		+	if (enabled)
		+	{
		+	// We were just enabled
		+	}
		+	else
		+	{
		+	// We were just disabled
		+	}
		+	}
		+
		+	Note that it's quicker to use <tt>GetConVarBool</tt>, Int, or Float instead of converting oldValue or newValue to the appropriate types.
		+
		+	There is also an <tt>UnhookConVarChange</tt>, but it is largely unnecessary as these hooks are automatically released when your plugin unloads.
	[[Category:SourcePawn Basics]]		[[Category:SourcePawn Basics]]

@@ Line 3: / Line 3: @@
 Server owners like customization.  Lots of customization.  So, how do you add customization to your plugin?  The simplest route is by adding ConVars.
-== ConVars / CVars ==
+== General Info ==
 Console Variables (ConVars or CVars for short) are server settings that can be changed by server owners.  Anything you put into your server's server.cfg file is a convar.
@@ Line 9: / Line 9: @@
 Just like the server itself, plugins can create their own convars.  A convar is different from a regular variable in that it is visible outside your plugin.
-=== Creating your own ConVars ===
+== Creating your own ConVars ==
 ConVars should always be created in OnPluginStart.
@@ Line 26: / Line 26: @@
 ; min : A Float with the maximum allowed value
-==== Useful ConVar Flags ====
+=== Useful ConVar Flags ===
 * <tt>FCVAR_NONE</tt> - The default, no flags set.
@@ Line 36: / Line 36: @@
 * <tt>FCVAR_PLUGIN</tt> - Defined by a 3rd Party plugin.  SourceMod probably adds this already even if you don't.
-=== Locating ConVars from the game or other plugins ===
+== Standard ConVars ==
 Looking up plugins is an expensive operation and should be done just once if you can help it.
@@ Line 52: / Line 90: @@
 == Reading and Setting ConVars ==
 ConVars can be read as several different kinds of values: cell (int), bool, Float, or String.
@@ Line 71: / Line 111: @@
 This pattern is common for functions that do String manipulations.
 [[Category:SourcePawn Basics]]

@@ Line 45: / Line 45: @@
    new Handle:g_hAutoTeamBalance;
-−
    public OnAllPluginsLoaded()
+   {