HowTo/Your first Trainz Script - Revision history

Tonyhilliam at 23:15, 16 January 2018

2018-01-16T23:15:15Z

← Older revision		Revision as of 23:15, 16 January 2018
Line 96:		Line 96:

	callavsg		callavsg

			==Return to Index==

			[[HowToGuides\|<< How To Guides]]

			[[Category:How-to guides]]

Trev999: --~~~~ corrected spelling and grammar

2017-08-16T15:59:39Z

--~~~~ corrected spelling and grammar

Callavsg at 20:54, 18 April 2016

2016-04-18T20:54:42Z

← Older revision		Revision as of 20:54, 18 April 2016
Line 91:		Line 91:


	If you ~~wnt~~ to contact me, you may use this e-mail: callavsg@gmx.de		If you want to contact me, you may use this e-mail: callavsg@gmx.de

	Until next time!		Until next time!

	callavsg		callavsg

Callavsg at 20:54, 18 April 2016

2016-04-18T20:54:26Z

← Older revision		Revision as of 20:54, 18 April 2016
Line 81:		Line 81:
	}		}
	</pre>		</pre>


			; What we've learned today:
			- If we want to extend the functionallity of an asset, we have to extend the Trainz-Script-Class that belongs to our asset (here [[Class MapObject]])

			- We extend our class by implementing a custom class that inherits from our parent class (CMyClass inherits from [[Class MapObject]])

			- All Trainz-Classes that assets can inherit from have the Init-Method and custom classes has to implement the Init-Method, too!


			If you wnt to contact me, you may use this e-mail: callavsg@gmx.de

			Until next time!

			callavsg

Callavsg at 20:47, 18 April 2016

2016-04-18T20:47:03Z

@@ Line 19: / Line 19: @@
 A basic script may look like this:
   '''<font color="#0000C0">include</font>''' <font color="#808080">"MapObject.gs"</font>
@@ Line 25: / Line 27: @@
       <font color="#0000C0">'''public void''' Init</font>(<font color="#800000">'''Asset'''</font> <font color="#008000">pAsset</font>)
+      {
-          <font color="#0000C0">inherited</font>(<font color="#008000">pAsset</font>);
+          <font color="#0000C0">'''inherited'''</font>(<font color="#008000">pAsset</font>);
+      }
   };

Callavsg: Created page with "Scripting is one of most powerful tools when creating trainz assets. More and more content creators are using scripts to extend the funciontallity of their contents, so script..."

2016-04-18T20:28:39Z

Created page with "Scripting is one of most powerful tools when creating trainz assets. More and more content creators are using scripts to extend the funciontallity of their contents, so script..."

New page

Scripting is one of most powerful tools when creating trainz assets.
More and more content creators are using scripts to extend the funciontallity of their contents,
so scripters, like me, get a lot of request for script work.
Finally, I thought, even for small functionallity, it'll be a good idea, if more people know how to script.

I'm from germany and this is my first article here, so feel free to send corrections or if you have the permission,
feel free to correct this article on your own!

First, let us take a theoretical approach:

Trainz Script is a small programming language and has many similar aspects to Java or C++. I'll say it's a kind of a Framework,
that allows us to implement new features based on built-in classes and their members.
That means we have to assign our assets to a script class. Without a custom script, we do it by selecting the kind of our asset
in config.txt. A kind of "scenery" (not "screnery-trackside"!) will assign the class "MapObject" to our asset.
So, if we want to extend our asset of [[Class MapObject]], we'll have to extend the class itself.
Extending a class means to create a custom script file with a custom class declaration inside of it that inherits from the [[Class MapObject]].
"MapObject" then becomes our parent class and we have all functionallity of this class within our custom implemented class.

A basic script may look like this:

'''include''' "MapObject.gs"

'''class''' CMyClass '''isclass''' '''MapObject'''
{
'''public void''' Init('''Asset''' pAsset)
{
inherited(pAsset);
}
};

← Older revision		Revision as of 15:59, 16 August 2017
Line 4:		Line 4:
	Finally, I thought, even for small functionallity, it'll be a good idea, if more people know how to script.		Finally, I thought, even for small functionallity, it'll be a good idea, if more people know how to script.

	I'm from ~~germany~~ and this is my first article here, so feel free to send corrections or if you have the permission,		I'm from Germany and this is my first article here, so feel free to send corrections or if you have the permission,
	feel free to correct this article on your own!		feel free to correct this article on your own!

Line 12:		Line 12:
	that allows us to implement new features based on built-in classes and their members.		that allows us to implement new features based on built-in classes and their members.
	That means we have to assign our assets to a script class. Without a custom script, we do it by selecting the kind of our asset		That means we have to assign our assets to a script class. Without a custom script, we do it by selecting the kind of our asset
	in config.txt. A kind of "scenery" (not "~~screnery~~-trackside"!) will assign the class "MapObject" to our asset.		in config.txt. A kind of "scenery" (not "scenery-trackside"!) will assign the class "MapObject" to our asset.
	So, if we want to extend our asset of [[Class MapObject]], we'll have to extend the class itself.		So, if we want to extend our asset of [[Class MapObject]], we'll have to extend the class itself.
	Extending a class means to create a custom script file with a custom class declaration inside of it that inherits from the [[Class MapObject]].		Extending a class means to create a custom script file with a custom class declaration inside of it that inherits from the [[Class MapObject]].
Line 31:		Line 31:
	};		};

	As you see in the little script above, our class already ~~got~~ a member function. This member function (Init) is the most important member we have to implement.		As you see in the little script above, our class already has a member function. This member function (Init) is the most important member we have to implement.
	This little function ~~initializies~~ our class and inherits all ~~initializations~~ of our parent class (see: <font color="#0000C0">'''inherited'''</font>(<font color="#008000">pAsset</font>);).		This little function initializes our class and inherits all the properties of our parent class (see: <font color="#0000C0">'''inherited'''</font>(<font color="#008000">pAsset</font>);).
	Without that function with ~~it's~~ call to <font color="#0000C0">'''inherited'''</font>, ~~functionallity~~ of our asset is not granted, because in this case our parent class won't be initialized.		Without that function with its call to <font color="#0000C0">'''inherited'''</font>, functionality of our asset is not granted, because in this case our parent class won't be initialized.


Line 88:		Line 88:
	- We extend our class by implementing a custom class that inherits from our parent class (CMyClass inherits from [[Class MapObject]])		- We extend our class by implementing a custom class that inherits from our parent class (CMyClass inherits from [[Class MapObject]])

	- All Trainz-Classes that assets can inherit from have the Init-Method and custom classes ~~has~~ to implement the Init-Method, too!		- All Trainz-Classes that assets can inherit from have the Init-Method and custom classes have to implement the Init-Method, too!