HowTo/Hide- & Unhide Meshes - Revision history

Tonyhilliam at 23:18, 16 January 2018

2018-01-16T23:18:46Z

← Older revision		Revision as of 23:18, 16 January 2018
Line 355:		Line 355:

	Edited by --[[User:Trev999\|Trev999]] ([[User talk:Trev999\|talk]]) 02:28, 20 August 2017 (AEST)		Edited by --[[User:Trev999\|Trev999]] ([[User talk:Trev999\|talk]]) 02:28, 20 August 2017 (AEST)

			==Return to Index==

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

			[[Category:How-to guides]]

Trev999 at 17:00, 19 August 2017

2017-08-19T17:00:06Z

← Older revision		Revision as of 17:00, 19 August 2017
Line 198:		Line 198:


	Now we can display and hide the meshes. But the object itself has to be prepared for it. The Ice cream truck has three meshes. The truck with a hole where the door is, a door in the opened state and a door in the closed state. You also may achieve this by using animations, but this way is much easier.		Now we can display and hide the meshes. But the object itself has to be prepared for it. The Ice cream truck has three meshes: The truck with a hole where the door should be, a door in the opened state and a door in the closed state. You also may achieve this by using animations, but this way is much easier.

	[[File:Scripting_2_Truck_whole.jpg]]<br>		[[File:Scripting_2_Truck_whole.jpg]]<br>
Line 254:		Line 254:


	We have two meshes, that have to be set. In script we'll hide/show them like this:		We have two meshes that have to be set. In script we'll hide/show them like this:

Trev999 at 16:46, 19 August 2017

2017-08-19T16:46:38Z

← Older revision		Revision as of 16:46, 19 August 2017
Line 248:		Line 248:
	Our CIceCreamTruck's parent class is MapObject. And MapObject's parent class is MeshObject, and there we will find a method "SetMeshVisible".		Our CIceCreamTruck's parent class is MapObject. And MapObject's parent class is MeshObject, and there we will find a method "SetMeshVisible".
	We can use it directly, because we automatically inherit from MeshObject, too.		We can use it directly, because we automatically inherit from MeshObject, too.
	SetMeshVsible expects three parameters. The name of our mesh-table entry, a state (true, false - [visible, invisible]) and a floating-point number that sets a fading time in seconds.		SetMeshVsible expects to receive three parameters: The name of our mesh-table entry, a state (true or false - [visible, invisible]) and a floating-point number that sets a fading time in seconds.
	We'll leave the last parameter 0.0f.		We'll leave the last parameter 0.0f.

Trev999 at 16:41, 19 August 2017

2017-08-19T16:41:53Z

← Older revision		Revision as of 16:41, 19 August 2017
Line 288:		Line 288:

	We use our bool variable for indicating the mesh state. The opened mesh is set with the value of m_bDoorOpened. If m_bDoorOpened is true, the mesh will display, otherwise it'll be hidden.		We use our bool variable for indicating the mesh state. The opened mesh is set with the value of m_bDoorOpened. If m_bDoorOpened is true, the mesh will display, otherwise it'll be hidden.
	The closed state mesh is set with the opposite value of m_bDoorOpened. This can be easily done by using the [[not]] operator "!". Just place it in front of a boolean variable, to use the opposite value.		The closed state mesh is set with the opposite value of m_bDoorOpened. This can be easily done by using the 'not' operator "!". Just place it in front of a boolean variable, to use the opposite value.

	Now you know how to control meshes. Because it will be too much for now, I'll give the last part of the script without explanation and move it to another time :)		Now you know how to control meshes. Because it will be too much for now, I'll give the last part of the script without explanation and move it to another time :)

Trev999 at 16:39, 19 August 2017

2017-08-19T16:39:29Z

← Older revision		Revision as of 16:39, 19 August 2017
Line 288:		Line 288:

	We use our bool variable for indicating the mesh state. The opened mesh is set with the value of m_bDoorOpened. If m_bDoorOpened is true, the mesh will display, otherwise it'll be hidden.		We use our bool variable for indicating the mesh state. The opened mesh is set with the value of m_bDoorOpened. If m_bDoorOpened is true, the mesh will display, otherwise it'll be hidden.
	The closed state mesh is set with the opposite value of m_bDoorOpened. This can be easily done by using the [not] operator "!". Just place it in front of a boolean variable, to use the opposite value.		The closed state mesh is set with the opposite value of m_bDoorOpened. This can be easily done by using the [[not]] operator "!". Just place it in front of a boolean variable, to use the opposite value.

	Now you know how to control meshes. Because it will be too much for now, I'll give the last part of the script without explanation and move it to another time :)		Now you know how to control meshes. Because it will be too much for now, I'll give the last part of the script without explanation and move it to another time :)

Trev999 at 16:36, 19 August 2017

2017-08-19T16:36:44Z

← Older revision		Revision as of 16:36, 19 August 2017
Line 64:		Line 64:
	We begin by stating the data-type of our variable and then give it a name. Now we can use it.		We begin by stating the data-type of our variable and then give it a name. Now we can use it.
	This variable now is available in the whole CIceCreamTruck-Class, because we declared it before any other methods, so we may say it's a global variable (that isn't true, but it's easier to explain).		This variable now is available in the whole CIceCreamTruck-Class, because we declared it before any other methods, so we may say it's a global variable (that isn't true, but it's easier to explain).
	We also ~~may~~ declare variables within methods/functions. These then will only be ~~accessable~~ inside the function or method and not in other parts of the script.		We may also declare variables within methods/functions. These then will only be accessible inside the function or method and not in other parts of the script.
	In Trainz Script there are now real global variables (that's why I think we may call the members global, even if it's not true). We may only declare variables inside classes.		In Trainz Script there are now real global variables (that's why I think we may call the members global, even if it's not true). We may only declare variables inside classes.

Trev999: Corrected spelling and grammar and made explanations clearer

2017-08-19T16:28:50Z

Corrected spelling and grammar and made explanations clearer

Show changes

Trev999 at 17:14, 16 August 2017

2017-08-16T17:14:14Z

← Older revision		Revision as of 17:14, 16 August 2017
Line 14:		Line 14:


	Today we're gonna use this little example for a vehicle. There is an ice cream truck on the DLS by misterairbrush (<kuid:414943:100987>). This ice cream truck has a door that can be ~~set~~ opened or closed.		Today we're gonna use this little example for a vehicle. There is an ice cream truck on the DLS by misterairbrush (<kuid:414943:100987>). This ice cream truck has a door that can be opened or closed.
	It looks like:		It looks like:

	[[File:Scripting_02_Truck_1.jpg]] [[File:Scripting_02_Truck_2.jpg]]		[[File:Scripting_02_Truck_1.jpg]] [[File:Scripting_02_Truck_2.jpg]]

	We'll learn today how to hide the "wrong" and show the right mesh. Also we want ~~that the~~ users ~~may~~ select ~~the~~ option in de "?"-Window of the scenery object.		The truck comes equipped with two versions of the door, called meshes. One or the other mesh is visible at any one time but never both together.
	~~First we need a member variable~~ to ~~store the information if~~ the door is ~~opened~~ or closed~~, then we need functions to save and load the information every time the map[the vehicle] loads~~.		We'll learn today how to hide the "wrong" and show the right mesh. Also we want users to be able to select an option in the "?"-Window of the scenery object to determine whether the door is to be open or closed.

			First we need a member variable to store the (user-selected) open/closed state of the door, then we need functions to save and load the information every time the session starts or is saved.

	Variables ~~may be described as kind of placeholders~~. These ~~placeholders offers us~~ the ~~opportunity to save data temporary~~.
			Variables store values used in the game. These values can be changed by script and are stored in the computer's memory until needed.

	In Trainz Script there are four (well, really there are five, but we will ignore one this time!) data [[Types]] we can use:		In Trainz Script there are four (well, really there are five, but we will ignore one this time!) data [[Types]] we can use:
Line 30:		Line 32:
	* '''int''' - every number between -2147483647 and 2147483647 (a 32 Bit integer)		* '''int''' - every number between -2147483647 and 2147483647 (a 32 Bit integer)
	* '''string''' - characters		* '''string''' - characters
	* '''float''' - ~~floating~~ numbers (32 Bit)		* '''float''' - numbers with a decimal point (32 Bit)


	Today we'll have a closer look on the '''bool''' type. The others will be explained another time :)		Today we'll have a closer look at the '''bool''' type. The others will be explained another time :)


Line 60:		Line 62:


	~~As you can see, we just have to~~ begin with the type of our variable and then ~~giving~~ it a name~~. This is it~~. Now we can use it.		We begin with the data-type of our variable and then give it a name. Now we can use it.
	This variable now is available in the whole CIceCreamTruck-Class, because we declared it ~~as member~~, so we may say it's a global variable (that isn't true, but it's easier to explain).		This variable now is available in the whole CIceCreamTruck-Class, because we declared it before any other methods, so we may say it's a global variable (that isn't true, but it's easier to explain).
	We also may declare variables within methods/functions. These then will only be accessable inside the function or method and not on other places in the script.		We also may declare variables within methods/functions. These then will only be accessable inside the function or method and not on other places in the script.
	In Trainz Script there are now real global variables (that's why I think we may call the members global, even if it's not true). We only may declare variables inside classes.		In Trainz Script there are now real global variables (that's why I think we may call the members global, even if it's not true). We only may declare variables inside classes.


	Next, we will have a look an two new methods:		Next, we will have a look at two new methods:

	* '''[[Class_PropertyObject#GetProperties]] (GetProperties)''' - Save data to a soup		* '''[[Class_PropertyObject#GetProperties]] (GetProperties)''' - Save data to a soup
	* '''[[Class_PropertyObject#SetProperties]] (SetProperties)''' - Fetch data from a Soup		* '''[[Class_PropertyObject#SetProperties]] (SetProperties)''' - Fetch data from a Soup

	These methods are implemented in native code. That means we don't have to care about when they are called. We just have to override them. Trainz will call ~~it every time it is~~ needed.		These methods are implemented in native code. That means we don't have to care about when they are called. We just have to override them. Trainz will call them whenever needed. To override a class means to replace the built-in class with a new one that extends the functions of the original (the parent) while retaining all the original functionality.
	Let's override them:		Let's override them:

Line 101:		Line 103:

	; GetProperties:		; GetProperties:
	As I said above, this ~~functions task~~ is to save data into a Soup. It expects a Soup-Object to be ~~returend~~. You'll see, that Soup is a class, not a data type,		As I said above, the purpose of this function is to save data into a Soup. It expects a Soup-Object to be returned. You'll see, that Soup is a class, not a data type.

	But we're able to declare class instances as variables too. (Look at: '''<font color="#800000">Soup</font>''' <font color="#008000">pSoup</font> = <font color="#0000C0">'''inherited'''</font>();)		But we're able to declare class instances as variables too. (Look at: '''<font color="#800000">Soup</font>''' <font color="#008000">pSoup</font> = <font color="#0000C0">'''inherited'''</font>();)
Line 109:		Line 111:
	Only miss the call to inherited if you want to disable functionallity for a class, if not, don't forget it.		Only miss the call to inherited if you want to disable functionallity for a class, if not, don't forget it.

	In the script above, we return the Soup directly, without any operation. What exactly return types are will be explained another time :) (it will be too much ~~for us~~ now!)		In the script above, we return the Soup directly, without any operation. What exactly "return types" are will be explained another time :) (it will be too much detail to go into now!)


Line 117:		Line 119:

	; '''Saving data'''		; '''Saving data'''
	I already explained that Soup is a class. So it may ~~has~~ members, and in fact, it has. Look at: [[Class_Soup]]		Think of soup as a container into which you throw pieces of paper with names and values. When you want to find out what you wrote on the paper you look through all the pieces until you find the name and then read off the value.
			I already explained that Soup is a class. So it may have members, and in fact it has. Look at: [[Class_Soup]]

	~~A Soup is like a small database. We can set values by a name and a value.~~ I use the variable name as name, because ~~I don~~'~~t have to look it up every time, and not to think, what name~~		I use the variable name as the soup tag name, because it's convenient. The method "SetNamedTag" in class Soup is used to assign a value to each tag in the soup. We can access all public methods inside a class with the dereference operator, that
	~~the value inside the soup has~~. The method "SetNamedTag" in class Soup is ~~the right here for us~~ to ~~save~~ a value. We can access all public methods inside a class with the dereference operator, that
	is a single dot ('''.'''). So, we call the function like this:		is a single dot ('''.'''). So, we call the function like this:

Callavsg at 09:05, 21 April 2016

2016-04-21T09:05:15Z

← Older revision		Revision as of 09:05, 21 April 2016
Line 346:		Line 346:

	Hope you enjoyed an learned!<br>		Hope you enjoyed an learned!<br>
	Full example here: [[Media:TrainzDevIceCreamTruck.zip]]		Full example here: [[Media:TrainzDevIceCreamTruck.zip]] (Thanks to misterairbursh for the permission!)

	If you want 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

	callavsg		callavsg

Callavsg at 09:02, 21 April 2016

2016-04-21T09:02:05Z

← Older revision		Revision as of 09:02, 21 April 2016
Line 144:		Line 144:
	{		{
	'''<font color="#800000">Soup</font>''' <font color="#008000">pSoup</font> = <font color="#0000C0">'''inherited'''</font>();		'''<font color="#800000">Soup</font>''' <font color="#008000">pSoup</font> = <font color="#0000C0">'''inherited'''</font>();
	<font color="#008000">pSoup</font>.<font color="#0000C0">SetNamedTag</font>(<font color="#808080">"~~bDoorOpened~~"</font>, <font color="#008000">m_bDoorOpened</font>);		<font color="#008000">pSoup</font>.<font color="#0000C0">SetNamedTag</font>(<font color="#808080">"m_bDoorOpened"</font>, <font color="#008000">m_bDoorOpened</font>);
	<font color="#0000C0">'''return'''</font> <font color="#008000">pSoup</font>;		<font color="#0000C0">'''return'''</font> <font color="#008000">pSoup</font>;
	}		}
Line 184:		Line 184:
	{		{
	'''<font color="#800000">Soup</font>''' <font color="#008000">pSoup</font> = <font color="#0000C0">'''inherited'''</font>();		'''<font color="#800000">Soup</font>''' <font color="#008000">pSoup</font> = <font color="#0000C0">'''inherited'''</font>();
	<font color="#008000">pSoup</font>.<font color="#0000C0">SetNamedTag</font>(<font color="#808080">"~~bDoorOpened~~"</font>, <font color="#008000">m_bDoorOpened</font>);		<font color="#008000">pSoup</font>.<font color="#0000C0">SetNamedTag</font>(<font color="#808080">"m_bDoorOpened"</font>, <font color="#008000">m_bDoorOpened</font>);
	<font color="#0000C0">'''return'''</font> <font color="#008000">pSoup</font>;		<font color="#0000C0">'''return'''</font> <font color="#008000">pSoup</font>;
	}		}
Line 270:		Line 270:
	{		{
	'''<font color="#800000">Soup</font>''' <font color="#008000">pSoup</font> = <font color="#0000C0">'''inherited'''</font>();		'''<font color="#800000">Soup</font>''' <font color="#008000">pSoup</font> = <font color="#0000C0">'''inherited'''</font>();
	<font color="#008000">pSoup</font>.<font color="#0000C0">SetNamedTag</font>(<font color="#808080">"~~bDoorOpened~~"</font>, <font color="#008000">m_bDoorOpened</font>);		<font color="#008000">pSoup</font>.<font color="#0000C0">SetNamedTag</font>(<font color="#808080">"m_bDoorOpened"</font>, <font color="#008000">m_bDoorOpened</font>);
	<font color="#0000C0">'''return'''</font> <font color="#008000">pSoup</font>;		<font color="#0000C0">'''return'''</font> <font color="#008000">pSoup</font>;
	}		}
Line 289:		Line 289:

	Now you know how to control meshes. Because it will be too much for now, I'll give the last part of the script without explanation and move it to another time :)		Now you know how to control meshes. Because it will be too much for now, I'll give the last part of the script without explanation and move it to another time :)



Line 308:		Line 307:
	{		{
	'''<font color="#800000">Soup</font>''' <font color="#008000">pSoup</font> = <font color="#0000C0">'''inherited'''</font>();		'''<font color="#800000">Soup</font>''' <font color="#008000">pSoup</font> = <font color="#0000C0">'''inherited'''</font>();
	<font color="#008000">pSoup</font>.<font color="#0000C0">SetNamedTag</font>(<font color="#808080">"~~bDoorOpened~~"</font>, <font color="#008000">m_bDoorOpened</font>);		<font color="#008000">pSoup</font>.<font color="#0000C0">SetNamedTag</font>(<font color="#808080">"m_bDoorOpened"</font>, <font color="#008000">m_bDoorOpened</font>);
	<font color="#0000C0">'''return'''</font> <font color="#008000">pSoup</font>;		<font color="#0000C0">'''return'''</font> <font color="#008000">pSoup</font>;
	}		}
Line 346:		Line 345:
	};		};

	Hope you enjoyed an learned!		Hope you enjoyed an learned!<br>
			Full example here: [[Media:TrainzDevIceCreamTruck.zip]]

	If you want 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

	callavsg		callavsg