Introduction to SourcePawn (legacy syntax) - Revision history

Nosoop: Nosoop moved page Introduction to SourcePawn to Introduction to SourcePawn (legacy syntax): Kill off pre-1.7 things

2020-02-01T08:56:27Z

Nosoop moved page Introduction to SourcePawn to Introduction to SourcePawn (legacy syntax): Kill off pre-1.7 things

Nosoop: Note for new SourcePawn page

2017-09-01T07:59:15Z

Note for new SourcePawn page

Headline: Undo revision 10388 by Headline (talk)

2017-08-25T10:00:00Z

Undo revision 10388 by Headline (talk)

Headline: Undo revision 10389 by Headline (talk)

2017-08-25T09:59:55Z

Undo revision 10389 by Headline (talk)

Headline: Undo revision 10390 by Headline (talk)

2017-08-25T09:59:49Z

Undo revision 10390 by Headline (talk)

Headline: Undo revision 10391 by Headline (talk)

2017-08-25T09:59:41Z

Undo revision 10391 by Headline (talk)

Headline: Undo revision 10392 by Headline (talk)

2017-08-25T09:59:32Z

Undo revision 10392 by Headline (talk)

Headline: Undo revision 10393 by Headline (talk)

2017-08-25T09:59:26Z

Undo revision 10393 by Headline (talk)

Headline: Undo revision 10394 by Headline (talk)

2017-08-25T09:59:20Z

Undo revision 10394 by Headline (talk)

Headline: Undo revision 10395 by Headline (talk)

2017-08-25T09:59:14Z

Undo revision 10395 by Headline (talk)

← Older revision		Revision as of 07:59, 1 September 2017
Line 1:		Line 1:
		+	{{Note\|This page is for the old, legacy SourcePawn syntax. It is '''strongly''' recommended that new plugin authors read the [[Introduction to SourcePawn 1.7]], as that covers modern SourcePawn.}}
		+
	This guide is designed to give you a very basic overview to fundamentals of scripting in SourcePawn. [[Pawn]] is a "scripting" language used to embed functionality in other programs. That means it is not a standalone language, like C++ or Java, and its details will differ based on the application. SourcePawn is the version of Pawn used in [[SourceMod]].		This guide is designed to give you a very basic overview to fundamentals of scripting in SourcePawn. [[Pawn]] is a "scripting" language used to embed functionality in other programs. That means it is not a standalone language, like C++ or Java, and its details will differ based on the application. SourcePawn is the version of Pawn used in [[SourceMod]].

@@ Line 13: / Line 13: @@
 ==Variables==
-There a few important constructs you should know before you begin to script.  The first is a '''variable'''.  A variable is a symbol, or name, that holds a type of data. For example, the variable "a" could hold the number "2", "16", "0", etc aslong as the variable "a" is created as an integer.  Variables are created for storage space throughout a program.  Variables must be declared before being used, using the keyword "int" in our case since we are only storing real numbers.  Data is assigned to variables using the equal sign (=).  Example:
+There a few important constructs you should know before you begin to script.  The first is a '''variable'''.  A variable is a symbol, or name, that holds data. For example, the variable "a" could hold the number "2", "16", "0", et cetera.  Variables are created for storage space throughout a program.  Variables must be declared before being used, using the "new" keyword.  Data is assigned to variables using the equal sign (=).  Example:
-<pawn>int a, b, c, d;
+<pawn>new a, b, c, d;
 a = 5;
@@ Line 22: / Line 22: @@
 d = 500;</pawn>
-In SourcePawn, variables can really have only two types, which will be explained in more detail further on. If this confuses you, don't worry about it.
+In SourcePawn, variables have two types, which will be explained in more detail further on.
 *Cells (arbitrary numerical data), as shown above.
 *Strings (a series of text characters)

@@ Line 82: / Line 82: @@
 Examples of different valid variable declarations:
 <pawn>
-int a = 5;
+new a = 5;
-float b = 5.0;
+new Float:b = 5.0;
-bool c = true;
+new bool:c = true;
-bool d = 0;      //Works because 0 is false
+new bool:d = 0;      //Works because 0 is false
 </pawn>
 Invalid variable usage:
 <pawn>
-int a = 5.0;         //Tag mismatch.  5.0 is tagged as Float
+new a = 5.0;         //Tag mismatch.  5.0 is tagged as Float
-float b = 5;     //Tag mismatch.  5 is not tagged.
+new Float:b = 5;     //Tag mismatch.  5 is not tagged.
 </pawn>
 If a variable is not assigned upon declaration, it will be set to 0.  For example:
 <pawn>
-int a;        //Set to 0
+new a;        //Set to 0
-float b;  //Set to 0.0
+new Float:b;  //Set to 0.0
-bool c;   //Set to false
+new bool:c;   //Set to false
 </pawn>
 ==Assignment==
 Variables can be re-assigned data after they are created.  For example:
-<pawn>int a, float b, bool c;
+<pawn>new a, Float:b, bool:c;
 a = 5;

@@ Line 103: / Line 103: @@
 ==Assignment==
 Variables can be re-assigned data after they are created.  For example:
-<pawn>
+<pawn>int a, float b, bool c;
 a = 5;

@@ Line 119: / Line 119: @@
 An array is declared using brackets.  Some examples of arrays:
 <pawn>
-int players[32];     //Stores 32 cells (numbers)
+new players[32];     //Stores 32 cells (numbers)
-float origin[3]; //Stores 3 floating point numbers
+new Float:origin[3]; //Stores 3 floating point numbers
 </pawn>
 By default, arrays are initialized to 0.  You can assign them different default values, however:
 <pawn>
-int numbers[5] = {1, 2, 3, 4, 5};       //Stores 1, 2, 3, 4, 5 in the cells.
+new numbers[5] = {1, 2, 3, 4, 5};       //Stores 1, 2, 3, 4, 5 in the cells.
-float origin[3] = {1.0, 2.0, 3.0};  //Stores 1.0, 2.0, 3.0 in the cells.
+new Float:origin[3] = {1.0, 2.0, 3.0};  //Stores 1.0, 2.0, 3.0 in the cells.
 </pawn>
 You can leave out the array size if you're going to pre-assign data to it.  For example:
 <pawn>
-int numbers[] = {1, 3, 5, 7, 9};
+new numbers[] = {1, 3, 5, 7, 9};
 </pawn>

← Older revision	Revision as of 08:56, 1 February 2020
(No difference)

@@ Line 141: / Line 141: @@
 For example, here is an example of the above code using indexes:
 <pawn>
-int numbers[5]; float origin[3];
+new numbers[5], Float:origin[3];
 numbers[0] = 1;
@@ Line 157: / Line 157: @@
 To use an incorrect index will cause an error.  For example:
 <pawn>
-int numbers[5];
+new numbers[5];
 numbers[5] = 20;</pawn>
@@ Line 164: / Line 164: @@
 You can use any expression as an index.  For example:
-<pawn>int a, numbers[5];
+<pawn>new a, numbers[5];
 a = 1;                   //Set a = 1

@@ Line 183: / Line 183: @@
 Strings are declared almost equivalently to arrays.  For example:
 <pawn>
-char message[] = "Hello!";
+new String:message[] = "Hello!";
-char clams[6] = "Clams";
+new String:clams[6] = "Clams";
 </pawn>
 These are equivalent to doing:
 <pawn>
-char message[7], clams[6];
+new String:message[7], String:clams[6];
 message[0] = 'H';

@@ Line 212: / Line 212: @@
 ==Characters==
 A character of text can be used in either a String or a cell.  For example:
-<pawn>char text[] = "Crab";
+<pawn>new String:text[] = "Crab";
-int clam;
+new clam;
 clam = 'D';         //Set clam to 'D'
@@ Line 223: / Line 223: @@
 What you can't do is mix character arrays with strings.  The internal storage is different.  For example:
 <pawn>
-int clams[] = "Clams";                       //Invalid, needs String: type
+new clams[] = "Clams";                       //Invalid, needs String: type
-int clams[] = {'C', 'l', 'a', 'm', 's', 0};  //Valid, but NOT A STRING.
+new clams[] = {'C', 'l', 'a', 'm', 's', 0};  //Valid, but NOT A STRING.
 </pawn>
 =Functions=

@@ Line 249: / Line 249: @@
 Example of a function:
 <pawn>
-int AddTwoNumbers(int first, int second)
+AddTwoNumbers(first, second)
+{
-   int sum = first + second;
+   new sum = first + second;
    return sum;
@@ Line 257: / Line 257: @@
 This is a simple function.  The prototype is this line:
-<pawn>int AddTwoNumbers(int first, int second)</pawn>
+<pawn>AddTwoNumbers(first, second)</pawn>
 Broken down, it means:
 *<tt>AddTwoNumbers</tt> - Name of the function.
-*<tt>first</tt> - Name of the first parameter, which is an int.
+*<tt>first</tt> - Name of the first parameter, which is a simple cell.
-*<tt>second</tt> - Name of the second parameter, which is an int.
+*<tt>second</tt> - Name of the second parameter, which is a simple cell.
 The body is a simple block of code.  It creates a new variable, called <tt>sum</tt>, and assigns it the value of the two parameters added together (more on expressions later).  The important thing to notice is the <tt>return</tt> statement, which tells the function to end and return a value to the caller of the function.  All functions ''return a cell'' upon completion.  That means, for example:
-<pawn>int sum = AddTwoNumbers(4, 5);</pawn>
+<pawn>new sum = AddTwoNumbers(4, 5);</pawn>
 The above code will assign the number 9 to sum.  The function adds the two inputs, and the sum is given as the '''return value'''.  If a function has no return statement or does not place a value in the return statement, it returns 0 by default.
 A function can accept any type of input.  It can return any cell, but not arrays or strings.  Example:
-<pawn>float AddTwoFloats(float a, float b)
+<pawn>Float:AddTwoFloats(Float:a, Float:b)
+{
-    float sum = a + b;
+    new Float:sum = a + b;
     return sum;
 }</pawn>
-''Note that if in the above function, you returned a non-float, you would get a tag mismatch.''
+''Note that if in the above function, you returned a non-Float, you would get a tag mismatch.''
 You can, of course, pass variables to functions:
-<pawn>int numbers[3] = {1, 2, 0};
+<pawn>new numbers[3] = {1, 2, 0};
 numbers[2] = AddTwoNumbers(numbers[0], numbers[1]);</pawn>
 Note that cells are passed '''by value'''.  That is, their value cannot be changed by the function.  For example:
-<pawn>int a = 5;
+<pawn>new a = 5;
 ChangeValue(a);
-ChangeValue(int b)
+ChangeValue(b)
+{
     b = 5;