AlliedModders Wiki - User contributions [en]

SuperHero Mod

2009-03-26T06:32:53Z

Vittu: added very little content

'''''SuperHero Mod (SH Mod)''''' is a [http://en.wikipedia.org/wiki/Counter-Strike Counter-Strike] / [http://en.wikipedia.org/wiki/Counter-Strike:_Condition_Zero Counter-Strike: Condition Zero] [[AMX Mod X]] plugin. It was originally created by {Hoj}Batman for AMX Mod to be an extendable plugin.

What if SuperHeroes Played Counter-Strike? 
Now they Do. This is an add-on that will make Mix/Match Hero Abilities available to players. Pick and choose hero powers as you advance levels from a vast selection of heroes. 
Thanks goes out to {Hoj}Batman for this awesome plugin, he is the original author that got it all started and did most of (if not all) of the original coding. 

ToDo: Fill this in

== External links ==
*[http://shero.alliedmods.net/ SuperHero Mod website] - Official website
**[http://forums.alliedmods.net/forumdisplay.php?f=30 SuperHero Mod forums] - Official forums
*[http://svn.tcwonline.org/viewvc.cgi/?root=superhero SuperHero Mod SVN] - SVN for latest build
*[http://fs.alliedmods.net/index.php?project=7 SuperHero Mod Bug Reports] - Report bugs with SuperHero Mod
*[http://steamcommunity.com/groups/shero SuperHero Mod (SH Mod)] - Official Steam Community

[[Category:3rd Party Plugins (AMX Mod X)]]

SuperHero Mod

2009-03-26T05:53:41Z

Vittu: added more content

What if SuperHeroes Played Counter-Strike? 
Now they Do. This is an add-on that will make Mix/Match Hero Abilities available to players. Pick and choose hero powers as you advance levels from a vast selection of heroes. 
Thanks goes out to {Hoj}Batman for this awesome plugin, he is the original author that got it all started and did most of (if not all) of the original coding. 

ToDo: Fill this in

== External links ==
*[http://shero.alliedmods.net/ SuperHero Mod website] - Official website
**[http://forums.alliedmods.net/forumdisplay.php?f=30 SuperHero Mod forums] - Official forums
*[http://svn.tcwonline.org/viewvc.cgi/?root=superhero SuperHero Mod SVN] - SVN for latest build
*[http://fs.alliedmods.net/index.php?project=7 SuperHero Mod Bug Reports] - Report bugs with SuperHero Mod
*[http://steamcommunity.com/groups/shero SuperHero Mod (SH Mod)] - Official Steam Community

[[Category:3rd Party Plugins (AMX Mod X)]]

SuperHero Mod

2009-03-26T04:22:07Z

Vittu: Created page for SuperHero Mod documenation.

Place holder for adding documentation.

[[Category:3rd Party Plugins (AMX Mod X)]]

Writing Extensions from Metamod:Source Plugins

2007-11-13T21:23:49Z

Vittu: /* Doing Something Useful */ fixed Writing Extensions link

[[SourceMod]]'s "External Extensions" feature lets developers implement an extension simply by passing in an object instance, rather than implementing a full library file. This is typically done from [[Metamod:Source]] plugins which wish to:

*Enable optional, third party extensibility via SourceMod's scripting layer.
*For whatever reason, do not want to move their "standalone" plugin to a full SourceMod extension.
*Or any of the above, in the presence of SourceMod, without actually requiring it to be loaded.

=Overview=
Attaching to SourceMod will be fairly easy for any developer who has authored a Metamod:Source plugin. However, unlike Metamod:Source, SourceMod has fairly stricter design standards and a much richer API set. It is unacceptable to not account for details such as unloading, and special attention must be taken care to free and manage SourceMod resources properly. Remember crashes or Handle leaks will affect all of SourceMod's loaded plugins/extensions, instead of just your plugin.

The general steps are:
<ol>
<li>Implement the <tt>IExtensionInterface</tt> interface, from <tt>public/IExtensionSys.h</tt>.</li>
<li>In <tt>ISmmPlugin::AllPluginsLoaded()</tt>, perform the attach if possible.</li>
<li>Detect SourceMod loads in <tt>IMetamodListener::OnMetamodQuery()</tt>.</li>
<li>Store global pointers once bound, such as the self-referencing <tt>IExtension *</tt>.</li>
<li>On <tt>ISmmPlugin::Unload()</tt>, detach from SourceMod.</li>
</ol>

Note that SourceMod requires each extension to have a unique name. This is not necessarily a file name, although usually it resembles one. This name is to used, in conjunction with include files, to make sure plugin requirements are met when they load.

=Detailed Steps=
The information below is for a more detailed overview. The sample SDK provides a full implementation that is recommended over simply copying and pasting the sample code provided here. The sample SDK is explained further on.

==Implementing the Extension==
Implementing the actual Extension itself means simply inheriting the <tt>IExtensionInterface</tt> class as noted earlier. For example:

<cpp>
class MyExtension : public IExtensionInterface
{
public:
virtual bool OnExtensionLoad(IExtension *me,
IShareSys *sys,
char *error,
size_t maxlength,
bool late);
virtual void OnExtensionUnload();
virtual void OnExtensionsAllLoaded();
virtual void OnExtensionPauseChange(bool pause);
virtual bool QueryRunning(char *error, size_t maxlength);
virtual bool IsMetamodExtension();
virtual const char *GetExtensionName();
virtual const char *GetExtensionURL();
virtual const char *GetExtensionTag();
virtual const char *GetExtensionAuthor();
virtual const char *GetExtensionVerString();
virtual const char *GetExtensionDescription();
virtual const char *GetExtensionDateString();
};
</cpp>

Most functions are self explanatory. A few important notes:
*<tt>OnExtensionLoad</tt> is used to provide essential interfaces: <tt>IShareSys</tt> (acquires/shares objects in the SourceMod heirarchy), and <tt>IExtension</tt> (self-referencing pointer used for identification and unloading).
*<tt>OnExtensionLoad</tt> is also used to query for any extra interfaces that the extension requires. For example, if the [[Handle API (SourceMod)|Handle System]] is needed, it would be queried and its pointer cached. If it couldn't be found, then <tt>OnExtensionLoad</tt> would return false to deny loading.
*<tt>OnExtensionUnload()</tt> is used to free resources. If a resource (interface) is being used from another extension, and that extension is unloaded, separate cases must be taken care of because of dynamic unloadability. These (unusual) cases are explained further in the [[Writing Extensions]] article.
*<tt>IsMetamodExtension()</tt> must return false. No exceptions. Only pure-SourceMod extensions which optionally bind to Metamod:Source can return true here.

Examples:
<cpp>
IShareSys *sharesys = NULL;
IExtension *myself = NULL;

bool MyExtension::OnExtensionLoad(IExtension *me,
IShareSys *sys,
char *error,
size_t maxlength,
bool late)
{
sharesys = sys;
myself = me;

/* Get anything important we rely on */

return true;
}</cpp>

==Binding to SourceMod==
Binding to SourceMod requires a few steps:
<ol>
<li>Acquire the <tt>IExtensionManager</tt> interface.</li>
<li>If it exists, bind the extension.</li>
<li>If not, wait for SourceMod to load.</li>
</ol>

<tt>IExtensionSys.h</tt> provides a macro, <tt>SOURCEMOD_INTERFACE_EXTENSIONSYS</tt>, which can be used via <tt>ISmmAPI::MetamodQuery()</tt>. If you do not recall, that is the facility Metamod:Source uses for inter-plugin communication. An example implementation of binding to SourceMod might look like:

<cpp>
bool SM_LoadExtension(char *error, size_t maxlength)
{
if ((smexts = (IExtensionManager *)g_SMAPI->MetaFactory(
SOURCEMOD_INTERFACE_EXTENSIONS,
NULL,
NULL)) == NULL)
{
UTIL_Format(error, maxlength, SOURCEMOD_INTERFACE_EXTENSIONS " interface not found");
return false;
}

char path[256];
g_SMAPI->PathFormat(path, sizeof(path),
#if defined __linux__
"addons/myplugin/bin/myplugin_mm_i486.so"
#else
"addons\\myplugin\\bin\\myplugin_mm.dll"
#endif
);

if ((myself = smexts->LoadExternal(&g_SMExt,
path,
"myplugin_mm.ext",
error,
maxlength)) == NULL)
{
/* Error was supplied by call */
return false;
}

return true;
}</cpp>

==Detecting SourceMod Loads==
This is also fairly easy:
<ol>
<li>If not already done: Inherit <tt>IMetamodListener</tt>, implement <tt>OnMetamodQuery()</tt>.</li>
<li>If not already done: Call <tt>ISmmAPI::AddListener</tt> for your <tt>IMetamodListener</tt> interface.</li>
<li>Watch for occurrences of <tt>SOURCEMOD_NOTICE_EXTENSIONS</tt>.</li>
</ol>

Example of such an implementation:
<cpp>
bool StubPlugin::Load(PluginId id, ISmmAPI *ismm, char *error, size_t maxlen, bool late)
{
PLUGIN_SAVEVARS();

/* Blah blah blah */

ismm->AddListener(this, this);

return true;
}

void StubPlugin::AllPluginsLoaded()
{
/* BIND TO SOURCMEOD IF POSSIBLE */
}

void *StubPlugin::OnMetamodQuery(const char *iface, int *ret)
{
if (strcmp(iface, SOURCEMOD_NOTICE_EXTENSIONS) == 0)
{
/* BIND TO SOURCEMOD */
}

if (ret != NULL)
{
*ret = IFACE_OK;
}

return NULL;
}</cpp>

It is very important to return <tt>NULL</tt> even when this interface is detected. Otherwise, you may block other extensions from receiving the callback.

==Detaching from SourceMod==
Detaching is essential; if your plugin unloads without detaching, SourceMod will very quickly crash trying to deference your memory. Luckily, doing so is trivial. For example, in your <tt>ISmmPlugin::Unload()</tt> callback:

<cpp>
bool StubPlugin::Unload(char *error, size_t maxlen)
{
smexts->UnloadExtension(myself);
}</cpp>

Where <tt>smexts</tt> is the <tt>IExtensionManager</tt> pointer, and <tt>myself</tt> is the <tt>IExtension</tt> pointer.

=SDK and Sample Implementation=
The SourceMod SDK contains a sample implementation in <tt>public/mms_sample_ext</tt>. It is the Metamod:Source "stub plugin," modified to load as a SourceMod extension.

The following files have been added:
*<tt>sm_sdk_config.h</tt> - Contains two function for mapping and unmapping SourceMod Core interfaces. Interfaces can be enabled or disabled by toggling comments next to preprocessor macros here.
*<tt>sm_sdk_config.cpp</tt> - Implementation of <tt>sm_sdk_config.h</tt>. There is no need to edit this.
*<tt>stub_util.h/cpp</tt> - Contains a platform-safe wrapper for text formatting.
*<tt>sm_ext.cpp/sm_ext.h</tt> - Sample implementation <tt>IExtensionInterface.h</tt> and the binding/detaching code.

Additionally, <tt>stub_mm.cpp</tt>/<tt>stub_mm.h</tt> have been modified. <tt>IMetamodListener</tt> is inherited, and <tt>OnMetamodQuery</tt> is implemented as described earlier. Also, <tt>ISmmAPI::AllPluginsLoaded</tt> attempts a SourceMod binding.

'''Note:''' <tt>sm_sdk_config.h</tt> provides <tt>SM_AcquireInterfaces</tt>. It must be called to acquire the interfaces that are uncommented in the same file, unless you intend to query them manually.

'''Note:''' It is highly recommend that developers read the added files, and at the very least, include the <tt>sm_sdk_config</tt> files, which greatly simplify the acquisition of interfaces.

'''Note:''' The Makefiles are provided as a convenience/example, and for our own testing. As our build process requires special vcproj/sln changes (which are not yet documented), no Visual Studio project files are provided for <tt>mms_sample_ext</tt>. As most developers will already have an MM:S plugin implemented, this should largely be irrelevant. Otherwise, the project files from <tt>stub_mm</tt> can be used instead.

==Renamed Variables/Macros==
The extension SDK has a few renamed macros/variables from the default SDK. This is to prevent potential name clashes for Metamod:Source plugins, which have pre-existing code.

'''Changed global variables:'''
*g_pForwards, forwards -> sm_forwards
*g_pHandleSys, handlesys -> sm_handlesys
*g_pSM -> sm_main
*playerhelpers -> sm_players
*dbi -> sm_dbi
*gameconfs -> sm_gameconfs
*memutils -> sm_memutils
*gamehelpers -> sm_gamehelpers
*timersys -> sm_timersys
*threader -> sm_threader
*libsys -> sm_libsys
*plsys -> sm_plsys
*textparsers -> sm_text
*adminsys -> sm_adminsys
*menus -> sm_menus

'''Changed macros:'''
*<tt>SM_GET_IFACE</tt> -> <tt>SM_FIND_IFACE_OR_FAIL</tt>
*<tt>SM_GET_LATE_IFACE</tt> -> <tt>SM_FIND_IFACE</tt>

==Example of a Successful Load==
<pre>
meta load addons/stub_mm
Plugin "Stub Plugin" loaded with id 3.
sm exts list
[SM] Displaying 3 extensions:
[01] SDK Tools (1.0.0.1336): Source SDK Tools
[02] BinTools (1.0.0.1336): Low-level C/C++ Calling API
[03] Stub Plugin (1.0.0.0): Sample empty plugin
sm exts info 3
File: myplugin_mm.ext
Loaded: Yes (version 1.0.0.0)
Name: Stub Plugin (Sample empty plugin)
Author: AlliedModders LLC (http://www.sourcemm.net/)
Binary info: API version 2 (compiled Nov 10 2007)
Method: Loaded by Metamod:Source, attached to SourceMod
meta unload 3
Plugin 3 unloaded.
sm exts list
[SM] Displaying 2 extensions:
[01] SDK Tools (1.0.0.1336): Source SDK Tools
[02] BinTools (1.0.0.1336): Low-level C/C++ Calling API
</pre>

=Doing Something Useful=
SourceMod has over a dozen interfaces for interacting with plugins and greatly simplifying the Half-Life 2 development process. It contains memory abstraction, fast data structures, an abstracted menu and voting system, the ability to create and invoke plugin callbacks ("forwards"), the ability to provide new native functions to plugins, text processing, game data abstraction, threading abstraction, signature scanning, timers, and an object-oriented SQL layer.

For more information, see the [[Writing Extensions]] article. Note that the article uses different global names. See the earlier section for finding which names changed.

=Further Reading=
*[[Writing Extensions]]
*[[:Category:SourceMod Development|SourceMod Development Category]]
*[http://www.sourcemod.net/sdk/dox/ C++ API auto-generated documentation]

[[Category:SourceMod Development]].

Adding Admins (AMX Mod X)

2006-07-26T07:48:18Z

Vittu: Small fix plus format changes to links in page

=Admins (non-SQL)=
==Adding an Admin==
First, open the amxmodx/configs/users.ini file with your favorite text editor. Scroll to the bottom. Admin entries are stored with four options: Authentication, Password, Access Right, Connection Properties.

In the early days of [[Half-Life 1]] it was common to have admins authenticate by name. However, now it is recommended to auth by steamid. An example of a typical admin entry is:
<pre>"STEAM_0:0:123456" "" "abcdefghijklmnopqrstu" "ce"</pre>
Entries are one-per-line, and each of the four options are space separated, contained in double-quotes. This one means:
#The user has [[SteamID]] STEAM_0:0:123456
#The user has no password (steamid-authentication)
#Access rights are levels <tt>a</tt> through <tt>u</tt>
#The user is a steamid ("c") and has no password ("e")

It is also possible to authenticate by username:
<pre>"BAILOPAN" "mypass" "abcdefghijklmnopqrstu" "a"</pre>

To authenticate, BAILOPAN would put this in his client's autoexec.cfg, where "_pw" is the value of "amx_password_field" in [[amxx.cfg]].
<pre>setinfo "_pw" "mypass"</pre>

For information on what access levels mean, see [[#Access Levels|Access Levels]].

{{qnotice|It is important that you do not use the 'z' flag for admins.}}

==Removing an Admin==
Find the admin's entry in your amxmodx/configs/users.ini file, and put a semicolon in front of it. For example:
<pre>;"STEAM_0:0:123456" "" "abcdefghijklmnopqrstu" "ce"</pre>

That will prevent the entry from being read.
{{LanguageSwitch}}

=Admins (SQL)=
AMX Mod X lets you store admin accounts in a MySQL database. This is ideal if you have multiple servers with common administrators.

==Configuring Server==
First, make sure you have configured your server for SQL by reading [[Configuring AMX Mod X#SQL|Configuring AMX Mod X: SQL]]. Then, enable the admin_sql.amxx plugin instead of admin.amxx, by opening amxmodx/configs/plugins.ini. You should change the first two entries to look something like this:
<pre>;admin.amxx ; Disabled
admin_sql.amxx ; SQL admins</pre>

==Maintaining Admins==

Once the server loads for the first time, it will automatically create the table specified with <tt>amx_sql_table</tt>.

You can either add an admin through an SQL tool like an SQL Console or phpMyAdmin, or you can add an admin [[Adding Admins (AMX Mod X)#Console Command|using amx_addadmin]].

If you choose to use SQL directly (or an interface), you must learn the table layout. There are four columns, each corresponding to one of the four properties listed above in [[#Adding an Admin|Adding an Admin]]. For example:
<pre>INSERT INTO admins VALUES("STEAM_0:1:23456", "", "abcdefghijklmnopqrstu", "ce");</pre>

{{qnotice|It is important that you do not use the 'z' flag for admins.}}

For information on what access levels mean, see [[AMX Mod X Access Levels]].
{{LanguageSwitch}}

=Console Command=

You can also use the console command amx_addadmin for adding admins. It will work for both [[SQL]] and users.ini, depending on which plugin you have enabled. An example of using the command in-game:
<pre>amx_addadmin "BAILOPAN" "abcdefghijklmnopqrstu"</pre>
Using the command from the server/[[rcon]] console:
<pre>amx_addadmin "STEAM_0:1:23456" "abcdefgihjklmnopqrstu"</pre>

=Access Levels=
These access levels are the default access levels for the base [[AMX Mod X]] plugins. 3rd party plugins may have different usages for them, although in general users try to stick to the intentions for each flag.

:{|
|- class="t2th"
| Access Flag
| Purpose
|- class="t2td"
| a
| immunity (can't be kicked/baned/slayed/slaped and affected by other commmands)
|- class="t2td"
| b
| reservation (can join on reserved slots)
|- class="t2td"
| c
| amx_kick command
|- class="t2td"
| d
| amx_ban and amx_unban commands
|- class="t2td"
| e
| amx_slay and amx_slap commands
|- class="t2td"
| f
| amx_map command
|- class="t2td"
| g
| amx_cvar command (not all cvars will be available)
|- class="t2td"
| h
| amx_cfg command
|- class="t2td"
| i
| amx_chat and other chat commands
|- class="t2td"
| j
| amx_vote and other vote commands
|- class="t2td"
| k
| access to sv_password cvar (by amx_cvar command)
|- class="t2td"
| l
| access to amx_rcon command and rcon_password cvar (by amx_cvar command)
|- class="t2td"
| m
| custom level A (for additional plugins)
|- class="t2td"
| n
| custom level B
|- class="t2td"
| o
| custom level C
|- class="t2td"
| p
| custom level D
|- class="t2td"
| q
| custom level E
|- class="t2td"
| r
| custom level F
|- class="t2td"
| s
| custom level G
|- class="t2td"
| t
| custom level H
|- class="t2td"
| u
| menu access
|- class="t2td"
| z
| user (no admin)
|}

=Connection Flags=
These flags control how [[AMX Mod X]] attempts to authorize a connecting admin.

:{|
|- class="t2th"
| Connection Flag
| Purpose
|- class="t2td"
| a
| disconnect player on invalid password
|- class="t2td"
| b
| clan tag
|- class="t2td"
| c
| this is steamid/wonid
|- class="t2td"
| d
| this is ip
|- class="t2td"
| e
| password is not checked (only name/ip/steamid needed)
|}

[[Category:Documentation (AMX Mod X)]]

Temp Entity Events (Half-Life 1)

2006-02-05T00:45:43Z

Vittu: Added more effects, plus slight change to format

Add Main Description Here.

= Message Types=
Sets the type of message the temp entity is transmitted in.

MSG_ types that can be used for ''dest'' field in [http://www.amxmodx.org/funcwiki.php?go=func&id=262 message_begin] are as follows:
<pre>#define MSG_BROADCAST 0 // unreliable to all
#define MSG_ONE 1 // reliable to one (msg_entity)
#define MSG_ALL 2 // reliable to all
#define MSG_INIT 3 // write to the init string
#define MSG_PVS 4 // Ents in PVS of org
#define MSG_PAS 5 // Ents in PAS of org
#define MSG_PVS_R 6 // Reliable to PVS
#define MSG_PAS_R 7 // Reliable to PAS
#define MSG_ONE_UNRELIABLE 8 // Send to one client, but don't put in reliable stream, put in unreliable datagram (could be dropped)
#define MSG_SPEC 9 // Sends to all spectator proxies</pre>

= TempEnt Events =
Add Description Here.

== 0: TE_BEAMPOINTS ==
Creates a beam between two points.

Options
{| border="1" cellpadding="5"
|- style="background:#efefef;"
! Option || Range || Default || Description
|-
|nowrap="1"| Start
|nowrap="1"| X Y Z (coords)
|nowrap="1"| Origin of primary entity, or 0 0 0
|Starting point of the beam
|-
|nowrap="1"| End
|nowrap="1"| X Y Z (coords)
|nowrap="1"| Origin of secondary entity, or 0 0 0
|Ending point of the beam
|-
|nowrap="1"| Sprite
|nowrap="1"| sprite path
|nowrap="1"| "sprites/laserbeam.spr"
|The sprite to use in the beam
|-
|nowrap="1"| FrameStart
|nowrap="1"| 0-255
|nowrap="1"| 0
|The frame to start with in the sprite
|-
|nowrap="1"| FrameRate
|nowrap="1"| 0-255
|nowrap="1"| 0
|The frame rate to show the sprite at, in 0.1s (10 = 1 fps)
|-
|nowrap="1"| Life
|nowrap="1"| 0-255
|nowrap="1"| 50
|The length of time the beam shall remain, in 0.1s (50 = 5 seconds)
|-
|nowrap="1"| Width
|nowrap="1"| 0-255
|nowrap="1"| 10
|The width of the beam in 0.1s
|-
|nowrap="1"| Noise
|nowrap="1"| 0-255
|nowrap="1"| 10
|The noise amplitude of the beam, this controls how much the beam distorts, again in 0.1s
|-
|nowrap="1"| Color
|nowrap="1"| R G B
|nowrap="1"| 255 255 255
|The color of the beam in the RBG triplet value
|-
|nowrap="1"| Brightness
|nowrap="1"| 0-255
|nowrap="1"| 127
|The brightness of the beam
|-
|nowrap="1"| Scroll
|nowrap="1"| 0-255
|nowrap="1"| 0
|The scroll speed of the beam, in 0.1s (??)
|}

Format
<pre>#define TE_BEAMPOINTS 0 // beam effect between two points

message_begin(MSG_ ,SVC_TEMPENTITY)
write_byte(TE_BEAMPOINTS)
write_coord() // start position
write_coord()
write_coord()
write_coord() // end position
write_coord()
write_coord()
write_short() // sprite index
write_byte() // starting frame
write_byte() // frame rate in 0.1's
write_byte() // life in 0.1's
write_byte() // line width in 0.1's
write_byte() // noise amplitude in 0.01's
write_byte() // Red
write_byte() // Green
write_byte() // Blue
write_byte() // brightness
write_byte() // scroll speed in 0.1's
message_end()</pre>

== 1: TE_BEAMENTPOINT ==
Creates a beam between the primary entity and a point.

Options
{| border="1" cellpadding="5"
|- style="background:#efefef;"
! Option || Range || Default || Description
|-
|nowrap="1"| Start Entity
|nowrap="1"| ID of Entity
|nowrap="1"| Primary entity id
|Starting point of the beam from the id's origin
|-
|nowrap="1"| End
|nowrap="1"| X Y Z (coords)
|nowrap="1"| Origin of secondary entity, or 0 0 0
|Ending point of the beam
|-
|nowrap="1"| Sprite
|nowrap="1"| sprite path
|nowrap="1"| "sprites/laserbeam.spr"
|The sprite to use in the beam
|-
|nowrap="1"| FrameStart
|nowrap="1"| 0-255
|nowrap="1"| 0
|The frame to start with in the sprite
|-
|nowrap="1"| FrameRate
|nowrap="1"| 0-255
|nowrap="1"| 0
|The frame rate to show the sprite at, in 0.1s (10 = 1 fps)
|-
|nowrap="1"| Life
|nowrap="1"| 0-255
|nowrap="1"| 50
|The length of time the beam shall remain, in 0.1s (50 = 5 seconds)
|-
|nowrap="1"| Width
|nowrap="1"| 0-255
|nowrap="1"| 10
|The width of the beam in 0.1s
|-
|nowrap="1"| Noise
|nowrap="1"| 0-255
|nowrap="1"| 10
|The noise amplitude of the beam, this controls how much the beam distorts, again in 0.1s
|-
|nowrap="1"| Color
|nowrap="1"| R G B
|nowrap="1"| 255 255 255
|The color of the beam in the RBG triplet value
|-
|nowrap="1"| Brightness
|nowrap="1"| 0-255
|nowrap="1"| 127
|The brightness of the beam
|-
|nowrap="1"| Scroll
|nowrap="1"| 0-255
|nowrap="1"| 0
|The scroll speed of the beam, in 0.1s (??)
|}

Format
<pre>#define TE_BEAMENTPOINT 1 // beam effect between point and entity

message_begin(MSG_ ,SVC_TEMPENTITY)
write_byte(TE_BEAMENTPOINT)
write_short() // start entity
write_coord() // end position
write_coord()
write_coord()
write_short() // sprite index
write_byte() // starting frame
write_byte() // frame rate in 0.1's
write_byte() // life in 0.1's
write_byte() // line width in 0.1's
write_byte() // noise amplitude in 0.01's
write_byte() // Red
write_byte() // Green
write_byte() // Blue
write_byte() // brightness
write_byte() // scroll speed in 0.1's
message_end()</pre>

== 2: TE_GUNSHOT ==
Creates a particle effect plus a ricochet sound.

Options
{| border="1" cellpadding="5"
|- style="background:#efefef;"
! Option || Range || Default || Description
|-
|nowrap="1"| Pos
|nowrap="1"| X Y Z (coords)
|nowrap="1"| Origin of primary entity, or 0 0 0
|Position of the gunshot effect
|}

Format
<pre>#define TE_GUNSHOT 2 // particle effect plus ricochet sound

message_begin(MSG_ ,SVC_TEMPENTITY)
write_byte(TE_GUNSHOT)
write_coord() // start position
write_coord()
write_coord()
message_end()</pre>

== 3: TE_EXPLOSION ==
Creates an additive sprite, 2 dynamic lights, flickering particles, explosion sound, and moves the sprite vertically.

Options
{| border="1" cellpadding="5"
|- style="background:#efefef;"
! Option || Range || Default || Description
|-
|nowrap="1"| Pos
|nowrap="1"| X Y Z (coords)
|nowrap="1"| Origin of primary entity, or 0 0 0
|Position of the explosion effect
|-
|nowrap="1"| Sprite
|nowrap="1"| sprite path
|nowrap="1"| "sprites/zerogxplode.spr"
|The additive sprite to use in the explosion
|-
|nowrap="1"| Scale
|nowrap="1"| 0-255
|nowrap="1"| 1
|The scale of the sprite in the explosion, in 0.1s
|-
|nowrap="1"| FrameRate
|nowrap="1"| 0-255
|nowrap="1"| 0
|The frame rate to show the sprite at, in 0.1s (10 = 1 fps)
|-
|nowrap="1"| Flags
|nowrap="1"| 0-15
|nowrap="1"| 0
|Sets flags for the explosion, you may also add these together:
*0: Default Half-Life explosion
*1: Sprite will be drawn opaque
*2: Do not render the dynamic lights
*4: Do not play the explosion sound
*8: Do not draw the particles
|}

Format
<pre>#define TE_EXPLOSION 3 // additive sprite, 2 dynamic lights, flickering particles, explosion sound, move vertically 8 pps

message_begin(MSG_ ,SVC_TEMPENTITY)
write_byte(TE_EXPLOSION)
write_coord() // start position
write_coord()
write_coord()
write_short() // sprite index
write_byte() // scale in 0.1's
write_byte() // framerate
write_byte() // flags
message_end()</pre>

== 4: TE_TAREXPLOSION ==
Creates the Quake 'tar' explosion.

Options
{| border="1" cellpadding="5"
|- style="background:#efefef;"
! Option || Range || Default || Description
|-
|nowrap="1"| Pos
|nowrap="1"| X Y Z (coords)
|nowrap="1"| Origin of primary entity, or 0 0 0
|Position of the effect
|}

Format
<pre>#define TE_TAREXPLOSION 4 // Quake1 "tarbaby" explosion with sound

message_begin(MSG_ ,SVC_TEMPENTITY)
write_byte(TE_TAREXPLOSION)
write_coord() // start position
write_coord()
write_coord()
message_end()</pre>

== 5: TE_SMOKE ==
Creates a rising alphablend sprite at 30 pps.

Options
{| border="1" cellpadding="5"
|- style="background:#efefef;"
! Option || Range || Default || Description
|-
|nowrap="1"| Pos
|nowrap="1"| X Y Z (coords)
|nowrap="1"| Origin of primary entity, or 0 0 0
|Position of the smoke effect
|-
|nowrap="1"| Sprite
|nowrap="1"| sprite path
|nowrap="1"| "sprites/steam1.spr"
|The alphablend sprite to use for smoke
|-
|nowrap="1"| Scale
|nowrap="1"| 0-255
|nowrap="1"| 1
|The scale of the smoke, in 0.1s
|-
|nowrap="1"| FrameRate
|nowrap="1"| 0-255
|nowrap="1"| 0
|The frame rate to show the sprite at
|}

Format
<pre>#define TE_SMOKE 5 // alphablend sprite, move vertically 30 pps

message_begin(MSG_ ,SVC_TEMPENTITY)
write_byte(TE_SMOKE)
write_coord() // start position
write_coord()
write_coord()
write_short() // sprite index
write_byte() // scale in 0.1's
write_byte() // framerate
message_end()</pre>

== 6: TE_TRACER ==
Creates a tracer effect from one point to another.

Options
{| border="1" cellpadding="5"
|- style="background:#efefef;"
! Option || Range || Default || Description
|-
|nowrap="1"| Pos
|nowrap="1"| X Y Z (coords)
|nowrap="1"| Origin of primary entity, or 0 0 0
|Starting point of the tracer
|-
|nowrap="1"| End
|nowrap="1"| X Y Z (coords)
|nowrap="1"| Origin of secondary entity, or 0 0 0
|Ending point of the tracer
|}

Format
<pre>#define TE_TRACER 6 // tracer effect from point to point

message_begin(MSG_ ,SVC_TEMPENTITY)
write_byte(TE_TRACER)
write_coord() // start position
write_coord()
write_coord()
write_coord() // end position
write_coord()
write_coord()
message_end()</pre>

== 7: TE_LIGHTNING ==
Simplified options for TE_BEAMPOINTS - Lightning effect.

Options
{| border="1" cellpadding="5"
|- style="background:#efefef;"
! Option || Range || Default || Description
|-
|nowrap="1"| Pos
|nowrap="1"| X Y Z (coords)
|nowrap="1"| Origin of primary entity, or 0 0 0
|Starting point of the lightning
|-
|nowrap="1"| End
|nowrap="1"| X Y Z (coords)
|nowrap="1"| Origin of secondary entity, or 0 0 0
|Ending point of the lightning
|-
|nowrap="1"| Life
|nowrap="1"| 0-255
|nowrap="1"| 50
|The length of time the lightning shall remain, in 0.1s (50 = 5 seconds)
|-
|nowrap="1"| Width
|nowrap="1"| 0-255
|nowrap="1"| 10
|The width of the lightning in 0.1s
|-
|nowrap="1"| Noise
|nowrap="1"| 0-255
|nowrap="1"| 10
|The noise amplitude of the lightning, this controls how much it distorts, again in 0.1s
|-
|nowrap="1"| Sprite
|nowrap="1"| sprite path
|nowrap="1"| "sprites/laserbeam.spr"
|The sprite to use in the lightning
|}

Format
<pre>#define TE_LIGHTNING 7 // TE_BEAMPOINTS with simplified parameters

message_begin(MSG_ ,SVC_TEMPENTITY)
write_byte(TE_LIGHTNING)
write_coord() // start position
write_coord()
write_coord()
write_coord() // end position
write_coord()
write_coord()
write_byte() // life in 0.1's
write_byte() // width in 0.1's
write_byte() // amplitude in 0.01's
write_short() // sprite model index
message_end()</pre>

== 8: TE_BEAMENTS ==
Creates a beam between the primary entity and another entity.

Options
{| border="1" cellpadding="5"
|- style="background:#efefef;"
! Option || Range || Default || Description
|-
|nowrap="1"| Start Entity
|nowrap="1"| ID of Entity
|nowrap="1"| Primary entity id
|Starting point of the beam from the id's origin
|-
|nowrap="1"| End Entity
|nowrap="1"| ID of Entity
|nowrap="1"| Secondary entity id
|Ending point of the beam to the id's origin
|-
|nowrap="1"| Sprite
|nowrap="1"| sprite path
|nowrap="1"| "sprites/laserbeam.spr"
|The sprite to use in the beam
|-
|nowrap="1"| FrameStart
|nowrap="1"| 0-255
|nowrap="1"| 0
|The frame to start with in the sprite
|-
|nowrap="1"| FrameRate
|nowrap="1"| 0-255
|nowrap="1"| 0
|The frame rate to show the sprite at, in 0.1s (10 = 1 fps)
|-
|nowrap="1"| Life
|nowrap="1"| 0-255
|nowrap="1"| 50
|The length of time the beam shall remain, in 0.1s (50 = 5 seconds)
|-
|nowrap="1"| Width
|nowrap="1"| 0-255
|nowrap="1"| 10
|The width of the beam in 0.1s
|-
|nowrap="1"| Noise
|nowrap="1"| 0-255
|nowrap="1"| 10
|The noise amplitude of the beam, this controls how much the beam distorts, again in 0.1s
|-
|nowrap="1"| Color
|nowrap="1"| R G B
|nowrap="1"| 255 255 255
|The color of the beam in the RBG triplet value
|-
|nowrap="1"| Brightness
|nowrap="1"| 0-255
|nowrap="1"| 127
|The brightness of the beam
|-
|nowrap="1"| Scroll
|nowrap="1"| 0-255
|nowrap="1"| 0
|The scroll speed of the beam, in 0.1s (??)
|}

Format
<pre>#define TE_BEAMENTS 8 // Create a beam between two entities

message_begin(MSG_ ,SVC_TEMPENTITY)
write_byte(TE_BEAMENTS)
write_short() // start entity
write_short() // end entity
write_short() // sprite index
write_byte() // starting frame
write_byte() // frame rate in 0.1's
write_byte() // life in 0.1's
write_byte() // line width in 0.1's
write_byte() // noise amplitude in 0.01's
write_byte() // red
write_byte() // green
write_byte() // blue
write_byte() // brightness
write_byte() // scroll speed in 0.1's
message_end()</pre>

TODO: add rest, I'll get this done eventually.
[[Category:Half-Life 1]]
[[Category:Scripting (AMX Mod X)]]

Temp Entity Events (Half-Life 1)

2006-02-02T04:55:42Z

Vittu: Added more TE messages (will cont. later)

Temp Entity Events (Half-Life 1)

2006-02-01T08:24:55Z

Vittu: Started to add list of HL const.h TempEnts

Add Main Description Here.

= Message Types=
Sets the type of message the temp entity is transmitted in.

MSG_ types that can be used for ''dest'' in [http://www.amxmodx.org/funcwiki.php?go=func&id=262 message_begin] are listed below:
<pre>#define MSG_BROADCAST 0 // unreliable to all
#define MSG_ONE 1 // reliable to one (msg_entity)
#define MSG_ALL 2 // reliable to all
#define MSG_INIT 3 // write to the init string
#define MSG_PVS 4 // Ents in PVS of org
#define MSG_PAS 5 // Ents in PAS of org
#define MSG_PVS_R 6 // Reliable to PVS
#define MSG_PAS_R 7 // Reliable to PAS
#define MSG_ONE_UNRELIABLE 8 // Send to one client, but don't put in reliable stream, put in unreliable datagram (could be dropped)
#define MSG_SPEC 9 // Sends to all spectator proxies</pre>

= TempEnt Events =
Add Description Here.

== 0: TE_BEAMPOINTS ==
Creates a beam between two points.

=== Options ===
{| border="1" cellpadding="5"
|- style="background:#efefef;"
! Option || Range || Default || Description
|-
|nowrap="1"| Start
|nowrap="1"| X Y Z (coords)
|nowrap="1"| Origin of primary entity, or 0 0 0
|Starting point of the beam
|-
|nowrap="1"| End
|nowrap="1"| X Y Z (coords)
|nowrap="1"| Origin of secondary entity, or 0 0 0
|Ending point of the beam
|-
|nowrap="1"| Sprite
|nowrap="1"| sprite path
|nowrap="1"| "sprites/laserbeam.spr"
|The sprite to use in the beam
|-
|nowrap="1"| FrameStart
|nowrap="1"| 0-255
|nowrap="1"| 0
|The frame to start with in the sprite
|-
|nowrap="1"| FrameRate
|nowrap="1"| 0-255
|nowrap="1"| 0
|The frame rate to show the sprite at, in 0.1s (10 = 1 fps)
|-
|nowrap="1"| Life
|nowrap="1"| 0-255
|nowrap="1"| 50
|The length of time the beam shall remain, in 0.1s (50 = 5 seconds)
|-
|nowrap="1"| Width
|nowrap="1"| 0-255
|nowrap="1"| 10
|The width of the beam in 0.1s
|-
|nowrap="1"| Noise
|nowrap="1"| 0-255
|nowrap="1"| 10
|The noise amplitude of the beam, this controls how much the beam distorts, again in 0.1s
|-
|nowrap="1"| Color
|nowrap="1"| R G B
|nowrap="1"| 255 255 255
|The color of the beam in the RBG triplet value
|-
|nowrap="1"| Brightness
|nowrap="1"| 0-255
|nowrap="1"| 127
|The brightness of the beam
|-
|nowrap="1"| Scroll
|nowrap="1"| 0-255
|nowrap="1"| 0
|The scroll speed of the beam, in 0.1s (??)
|}

=== Format ===
<pre>#define TE_BEAMPOINTS 0 // beam effect between two points

message_begin(MSG_ ,SVC_TEMPENTITY) // message begin
write_byte(TE_BEAMPOINTS)
write_coord() // start position
write_coord()
write_coord()
write_coord() // end position
write_coord()
write_coord()
write_short() // sprite index
write_byte() // starting frame
write_byte() // frame rate in 0.1's
write_byte() // life in 0.1's
write_byte() // line width in 0.1's
write_byte() // noise amplitude in 0.01's
write_byte() // Red
write_byte() // Green
write_byte() // Blue
write_byte() // brightness
write_byte() // scroll speed in 0.1's
message_end()</pre>

== 1: TE_BEAMENTPOINT ==
Creates a beam between the primary entity and a point.

=== Options ===
{| border="1" cellpadding="5"
|- style="background:#efefef;"
! Option || Range || Default || Description
|}

=== Format ===
<pre>
</pre>

[[Category:Half-Life 1]]
[[Category:Scripting (AMX Mod X)]]

Pawn Tutorial

2006-01-19T16:37:11Z

Vittu: fixed typo

{{qnotice|This guide is rather hardcoded to [[AMX Mod X]]. It needs to be mode generic.}}

This guide is designed to give you a more in-depth overview of the basics of programming in [[Pawn]].

=Introduction=
Pawn is an embeddable, (almost) typeless, easy to use scripting language that is compiled for a virtual machine. [[AMX Mod X]] uses Pawn to route scripting functions to the Half-Life engine, using the Pawn [[Virtual Machine]] and [[Metamod]] ([[Pawn]] is written in C, Metamod is written in C++). While you write Pawn scripts in a text editor, the scripts must be compiled with a "Compiler", which produces a binary for AMX Mod X. The AMX Mod X team distributes a specially modified Pawn compiler.

Programming scripts in Pawn is relatively easy, and does not have concepts in other languages that are unnecessary for general use, such as pointers, vectors, structs, classes, allocation, et cetera.

==Language Paradigms==
Pawn was originally named "[[Small]]" to emphasize the size of the language specification. The language sacrifices many features found in modern languages to achieve simplicity and speed, which are required for embedded uses.
*No typing
**Pawn only has one data type -- the "[[Cell_(Pawn)|cell]]". It is the size of the processor's integral pointer (4 bytes for 32bit processor, 8 bytes for 64bit processors). This has two major implications - Pawn bytecode is processor specific, and pointers can fit inside a cell.
**[[Tagging_(Pawn)|Tagging]] - Pawn lets you create weakly statically typed "tags", which can be associated with variables for primitive operator overloading. For example, Pawn has no concept of floating point numbers (only integers). Instead, operators are overloaded with the Float: tag to redirect computation to new functions. Tag-checking is only enforced as a warning.
**Since Pawn only has one datatype, it does not support structs, records, objects, or anything else.
**Pawn does support arrays of cells, which leads to C-style arrays for strings.
*No garbage collection
**Pawn has no "heap" allocation built-in. All variables are stored on the stack or in the data section. Therefore, no garbage collection is necessary and memory leaks are not possible from the language specification alone.
*Procedural
**Pawn is entirely comprised of single, non-nested subroutines. There are no lambda functions, member functions, constructors, et cetera. Functions can either be internal (within the script) or public (exposed to the VM by name, like C's "extern").
*No thread-safety
**Pawn is targetted toward single-thread instances.

==Implementation Features==
*Cross-platform compatible compiler, which outputs bytecode and debug browsing information.
*Cross-platform compatible Virtual Machine (VM), with support for debug browsing, halting/stopping execution, and interacting with scripts from C/C++ libraries.
*IA32 JIT Compiler for vastly increasing script execution time.

Because the footprints of the VM and JIT are so small, Pawn is ideal inside games which need a simple and highly fast event system, embedded devices or applications, and realtime systems.

==License==
Pawn is licensed under the [[ZLib/libpng_License]] license.

=Variables=
Variables are simple structures for holding data throughout a period of time in your script.

==Types==
Small has just three data types for declaring variables. The default variable type is a regular whole number, or integer. A variable name, for backwards compatibility, should be 19 characters or less, and MUST start with a letter. It can contain the symbols A-Z, a-z, 0-9, and the underscore ("_"). It is important to note that variable names are case sensitive - "myvar", "MyVaR", and "MYVAR" are three separate symbols.

===Integers===
The simplest data type in Pawn is an "integer". Integers are whole numbers. To declare a new integer variable, use the "new" operator like so:

<pre>new a //Declare empty variable "a"
new b=5 //Declare variable "b" and set it to 5.
new c=5.0 //This is invalid, technically not a whole number!
new d="hello" //"hello" is not a number either, this is invalid.

//You can also declare multiple variables on one line:
new e,f,g,h
new x=7, y=3
</pre>

===Floats===
You can also declare a variable as a "Float", which means it can store numbers with decimal places. These are called "floating point" numbers:

<pre>
new Float:a //Declare empty floating point variable "a"
new Float:b=5.3 //This will declare a new variable "b" and assign 5.3 to it.
new Float:c=5 //This is valid, but the compiler will give you a warning.
new Float:d="hello" //This is invalid, "hello" is not a decimal number.
</pre>

You can also do the following:
<pre>
//float(n) is a function that takes a number n and makes it a
// floating point number.
new Float:var = float(5)
new Float:var2 = 5.0
new Float:var3 = 1.0*5
new var4 = floatround(5.0)
//Note: floatround(n) is a function that takes a number n and rounds it to a whole number.
// this makes the assignment to a regular integer variable valid.
</pre>

Note - Spacing does generally not matter, as long as the compiler can tell symbols apart from each other. If your spacing is REALLY bad, you will get errors or maybe even warnings. For example, "new var = 5" and "new var=5" are the same, but "newvar=5" is totally wrong.

===Booleans===
The last variable type is "boolean". It is very simple - it is either "true", or "false". Both "true" and "false" are predefined data structures.

new bool:IsItOn //Declares a new variable "IsItOn" which is automatically false
new bool:xyz=true //Declares a new variable "xyz" set to true

=Arrays=

Pawn features basic "arrays". An array is a simple type of aggregate data. This means you can store multiple values in one variable! An array follows the same rules as a regular variable, and it has the same types. It simply can contain multiple values. You define an array with brackets, and how many values it can hold. For example:

<pre>//This will declare a variable called "Players" which holds 32 numbers.
new Players[32]
//You can now store values in any of the 32 "slots" this array has.
// The slots are numbered from 0 to n-1, or in this case, 0 to 31.
//Every slot starts off as 0.

//Set slot 0 to 5
Players[0] = 5
//Set slot 1 to whatever is in slot 0, in this case, the number 5
Players[1] = Players[0]
//This is invalid!
//Although there are 32 slots, they are numbered from 0 to 31.
//Doing this results in AMX Native Error 4 - AMX_ERR_BOUNDS
// or, it simply won't compile!
Players[32] = 15
//This is also totally invalid
Players[-1] = 6
new a = 3
//This is also totally invalid.
//a must be a constant number, so this is valid:
new BadArray[a]
const b = 3
new GoodArray[b]
//You can also use Compiler Directives (See last section)

#define ARRAY_SIZE 3
new Array[ARRAY_SIZE]
</pre>

Arrays can also be declared with groups of data default, such as:

<pre>new Numbers[4] = {0,1,2,3}
//Note: it is important that you make sure the amount of numbers
// you pass and the size of the array match
</pre>

You can also use any data type with arrays:

<pre>//Array of floating points:
new Float:Numbers[4] = {0.0, 1.2, 2.4, 3.8}
//Array of booleans. Note this sets every slot to true.
new bool:playerHasGun[32] = true
</pre>

=Strings=

You have probably noticed that an important data type is missing - characters (letters and symbols). These are called "strings", and in Pawn, they are technically numbers! A string is an array of numbers that translate to ASCII (character) symbols. For example:

<pre>
//This will declare a number array "myString" that contains the data "Hello".
//It will have 6 slots, because there are 5 characters.
//The last slot is reserved for the number 0, which tells the Pawn engine that it is a string.
new myString[] = "Hello"
</pre>

Note: anything in between /* and */ is also a comment. You cannot use /* */ inside a /* */. The following set of commands achieves the same purpose, however, it is longer and not recommended. This works because each character of the string "Hello" is stored in a slot in the array.
<pre>
new myString[6]
myString[0] = "H"
myString[1] = "e"
myString[2] = "l"
myString[3] = "l"
myString[4] = "o"
myString[5] = 0
</pre>

{{qnotice|Note: Arrays that are meant to be strings must end in a 0, or the null character. This is so you know where the string ends.}}

You CANNOT do this! While it may compile, it is highly dangerous as it might cause overflow errors.
<pre>new myString[6]
myString = "Hello" //INVALID!
myString[0] = "Hello" //INVALID!
//To add data to a string, you can do this:
new goodString[7]
copy(goodString, 6, "Hello")
</pre>

Note that we copied 6 cells of the array into an array that can hold 7. If we were to copy 7 bytes into this array, copy() could potentially copy an extra byte for the Null character, overflowing the array. This is called a [[buffer overflow]] and must be carefully avoided.

More examples:
<pre>//Copy is a function that takes three parameters:
copy(destination[], length, source[])
//It copies the string inside the source array and places
// it into the destination array, but only copies up to length characters.

//Lastly, to prove that a string is really an array of numbers, this is completely valid:
new weird[6]
weird[0] = 68
weird[1] = 65
weird[2] = 73
weird[3] = 86
weird[4] = 68
weird[5] = 0
//This will set the variable "weird" to the string "DAVID".
//To see how letters and symbols translate into numbers, visit www.asctiitable.com
</pre>

=Functions=

Pawn allows you to define your own functions. This comes in handy for removing code that is used in multiple places. Note that all functions should return a value. To do this, you use the "return" command, which immediately halts the function and returns the value of the expression passed to it. No code is executed in a function once the return is found. Here are some examples:

<pre>
//This is a function that takes no parameters and returns 1.
//When activated, it uses the (non-existant) print function.
show()
{
print("Hello!")

return 1 //End, return 1
}

//Activate like this:
show()
</pre>

You can also declare functions to take parameters.

<pre>
//This declares a function called "add_two_numbers", which takes two numbers and returns the sum.
add_two_numbers(first, second)
{
new sum = first + second

return sum //Return the sum
}
//Then you can use your new function like this:

new a,b
a = 5
a = 12
new c = add_two_numbers(a,b)
//c will now be equal to 17.
</pre>

You are not limited by what types of data parameters can accept. When you give parameters to a function, it is called "passing". You can pass either data or a variable to a function.

<pre>
//This defines a new function called "add_two_floats"
// which takes two floating points and returns the sum
Float:add_two_floats(Float:first, Float:second)
{
new Float:sum = first + second

return sum
}

new Float:a
new Float:b
a = 5.0
b = 6.3
new Float:c
c = add_two_floats( a+b )
//c is now equal to 11.3
</pre>

You can even pass arrays! You do not have to specify the size of the array. If you do, you must make sure you are calling the function with an array of equal size and type.
<pre>
add_two_from_array(array[], a, b)
{
new first = array[a]
new second = array[b]
new sum = add_two_numbers(first, second) //use our function from earlier

return sum
}
</pre>

Note, that when you pass arrays through a function they are passed through what is called "by reference". When a normal variable is passed to a function, it is copied in memory, and the copy is sent and then deleted afterwards. This is not the case with an array. Because arrays can be very large, the array is "referenced" instead of copied. This means if you change the array, afterwards it will stay changed. For example:

<pre>
//This function will switch slots a and b inside any array passed to this function.
swap_slots(array[], a, b)
{
//Note, you need to temporarily hold one of the slots before swapping them
//Otherwise, you can't swap both values! This is a classic problem.
//If you have a and b, setting b equal to a eliminates the original value in b.
new temp

temp = array[b]
array[b] = array[a]
array[a] = temp
}

new myArray[2]
myArray[0] = 5
myArray[1] = 6
swap_slots(myArray, 0, 1)
//myArray[0] is 6, myArray[1] is 5
</pre>

You can prevent arrays from being modified by declaring them "constant", like so:
<pre>
add_two_from_array(const array[], a, b)
{
new first = array[a]
new second = array[b]
new sum = add_two_from_array(first, second)
return sum
}
//Note, now when you use the function, you are guaranteed that the array will not be modified.
</pre>

This function modifies an array passed as a constant. It will not work.
<pre>
bad_function(const array[])
{
array[0] = 0
}
</pre>

=Expressions=

Expressions are just what they sound like from mathematics. They are groupings of symbols that return one piece of data. Expressions are normally comprised of parenthetical expressions, and are evaluated in a certain order (from innermost to outermost, parenthesis first, then multiplication, division, addition, subtraction, et cetera). You can put expressions anywhere. You can set variables equal to them or pass them to functions.

<pre>//This is the simplest expression. It returns the number zero.
0
//However, to make it easier to read, this is also valid:
(0)
</pre>

If an expression is not zero or it is not false, it not only returns a value, it also returns "true". Otherwise, it will return 0, which is also "false".

<pre>
//Here are more mathematical expressions. The mathematical operators are
// + for addition
// - for subtraction
// * for multiplication
// / for division
// % for modulus (finding the remainder of one number divided by another (5%2 is 1)
(5+6) //returns 11
((5*6)+3) //returns 33
((((5+3)/2)*4)-9) //returns 5
((5*6) % 7) //returns 2
//Here are other expressions:
(true) //returns true
(5.0 + 2.3) //returns 7.3 as a floating point
</pre>

There are also extensions of these operators for direct use on variables.
<pre>
new a = 5
new b = 6
//The first are the post/pre increment and decrement operators.
a++ //returns a+1, or 6. This is a post increment.
++a //also returns a+1, or 6. This is a pre increment.
</pre>

The difference between the two is subtle but important. a++ is evaluated LAST in an expression, while ++a is evaluated FIRST. This differences comes in handy with code that uses loops in certain ways. It is also important to know that the increment/decrement operators will not only return a+1, but set the variable a to a+1.

<pre>
a-- //returns 4, post decrement
--a //returns 4, pre decrement
</pre>

Note that a++ essentially trims down this code:
<pre>a = a + 1</pre>
However, there is another way to write lines of code of this form:
<pre>a = a OP y</pre>
Where OP is a math operator. It can be shortened to:
<pre>a OP= x</pre>
Observe:
<pre>
a += 1 //This sets a to a + 1
a -= b //This sets b to a - b
a *= 0 //This multiplies a by 0
a /= 2 //This divides a by 2.
</pre>

However, mathematical operators are not the only operators you are given. There are boolean operators to help you with logical circuits or logical decisions.

The and operator takes in the left expression and right expression. If both are "true", then it returns true.

<pre>
//This is false, because 1 returns true and 0 returns false.
//Since both are not true, && returns false.
(1 && 0)
(1 && 2) //Both numbers are "true", therefore the expression is true.
(true && false) //false
(false && false) //false
(true && true) //true
</pre>

The other important operator is "or". It returns true if one of two expressions are true.
<pre>
(1 || 0) //true, since one of the values is true.
(1 || 2) //true
(true || true) //true
(false || false) //false
(true || true) //true
</pre>

There are other operators as well, that you may not use as often. The "bitwise and" operator returns whether a binary bit sequence is contained in another sequence. In the technical terms, it does an "and (&&)" operation on each of the bits in both numbers. For example, say you have the number "9", which is "1001" in binary. If you want to know if that sequence contains the number "8" (1000), you can do:

<pre>
//This will return 8, which means 8 is indeed a bit in 9.
(9 & 8)
//4 (00100) is not a bit inside 16 (10000) and this will return 0.
(16 & 4)
//The next operator is "bitwise or"
//which does an "or (||)' operation on each of the bits in both numbers.
//This will take 9 (1001) and match it with 3 (0011), resulting in 1011, or 11.
(9 | 3)
</pre>

These two operators are also important, but not used often. They are the bitwise shift operators, << is a left shift and >> is a right shift. They shift the bits in a number to one direction.

<pre>
//This takes the number 3 (00011) and shifts it three places to binary (11000), or 24.
(3 << 3)
//This takes the number 24 (11000) and shifts it three places to binary (00011), or 3.
(24 >> 3)
</pre>

The last operator is "bitwise not". It returns the exact opposite of whatever is given to it. When used on a number, it will return each of the bits flipped (1 to 0, 0 to 1).

<pre>
//This returns false
(!true)
//This returns true
(!false)
//This takes 9 (binary 1001) and makes it 6 (binary 0110).
(!(9))
</pre>

=Conditionals=

Conditionals allow you to test if an expression meets a standard, and to execute code based on that decision.

==If Statements==

The most important conditional is called "if ... then". If evaluates whether a given expression is true or false. It if is true, it executes a block of code. If not, it executes a different block of code. For example:

This is an example of the most basic if ... then statement. The first line checks to see if the expression is true. In this case, if the variable a is equal to 5, then the if statement will execute the block of code underneath it, which sets a to 6.

<pre>if (a == 5)
{
a = 6
}</pre>

However, what happens if a does not equal 5? Then the code will not be executed. However, you can tell it to execute code if the conditions are not met. Now, if a is equal to 5, a will be set to 6. Otherwise, it will be set to 7.

<pre>if (a == 5)
{
a = 6
} else {
a = 7
}</pre>

There are many different operators you can use inside the if () statement. In fact, you can use any [[#Expressions|expression]] that evaluates to true (not zero) or false (zero).

<pre>
//This will return true if a does not equal 5
if (a != 5) {
//Returns true if a is greater than 5
if (a > 5) {
//Returns true if a is less than 5
if (a < 5) {
//Returns true if a is greater than or equal to 5
if (a >= 5) {
//Returns true if a is less than or equal to 5
if (a <= 5) {
//Returns true because 11 is true
if (5+6) {
//Returns true of both a and b are true
if (a && b) {
//Returns true if 7.5 is greater than c
if ( ((5*3)/2) > c) {
//Always returns true no matter what
if (true) {
//Never returns true
if (false) {
</pre>

Note that array comparisons have restrictions. This is invalid:

<pre>
my arrayOne[3]
my arrayTwo[3]
if (arrayOne == arrayTwo) {
</pre>

You must do:
<pre>
if ((arrayOne[0] == arrayTwo[0]) &&
(arrayOne[1] == arrayTwo[1]) &&
(arrayOne[2] == arrayTwo[2])) {
</pre>

Obviously, this would get very tedious with large arrays. You will see later on how to easily compare strings and arrays.

The if...then model of conditional switching can be brought up to another level. Pawn provides a way for you to provide multiple levels of true and false expressions.

<pre>
//Example of "if...else if"
if (a == 5) {
//This code will be run if a is 5.
} else if (a < 6) {
//This code will be run if a is less than 6
} else if (a == 7) {
//This code will be run if a is 7.
} else {
//If none of the above conditions are met, this code will be run.
}</pre>

It is important to note that in the above example, each code block is not "fall through". That means each of the conditions will be checked in order, and if one is true, the code will be executed and the if statement is done. It will not execute multiple true conditions.

==Switch Statements==

Lastly, there is one last type of conditional statement. It is called a "switch" statement, and it allows you to make a nicely ordered list of conditions similar to, but not as powerful as, "if...else if".

<pre>//Example of a switch statement
switch (a)
{
case 5:
{
//This code will run if a is equal to 5
}

case 6:
{
//This code will run if a is equal to 6
}

case 7:
{
//This code will run if a is equal to 7
}

default:
{
//This code will run if all other cases fail
}
}</pre>

Note that a switch is not "fall-through". If a case is true, no other cases are evaluated.

=Looping=

Looping is essential for any language. It allows you to perform the same block of code over and over, by constructing conditions on which code should be repeated.

==For Loops==

The first and most widely used loop is called a "for loop". It takes an initial value, a condition upon which it should stop, and an incremental step. Then it executes code until it the conditions are no longer true. This lets you repeat the same block of code any number of times. Example:

<pre>
/*A for loop has three parameters:
for (initial; condition; increment)
{
//your code here
}

Before the first loop executes, it runs your initial condition.
Then it begins looping your code with these steps:
1. Check if the condition is true. If so, continue. If not, stop.
2. Run the code.
3. Run the "increment" parameter.
4. Go to step 1.
*/

//Example of a for loop
new i
new sum
for (i=1; i<=10; i++)
{
sum += i
}
</pre>

Explanation:

#The first parameter, i=1, sets the i variable to one. This happens before the looping starts.
#Next, the "increment" parameter is checked. This parameter is a post-increment operator, so 1 will be added to i after the entire code block is evaluated.
#Then the condition is checked. Is i<=10? It is currently 1, so it is indeed less than or equal to 10.
#Since the condition is true, sum+=i is executed. This means i is added into sum.
#The code block has finished, and i++ increments i to 2.
#Now it repeats.
#Is i<=10? Yes, it is 2. Now sum+=i runs again, and now sum is equal to 3.
#The code block has finished, and i now increments to 3.
#This happens until...
#The increment parameter sets i to 11. The condition is no longer true, and the for loop is finished.
#The sum variable now holds the number 55, which is the sum of 1 through 10.

This provides a nice way of managing arrays!

<pre>
//Note: this provides a nice way to loop through arrays! Observe this function below.
sum_of_array(myArray[], size)
{
//Note: Make sure the user passes the size of the array, so we don't overflow it.
new i, sum

//This loop will start at 0 and stop right before size is reached.
//If the user passes the correct size of the array,
// the loop will be going from 0 to size-1
// This correctly matches the numbers of slots in the array.
for (i=0; i<size; i++)
{
//For every time this loop executes,
// i will be a number from 0 to size-1
//Add the value of the slot (i) in the array to sum.
//Once this is finished, sum will contain
// the sum of all slots in the array.
sum += myArray[i]
}

return sum
}

new NumberArray[4]
NumberArray[0] = 3
NumberArray[1] = 1
NumberArray[2] = 4
NumberArray[3] = 1

new answer = sum_of_array(NumberArray, 4)
//answer will be 3+1+4+1, or 9

//Here is a function to compare if one array is equal to another (i.e. a string)
bool:compare_arrays(array1[], array2[], size)
{
new i
for (i=0; i<size, i++)
{
//If a slot does not match, halt the function and return false.
if (array1[i] != array2[i])
{
return false
}
}

//If the function got to this point without returning false, return true.
return true
}
</pre>

==While Loops==

The next kind of loop is also very important, and is simpler than a for loop. Called a "while" loop, it only takes one parameter: a condition. As long as the condition is true, it keeps executing code. See the above examples rewritten with while loops.

<pre>
//Basic loop
new i=0
new sum

while (++i <= 10)
{
sum+=i
}

sum_of_array(array[], size)
{
new i=0, sum

//Do this loop while i is less than the size.
//i is incremented at the end of every loop.
while (i++ < size)
{
sum += array[i]
}

return sum
}

bool:compare_arrays(array1[], array2[], size)
{
new i
while (i++ < size)
{
if (array1[i] != array2[i])
{
return false
}
}

return true
}
</pre>

==Two Dimensional Arrays==

In Pawn it is possible to have arrays where each slot is another array. This is very useful for storing a table of data, where the first section of slots is a row and the second section of slots is a column. Two dimensional arrays are declared like so:

<pre>
//This declares an array with 50 rows and 50 columns.
new BigArray[50][50]
//this declares a floating point array with 25 rows and 10 columns.
new Float:BigArray[25][10]
</pre>

Each slot in the first subset of the array becomes its own array.

<pre>
new BigArray[3][3]
BigArray[0][0] = 10
BigArray[0][1] = 20
BigArray[0][2] = 30
BigArray[1][0] = 40
BigArray[1][1] = 50
BigArray[1][2] = 60
BigArray[2][0] = 70
BigArray[2][1] = 80
BigArray[2][2] = 90
</pre>

Will result in BigArray looking like this:
:{|
|-
| BigArray
| 0
| 1
| 2
|-
| 0
| 10
| 20
| 30
|-
| 1
| 40
| 50
| 60
|-
| 2
| 70
| 80
| 90
|}

Note that our old sum_of_array() function can still work! We can do:

<pre>new sum = sum_of_array(BigArray[2], 3)</pre>

Because BigArray[2] contains a second, single dimensional array, containing {7,8,9}. However, let's write a 2D sum of array function.

<pre>
//This function will tally up a two dimensional array.
sum_of_table(array[][], rows, cols)
{
new i, j, sum

//Note, there is a loop inside the loop.
//This lets you go through each array inside the
// bigger array.
for (i=0; i<rows; i++)
{
for (j=0; j<cols; j++)
{
sum += array[i][j]
}
}

return sum
}</pre>

Note, it is also possible to store an array of strings using two dimensional arrays.

<pre>
new StringList[3][] = {"Hello", "my", "friend"}
/*
StringList[0][0] through [0][5] contains "Hello"
StringList[1][0] through [1][2] contains "my"
StringList[2][0] through [1][6] contains "friend"
*/
</pre>

The table for StringList will look like:
StringList 0 1 2 3 4 5 6
0 H e l l o \0
1 m y \0
2 f r i e n d \0

Comparing strings in multidimensional arrays is also similar:

<pre>
if (StringList[0] == "Hello") //INVALID
if (StringList[0][0] == "Hello") //INVALID
if (equali(StringList[0], "Hello")) //Valid
</pre>

=Compiler Pre-processor Directives=

Compiler directives allow you to change how your code is read. This is rather advanced and will only be run over briefly.

<pre>
//To bind a symbol to a value, you can do this:
#define SYMBOL VALUE
//for example:

#define MAX_STRING 250
new String[MAX_STRING]

#define HELLO "Hello. This is a generic greeting."
new Hello[MAX_STRING] = {HELLO}
</pre>

You can also use #defines to change the flow of code the compiler makes.
<pre>
#if defined LINUX
//This portion will be compiled if #define LINUX exists
execute_command("ls -l")
#else
//This portion will be compiled if #define LINUX does not exist
execute_command("dir")
#endif
</pre>

You can also change how much memory your script uses.
<pre>
#pragma dynamic 4096
//This creates a 16K stack of memory (default).
//It is measured in blocks of 4 byte cells.
</pre>

=Conclusion=

This guide should have given you a VERY brief introduction to basic Pawn programming. It is by no means comprehensive and it should not constitute the entirety of one's knowledge of Pawn. To read the official Small documentation and language guide, go this website: http://www.compuphase.com/pawn/pawn-lang.pdf (Note, this guide is very long and should be used as a reference. You may want to try the Small forums or the AMX Mod X forums). Continue to the next Section to see how to apply Small programming to the Half-Life and AMX Mod X engine!

=External Links=
*[http://www.compuphase.com/pawn/pawn-lang.pdf Pawn Language Reference]
*[http://www.compuphase.com/pawn/pawn.htm Pawn Homepage]
*[http://www.compuphase.com/ ITB CompuPhase]

[[Category:Scripting (AMX Mod X)]]

Listen server

2006-01-19T13:58:58Z

Vittu:

This is where you start a server from the game itself and play at the same time... there is only a minimal control panel. This requires the Steam Client to always be running. All the stock game content is contained in a single cache file.