Scripting Cvars (AMX Mod X) - Revision history

Edon1337 at 22:51, 25 February 2017

2017-02-25T22:51:54Z

Edon1337 at 22:51, 25 February 2017

2017-02-25T22:51:09Z

Khoralt: wrong function named

2006-12-08T04:46:02Z

wrong function named

Freecode: /* Server-Side */

2006-01-14T20:38:16Z

‎Server-Side

BAILOPAN: Cvars (AMX Mod X) moved to Scripting Cvars (AMX Mod X)

2006-01-14T18:21:27Z

Cvars (AMX Mod X) moved to Scripting Cvars (AMX Mod X)

BAILOPAN at 16:33, 14 January 2006

2006-01-14T16:33:16Z

BAILOPAN at 16:30, 14 January 2006

2006-01-14T16:30:34Z

BAILOPAN at 16:28, 14 January 2006

2006-01-14T16:28:48Z

BAILOPAN at 16:28, 14 January 2006

2006-01-14T16:28:29Z

BAILOPAN at 16:27, 14 January 2006

2006-01-14T16:27:02Z

← Older revision		Revision as of 22:51, 25 February 2017
Line 1:		Line 1:
−	[[CVARs]], or Console VARiables, are an easy and efficient way to store configurable variables on the server. Half-Life 1 supports both server-side cvars and client-side cvars. Internally, cvars are stored as both a float and a string. CVARs can be used for easy access outside the plugin. Valid example would be : Storing Weapon Knock back in a CVAR then ~~edit~~ it via configurable files.	+	[[CVARs]], or Console VARiables, are an easy and efficient way to store configurable variables on the server. Half-Life 1 supports both server-side cvars and client-side cvars. Internally, cvars are stored as both a float and a string. CVARs can be used for easy access outside the plugin. Valid example would be : Storing Weapon Knock back in a CVAR then editing it via configurable files.

	== Server-Side ==		== Server-Side ==

← Older revision		Revision as of 22:51, 25 February 2017
Line 1:		Line 1:
−	[[CVARs]], or Console VARiables, are an easy and efficient way to store configurable variables on the server. Half-Life 1 supports both server-side cvars and client-side cvars. Internally, cvars are stored as both a float and a string.	+	[[CVARs]], or Console VARiables, are an easy and efficient way to store configurable variables on the server. Half-Life 1 supports both server-side cvars and client-side cvars. Internally, cvars are stored as both a float and a string. CVARs can be used for easy access outside the plugin. Valid example would be : Storing Weapon Knock back in a CVAR then edit it via configurable files.

	== Server-Side ==		== Server-Side ==

@@ Line 2: / Line 2: @@
 == Server-Side ==
-To create a cvar, use <tt>register_native</tt>.
+To create a cvar, use <tt>register_cvar</tt>.
 <pre>register_cvar(const name[],const string[],flags = 0,Float:fvalue = 0.0);</pre>

@@ Line 11: / Line 11: @@
 ** name[] : The name of the CVAR you want to register
 ** string[] : The default value of the CVAR
-** flags : See [[Cvars (AMX Mod X)#Flags]].
+** flags : See [[#Flags|Cvars (AMX Mod X)]].
 === Getting Values ===

← Older revision		Revision as of 16:33, 14 January 2006
Line 103:		Line 103:


−	[[Category:~~Core~~ (AMX Mod X)]]	+	[[Category:Scripting (AMX Mod X)]]

← Older revision	Revision as of 18:21, 14 January 2006
(No difference)

@@ Line 11: / Line 11: @@
 ** name[] : The name of the CVAR you want to register
 ** string[] : The default value of the CVAR
-** flags : See [[Cvars (AMX Mod X)#flags]].
+** flags : See [[Cvars (AMX Mod X)#Flags]].
 === Getting Values ===
@@ Line 35: / Line 35: @@
 set_cvar_num(const cvarname[],value);
 </pre>
-=== <a name="flags">Flags</a> ===
+===Flags===
 These flags can be used for the third parameter in the <tt>register_cvar</tt> native:

@@ Line 1: / Line 1: @@
-CVARs, or Console VARiables, are an easy and effecient way to incorporate user defined variations within code. Internally, all CVAR's are stored as strings, but can be recovered in any format.
+[[CVARs]], or Console VARiables, are an easy and efficient way to store configurable variables on the server.  Half-Life 1 supports both server-side cvars and client-side cvars.  Internally, cvars are stored as both a float and a string.
-CVARs come in two flavors: server and client.
+== Server-Side ==
+To create a cvar, use <tt>register_native</tt>.
-== Server Side CVARs ==
+<pre>register_cvar(const name[],const string[],flags = 0,Float:fvalue = 0.0);</pre>
 Note: The last parameter is for backwards compatibility only, and serves no purpose in AMXx.
-It is recommended you register CVARs during <tt>plugin_init</tt>, so that other plugins may alter them at <tt>plugin_cfg</tt>
+It is recommended you register CVARs during [[Core Forwards (AMX Mod X)|plugin_init]], so that other plugins may alter them at [[Core Forwards (AMX Mod X)|plugin_cfg]].
 *Parameters:
 ** name[] : The name of the CVAR you want to register
 ** string[] : The default value of the CVAR
-** flags : See [[CVARs in AMXx#flags]].
+** flags : See [[Editing Cvars (AMX Mod X)#flags]].
-==== Getting Value ====
+=== Getting Values ===
-<tt>
+<pre>
 /* Gets a cvar float. */
 Float:get_cvar_float(const cvarname[]);
@@ Line 31: / Line 23: @@
 /* Reads a cvar value. */
 get_cvar_string(const cvarname[],output[],iLen);
-</tt>
+</pre>
-==== Setting Value ====
+=== Setting Value ===
-<tt>
+<pre>
 /* Sets a cvar to given value. */
 set_cvar_string(const cvar[],const value[]);
@@ Line 42: / Line 34: @@
 /* Sets a cvar with integer value. */
 set_cvar_num(const cvarname[],value);
-</tt>
+</pre>
-==== Flags ====
+=== Flags ===
 These flags can be used for the third parameter in the <tt>register_cvar</tt> native:
-<tt>
+<pre>
 #define	FCVAR_ARCHIVE		1	/* set to cause it to be saved to vars.rc */
 #define	FCVAR_USERINFO		2	/* changes the client's info string */
@@ Line 58: / Line 48: @@
 #define FCVAR_PRINTABLEONLY	128	/* This cvar's string cannot contain unprintable characters ( e.g., used for player name etc ). */
 #define FCVAR_UNLOGGED		256	/* If this is a FCVAR_SERVER, don't log changes to the log file / console if we are creating a log */
-</tt>
+</pre>
-One may also alter these flags dynamically, using the flag natives:
+You can alter these flags dynamically, using the cvar flag natives:
-<tt>
+<pre>
 /* Returns a cvar flags. */
 get_cvar_flags(const cvar[]);
@@ Line 72: / Line 62: @@
 * fun_version and sv_cheats cvars). */
 remove_cvar_flags(const cvar[],flags = -1);
-</tt>
+</pre>
 == Client Side CVARs ==
-Client side CVARs, like server side CVARs, allow bits of code to be dynamic. However, since they are in the client, we cannot create such CVARs, only alter them.
+Client side cvars cannot be created in Half-Life 1.  The cvar must exist in advance.  Furthermore, since it must be retrieved or set over the network, knowing the value at a given point in time is impossible.  You can, however, query a client for a cvar and get an asynchronous response, and use client_cmd to set a new value if necessary.
-==== Setting ====
+=== Getting ===
-Setting a client side CVAR is easy; execute a new value onto the client:
+Recently, VALVE added a client CVAR checking interface, which has been added to AMX Mod X:
 // Dispatches a client cvar query
 //  id: Player id
@@ Line 99: / Line 81: @@
 //  public callbackCvarValue(id, const cvar[], const value[], const param[])
 query_client_cvar(id, const cvar[], const resultFunc[], paramlen=0, const params[] = "");
-This native may appear daunting, but it is actually quite simple; the first parameter is the player, the second the CVAR, the third the function called which will contain the client CVAR, and the last two are for allowing the passage of strings.
+This native may appear daunting, but it is actually quite simple; the first parameter is the player, the second the cvar, the third the function called which will contain the client CVAR, and the last two are for allowing the passage of strings.
 If you wish to get an array or strting back, simply put the length you want it, and fill params will a value. Then, in your return function, you will receive an array.
-==== Locking ====
+=== Setting ===
-Unfortunately, the client can change CVAR values back, unless we lock them. Since alias's are executed before CVARs, we can create an alias of the same name of the CVAR, thus locking the CVAR:
+Since the client can change cvar values back as soon as they're set, it might be necessary to lock them. Since alias's are executed before cvars, you can create an alias of the same name of the cvar, thus locking the cvar:
-<tt> CVAR: cvar_ex.<br>
+<pre>//CVAR: cvar_ex.
-client_cmd(player_id,"cvar_ex 1")<br>
+client_cmd(player_id,"cvar_ex 1")
-client_cmd(player_id,";alias cvar_ex")</tt>
+client_cmd(player_id,";alias cvar_ex")</pre>
-Now the CVAR cannot be changed by the player or the server; it is locked.
+Now the cvar cannot be changed by the player or the server; it is locked.
 [[Category:Core (AMX Mod X)]]