Scripting:Basic course - Revision history

Jacksfh at 09:10, 2 May 2020

2020-05-02T09:10:58Z

← Older revision		Revision as of 09:10, 2 May 2020
Line 569:		Line 569:
	\|}		\|}

-	[[Category:Scripting~~-Help~~]]	+	[[Category:Scripting]]

Jacksfh: /* Summary: Variables */

2012-05-23T10:30:28Z

Summary: Variables

← Older revision		Revision as of 10:30, 23 May 2012
Line 108:		Line 108:

	* A variable takes the place of "hard coded" data.		* A variable takes the place of "hard coded" data.
-	* To create a variable use 'VAR <b>Name</b> AS <b>~~Datatype~~</b>;''	+	* To create a variable use 'VAR <b>Name</b> AS <b>Data type</b>;''
	* To assign data to a variable you use ''<b>Name</b> = <b>Content</b>;''		* To assign data to a variable you use ''<b>Name</b> = <b>Content</b>;''
	* To output a variable use ''WriteLine(<b>Name</b>);'' This can be very important when debugging.		* To output a variable use ''WriteLine(<b>Name</b>);'' This can be very important when debugging.

Jacksfh: /* Summary: Variables */

2012-05-23T10:30:08Z

Summary: Variables

← Older revision		Revision as of 10:30, 23 May 2012
Line 108:		Line 108:

	* A variable takes the place of "hard coded" data.		* A variable takes the place of "hard coded" data.
-	* To create a variable use 'VAR <b>Name</b> AS <b>~~Datentype~~</b>;''	+	* To create a variable use 'VAR <b>Name</b> AS <b>Datatype</b>;''
-	* To assign data to a variable you use ''<b>Name</b> = <b>~~Inhalt~~</b>;''	+	* To assign data to a variable you use ''<b>Name</b> = <b>Content</b>;''
	* To output a variable use ''WriteLine(<b>Name</b>);'' This can be very important when debugging.		* To output a variable use ''WriteLine(<b>Name</b>);'' This can be very important when debugging.
	* The ''&'' symbol connects variables withing a function call''WriteLine();''		* The ''&'' symbol connects variables withing a function call''WriteLine();''

Jacksfh at 21:15, 30 December 2011

2011-12-30T21:15:56Z

← Older revision		Revision as of 21:15, 30 December 2011
Line 1:		Line 1:
-	~~{{NeedTranslation}}~~
	{{ScriptingMenu}}		{{ScriptingMenu}}
	'''This is a beginners course for the STNE engine script. It is not complete and probably not 100% correct. I have basically taught myself to use the STNE engine through trail and error, bad translation, good examples, and the benevolence of others. My spelling sucks. I'm sorry. If you see a mistake please fix it.'''		'''This is a beginners course for the STNE engine script. It is not complete and probably not 100% correct. I have basically taught myself to use the STNE engine through trail and error, bad translation, good examples, and the benevolence of others. My spelling sucks. I'm sorry. If you see a mistake please fix it.'''
Line 526:		Line 525:
	If you try and access the method GetPoint statically, you will generate a run time error. If the method GetPoint did not use the This pointer, the code would look for ToString in the script global name space, and generate a compile time error.		If you try and access the method GetPoint statically, you will generate a run time error. If the method GetPoint did not use the This pointer, the code would look for ToString in the script global name space, and generate a compile time error.

-	==~~Autoren~~==	+	==Authors==
-	~~(hier dürfen sich diejenigen verewigen die hier min. ein Kapitel geschrieben haben [sonst kommt noch einer daher nur weil er nen Rechtschreibfehler verbessert hat ;)])~~	+
	{\|		{\|
	!Nickname		!Nickname
-	!IG-id	+	!IG-ID
-	!~~Kapitel~~	+	!Chapter
	\|-		\|-
	\|WiZz4Rd		\|WiZz4Rd
-	\|16475	+	\|DE1-16475
-	\|~~Kapitel~~ 1, ~~Kapitel~~ 2, ~~Kapitel~~ 4	+	\|Chapter 1, Chapter 2, Chapter 4
	\|-		\|-
	\|Stryke		\|Stryke
-	\|28885	+	\|DE1-28885
-	\|~~Vorwort~~, ~~Kapitel~~ 3, ~~Kapitel~~ 4	+	\|Preface, Chapter 3, Chapter 4
	\|-		\|-
-	\|~~[[Spieler:~~Xenon~~\|Xenon]]~~	+	\|Xenon
-	\|10127	+	\|DE1-10127
-	\|~~Korrektur~~ & ~~Überarbeitung Kapitel~~ 1	+	\|Corrector & Chapter 1 revision
	\|-		\|-
	\|Fling		\|Fling
-	\|54865	+	\|DE1-54865
-	\|~~Kapitel~~ 7, ~~Kapitel~~ 8	+	\|Chapter 7, Chapter 8
	\|}		\|}

		+	==Translators==
		+
		+	{\|
		+	!Nickname
		+	!IG-ID
		+	!Chapter
		+	\|-
		+	\|Cs.temp.mail
		+	\|Unknown
		+	\|Preface, Chapter 1, Chapter 2, Chapter 3, Chapter 4
		+	\|-
		+	\|Miltiades
		+	\|EN1-56599
		+	\|Chapter 4, Chapter 6, Chapter 7
		+	\|-
		+	\|Glest Durnham
		+	\|EN1-6609
		+	\|Corrector
		+	\|}

-	[[~~Kategorie~~:Scripting-~~Hilfe\|Anfängerkurs~~]]	+	[[Category:Scripting-Help]]

Jacksfh: /* Vorwort */

2011-12-30T20:28:23Z

Vorwort

← Older revision		Revision as of 20:28, 30 December 2011
Line 4:		Line 4:

	__TOC__		__TOC__
-	==~~Vorwort~~==	+	==Preface==
	Much like the German version this course is aimed primarily at those who have never programmed and would like to start scripting in STNE. Please realize it is not easy and it will take a little while before you realize results. Be patient and keep at it! Like all good things it takes effort but it should be worth the time you put into it. I wish you the best of luck.		Much like the German version this course is aimed primarily at those who have never programmed and would like to start scripting in STNE. Please realize it is not easy and it will take a little while before you realize results. Be patient and keep at it! Like all good things it takes effort but it should be worth the time you put into it. I wish you the best of luck.

Miltiades: /* Classes */

2011-11-12T06:00:37Z

Classes

← Older revision		Revision as of 06:00, 12 November 2011
Line 436:		Line 436:
	Keep in mind, that a variable or a method can only be declared once, so if you define something in the include, its name must be unique.		Keep in mind, that a variable or a method can only be declared once, so if you define something in the include, its name must be unique.

-	==~~Klassen~~==	+	== Classes ==
		+	To encapsulate both data and functions within a single object, you can use classes. The benefits of classes are that they can reuse variable names (variables are scoped within the class), You can make your code more self documenting, and they are easily included with a minim of name space clashes (you're less likely to use the same for a variable or function within the same name space scope).

-	~~In Klassen können Daten und Methoden in einem Objekt gekapselt werden:~~	+	<pre> <nowiki>
-		+	Class CCoords
-	<pre><nowiki>	+
-	Class ~~CKoords~~	+
	{		{
-	Var x As Integer;	+	Var x As Integer;
-	Var y As Integer;	+	Var y Integer;

-	~~Function~~ New(x As Integer, y As Integer)	+	New Function (x As Integer, y As Integer)
-	{	+	{
-	This.x = x;	+	This.x = x;
-	This.y = y;	+	This.y = y;
-	}	+	}

-	~~Function~~ ToString() As String	+	ToString () As String
		+	{
		+	Return (CStr (x) + '\|' + CStr (y);
		+	}
		+
		+	Function distance (coord As CCoords) As Integer
		+	{
		+	Return Math.Abs ??(x - coord.x) + Math.abs (y - coord.y);
		+	}
		+	}
		+
		+	Var ko1 As New CCoords (3, 5);
		+	Var ko2 As CCoords;
		+
		+	ko2 = New CKoords(8, 9);
		+	WriteLine ('Distance from' ko1.ToString + () + 'for' + ko2.ToString () + ': ' + CStr (ko1.distance (ko2)));
		+	</nowiki> </pre>
		+
		+	Important: classes always need a new () method, otherwise a new object of class will be generated! Worse, you won't be able to have multiple instances of the class. This is fine if you are creating a static class, but this is rarely the case. If you don't need to send any parameters to initialize the object, you can create an empty New method:
		+	<pre> <nowiki>
		+	Class Coords2
		+	{
		+	Function New()
	{		{
-	~~Return~~ (~~CStr(x~~) ~~+ '\|' + CStr(y);~~	+	; // NOP (No Operation) instruction, does nothing
	}		}
-		+	...
-	Function ~~Distanz~~(~~koord As CKoords~~) As ~~Integer~~	+	}
		+	</nowiki> </pre>
		+
		+	You can also call methods statically from any context by prefixing the class name:
		+	<pre> <nowiki>
		+	Class Coords3
		+	{
		+	Function NotTrue() As Boolean
	{		{
-	Return ~~Math.Abs(x - koord.x) + Math.Abs(y - koord.y)~~;	+	Return False;
	}		}
	}		}

-	Var ~~ko1~~ As ~~New CKoords(3, 5)~~;	+	Var MyFalse As Boolean = Coords3.NotTrue;
-	~~Var ko2 As CKoords;~~	+	</nowiki> </pre>

		+	The above is also an example of a read only object property. You can get the value multiple times, but you can never change it. This is useful in some instances. Finally, The class can access a method within the class, but you have to prefix either the class name for a static value, or use the This pointer to access dynamic data:

-	~~ko2 =~~ New ~~CKoords~~(8, 9);	+	<pre><nowiki>
-	~~WriteLine('Distanz von ' + ko1~~.ToString() + ' ~~nach~~ ' + ~~ko2~~.~~ToString~~() + ~~': ' + CStr~~(~~ko1~~.~~Distanz~~(~~ko2~~)));	+	Class CCoords
-	</nowiki></pre>	+	{
		+	Var x As Integer;
		+	Var y Integer;
		+
		+	New Function (x As Integer, y As Integer)
		+	{
		+	This.x = x;
		+	This.y = y;
		+	}
		+
		+	ToString () As String
		+	{
		+	Return (CStr (x) + '\|' + CStr (y);
		+	}
		+
		+	Function distance (coord As CCoords) As Integer
		+	{
		+	Return Math.Abs ??(x - coord.x) + Math.abs (y - coord.y);
		+	}
		+	// Method added to Coords
		+	Function GetPoint() As SPoint {
		+	Return SPoint.FromString(This.ToString());
		+	}
		+	}
		+	</nowiki> </pre>

-	~~Wichtig: Klassen brauchen immer eine Methode New()~~, ~~sonst kann kein neues Objekt der Klasse generiert werden!~~	+	If you try and access the method GetPoint statically, you will generate a run time error. If the method GetPoint did not use the This pointer, the code would look for ToString in the script global name space, and generate a compile time error.

	==Autoren==		==Autoren==

Miltiades: /* Methods */

2011-11-12T05:26:16Z

Methods

← Older revision		Revision as of 05:26, 12 November 2011
Line 397:		Line 397:
	kommt noch		kommt noch

-	==~~Methoden~~==	+	== Methods ==
		+
		+	Anything that you would want to do more than one time can be grouped into scripting methods. A scripting method is essentially a function or a procedure (The difference between a function and a procedure being that a function returns a value. A procedure does not.)

-	~~Öfters wiederkehrende Aufgaben können in Methoden zusammengefasst werden:~~
	<pre><nowiki>		<pre><nowiki>
-	Function ~~ShowKoords~~(x As Integer, y As Integer)	+	// This would be considered a procedure, as it returns no value
		+	Function ShowCoords (x As Integer, y As Integer)
	{		{
-	WriteLine(CStr(x) + '\|' + CStr(y));	+	WriteLine (CStr(x) + '\|' + CStr(y));
	}		}
-	</nowiki></pre>	+	</nowiki> </pre>
-	~~Die Methode ShowKoords kann dann im Script folgendermaßen aufgerufen werden~~:	+	The method ShowCoords can then be called in the script as follows:
	<pre><nowiki>		<pre><nowiki>
-	~~ShowKoords~~(3, 4);	+	ShowCoords (3, 4);
-	~~ShowKoords~~(ship.MapPosition.X,ship.MapPosition.Y);	+	ShowCoords (ship.MapPosition.X, ship.MapPosition.Y);
-	</nowiki></pre>	+	</nowiki> </pre>
-	~~Wenn berechnete Werte von der Methode zurückgegeben werden sollen~~:	+	If calculated values are to be returned by the method:
	<pre><nowiki>		<pre><nowiki>
-	Function ~~Distanz~~(x1 As Integer, y1 As Integer, x2 As Integer, y2 As Integer) As Integer	+	// This is a function, as it returns a value
		+	Function distance (x1 As Integer, y1 As Integer, x2 As Integer, y2 As Integer) As Integer
	{		{
-	Var ~~distanz~~ As Integer;	+	Var As Integer distance;

-	~~distanz~~ = Math.~~Abs~~(x1 - x2) + Math.~~Abs~~(y1 - y2);	+	distance = Math.abs (x1 - x2) + Math.abs (y1 - y2);
-	Return ~~distanz~~ ;	+	Return distance;
	}		}

-	WriteLine(~~Distanz~~(1, 1, 5, 5));	+	WriteLine (distance (1, 1, 5, 5));
	</nowiki></pre>		</nowiki></pre>
-	~~Einfache Typen werden immer 'ByVal' übergeben~~, d.h. ~~die Werte werden als Kopie an die Methode übergeben und die entsprechenden Variablen im Script nicht verändert~~.	+	Simple types are always passed by value (the value assigned to the variable is pushed onto the stack before calling the method). Examples of a simple type are Integer, Double, Char. This means that you don't change their values in the calling method. Complex types (such as Classes, Strings, Dates, Objects) are passed by reference (as attempting to pass such by value is very memory intensive unnecessarily, so the address of the variable is pushed onto the stack instead), so if you change the value of a complex type from a called function, it changes the value in the calling function as well.
-	'~~ByRef~~' ~~ist zwar in der Scriptengine vorgesehen und kann angegeben werden~~, ~~ist aber derzeit ohne Funktion.~~	+
-	~~Objekte werden immer ByRef übergeben~~.	+	For Classes or methods that need to be consistent and available from multiple scripts, There is the scripting pragma #Include. The syntax is as follows:
		+	<pre><nowiki>#Include ScriptName = 'The Name of the included script', FromUser = 'Server-UserID';</nowiki></pre>
		+
		+	So something like:
		+	<pre><nowiki>#Include ScriptName = 'My Coordinate Methods', FromUser = 'En1-123456';</nowiki></pre>
		+
		+	Keep in mind, that a variable or a method can only be declared once, so if you define something in the include, its name must be unique.

	==Klassen==		==Klassen==

Miltiades: /* Alternative to ShipManager: Ship.Action */

2011-11-12T04:55:40Z

Alternative to ShipManager: Ship.Action

← Older revision		Revision as of 04:55, 12 November 2011
Line 384:		Line 384:
	kommt noch		kommt noch

-	===~~Alternative zum Schiffsmanager~~: ~~Schiffsaktion~~===	+	=== An alternative to using the Ship Manager: Ship Action ===

-	~~Für Objekte des Typ's CMyFlotte und~~ CMyShip ~~kann über die Eigenschaft Aktion direkt auf die Funktionen des Schiffsmanagers zugegriffen werden~~.	+	The objects CMyShip (not CShip) And CMyFleet can access methods of the Ship Manager directly via the Action method of the object.

-	<pre><nowiki>VAR ~~Schiff~~ AS CMyShip = new CMyShip( ~~4711~~ )	+	<pre><nowiki>VAR Ship AS CMyShip = new CMyShip( 1 );
-	~~Schiff~~.~~Aktion~~.~~Abdocken~~()</nowiki></pre>	+	Ship.Action.Undock();</nowiki></pre>

-	<pre><nowiki>VAR ~~Flotte~~ AS ~~CMyFlotte~~ = new ~~CMyFlotte~~( ~~4711~~ )	+	<pre><nowiki>VAR Fleet AS CMyFleet = new CMyFleet( 1 );
-	~~Flotte~~.~~Aktion~~.~~Abdocken~~()</nowiki></pre>	+	Fleet.Action.Undock();</nowiki></pre>

	==Enumeration ist Alles==		==Enumeration ist Alles==

Miltiades: /* Parameters */

2011-11-11T18:37:36Z

Parameters

← Older revision		Revision as of 18:37, 11 November 2011
Line 306:		Line 306:

	This way the ShipManager knows which ship or fleet to interact with.		This way the ShipManager knows which ship or fleet to interact with.
		+
		+	Syntax:
		+	CShipManager.TransferToShip(<i>ToShipID, Amount, EBeamResource.Resource</i>)
		+	You just need to replace the parameters with the respective values. Here's an example:
		+	ShipManager.SelectShip (1);
		+	ShipManager.TransferToShip (2, 20, EBeamRessource.Food);
		+	Of course, you can also beam from an entire fleet, if your replace ShipManager.SelectShip(1) by ShipManager.SelectFleet(1), Then the script transfers the amount from every ship in a fleet:
		+	ShipManager.BenutzteFlotte (1);
		+	ShipManager.TransferToShip (2, 20, EBeamRessource.Food);

	With the Ship Managers, you can do the following:		With the Ship Managers, you can do the following:
Line 315:		Line 324:
	* Collect deuterium (only with FP)		* Collect deuterium (only with FP)
	* Gather ore (only with FP)		* Gather ore (only with FP)
-	* Fly (AutoPilot, only with FP)	+	* Fly (FlyTo() AutoPilot, only with FP)
-	* Fly (Using the ~~FlyTo~~() method)	+	* Fly (Using the Fly() method)
	* Tractor beam on / off		* Tractor beam on / off
	* Beaming		* Beaming
Line 326:		Line 335:
	* And more		* And more

-	For a complete list of the features ~~found in~~ [http://game.stne.net/ObjectExplorer.aspx?p=CShipManager Object Explorer].	+	For a complete list of the CShipManager features, see [http://game.stne.net/ObjectExplorer.aspx?p=CShipManager Object Explorer].

	Next, we will look at some specific features:		Next, we will look at some specific features:

Miltiades: /* Flying */

2011-11-11T18:29:37Z

Flying

← Older revision		Revision as of 18:29, 11 November 2011
Line 340:		Line 340:
	ShipManager.TransferToShip (2, 20, EBeamRessource.Food);		ShipManager.TransferToShip (2, 20, EBeamRessource.Food);

-	===~~Fliegen~~===	+	===Flying===
-	~~Bei der Syntaxe gibt es 2 Möglichkeiten~~, ~~die eine für Spieler unter Level 8 oder mit~~ [[Feature-Pack]], ~~also mit Autopilot~~, ~~und die andere für die Leute über Level 8 und ohne Feature-Pack~~, ~~die Variante ohne Autopilot~~.	+	There are two versions of flying, CShipManager.FlyTo() (For players with the [[Feature-Pack]]), and CShipManager.Fly() (Works for everyone). FlyTo() is an auto pilot, like the helm control with FP, while Fly() moves you a number of sectors in a straight line.
-	~~====Fliegen mit dem Autopiloten====~~	+
-	~~<font color="red">'''''Nur für Spieler mit Feature-Pack oder unter Kolonisationslevel 8 möglich!'''''</font>~~	+

-	~~Der Befehl:~~	+	====Flying with the Autopilot====
-	~~ShipManager.FliegeZu(~~''~~xxx\|yyy~~'');	+	<font color="red">'''''Only for players with the feature pack!'''''</font>
-	~~Auch hier Gilt es wieder das kursive durch die eigenen Angaben zu ersetzten. Wie in folgendem Beispiel:~~	+
-	~~ShipManager.BenutzteSchiff(1);~~	+
-	~~ShipManager.FliegeZu(~~'~~123\|465~~');	+
-	~~oder mit dem Flottenbefehl:~~	+
-	~~ShipManager.BenutzteFlotte(1);~~	+
-	~~ShipManager.FliegeZu(~~'~~123\|465~~');	+
-	Mit deisem Befehl fliegt das Schiff zu einer belibigen Position, [[NPC\|NPC-Gebiete]] ausgenommen, und umgeht dabei wie der Autopilot Energie-intensive Hindernisse, sowie solche die das Schiff oder die Crew Gefährden.	+

-	====~~Fliegen ohne~~ Autopilot====	+
-	~~Der Befehl hierzu sieht wie folgt aus~~:	+	The command:
-	ShipManager.~~Fliege~~(''~~Strecke~~'', ~~EShipRichtung.~~''~~Richtung~~'');	+	ShipManager.FlyTo (<i>'xxx \| yyy'</i>);
-	~~Auch hier ersetzt du die kursiven Worte mit deinen Angaben, ein Beispiel folgt~~:	+	Again, it you need to replace the italicized parameter 'xxx \| yyy' with something appropriate. Here is an example:
-	ShipManager.~~BenutzteSchiff~~(1);	+	ShipManager.SelectShip(1);
-	ShipManager.~~Fliege~~(5, ~~EShipRichtung~~.~~Hoch~~);	+	ShipManager.FlyTo('123\|465');
-	ShipManager.~~Fliege~~(8, ~~EshipRichtung~~.~~Links~~);	+	Or, with a fleet:
-	~~oder wenn es eine ganze Flotte ist~~:	+	ShipManager.SelectFleet(1);
-	ShipManager.~~BenutzteFlotte~~(1);	+	ShipManager.FlyTo('123\|465');
-	ShipManager.~~Fliege~~(5, ~~EShipRichtung~~.~~Hoch~~);	+
-	ShipManager.~~Fliege~~(8, ~~EshipRichtung~~.~~Links~~);	+	With this command, the ship or fleet flew through space to the destination, using the auto pilot to bypass [[NPC \| NPC Areas]], energy-intensive obstacles, and those which endanger the ship or the crew
		+
		+	====Flying without the Autopilot====
		+	The command for this is as follows:
		+	ShipManager.Fly (''distance'',''EShipDirection.Direction'');
		+	Here is an example:
		+	ShipManager.SelectShip (1);
		+	ShipManager.Fly (5, EShipDirection.Up);
		+	ShipManager.Fly (8, EShipDirection.Left);
		+	or if you wanted to move an entire fleet:
		+	ShipManager.SelectFleet (1);
		+	ShipManager.Fly (5, EShipDirection.Up);
		+	ShipManager.Fly (8, EShipDirection.Left);
		+
		+	Please note, Fly() will <B>NOT</b> avoid dangerous areas, it will fly in a straight line though Nebulas etc.

	===Schiffsystem nutzen===		===Schiffsystem nutzen===