AutoConfigs (AMX Mod X Scripting) - Revision history

Arkshine: Replaced the hardcoded page name with PAGENAME global

2017-06-17T22:57:50Z

Replaced the hardcoded page name with PAGENAME global

Arkshine at 22:55, 17 June 2017

2017-06-17T22:55:15Z

Arkshine: Adjusted spaces and added some examples

2017-06-17T20:07:09Z

Adjusted spaces and added some examples

Arkshine: Fixed some typos

2017-06-16T22:21:43Z

Fixed some typos

Arkshine: Fixed category link

2017-06-16T21:40:19Z

Fixed category link

Arkshine: Added AutoConfigs documentation

2017-06-16T21:38:38Z

Added AutoConfigs documentation

New page

{{Languages|AutoConfigs (AMX Mod X Scripting)}}

== Purpose ==

AMX Mod X provides a system for simple plugins to automatically generate config files which get executed on load. This is done via the {{tt|AutoExecConfig}} native in {{tt|[https://github.com/alliedmodders/amxmodx/blob/master/plugins/include/amxmodx.inc#L3266-L3306 scripting/include/amxmodx.inc]}}.

Once all configuration files are executed, {{tt|OnConfigsExecuted}} is called. This forward will always be called, even if your plugin had no configs or if it was loaded late.

== Usage ==

=== Native ===

:{{margin|20px 0|{{tt|AutoExecConfig(bool:{{h:title||autoCreate}} <nowiki>=</nowiki> true, const {{h:title||name}}[] <nowiki>=</nowiki> "", const {{h:title||folder}}[] <nowiki>=</nowiki> "")|opt=large}}}}

:Specifies that the given config file should be executed after plugin load.

:{|
|-
| {{tt|autoCreate}} || {{ns}} If true, AMX Mod X will dump all cvars created by the plugin into a config file if the specified config file does not exist.
|-
| {{tt|name}} || {{ns}} Name of the config file (excluding the {{tt|.cfg|opt=nobg}} extension). If empty, the plugin's name will be used instead, with {{tt|plugin_|opt=nobg}} prepended. For example, {{tt|hat.amxx|opt=nobg}} becomes {{tt|plugin_hat.cfg|opt=nobg}}.
|-
| {{tt|folder}} || {{ns}} Optionally change the folder under the main configs folder. By default configs go in {{tt|/amxmodx/configs/|opt=nobg}}.
|}

:{{alert|info|Note:|It is possible to write nested folders; AMX Mod X will attempt to create each one.|opt=full-border}}
:{{alert|info|Note:|If you have multiple {{tt|AutoExecConfig|opt=nobg}} calls marked with {{tt|autoCreate|opt=nobg}} being true, the first file to be auto created will prevent any others from being created. Thus, there is no way to automatically split cvars between multiple files.|opt=full-border}}

=== Forward ===

:{{margin|20px 0|{{tt|OnConfigsExecuted()|opt=large}}}}

:Called when the map has loaded, and all configs are done executing.
:This includes {{tt|servercfgfile|opt=nobg}} ({{tt|server.cfg|opt=nobg}}), {{tt|amxx.cfg|opt=nobg}}, plugin's config, and per-map config.

:{{alert|info|Note:|This is best place to initialize plugin functions which are based on cvar data.|opt=full-border}}
:{{alert|info|Note:|This will always be called once and only once per map. It will be called few seconds after {{tt|plugin_cfg()|opt=nobg}}.|opt=full-border}}

:{{margin|30px 0 20px 0|{{tt|OnAutoConfigsBuffered()|opt=large}}}}

:Called when the map has loaded, right after {{tt|plugin_cfg()|opt=nobg}} but any time before {{tt|OnConfigsExecuted()|opt=nobg}}.
:It's called after {{tt|amxx.cfg|opt=nobg}} and all {{tt|AutoExecConfig|opt=nobg}} exec commands have been added to the server command buffer.

:{{alert|info|Note:|This will always be called once and only once per map.|opt=full-border}}

== Example ==

<pawn>#include <amxmodx>

public plugin_init()
{
register_plugin("Hat", "User", "1.0");

create_cvar("mysqlk_database", "", .description = "MySQL database");
create_cvar("mysqlk_host", "localhost", .description = "MySQL host, use this to configure various^nthings for your server.");

AutoExecConfig();
}</pawn>

That would export a config file that looks like this:

<pawn>
// This file was auto-generated by AMX Mod X (v1.9)
// Cvars for plugin "Hat" by "User" (hat.amxx, v1.0)

// MySQL database
// -
// Default: ""
mysqlk_database ""

// MySQL host, use this to configure various
// things for your server.
// -
// Default: "localhost"
mysqlk_host "localhost"
</pawn>

[[Category:AMX Mod X Scripting]]

← Older revision		Revision as of 22:57, 17 June 2017
Line 1:		Line 1:
−	{{Languages\|~~AutoConfigs_(AMX_Mod_X_Scripting)~~}}	+	{{Languages\|{{PAGENAME}}}}

@@ Line 12: / Line 12: @@
 === Native ===
-:{{margin|20px 0 15px 0|{{tt|AutoExecConfig({{color|green|bool}}:{{h:title||autoCreate}} <nowiki>=</nowiki> true, const {{h:title||name}}[] <nowiki>=</nowiki> "", const {{h:title||folder}}[] <nowiki>=</nowiki> "")|opt=large}}}}
+{{margin|20px 0 15px 0|{{tt|AutoExecConfig({{color|green|bool}}:{{h:title||autoCreate}} <nowiki>=</nowiki> true, const {{h:title||name}}[] <nowiki>=</nowiki> "", const {{h:title||folder}}[] <nowiki>=</nowiki> "")|opt=large}}}}
-::Specifies that the given config file should be executed after plugin load.
+:Specifies that the given config file should be executed after plugin load.
-::{|
+:{|
 |-
 | {{tt|autoCreate}} || {{ns}} If true, AMX Mod X will dump all cvars created by the plugin into a config file if the specified config file does not exist.
@@ Line 24: / Line 24: @@
 |}
-::{{alert|info|Note:|It is possible to write nested folders; AMX Mod X will attempt to create each one.|opt=full-border}}
+:{{alert|info|Note:|It is possible to write nested folders; AMX Mod X will attempt to create each one.|opt=full-border}}
-::{{alert|info|Note:|If you have multiple {{tt|AutoExecConfig|opt=nobg}} calls marked with {{tt|autoCreate|opt=nobg}} being true, the first file to be auto created will prevent any others from being created.  Thus, there is no way to automatically split cvars between multiple files.|opt=full-border}}
+:{{alert|info|Note:|If you have multiple {{tt|AutoExecConfig|opt=nobg}} calls marked with {{tt|autoCreate|opt=nobg}} being true, the first file to be auto created will prevent any others from being created.  Thus, there is no way to automatically split cvars between multiple files.|opt=full-border}}
-::{{alert|success|Example:|{{tt|{{color|green|// Default values. /configs/plugins/plugin-hat.cfg will be created (if not present) and executed.}}<br />AutoExecConfig();<br />{{color|green|// plugin-hat.cfg will executed only.}}<br />AutoExecConfig(.autoCreate <nowiki>=</nowiki> false);<br />{{color|green|// plugin-MyHat.cfg will be created (if not present) and executed.}}<br />AutoExecConfig(.name <nowiki>=</nowiki> "MyHat");<br />{{color|green|// /configs/my-plugins/plugin-hat.cfg will be created (if not present) and executed.}}<br />AutoExecConfig(.folder <nowiki>=</nowiki> "my-plugins");|opt=nobg}}|opt=full-border}}
+:{{alert|success|Example:|{{tt|{{color|green|// Default values. /configs/plugins/plugin-hat.cfg will be created (if not present) and executed.}}<br />AutoExecConfig();<br />{{color|green|// plugin-hat.cfg will executed only.}}<br />AutoExecConfig(.autoCreate <nowiki>=</nowiki> false);<br />{{color|green|// plugin-MyHat.cfg will be created (if not present) and executed.}}<br />AutoExecConfig(.name <nowiki>=</nowiki> "MyHat");<br />{{color|green|// /configs/my-plugins/plugin-hat.cfg will be created (if not present) and executed.}}<br />AutoExecConfig(.folder <nowiki>=</nowiki> "my-plugins");|opt=nobg}}|opt=full-border}}
 === Forward ===
-:{{margin|20px 0 15px 0|{{tt|OnConfigsExecuted()|opt=large}}}}
+{{margin|20px 0 15px 0|{{tt|OnConfigsExecuted()|opt=large}}}}
-::Called when the map has loaded, and all configs are done executing.
+:Called when the map has loaded, and all configs are done executing.
-::This includes {{tt|servercfgfile|opt=nobg}} ({{tt|server.cfg|opt=nobg}}), {{tt|amxx.cfg|opt=nobg}}, plugin's config, and per-map config.
+:This includes {{tt|servercfgfile|opt=nobg}} ({{tt|server.cfg|opt=nobg}}), {{tt|amxx.cfg|opt=nobg}}, plugin's config, and per-map config.
-::{{alert|info|Note:|This is best place to initialize plugin functions which are based on cvar data.|opt=full-border}}
+:{{alert|info|Note:|This is best place to initialize plugin functions which are based on cvar data.|opt=full-border}}
-::{{alert|info|Note:|This will always be called once and only once per map.  It will be called few seconds after {{tt|plugin_cfg()|opt=nobg}}.|opt=full-border}}
+:{{alert|info|Note:|This will always be called once and only once per map.  It will be called few seconds after {{tt|plugin_cfg()|opt=nobg}}.|opt=full-border}}
-::{{alert|success|Example:|{{tt|public OnConfigsExecuted()<br />{<br />{{ns|4}}new const value <nowiki>=</nowiki> get_cvar_num("mp_timelimit");<br />{{ns|4}}...<br />}|opt=nobg}}|opt=full-border}}
+:{{alert|success|Example:|{{tt|public OnConfigsExecuted()<br />{<br />{{ns|4}}new const value <nowiki>=</nowiki> get_cvar_num("mp_timelimit");<br />{{ns|4}}...<br />}|opt=nobg}}|opt=full-border}}
-:{{margin|30px 0 15px 0|{{tt|OnAutoConfigsBuffered()|opt=large}}}}
+{{margin|30px 0 15px 0|{{tt|OnAutoConfigsBuffered()|opt=large}}}}
-::Called when the map has loaded, right after {{tt|plugin_cfg()|opt=nobg}} but any time before {{tt|OnConfigsExecuted()|opt=nobg}}.
+:Called when the map has loaded, right after {{tt|plugin_cfg()|opt=nobg}} but any time before {{tt|OnConfigsExecuted()|opt=nobg}}.
-::It's called after {{tt|amxx.cfg|opt=nobg}} and  all {{tt|AutoExecConfig|opt=nobg}} exec commands have been added to the server command buffer.
+:It's called after {{tt|amxx.cfg|opt=nobg}} and  all {{tt|AutoExecConfig|opt=nobg}} exec commands have been added to the server command buffer.
-::{{alert|info|Note:|This will always be called once and only once per map.|opt=full-border}}
+:{{alert|info|Note:|This will always be called once and only once per map.|opt=full-border}}
 == Example ==

← Older revision		Revision as of 21:40, 16 June 2017
Line 78:		Line 78:
	</pawn>		</pawn>

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

@@ Line 1: / Line 1: @@
-{{Languages|AutoConfigs (AMX Mod X Scripting)}}
+{{Languages|AutoConfigs_(AMX_Mod_X_Scripting)}}
@@ Line 20: / Line 20: @@
 | {{tt|autoCreate}} || {{ns}} If true, AMX Mod X will dump all cvars created by the plugin into a config file if the specified config file does not exist.
 |-
-| {{tt|name}}       || {{ns}} Name of the config file (excluding the {{tt|.cfg|opt=nobg}} extension).  If empty, the plugin's name will be used instead, with {{tt|plugin_|opt=nobg}} prepended.  For example, {{tt|hat.amxx|opt=nobg}} becomes {{tt|plugin_hat.cfg|opt=nobg}}.
+| {{tt|name}}       || {{ns}} Name of the config file (excluding the {{tt|.cfg|opt=nobg}} extension).  If empty, the plugin's name will be used instead, with {{tt|plugin-|opt=nobg}} prepended.  For example, {{tt|hat.amxx|opt=nobg}} becomes {{tt|plugin-hat.cfg|opt=nobg}}.
 |-
 | {{tt|folder}}     || {{ns}} Optionally change the folder under the main configs folder.  By default configs go in {{tt|/amxmodx/configs/|opt=nobg}}.