How to Use Variables in Sessions (Examples) - Revision history

Pware at 00:03, 26 July 2026

2026-07-26T00:03:35Z

← Older revision		Revision as of 00:03, 26 July 2026
Line 631:		Line 631:
	<td>		<td>
	<span style="font-size: 17px;">'''More Tutorials and Guides to Using Trainz'''</span><br>		<span style="font-size: 17px;">'''More Tutorials and Guides to Using Trainz'''</span><br>
	*'''<span class="plain;s">[http://online.ts2009.com/mediaWiki/index.php/HowTo How to Guides]</span>'''		*'''<span class="plain;">[http://online.ts2009.com/mediaWiki/index.php/HowTo How to Guides]</span>'''
	*'''[[Driver Commands List]]'''		*'''[[Driver Commands List]]'''
	*'''[[Session Rule List with Parameters\|Session Rules List (Alphabetical) with Parameters]]'''		*'''[[Session Rule List with Parameters\|Session Rules List (Alphabetical) with Parameters]]'''
Line 639:		Line 639:
	</table>		</table>
	----		----
	This page was created by Trainz user '''<span class="plain;s">[http://online.ts2009.com/mediaWiki/index.php/User:Pware pware]</span>''' in April 2018 and was last updated as shown below.		This page was created by Trainz user '''<span class="plain;">[http://online.ts2009.com/mediaWiki/index.php/User:Pware pware]</span>''' in April 2018 and was last updated as shown below.
	----		----
	[[Category:How-to guides]]		[[Category:How-to guides]]

Pware at 08:22, 4 July 2026

2026-07-04T08:22:40Z

@@ Line 1: / Line 1: @@
-The information in this Wiki Page applies to '''TANE''', '''TRS19''', '''Trainz Plus''' and '''TRS22'''. It gives examples of using variables in Sessions.
+<table width=1000 bgcolor=#000000 cellpadding=2>
 <table width=1000>
 <tr valign="top">

Pware at 00:30, 2 August 2024

2024-08-02T00:30:38Z

← Older revision		Revision as of 00:30, 2 August 2024
Line 99:		Line 99:
	<td width=10>[[image:DotPoint.JPG\|10px\|link=]]</td>		<td width=10>[[image:DotPoint.JPG\|10px\|link=]]</td>
	<td>The '''[[Session_Rule_List_with_Parameters#Randomize_Rule\|Randomize Rule]]''' is used at the start of the session to create a different sequence of random values each time the session is run</td>		<td>The '''[[Session_Rule_List_with_Parameters#Randomize_Rule\|Randomize Rule]]''' is used at the start of the session to create a different sequence of random values each time the session is run</td>
	~~</tr>~~
	~~<tr valign="top">~~
	~~<td colspan=2>[[image:VariableRandom.jpg\|link=]]</td>~~
	</tr>		</tr>
	<tr valign="top">		<tr valign="top">
Line 117:		Line 114:
	<td>[[image:DotPoint.JPG\|10px\|link=]]</td>		<td>[[image:DotPoint.JPG\|10px\|link=]]</td>
	<td>The '''[[Session_Rule_List_with_Parameters#Variable_Random_Rule\|Variable Random Rule]]''' is used to create a variable, '''stopID''', with an integer random value from 1 to 3. Each number representing one of the stops</td>		<td>The '''[[Session_Rule_List_with_Parameters#Variable_Random_Rule\|Variable Random Rule]]''' is used to create a variable, '''stopID''', with an integer random value from 1 to 3. Each number representing one of the stops</td>
			</tr>
			<tr valign="top">
			<td colspan=2>[[image:VariableRandom.jpg\|link=]]</td>
	</tr>		</tr>
	</table>		</table>
Line 139:		Line 139:
	<td>[[image:DotPoint.JPG\|10px\|link=]]</td>		<td>[[image:DotPoint.JPG\|10px\|link=]]</td>
	<td>'''[[Session_Rule_List_with_Parameters#Navigation_Set_Hide/Show_Rule\|Navigation Set Hide/Show Rule]]''' to hide all three navigation sets (in '''Preconditions''' above) and to reveal one set identified by the random variable</td>		<td>'''[[Session_Rule_List_with_Parameters#Navigation_Set_Hide/Show_Rule\|Navigation Set Hide/Show Rule]]''' to hide all three navigation sets (in '''Preconditions''' above) and to reveal one set identified by the random variable</td>
			</tr>
			<tr valign="top">
			<td>[[image:DotPoint.JPG\|10px\|link=]]</td>
			<td>'''[[Session_Rule_List_with_Parameters#Randomize_Rule\|Randomize Rule]]''' to create a different sequence of random values each time the session is run (in '''Preconditions''' above)</td>
	</tr>		</tr>
	<tr valign="top">		<tr valign="top">
Line 177:		Line 181:
	<tr valign="top">		<tr valign="top">
	<!-- <td> </td> -->		<!-- <td> </td> -->
	<td>[[image:AppRandomStop1.jpg\|link=]]</td>		<td>[[image:AppRandomStop1.jpg\|link=]]<br>
			The '''Trigger Check''' sequence</td>
	</tr>		</tr>
	</table>		</table>
Line 614:		Line 619:
	<td>		<td>
	<span style="font-size: 17px;">'''More Tutorials and Guides to Using Trainz'''</span><br>		<span style="font-size: 17px;">'''More Tutorials and Guides to Using Trainz'''</span><br>
	*'''<span class="~~plainlinks~~">[http://online.ts2009.com/mediaWiki/index.php/HowTo How to Guides]</span>'''		*'''<span class="plain;s">[http://online.ts2009.com/mediaWiki/index.php/HowTo How to Guides]</span>'''
	*'''[[Driver Commands List]]'''		*'''[[Driver Commands List]]'''
	*'''[[Session Rule List with Parameters\|Session Rules List (Alphabetical) with Parameters]]'''		*'''[[Session Rule List with Parameters\|Session Rules List (Alphabetical) with Parameters]]'''
Line 622:		Line 627:
	</table>		</table>
	----		----
	This page was created by Trainz user '''<span class="~~plainlinks~~">[http://online.ts2009.com/mediaWiki/index.php/User:Pware pware]</span>''' in April 2018 and was last updated as shown below.		This page was created by Trainz user '''<span class="plain;s">[http://online.ts2009.com/mediaWiki/index.php/User:Pware pware]</span>''' in April 2018 and was last updated as shown below.
	----		----
	[[Category:How-to guides]]		[[Category:How-to guides]]

Pware at 09:35, 4 October 2023

2023-10-04T09:35:58Z

← Older revision		Revision as of 09:35, 4 October 2023
Line 133:		Line 133:
	<table>		<table>
	<tr valign="top">		<tr valign="top">
	<td ~~colspan~~=2>~~In addition~~ to ~~those used~~ in the '''Preconditions''' above:-</td>		<td width=10>[[image:DotPoint.JPG\|10px\|link=]]</td>
			<td>'''[[Session_Rule_List_with_Parameters#Navigation_Display_Rule\|Navigation Display Rule]]''' to create three Navigation Point Sets (in '''Preconditions''' above)</td>
			</tr>
			<tr valign="top">
			<td>[[image:DotPoint.JPG\|10px\|link=]]</td>
			<td>'''[[Session_Rule_List_with_Parameters#Navigation_Set_Hide/Show_Rule\|Navigation Set Hide/Show Rule]]''' to hide all three navigation sets (in '''Preconditions''' above) and to reveal one set identified by the random variable</td>
			</tr>
			<tr valign="top">
			<td>[[image:DotPoint.JPG\|10px\|link=]]</td>
			<td>'''[[Session_Rule_List_with_Parameters#Variable_Random_Rule\|Variable Random Rule]]''' to create the variable '''stopID''' (in '''Preconditions''' above)</td>
	</tr>		</tr>
	<tr valign="top">		<tr valign="top">
	<td ~~width=10~~>[[image:DotPoint.JPG\|10px\|link=]]</td>		<td>[[image:DotPoint.JPG\|10px\|link=]]</td>
	<td>'''[[Session_Rule_List_with_Parameters#Trigger_Check_Rule\|Trigger Check Rule]]''' to trigger the decision and message event</td>		<td>'''[[Session_Rule_List_with_Parameters#Trigger_Check_Rule\|Trigger Check Rule]]''' to trigger the decision and message event</td>
	</tr>		</tr>
Line 151:		Line 160:
	</table>		</table>
	</td>		</td>
	~~</tr>~~
	~~<tr valign="top">~~
	~~<td>[[image:DotPoint.JPG\|10px\|link=]]</td>~~
	~~<td>'''[[Session_Rule_List_with_Parameters#Navigation_Set_Hide/Show_Rule\|Navigation Set Hide/Show Rule]]''' to show the navigation set identified by the random variable</td>~~
	</tr>		</tr>
	<tr valign="top">		<tr valign="top">
Line 322:		Line 327:
	<tr valign="top">		<tr valign="top">
	<!-- <td> </td> -->		<!-- <td> </td> -->
	<td>Lines 9 and 10 are then repeated with variations as shown. If more than 5 SPADs occur, then no new messages will be shown (the driver is clearly taking no notice so what is the point?) but the '''SPADCounter''' will continue to be updated.		<td>Lines <span style="font-weight: 700; font-size: 15px; color: white; background-color: black;"> 9 </span> and <span style="font-weight: 700; font-size: 15px; color: white; background-color: black;"> 10 </span> are then repeated with variations as shown. If more than 5 SPADs occur, then no new messages will be shown (the driver is clearly taking no notice so what is the point?) but the '''SPADCounter''' will continue to be updated.
	</td>		</td>
	</tr>		</tr>

Pware: /* Example 4: Train Status */

2023-10-03T02:09:12Z

Example 4: Train Status

← Older revision		Revision as of 02:09, 3 October 2023
Line 463:		Line 463:
	<tr valign="top">		<tr valign="top">
	<td width=10>[[image:DotPoint.JPG\|10px\|link=]]</td>		<td width=10>[[image:DotPoint.JPG\|10px\|link=]]</td>
	<td>A variable, '''T188Status''' is initially set to "1" signifying that the train is empty. This will be modified to "2" after it has been loaded</td>		<td>A variable, '''T188Status''' is initially set to "1" signifying that the train is empty. This will be modified to "2" after it has been loaded. Use the '''[[Session_Rule_List_with_Parameters#Variable_Modify_Rule\|Variable Modify Rule]]''' to create and set this variable</td>
	</tr>		</tr>
	</table>		</table>

Pware: /* Example 2: Event Counter and Message Selection */

2023-10-03T02:08:42Z

Example 2: Event Counter and Message Selection

← Older revision		Revision as of 02:08, 3 October 2023
Line 228:		Line 228:
	<tr valign="top">		<tr valign="top">
	<td width=10>[[image:DotPoint.JPG\|10px\|link=]]</td>		<td width=10>[[image:DotPoint.JPG\|10px\|link=]]</td>
	<td>A variable, '''SetSPAD''' (value "0" or "1"), is used to indicate whether a SPAD event is to be counted and responded to or not. This is set to "0" or "1" by track triggers</td>		<td>A variable, '''SetSPAD''' (value "0" or "1"), is used to indicate whether a SPAD event is to be counted and responded to or not. This is set to "0" or "1" by track triggers. Use the '''[[Session_Rule_List_with_Parameters#Variable_Modify_Rule\|Variable Modify Rule]]''' to create and set this variable</td>
	</tr>		</tr>
	<tr valign="top">		<tr valign="top">
	<td>[[image:DotPoint.JPG\|10px\|link=]]</td>		<td>[[image:DotPoint.JPG\|10px\|link=]]</td>
	<td>A variable, '''SPADCounter''', is used to count the SPAD events and is initially set at 0</td>		<td>A variable, '''SPADCounter''', is used to count the SPAD events and is initially set at 0. Use the '''[[Session_Rule_List_with_Parameters#Variable_Modify_Rule\|Variable Modify Rule]]''' to create and set this variable</td>
	</tr>		</tr>
	</table>		</table>
Line 330:		Line 330:
	<tr valign="top">		<tr valign="top">
	<td width=629><span id="stepEx3"></span>		<td width=629><span id="stepEx3"></span>

	='''Example 3: Counting Consist Checks'''=		='''Example 3: Counting Consist Checks'''=
	</td>		</td>

Pware: /* Example 3: Counting Consist Checks */

2023-10-03T02:08:00Z

Example 3: Counting Consist Checks

← Older revision		Revision as of 02:08, 3 October 2023
Line 363:		Line 363:
	<tr valign="top">		<tr valign="top">
	<td width=10>[[image:DotPoint.JPG\|10px\|link=]]</td>		<td width=10>[[image:DotPoint.JPG\|10px\|link=]]</td>
	<td>A variable, '''ConsistCount''', is initially set to "0"</td>		<td>A variable, '''ConsistCount''', is initially set to "0". Use the '''[[Session_Rule_List_with_Parameters#Variable_Modify_Rule\|Variable Modify Rule]]''' to create and set this variable</td>
	</tr>		</tr>
	</table>		</table>
Line 428:		Line 428:
	<tr valign="top">		<tr valign="top">
	<td width=629><span id="stepEx4"></span>		<td width=629><span id="stepEx4"></span>

	='''Example 4: Train Status'''=		='''Example 4: Train Status'''=
	</td>		</td>

Pware: /* Example 4: Train Status */

2023-10-03T00:54:57Z

Example 4: Train Status

← Older revision		Revision as of 00:54, 3 October 2023
Line 513:		Line 513:
	<!-- <td> </td> -->		<!-- <td> </td> -->
	<td>'''Line''' <span style="font-weight: 700; font-size: 15px; color: white; background-color: black;"> 1 </span>''': Trigger Check Rule''' Triggered by the train. This is '''NOT''' set to trigger once only. When triggered it will execute the following lines:-		<td>'''Line''' <span style="font-weight: 700; font-size: 15px; color: white; background-color: black;"> 1 </span>''': Trigger Check Rule''' Triggered by the train. This is '''NOT''' set to trigger once only. When triggered it will execute the following lines:-
	:'''Line''' <span style="font-weight: 700; font-size: 15px; color: white; background-color: black;"> 2 </span>''': Variable Check''' Compares the value stored in '''T188Status''' to 1, indicating "empty". If it matches then the next ~~line is~~ executed:-		:'''Line''' <span style="font-weight: 700; font-size: 15px; color: white; background-color: black;"> 2 </span>''': Variable Check''' Compares the value stored in '''T188Status''' to 1, indicating "empty". If it matches then the next lines are executed:-
	::'''Line''' <span style="font-weight: 700; font-size: 15px; color: white; background-color: black;"> 3 </span>''': Message Popup''' Places a message on the screen		::'''Line''' <span style="font-weight: 700; font-size: 15px; color: white; background-color: black;"> 3 </span>''': Message Popup''' Places a message on the screen
	::'''Line''' <span style="font-weight: 700; font-size: 15px; color: white; background-color: black;"> 4 </span>''': Variable Check''' Compares the value stored in '''T188Status''' to 2, indicating "loaded". If it matches then the next line is executed:-		::'''Line''' <span style="font-weight: 700; font-size: 15px; color: white; background-color: black;"> 4 </span>''': Variable Check''' Compares the value stored in '''T188Status''' to 2, indicating "loaded". If it matches then the next line is executed:-
Line 523:		Line 523:
	<tr valign="top">		<tr valign="top">
	<td width=629><span id="stepRules"></span>		<td width=629><span id="stepRules"></span>

	='''Variable Rules and Commands'''=		='''Variable Rules and Commands'''=
	</td>		</td>

Pware at 00:28, 3 October 2023

2023-10-03T00:28:02Z

← Older revision		Revision as of 00:28, 3 October 2023
Line 89:		Line 89:
	<table width=1000 cellpadding=2 bgcolor=#ffffff>		<table width=1000 cellpadding=2 bgcolor=#ffffff>
	<tr valign="top">		<tr valign="top">
	<td width=60 rowspan=4>[[image:conditions.PNG\|link=]]</td>		<td width=60 rowspan=2>[[image:conditions.PNG\|link=]]</td>
	<td colspan=2><span style="font-size: 17px;">'''Preconditions:'''</span></td>		<td colspan=2><span style="font-size: 17px;">'''Preconditions:'''</span></td>
	</tr>		</tr>
Line 99:		Line 99:
	<td width=10>[[image:DotPoint.JPG\|10px\|link=]]</td>		<td width=10>[[image:DotPoint.JPG\|10px\|link=]]</td>
	<td>The '''[[Session_Rule_List_with_Parameters#Randomize_Rule\|Randomize Rule]]''' is used at the start of the session to create a different sequence of random values each time the session is run</td>		<td>The '''[[Session_Rule_List_with_Parameters#Randomize_Rule\|Randomize Rule]]''' is used at the start of the session to create a different sequence of random values each time the session is run</td>
			</tr>
			<tr valign="top">
			<td colspan=2>[[image:VariableRandom.jpg\|link=]]</td>
			</tr>
			<tr valign="top">
			<td colspan=2>Setting the random variable '''stopID'''</td>
	</tr>		</tr>
	<tr valign="top">		<tr valign="top">
Line 114:		Line 120:
	</table>		</table>
	</td>		</td>
	~~</tr>~~
	~~<tr valign="top">~~
	~~<!-- <td> </td> -->~~
	~~<td>[[image:VariableRandom.jpg\|link=]]</td>~~
	~~</tr>~~
	~~<tr valign="top">~~
	~~<!-- <td> </td> -->~~
	~~<td>Setting the random variable '''stopID'''</td>~~
	</tr>		</tr>
	</table>		</table>

Pware at 00:22, 3 October 2023

2023-10-03T00:22:16Z

Show changes