Session Rule List with Parameters

Revision as of 08:00, 16 June 2018 (view source) Pware (Talk | contribs) m ← Older edit		Revision as of 08:00, 16 June 2018 (view source) Pware (Talk | contribs) m Newer edit →
Line 1:		Line 1:
−	'''TRAINZ A New Era (TANE) SP2. List of Trainz Session Rules in Alphabetical Order with Properties. All rules are the Copyright of N3V Games'''	+	'''TRAINZ A New Era (TANE) SP2. List of Trainz Session Rules by Categories with Properties. All rules are the Copyright of N3V Games'''
	'''This page is always under construction. As new rules appear they will be added to this list.'''		'''This page is always under construction. As new rules appear they will be added to this list.'''
		+
	'''Only rules supplied with TANE or on the DLS are covered in this document.'''		'''Only rules supplied with TANE or on the DLS are covered in this document.'''
−	Also available '''[[Session Rules By Categories With Properties]]'''	+	Also available '''[[Session Rule List with Parameters|Session Rule List (Alphabetical) with Parameters]]'''
	----		----
		+
	'''Description Key:'''		'''Description Key:'''
	*'''<kuid number>''' is for the rule version at the time of writing. This number will change if the rule is updated.		*'''<kuid number>''' is for the rule version at the time of writing. This number will change if the rule is updated.
Line 15:		Line 17:
	*'''Legacy Rule''' has been replaced by another rule (new rule will be identified).		*'''Legacy Rule''' has been replaced by another rule (new rule will be identified).
−	----
−	'''[[#A, B|A, B]]''' | '''[[#C|C]]''' | '''[[#D|D]]''' | '''[[#E, F, G|E, F, G]]''' | '''[[#H, I, J|H, I, J]]''' | '''[[#K, L, M|K, L, M]]''' | '''[[#N, O|N, O]]''' | '''[[#P, Q|P, Q]]''' | '''[[#R|R]]''' | '''[[#S-Se|S-Se]]''' | '''[[#Sh-Sz|Sh-Sz]]''' | '''[[#T|T]]''' | '''[[#U, V|U, V]]''' | '''[[#W, X, Y, Z|W, X, Y, Z]]'''
−	=='''A, B'''==	+	=='''Achievement Rules'''==
	==='''Achievement Check Rule'''===		==='''Achievement Check Rule'''===
Line 39:		Line 39:
	'''has not been gained''' - the rule will be triggered when this achievement has '''NOT''' been gained		'''has not been gained''' - the rule will be triggered when this achievement has '''NOT''' been gained
−	==='''Advanced Industry Load Configuration Rule'''===	+	==='''Consist Check Rule'''===
−	Locks train controls when loading/unloading at an industry, overrides time settings for begin load and begin unload operations	+	Executes child rules when a matching consist is found. The order of the vehicles in the consists is not important.
−	*'''<kuid:30501:100007>'''	+	*'''<kuid:-25:1068>'''
−	*'''Base Rule'''	+	*'''Built-in Rule'''
		+
		+	*'''Parent Rule'''
	'''Properties:'''		'''Properties:'''
−	'''Target object ''<select>''''' - select industry object from session list	+	'''[Check Box] Enforce strict exclusive testing''' - check to only accept an exact match with no unspecified vehicles in the consist.
−	'''[Check Box] Lock the train's controls during a stopped load/unload operation''' - check to disable driver controls while train is stopped and loading/unloading	+	- leave unchecked to accept any consist that contains the specified vehicles.
−	'''[Check Box] Override 'begin load' and 'begin unload' durations to ''<value>'' seconds''' - if checked enter number of seconds to override	+	Select one of two option buttons:-
		+	'''( ) Rule disabled''' - select to disable the operation of this rule
		+	'''( ) Complete whenever a train matching the description exists''' - When selected, enter the consist description:-
		+	'''Specific vehicle''' - identify the specific vehicle(s) that will trigger the rule
		+	'''''+''''' - click to add a ''specific'' vehicle from the session list
		+	'''''x''''' - click to remove the ''specific'' vehicle from the rule
		+	'''Vehicle types''''' - identify the ''type'' of vehicle(s) that will trigger the rule
		+	'''''+''''' - click to add a ''type'' of vehicle from the session list
		+	'''''x''''' - click to remove the ''type'' of vehicle from the rule
		+	'''Drivers''''' - identify the ''driver(s)'' that will trigger the rule
		+	'''''+''''' - click to add a ''driver'' from the session list
		+	'''''x''''' - click to remove a ''driver'' from the rule
		+
		+	*'''Known Issues:'''
		+	:When used as a top level parent rule it does not terminate after triggering but will continue to check all consists for a match and will trigger every time another match is found.
		+
		+	*'''Trainz Wiki Links:'''
		+	**'''http://online.ts2009.com/mediaWiki/index.php/Consist_Check_Rule'''
		+	**'''[[How to Use Variables in Sessions (Examples)#Example 3: Counting Consist Checks|How to Use Variables in Sessions (Examples): Counting Consist Checks]]'''
		+
		+	==='''Multiple Resource Check Rule'''===
		+
		+	Executes child rules if industries or vehicles reach set commodity levels. This rule replaces the older '''Resource Check Rule'''
		+
		+	*'''<kuid:-25:656>'''
		+
		+	*'''Built-in Rule'''
		+
		+	*'''Parent Rule'''
		+
		+	'''Properties:'''
		+	'''<Product Level>''' - click to select a product test from two choices:-
		+	'''''Reach/Exceed''''' - sets an upper limit for the resources being monitored.
		+	For example: the rule will be triggered if the quantity of coal in a coal loader stockpile or a coal wagon reaches or exceeds a specified level.
		+	The initial level in the object must be below the set upper limit.
		+	'''''Fall below''''' - sets a lower limit for the resources being monitored.
		+	For example: the rule will be triggered if the quantity of coal in a coal loader stockpile or a coal wagon falls below a specified level.
		+	The initial level in the object must be above the set lower limit.
		+	To test when a resource level reaches zero (i.e. is empty) set the lower limit to a very low value but not zero as the level can never fall below zero.
		+	'''''<value>''''' - enter required quantity value
		+	'''''<select>''''' - select a product from session list of products
		+	'''''<Add object>''''' - click to select a source or target object. Multiple objects and their queues can be added to the rule.
		+	ALL the entered products must reach/exceed or fall below the specified value for the rule to be triggered.
		+	For each object:-
		+	'''''<Object>''''' - click to select session active industry or product enabled rail vehicle
		+	'''''<Queue>''''' - select product queue (there may be only one available)
		+	'''''<Remove>''''' - removes the object and its product queue from the rule
	*'''Notes:'''		*'''Notes:'''
−	:Times are Trainz clock time, not real time	+	:This rule only checks for ''changing'' commodity levels during loading and unloading operations. It cannot be used to test, for example, if a vehicle is ''full'' or ''empty''.
−	==='''AI Start Rule'''===	+	*'''Related Rules:'''
		+	**'''[[#Resource Check Rule|Resource Check Rule]]'''http: executes child rules when set resource (commodity) levels are reached
		+	**'''[[#Resource Verify Rule (fixed)|Resource Verify Rule (fixed)]]''' - executes child rules when a set resource (commodity) level is reached
−	Restarts all halted AI controlled trains. Drivers will continue with the commands in their driver command list.	+	*'''Trainz Wiki Links:'''
		+	**'''[[How to Use Navigation Point Rules (Applications)#Application 3: Wait for Loading to be Completed|How to Use Navigation Point Rules (Applications): Wait for Loading to be Completed]]'''
−	*'''<kuid2:400048:100981:1>'''	+	==='''Objective Add Rule'''===
−	*'''DLS Rule''' by '''callavsg'''	+	Sets up a game Objective with ID and display Name
		+
		+	*'''<kuid:401543:2001>'''
		+
		+	*'''Base Rule'''
	'''Properties:'''		'''Properties:'''
−	'''None'''	+	'''Priority ''<Select>''''' - select one of:-
−		+	'''''Above Normal'''''
		+	'''''Below Normal'''''
		+	'''''Normal'''''
		+	'''''Optional'''''
		+	'''''Urgent'''''
		+	'''Completion Target Number ''<value>''''' - to set Completion Target Number
		+	'''Icon ''<select>''''' - to select Icon from list
		+	'''Display Name ''<enter>''''' - to insert Name
		+	'''Unique Objective ID ''<enter>''''' - enter a unique objective ID
		+	'''Custom Message ''<Text Box>''''' - insert typed message in text area
		+
	*'''Related Rules:'''		*'''Related Rules:'''
−	**'''[[#AI Stop Rule|AI Stop Rule]]''' - halts all AI drivers	+	**'''[[#Objective Check Rule|Objective Check Rule]]''' - executes child rules if an objective is completed
−	**'''[[#Disallow AI Rule|Disallow AI Rule]]''' - cancels all AI driver commands	+	**'''[[#Objective Update Rule|Objective Update Rule]]''' - changes the progress of a game objective
−	==='''AI Stop Rule'''===	+	==='''Objective Check Rule'''===
−	Halts all AI controlled trains but does not delete their driver commands. AI trains can be restarted with the '''AI Start Rule''' or by issuing individual '''Continue Schedule''' commands.	+	Executes child rules if an objective created with the '''Objective Add Rule''' is complete.
−	*'''<kuid2:400048:100980:1>'''	+	*'''<kuid:401543:2003>'''
−	*'''DLS Rule''' by '''callavsg'''	+	*'''Base Rule'''
		+
		+	*'''Parent Rule'''
	'''Properties:'''		'''Properties:'''
−	'''None'''	+	'''Unique Objective ID ''<value>''''' - enter the unique ID created with the '''Objective Add Rule'''
−		+	'''Mode ''<select>''''' - select one of three:-
		+	'''''Wait for completion'''''
		+	'''''Wait for failure'''''
		+	'''''Wait for progress'''''
		+
	*'''Related Rules:'''		*'''Related Rules:'''
−	**'''[[#AI Start Rule|AI Start Rule]]''' - restarts all halted AI drivers	+	**'''[[#Objective Add Rule|Objective Add Rule]]''' - sets up a game objective
−	**'''[[#Disallow AI Rule|Disallow AI Rule]]''' - cancels all AI driver commands	+	**'''[[#Objective Update Rule|Objective Update Rule]]''' - changes the progress of a game objective
−	==='''ATP Speed Limiter Rule'''===	+	==='''Objective Update Rule'''===
−	Limits allowable speed over set limit	+	Changes progress of an objective outcome created with the '''Objective Add Rule''' according to Property choices
−	*'''<kuid2:321959:1000:1>'''	+	*'''<kuid:401543:2002>'''
−	*'''Built-in Rule'''	+	*'''Base Rule'''
	'''Properties:'''		'''Properties:'''
−	'''Limits the speed to ''<value>'' mph over the set limit''' - enter speed value in mph	+	'''Unique Objective ID ''<value>''''' - enter the unique ID created with the '''Objective Add Rule'''
		+	'''Mode ''<select>''''' - select one from the following options
		+	'''''Decrement progress'''''
		+	'''''Increment progress'''''
		+	'''''Reset Objective'''''
		+	'''''Set objects as complete'''''
		+	'''''Set objects as failed'''''
		+	'''''Set progress'''''
		+	'''''Set progress only if greater'''''
		+	'''Amount ''<value>''''' - click to enter a value
−	==='''AWS Configuration Rule'''===	+	*'''Related Rules:'''
		+	**'''[[#Objective Add Rule|Objective Add Rule]]''' - sets up a game objective
		+	**'''[[#Objective Check Rule|Objective Check Rule]]''' - executes child rules if an objective is completed
−	This rule configures the Trainz implementation of the Automatic Warning System when approaching signals	+	==='''Ranked Session Begin Rule'''===
−	*'''<kuid2:60850:89002:3>'''	+	Begins a ranked Session
−	*'''Built-in Rule'''	+	*'''<kuid:401543:2031>'''
		+
		+	*'''Base Rule'''
	'''Properties:'''		'''Properties:'''
−	Select one of three option buttons:-	+	'''Countdown Starting Value ''<value>'''''
−	'''( ) Active'''	+	'''''hrs:'''''
−	'''( ) Passive'''	+	'''''min:'''''
−	'''( ) Passive with HUD hidden'''	+	'''''sec:'''''
−	'''[Check Box] Simulate AWS for unfitted cabs?'''	+	'''1 through 5 stars, points for each star ''<value>''''' - enter number of points for each star rating
−	'''[Check Box] Use modern sound set for unfitted cabs?'''	+	'''Session timer mode:''' - select one of three option buttons:-
−	----	+	'''( ) Timer'''
−	'''[[#top|Back to Top]]''' | '''[[#A, B|A, B]]''' | '''[[#C|C]]''' | '''[[#D|D]]''' | '''[[#E, F, G|E, F, G]]''' | '''[[#H, I, J|H, I, J]]''' | '''[[#K, L, M|K, L, M]]''' | '''[[#N, O|N, O]]''' | '''[[#P, Q|P, Q]]''' | '''[[#R|R]]''' | '''[[#S-Se|S-Se]]''' | '''[[#Sh-Sz|Sh-Sz]]''' | '''[[#T|T]]''' | '''[[#U, V|U, V]]''' | '''[[#W, X, Y, Z|W, X, Y, Z]]'''	+	'''( ) Countdown Starting value ''<value>''''' - enter time ''hh:mm:ss''
		+	'''( ) None'''
−	=='''C'''==	+	*'''Notes:'''
		+	:Times are Trainz clock time, not real time
−	==='''Cab Controls HUD Rule'''===	+	*'''Related Rules:'''
		+	**'''[[#Ranked Session Complete Rule|Ranked Session Complete Rule]]''' - completes the active ranked Session
−	Was used to provide the HUD controls for the cabin view. Now obsolete.	+	==='''Ranked Session Complete Rule'''===
−	*'''<kuid:-16:287428>'''	+	Completes the active ranked Session
		+
		+	*'''<kuid:401543:2032>'''
	*'''Base Rule'''		*'''Base Rule'''
−	*'''Obsolete Rule''' (function is now built into TANE)	+	'''Properties:'''
		+	'''Set the active ranked session as:''' - select one of two option buttons:-
		+	'''( ) Complete'''
		+	'''( ) Failed'''
		+	'''[Check Box] Customize the completion message ''<text>''''' - enter a text message
		+
		+	*'''Related Rules:'''
		+	**'''[[#Ranked Session Begin Rule|Ranked Session Begin Rule]]''' - begins a ranked Session
		+
		+	==='''Resource Check Rule'''===
		+
		+	Executes child rules if a selected industry or vehicle reaches a set commodity level. This rule has been superseded by the '''Multiple Resource Check Rule'''
		+
		+	*'''<kuid:-25:1067>'''
		+
		+	*'''Legacy Rule''' (replaced by '''Multiple Resource Check Rule''')
		+
		+	*'''Built-in Rule'''
		+
		+	*'''Parent Rule'''
	'''Properties:'''		'''Properties:'''
−	'''None'''	+	Select one of two option buttons:-
		+	'''( ) Watch industry queue'''
		+	'''Target Object ''<select>''''' - select an industry from the session list
		+	'''Queue ''<select>''''' - select a product queue from the selected industry
		+	'''Product ''<select>''''' - select a product from the selected queue
		+	'''Amount ''<value>''''' - enter a quantity
		+	Select one of two option buttons:-
		+	'''( ) Complete when designated queue equals or exceeds required amount'''
		+	'''( ) Complete when designated queue falls below required amount'''
		+	'''( ) Watch vehicle'''
		+	'''Target Object ''<select>''''' - select a rolling stock asset from the session list
		+	'''Queue ''<select>''''' - select a product queue from the selected rolling stock
		+	'''Product ''<select>''''' - select a product from the selected queue
		+	'''Amount ''<value>''''' - enter a quantity
		+	Select one of two option buttons:-
		+	'''( ) Complete when designated queue equals or exceeds required amount'''
		+	'''( ) Complete when designated queue falls below required amount'''
		+
		+	*'''Notes:'''
		+	:This rule only checks for ''changing'' commodity levels during loading and unloading operations. It cannot be used to test, for example, if a vehicle is ''full'' or ''empty''.
		+
		+	*'''Related Rules:'''
		+	**'''[[#Multiple Resource Check Rule|Multiple Resource Check Rule]]''' - executes child rules when set resource (commodity) levels are reached
		+	**'''[[#Resource Verify Rule (fixed)|Resource Verify Rule (fixed)]]''' - executes child rules when a set resource (commodity) level is reached
		+
		+	*'''Trainz Wiki Links:'''
		+	**'''http://online.ts2009.com/mediaWiki/index.php/Resource_Check_Rule'''
		+
		+	==='''Resource Verify Rule (fixed)'''===
		+
		+	Executes child rules if a selected industry or vehicle reaches a set commodity level. The rule resets when all child rules have completed.
		+
		+	*'''<kuid:160293:10060>'''
		+
		+	*'''DLS Rule''' by '''trev999
		+
		+	*'''Parent Rule'''
		+
		+	'''Properties:'''
		+	Select one of two option buttons:-
		+	'''( ) Watch industry queue'''
		+	'''Target object ''<click to select>''''' - click to select an industry from the session list.
		+	'''Product ''<click to select>''''' - click to select an industry product.
		+	'''Amount ''<value>''''' - enter a quantity for the selected product.
		+	Select one of two option buttons:-
		+	'''( ) Complete when designated queue equals or exceeds designated amount'''
		+	'''( ) Complete when designated queue falls below designated amount'''
		+	'''( ) Watch vehicle queue'''
		+	'''Target object ''<click to select>''''' - click to select a rolling stock vehicle from the session list.
		+	'''Product ''<click to select>''''' - click to select a commodity product.
		+	'''Amount ''<value>''''' - enter a quantity for the selected product.
		+	Select one of two option buttons:-
		+	'''( ) Complete when designated queue equals or exceeds designated amount'''
		+	'''( ) Complete when designated queue falls below designated amount'''
		+
		+	*'''Notes:'''
		+	#This rule will only monitor a single commodity in a single industry or vehicle.
		+	#This rule only checks for ''changing'' commodity levels during loading and unloading operations. It cannot be used to test, for example, if a vehicle is ''full'' or ''empty''.
		+
		+	*'''Related Rules:'''
		+	**'''[[#Multiple Resource Check Rule|Multiple Resource Check Rule]]''' - executes child rules when set resource (commodity) levels are reached
		+	**'''[[#Resource Check Rule|Resource Check Rule]]''' - executes child rules when set resource (commodity) levels are reached
		+
		+	==='''Station Visited Check Rule'''===
		+
		+	Executes child rules if specific trains call at set stations or industries
		+
		+	*'''<kuid2:60850:89005:3>'''
		+
		+	*'''Built-in Rule'''
		+
		+	*'''Parent Rule'''
		+
		+	'''Properties:'''
		+	'''Trigger: ''<select>''''' - click to select one of the following
		+	'''''Never''''' - stopping at the selected industries will never trigger the rule.
		+	'''''Once only''''' - the rule is triggered on the first visit only to any one of the selected industries
		+	'''''Once per industry''''' - the rule is triggered on the first visit to each industry with each individual product
		+	'''''Once per visit''''' - the rule is triggered on the first visit to each industry regardless of the product
		+	'''''Once per vehicle''''' - each vehicle can only trigger the rule once.
		+	'''''<select industry>''''' - select industry or industries from session list
		+	Select one of two option buttons:-
		+	'''( ) click to accept all trains'''
		+	'''( ) click to accept trains matching specific criteria'''
		+	Selecting the second option will produce the following selection controls:-
		+	'''Specific vehicle''' - identify the specific vehicle or set of specific vehicles that will trigger the rule
		+	'''''+''''' - click to add a ''specific'' vehicle from the session list
		+	'''''x''''' - click to remove the ''specific'' vehicle from the rule
		+	'''Vehicle types''''' - identify the ''type'' of vehicle or a set of vehicle ''types'' that will trigger the rule
		+	'''''+''''' - click to add a ''type'' of vehicle from the session list
		+	'''''x''''' - click to remove the ''type'' of vehicle from the rule
		+	'''Drivers''''' - identify the ''drivers'' that will trigger the rule
		+	'''''+''''' - click to add a ''driver'' from the session list
		+	'''''x''''' - click to remove a ''driver'' from the rule
		+
		+	'''[[#top|Back to Top]]'''
		+	----
		+	=='''Camera Rules'''==
	==='''Cinematic Camera Rule'''===		==='''Cinematic Camera Rule'''===
Line 159:		Line 364:
	**'''[[#Set Camera Rule|Set Camera Rule]]''' - sets the target object and properties of the camera		**'''[[#Set Camera Rule|Set Camera Rule]]''' - sets the target object and properties of the camera
	**'''[[#Wait for Camera View Mode Rule|Wait for Camera View Mode Rule]]''' - executes child rules when the camera view is changed		**'''[[#Wait for Camera View Mode Rule|Wait for Camera View Mode Rule]]''' - executes child rules when the camera view is changed
		+
		+	==='''Focus Camera Rule'''===
		+
		+	Sets the initial camera view and starting vehicle for a session.
		+
		+	*'''<kuid2:122381:10014:1>'''
		+
		+	*'''DLS Rule''' by '''mizi'''
		+
		+	'''Properties:'''
		+	'''Focus camera to:''' - select one of two option buttons
		+	'''( ) Map object'''
		+	'''( ) Vehicle'''
		+	'''Named ''<?????>''''' - enter name of object or vehicle from session list
		+	'''Additionally:'''
		+	'''[Check Box] set view mode to''' - check to select one of four option buttons
		+	'''( ) Internal view'''
		+	'''( ) External view'''
		+	'''( ) Tracking view'''
		+	'''( ) Roaming view'''
		+	'''[Check Box] restrict user to manipulate the camera''' - check to set user limits on camera controls
		+	'''[Check Box] allow internal view'''
		+	'''[Check Box] allow external view'''
		+	'''[Check Box] allow tracking view'''
		+	'''[Check Box] allow roaming view'''
		+	'''[Check Box] allow change of view mode'''
		+	'''[Check Box] allow change vehicle in train'''
		+	'''[Check Box] allow change trains'''
		+	'''[Check Box] allow adjust camera viewpoint'''
		+	'''[Check Box] set camera angles''' - check to set the initial camera view point
		+	'''Yaw (90 = look at front of train): ''<value>'' degrees''' - enter yaw angle
		+	'''Pitch (-90 = down, 90 = up): ''<value>'' degrees''' - enter pitch angle
		+	'''Distance from the focused object: ''<value>'' metres''' - enter distance from camera to object
		+
		+	*'''Related Rules:'''
		+	**'''[[#Cinematic Camera Rule|Cinematic Camera Rule]]''' - provides several different cinematic style cameras with animations
		+	**'''[[#Set Camera Rule|Set Camera Rule]]]''' - sets the target object and properties of the camera
		+	**'''[[#Wait for Camera View Mode Rule|Wait for Camera View Mode Rule]]''' - executes child rules when the camera view is changed
		+
		+	==='''Set Camera Rule'''===
		+
		+	Sets the target object and properties of the camera.
		+
		+	*'''<kuid:-25:179>'''
		+
		+	*'''Built-in Rule'''
		+
		+	'''Properties:'''
		+	'''[Check Box] Set the target object of the camera to:''' - if checked, select one of three option buttons:-
		+	'''( ) Vehicle ''<click to select>''''' - select a vehicle from the Session list
		+	'''( ) Junction ''<click to select>''''' - select a junction from the Session list
		+	'''( ) Map Object ''<click to select>''''' - select a named map object from the Session list
		+	'''[Check Box] Change the camera view mode to ''<click to select>''''' - if checked, select one camera view mode from
		+	'''Cab View'''
		+	'''External View'''
		+	'''Tracking View'''
		+	'''Free Roaming'''
		+	'''[Check Box] Set the camera flags to enable/disable user access to''' - if checked, select as many of the following check boxes as needed
		+	'''[Check Box] Internal view mode''' - check to enable, uncheck to disable
		+	'''[Check Box] External view mode''' - check to enable, uncheck to disable
		+	'''[Check Box] Tracking view mode''' - check to enable, uncheck to disable
		+	'''[Check Box] Roaming view mode''' - check to enable, uncheck to disable
		+	'''[Check Box] View switching''' - check to enable, uncheck to disable
		+	'''[Check Box] Vehicle view switching''' - check to enable, uncheck to disable
		+	'''[Check Box] Train view switching''' - check to enable, uncheck to disable
		+	'''[Check Box] Camera adjustments (pan, zoom, etc)''' - check to enable, uncheck to disable
		+
		+	*'''Related Rules:'''
		+	**'''[[#Cinematic Camera Rule|Cinematic Camera Rule]]''' - provides several different cinematic style cameras with animations
		+	**'''[[#Focus Camera Rule|Focus Camera Rule]]''' - sets the initial camera view and starting vehicle for a session
		+	**'''[[#Wait for Camera View Mode Rule|Wait for Camera View Mode Rule]]''' - executes child rules when the camera view is changed
		+
		+	==='''Wait for Camera View Mode Rule'''===
		+
		+	Executes child rules when the camera view is changed to a selected view
		+
		+	*'''<kuid:-25:192>'''
		+
		+	*'''Built-in Rule'''
		+
		+	*'''Parent Rule'''
		+
		+	'''Properties:'''
		+	'''[Check Box] Trigger rule once''' - check to set
		+	'''Wait for the camera to change to the ''<click to select>''''' - select one camera view mode from:-
		+	'''Cab View'''
		+	'''External View'''
		+	'''Tracking View'''
		+	'''Free Roaming'''
		+	'''[Check Box] Wait for the camera to target vehicle ''<click to select>''''' - if checked, select a vehicle from the Session list
		+
		+	*'''Related Rules:'''
		+	**'''[[#Cinematic Camera Rule|Cinematic Camera Rule]]''' - provides several different cinematic style cameras with animations
		+	**'''[[#Focus Camera Rule|Focus Camera Rule]]''' - sets the initial camera view and starting vehicle for a session
		+	**'''[[#Set Camera Rule|Set Camera Rule]]''' - sets the target object and properties of the camera
		+
		+	'''[[#top|Back to Top]]'''
		+	----
		+	=='''Danger, Derailment and Safety Rules'''==
		+
		+	==='''ATP Speed Limiter Rule'''===
		+
		+	Limits allowable speed over set limit
		+
		+	*'''<kuid2:321959:1000:1>'''
		+
		+	*'''Built-in Rule'''
		+
		+	'''Properties:'''
		+	'''Limits the speed to ''<value>'' mph over the set limit''' - enter speed value in mph
		+
		+	'''Related Rules:'''
		+	'''[[#AWS Configuration Rule|AWS Configuration Rule]]''' - configures the Trainz implementation of the Automatic Warning System when approaching signals
		+
		+	==='''AWS Configuration Rule'''===
		+
		+	This rule configures the Trainz implementation of the Automatic Warning System when approaching signals
		+
		+	*'''<kuid2:60850:89002:3>'''
		+
		+	*'''Built-in Rule'''
		+
		+	'''Properties:'''
		+	Select one of three option buttons:-
		+	'''( ) Active'''
		+	'''( ) Passive'''
		+	'''( ) Passive with HUD hidden'''
		+	'''[Check Box] Simulate AWS for unfitted cabs?'''
		+	'''[Check Box] Use modern sound set for unfitted cabs?'''
	==='''Clean Up Derailed Trains Rule'''===		==='''Clean Up Derailed Trains Rule'''===
Line 184:		Line 518:
	**'''http://online.ts2009.com/mediaWiki/index.php/Clean_up_Derailed_Trains_Rule'''		**'''http://online.ts2009.com/mediaWiki/index.php/Clean_up_Derailed_Trains_Rule'''
−	==='''Clock Rule'''===	+	==='''Coupler Breakage Check Rule'''===
−	Rule needed for animated clocks.	+	Executes child rules if there is a coupler breakage
−	*'''<kuid2:62310:30041:2>'''	+	*'''<kuid2:447264:1017:1>'''
	*'''Built-in Rule'''		*'''Built-in Rule'''
		+
		+	*'''Parent Rule'''
	'''Properties:'''		'''Properties:'''
	'''None'''		'''None'''
−	*'''Notes:'''	+	*'''Related Rules:'''
−	:Apply this rule to your session to make use of the animated clocks. See the forum for code to include in your clock object to work with this rule.	+	**'''[[#Coupler Breakage HUD Rule|Coupler Breakage HUD Rule]]''' - adds a coupler stress and breakage warning to the HUD
		+	**'''[[#Set Coupler Masks Rule|Set Coupler Masks Rule]]''' - sets the coupling/decoupling masks on selected vehicles
−	==='''Close Message Popup Rule'''===	+	==='''Coupler Breakage HUD Rule'''===
−	Closes open message popups	+	HUD displays warning about coupler stress and breakage
−	*'''<kuid:447264:1526>'''	+	*'''<kuid:-25:423>'''
	*'''Built-in Rule'''		*'''Built-in Rule'''
	'''Properties:'''		'''Properties:'''
−	'''None'''	+	Select one of two option buttons:-
		+	'''( ) Show the Coupler Breakage Display'''
		+	'''( ) Hide the Coupler Breakage Display'''
−	*'''Known Issues:'''	+	*'''Related Rules:'''
−	:This rule only appears to work if it is a child of the rule that triggered the Message Popup Rule	+	**'''[[#Coupler Breakage Check Rule|Coupler Breakage Check Rule]]''' - executes child rules if a coupler breaks
		+	**'''[[#Set Coupler Masks Rule|Set Coupler Masks Rule]]''' - sets the coupling/decoupling masks on selected vehicles
−	*'''Related Rule:'''	+	==='''Junction Derailment Prevention Rule'''===
−	**'''[[#Message Popup Rule|Message Popup Rule]]''' - displays a pop-up browser window and waits for it to be closed.	+
−	*'''Trainz Wiki Links:'''	+	Sets opposing (trailing) junctions ahead of a train to prevent derailments.  Works with both AI and manually driven trains.
−	**'''[[Message Popup Rule Applications]]'''	+
−	**'''[[Message Popup Example|Message Popup Examples]]'''	+
−	==='''Consist Check Rule'''===	+	*'''<kuid2:121843:100282:1>'''
−	Executes child rules when a matching consist is found. The order of the vehicles in the consists is not important.	+	*'''DLS Rule''' by '''pitkin'''
−		+
−	*'''<kuid:-25:1068>'''	+
−		+
−	*'''Built-in Rule'''	+
−		+
−	*'''Parent Rule'''	+
	'''Properties:'''		'''Properties:'''
−	'''[Check Box] Enforce strict exclusive testing''' - check to only accept an exact match with no unspecified vehicles in the consist.	+	'''None'''
−	- leave unchecked to accept any consist that contains the specified vehicles.	+
−	Select one of two option buttons:-	+
−	'''( ) Rule disabled''' - select to disable the operation of this rule	+
−	'''( ) Complete whenever a train matching the description exists''' - When selected, enter the consist description:-	+
−	'''Specific vehicle''' - identify the specific vehicle(s) that will trigger the rule	+
−	'''''+''''' - click to add a ''specific'' vehicle from the session list	+
−	'''''x''''' - click to remove the ''specific'' vehicle from the rule	+
−	'''Vehicle types''''' - identify the ''type'' of vehicle(s) that will trigger the rule	+
−	'''''+''''' - click to add a ''type'' of vehicle from the session list	+
−	'''''x''''' - click to remove the ''type'' of vehicle from the rule	+
−	'''Drivers''''' - identify the ''driver(s)'' that will trigger the rule	+
−	'''''+''''' - click to add a ''driver'' from the session list	+
−	'''''x''''' - click to remove a ''driver'' from the rule	+
−	*'''Known Issues:'''	+	*'''Notes:'''
−	:When used as a top level parent rule it does not terminate after triggering but will continue to check all consists for a match and will trigger every time another match is found.	+	:This rule will not overrule a junction already locked by another AI train or locked against AI control using the '''Set Junctions Rule'''.
−	*'''Trainz Wiki Links:'''	+	*'''Related Rules:'''
−	**'''http://online.ts2009.com/mediaWiki/index.php/Consist_Check_Rule'''	+	**'''[[#Lock All Junctions Rule|Lock All Junctions Rule]]''' - locks all junctions against user control
−	**'''[[How to Use Variables in Sessions (Examples)#Example 3: Counting Consist Checks|How to Use Variables in Sessions (Examples): Counting Consist Checks]]'''	+	**'''[[#Set Cleared Junctions Rule|Set Cleared Junctions Rule]]''' - sets selected junctions to specific states (direction, locked/unlocked, allow/prevent AI control) while they are unoccupied.
		+	**'''[[#Set Junctions Rule|Set Junctions Rule]]''' - sets selected junctions to specific states (direction, locked/unlocked, allow/prevent AI control).
−	==='''ConsistDataHandler Rule'''===	+	==='''Replace Missing Vehicles Rule'''===
−	Was used by the '''QuickDrive Rule''' to place consists onto a route. Now obsolete.	+	Produces new trains to replace missing vehicles that have been removed from the session by the '''Clean Up Derailed Trains Rule'''
−	*'''<kuid:401543:1180>'''	+	*'''<kuid:447264:1214>'''
−	*'''Obsolete Rule''' (function is now built into '''TANE''')	+	*'''Built-in Rule'''
−		+
−	*'''Base Rule'''	+
	'''Properties:'''		'''Properties:'''
−	'''None'''	+	'''[Check Box] Respawn trains if they are abandoned for 10 minutes'''
		+	If checked:-
		+	Select one of two option buttons:-
		+	'''( ) Respawn trains at their original locations'''
		+	'''( ) Respawn trains from portals'''
		+	'''''<+ Add a new portal>''''' - click to enter the name of a portal, there can be more than one portal.
		+	Entered portal names that appear in red have not been found in the session
−	==='''Control Check Rule'''===	+	*'''Related Rules:'''
		+	**'''[[#Clean Up Derailed Trains Rule|Clean Up Derailed Trains Rule]]''' - cleans up derailed train cars after a set time delay
		+	**'''[[#Wait for Derailment Rule|Wait for Derailment Rule]]''' - executes child rules when a derailment occurs
−	Executes child rules if the train control method has been altered or a specific method has been selected.	+	==='''Safety System Engaged Check Rule'''===
−	*'''<kuid:401543:1191>'''	+	Executes child rules if safety systems are applied.
		+
		+	*'''<kuid:447264:1216>'''
	*'''Built-in Rule'''		*'''Built-in Rule'''
Line 276:		Line 603:
	'''Properties:'''		'''Properties:'''
−	'''Execute child rules when:''' - select one of two option buttons:-	+	'''[Check Box] Trigger only once'''
−	'''( ) DCC mode is Selected'''	+
−	'''( ) Cab mode is Selected'''	+
−	'''Execute child rules:''' - select one of two option buttons:-	+
−	'''( ) Every time control method is set'''	+
−	'''( ) Once only'''	+
	*'''Related Rules:'''		*'''Related Rules:'''
−	**'''[[#Control Type Rule|Control Type Rule]]''' - sets the control method	+	**'''[[#Safety System Isolated Check Rule|Safety System Isolated Check Rule]]''' - executes child rules if safety systems have been isolated
−	==='''Control Type Rule'''===	+	==='''Safety System Isolated Check Rule'''===
−	Sets the control method	+	Executes child rules if safety systems are isolated (disengaged).
−	*'''<kuid:-16:2030>'''	+	*'''<kuid:447264:1217>'''
−		+
−	*'''Base Rule'''	+
−		+
−	'''Properties:'''	+
−	'''Current control method is: ''<select>''''' - click to select one of	+
−	'''''Easy Mode''''' - DCC (standard keyboard and mouse) control	+
−	'''''Ask User''''' - let the user decide	+
−	'''''Realistic Mode''''' - Cab controls (on screen levers, throttles, buttons, etc)	+
−		+
−	*'''Related Rules:'''	+
−	**'''[[#Control Check Rule|Control Check Rule]]''' - executes child rules if the train control method changes	+
−		+
−	==='''Coupler Breakage Check Rule'''===	+
−		+
−	Executes child rules if there is a coupler breakage	+
−		+
−	*'''<kuid2:447264:1017:1>'''	+
	*'''Built-in Rule'''		*'''Built-in Rule'''
Line 314:		Line 619:
	'''Properties:'''		'''Properties:'''
−	'''None'''	+	'''[Check Box] Trigger only once'''
	*'''Related Rules:'''		*'''Related Rules:'''
−	**'''[[#Coupler Breakage HUD Rule|Coupler Breakage HUD Rule]]''' - adds a coupler stress and breakage warning to the HUD	+	**'''[[#Safety System Engaged Check Rule|Safety System Engaged Check Rule]]''' - executes child rules if safety systems have been engaged
−	**'''[[#Set Coupler Masks Rule|Set Coupler Masks Rule]]''' - sets the coupling/decoupling masks on selected vehicles	+
−	==='''Coupler Breakage HUD Rule'''===	+	==='''Set Coupler Masks Rule'''===
−	HUD displays warning about coupler stress and breakage	+	Set the coupling/decoupling  masks on the selected vehicles
−	*'''<kuid:-25:423>'''	+	*'''<kuid:-25:980>'''
	*'''Built-in Rule'''		*'''Built-in Rule'''
	'''Properties:'''		'''Properties:'''
−	Select one of two option buttons:-	+	'''''<Add vehicle>''''' - click to select a vehicle from the session list
−	'''( ) Show the Coupler Breakage Display'''	+	'''''<Add All>''''' - click to add all vehicles in the session list
−	'''( ) Hide the Coupler Breakage Display'''	+	'''''<Delete All>''''' - click to remove all added vehicles from this rule
		+	For each selected vehicle:-
		+	'''Coupling Mask'''
		+	'''Front''' and '''Back''' - choose for each
		+	'''''Locked'''''
		+	'''''Unlocked'''''
		+	'''Decoupling Mask'''
		+	'''Front''' and '''Back''' - choose for each
		+	'''''Locked'''''
		+	'''''Unlocked'''''
		+	'''''<Remove>''''' - click to remove this vehicle from the rule
	*'''Related Rules:'''		*'''Related Rules:'''
−	**'''[[#Coupler Breakage Check Rule|Coupler Breakage Check Rule]]''' - executes child rules if a coupler breaks	+	**'''[[#Coupler Breakage Check Rule|Coupler Breakage Check Rule]]''' - executes child rules when a coupler breaks
−	**'''[[#Set Coupler Masks Rule|Set Coupler Masks Rule]]''' - sets the coupling/decoupling masks on selected vehicles	+	**'''[[#Coupler Breakage HUD Rule|Coupler Breakage HUD Rule]]''' - adds a coupler stress and breakage warning to the HUD
−	==='''Custom Script Rule'''===	+	==='''Signal Passed At Danger Check Rule'''===
−	No description	+	Executes child rules if a signal or stop mark is ''Passed at Danger (STOP)''.
−	*'''<kuid:447264:1526>'''	+	*'''<kuid2:60850:89007:2>'''
	*'''Built-in Rule'''		*'''Built-in Rule'''
		+
		+	*'''Parent Rule'''
	'''Properties:'''		'''Properties:'''
−	'''None'''	+	'''[Check Box] Trigger only once'''
−	----	+
−	'''[[#top|Back to Top]]''' | '''[[#A, B|A, B]]''' | '''[[#C|C]]''' | '''[[#D|D]]''' | '''[[#E, F, G|E, F, G]]''' | '''[[#H, I, J|H, I, J]]''' | '''[[#K, L, M|K, L, M]]''' | '''[[#N, O|N, O]]''' | '''[[#P, Q|P, Q]]''' | '''[[#R|R]]''' | '''[[#S-Se|S-Se]]''' | '''[[#Sh-Sz|Sh-Sz]]''' | '''[[#T|T]]''' | '''[[#U, V|U, V]]''' | '''[[#W, X, Y, Z|W, X, Y, Z]]'''	+
−	=='''D'''==	+	*'''Trainz Wiki Links:'''
		+	**'''[[How to Use Variables in Sessions (Examples)#Example 2: Event Counter and Message Selection|How to Use Variables in Sessions (Examples): Event Counter and Message Selection]]
−	==='''DestSign Table Rule'''===	+	==='''Speeding Check Rule'''===
−	Creates a list of destination names for a destination sign	+	Executes child rules if player controlled trains are over the local speed limit or over a set (custom) speed
−	*'''<kuid2:206816:99004:2>'''	+	*'''<kuid2:60850:89004:3>'''
	*'''Built-in Rule'''		*'''Built-in Rule'''
		+
		+	*'''Parent Rule'''
	'''Properties:'''		'''Properties:'''
−	'''''<add destination>''''' - enter a destination name to be added to the destination sign roll	+	Select one of two options to set a speed limit to be observed
−	'''''<import destinations from texture-group>''''' - select a list of destination names from session	+	'''( ) Watch for trains travelling above the posted speed limit'''
−	'''[Check Box] Enable industries/stations as destination''' - check to set	+	'''''<speed value>''''' - click to enter a new overspeed tolerance value
−	'''[Check Box] Enable Track Marks as destinations''' - check to set	+	'''''<speed units>''''' - click to select one from the list:-
−	'''[Check Box] Enable table of destinations''' - check to set	+	'''''Km/h''''' - Kilometres per hour
		+	'''''MPH''''' - Miles per hour
		+	'''''mps''''' - metres per second
		+	'''( ) Watch for trains travelling above a custom speed'''
		+	'''''<speed value>''''' - click to enter a new custom speed value
		+	'''''<speed units>''''' - click to select one from the list:-
		+	'''''Km/h''''' - Kilometres per hour
		+	'''''MPH''''' - Miles per hour
		+	'''''mps''''' - metres per second
		+	'''Warning: This option is very performance intensive and should only be used in sessions with few trains'''
−	==='''Directional Trigger Check Rule'''===	+	==='''Vehicle Physics Rule'''===
−	Executes child rules when a set train enters a set trigger in a set direction. Adds direction to the '''Trigger Check Rule'''.	+	Overrides the default vehicle physics properties for all vehicles or for those matching set criteria
−	*'''<kuid2:532391:100003:1>'''	+	*'''<kuid:-25:1052>'''
−	*'''DLS Rule''' by '''bobhahn'''	+	*'''Built-in Rule'''
−	'''Properties:'''	+	'''Properties:'''
−	'''[Check Box] Trigger only once '''	+
−	'''[Check Box] Wait for child rules to complete even if no trains are present in rule trigger'''	+
−	'''[Check Box] Only activate when the entering vehicle of the train is heading ''<select direction>'' into the trigger''' - select one of two directions:-	+
−	'''''forward'''''	+
−	'''''backward'''''	+
−	'''Triggers List'''	+
−	'''''<add trigger>''''' - select a trigger from the session list	+
−	'''''<delete trigger>''''' - delete a selected trigger from the rule	+
	Select one of two option buttons:-		Select one of two option buttons:-
	'''( ) click to accept all trains'''		'''( ) click to accept all trains'''
	'''( ) click to accept trains matching specific criteria'''		'''( ) click to accept trains matching specific criteria'''
	Selecting the second option will produce the following selection controls:-		Selecting the second option will produce the following selection controls:-
−	'''Specific vehicle''' - identify the specific vehicle(s) that will trigger the rule	+	'''Specific vehicle''' - identify the specific vehicle or set of specific vehicles that will trigger the rule
	'''''+''''' - click to add a ''specific'' vehicle from the session list		'''''+''''' - click to add a ''specific'' vehicle from the session list
	'''''x''''' - click to remove the ''specific'' vehicle from the rule		'''''x''''' - click to remove the ''specific'' vehicle from the rule
−	'''Vehicle types''''' - identify the ''type'' of vehicle(s) that will trigger the rule	+	'''Vehicle types''''' - identify the ''type'' of vehicle or a set of vehicle ''types'' that will trigger the rule
	'''''+''''' - click to add a ''type'' of vehicle from the session list		'''''+''''' - click to add a ''type'' of vehicle from the session list
	'''''x''''' - click to remove the ''type'' of vehicle from the rule		'''''x''''' - click to remove the ''type'' of vehicle from the rule
−	'''Drivers''''' - identify the ''driver(s)'' that will trigger the rule	+	'''Drivers''''' - identify the ''drivers'' that will trigger the rule
	'''''+''''' - click to add a ''driver'' from the session list		'''''+''''' - click to add a ''driver'' from the session list
	'''''x''''' - click to remove a ''driver'' from the rule		'''''x''''' - click to remove a ''driver'' from the rule
		+	'''Coupler Parameters:'''
		+	'''Couplers break at ''<value>'' kN expansion force''' - enter force value
		+	'''Couplers break at when coupling above ''<value>'' kph''' - enter speed value
		+	'''[Check Box] Show coupler breakage in HUD''' - check to display breakage in on-screen HUD
		+	'''Wheelslip Parameters:'''
		+	'''Maximum tractive effort adjusted by ''<value>'' %''' - enter adjustment as a %
		+	'''Traction is reduced to ''<value>'' % while wheelslipping''' - enter value as a %
		+	'''Traction boost is ''<value>'' % while sanding''' - enter value as a %
		+	'''Sway Parameters:'''
		+	'''Cab sway level is set to ''<value>'' %''' - enter value as a %
−	*'''Notes:'''	+	==='''Wait for Derailment Rule'''===
−	#This rule works best when used with the '''Directional Trigger''' track object available on the DLS.	+
−	#The Directional Trigger, when installed, will appear as a ''Signal'' not as a ''Trackmark''.	+
−	#Normal (non directional) triggers can be used with this rule but the rule will have no direction sensitivity apart from the ''forward'' and ''backward'' in the rule properties.	+
−	*'''Related Rules:'''	+	Executes child rules when a derailment occurs
−	**'''[[#Trackside Check Rule|Trackside Check Rule]]''' - executes child rules when activated by a train. Provides different options to the '''Trigger Check Rule'''	+
−	**'''[[#Trigger Check Rule|Trigger Check Rule]]''' - executes child rules when a set train enters a set trigger (non-directional)	+
−	*'''Trainz Wiki Links:'''	+	*'''<kuid:-25:1053>'''
−	**'''[[How to Control Signals in Sessions#Application 2: Halt Before Clear|How to Control Junctions in Sessions: Halt Before Clear]]'''	+
−	**'''[[Message Popup Rule Applications]]'''	+
−	**'''[[How to Use Navigation Point Rules (Applications)#Application 3: Wait for Loading to be Completed|How to Use Navigation Point Rules (Applications): Wait for Loading to be Completed]]'''	+
−	**'''[[How to Use Track Triggers]]'''	+
−	**'''[[How to Use Variables in Sessions (Examples)]]'''	+
−	==='''Disable/Enable Industry Rule'''===	+	*'''Built-in Rule'''
−	Enables/Disables vehicle load/unload for industry	+	*'''Parent Rule'''
−	*'''<kuid2:401543:1171:1>'''	+	'''Properties:'''
		+	'''[Check Box] Trigger derailment watch once''' - check to execute the rule once only
−	*'''Built-in Rule'''	+	*'''Related Rules:'''
		+	**'''[[#Clean Up Derailed Trains Rule|Clean Up Derailed Trains Rule]]''' - cleans up derailed train cars after a set time delay
		+	**'''[[#Replace Missing Vehicles Rule|Replace Missing Vehicles Rule]]''' - creates a replacement train after a derailment
−	'''Properties:'''	+	'''[[#top|Back to Top]]'''
−	'''Load/unload ''<Disable/Enable>''''' - click to set to '''Disable''' or '''Enable'''	+	----
−	'''Which Industry? ''<select>''''' - click to set Industry from Session List	+	=='''Driver Rules'''==
−	'''Which Vehicles:''' - select one of two option buttons:-	+
−	'''( ) Apply to every vehicle in the session'''	+
−	'''( ) Apply only to a specific vehicles from Session List'''	+
−	==='''Disallow AI Rule'''===	+	==='''AI Start Rule'''===
−	Cancels (deletes) all current and waiting AI commands for all drivers	+	Restarts all halted AI controlled trains. Drivers will continue with the commands in their driver command list.
−	*'''<kuid:400048:100603>'''	+	*'''<kuid2:400048:100981:1>'''
	*'''DLS Rule''' by '''callavsg'''		*'''DLS Rule''' by '''callavsg'''
	'''Properties:'''		'''Properties:'''
−	'''None'''	+	'''None'''
−		+
	*'''Related Rules:'''		*'''Related Rules:'''
−	**'''[[#AI Start Rule|AI Start Rule]]''' - restarts all halted AI drivers	+	**'''[[#AI Stop Rule|AI Stop Rule]]''' - halts all AI drivers
−	**'''[[#AI Stop Rule|AI Stop Rule]]''' - halts all AI drivers	+	**'''[[#Disallow AI Rule|Disallow AI Rule]]''' - cancels all AI driver commands
−	==='''Display Custom HUD Rule'''===	+	==='''AI Stop Rule'''===
−	Show or hide the Custom Heads Up Display.	+	Halts all AI controlled trains but does not delete their driver commands. AI trains can be restarted with the '''AI Start Rule''' or by issuing individual '''Continue Schedule''' commands.
−	*'''<kuid:-3:10206>'''	+	*'''<kuid2:400048:100980:1>'''
−	*'''Base Rule'''	+	*'''DLS Rule''' by '''callavsg'''
	'''Properties:'''		'''Properties:'''
−	'''Show or Hide the Custom Heads up Display''' - select one of two option buttons:-	+	'''None'''
−	'''( ) Show the Custom Heads up Display'''	+
−	'''( ) Hide the Custom Heads up Display'''	+
−		+
	*'''Related Rules:'''		*'''Related Rules:'''
−	**'''[[#Flash HUD Icon Rule|Flash HUD Icon Rule]]''' - flashes a HUD panel icon for a set duration.	+	**'''[[#AI Start Rule|AI Start Rule]]''' - restarts all halted AI drivers
−	**'''[[#mc Display Custom HUD V2 Rule (SP2 and later)|mc Display Custom HUD V2 Rule (SP2 and later)]]''' - shows or hides a graphical HUD.	+	**'''[[#Disallow AI Rule|Disallow AI Rule]]''' - cancels all AI driver commands
−	**'''[[#Quick CustomHud Manager Rule (SP2 and later)|Quick CustomHud Manager Rule (SP2 and later)]]''' - creates custom HUDs that can be assigned to different drivers	+
−	**'''[[#Show/Hide HUD Panel Rule|Show/Hide HUD Panel Rule]]''' - shows or hides a HUD panel.	+
−	**'''[[#Variable Show Rule|Variable Show Rule]]''' - adds or removes a specified variable and a descriptive label to the custom HUD.	+
−	**'''[[#Wait for Click on HUD Icon Rule|Wait for Click on HUD Icon Rule]]''' - executes child rules when a HUD icon is clicked	+
−	*'''Trainz Wiki Links:'''	+	==='''Control Check Rule'''===
−	**'''http://online.ts2009.com/mediaWiki/index.php/Display_Custom_HUD_Rule'''	+
−	==='''Display HTML Pages Rule'''===	+	Executes child rules if the train control method has been altered or a specific method has been selected.
−	Creates a browser to display the listed HTML files in order as a navigable sequence of pages. This rule has been superseded by the '''Message Popup Rule'''	+	*'''<kuid:401543:1191>'''
−	*'''<kuid:-25:442>'''	+	*'''Built-in Rule'''
−	*'''Legacy Rule''' (replaced by '''Message Popup Rule''')	+	*'''Parent Rule'''
−		+
−	*'''Base Rule'''	+
	'''Properties:'''		'''Properties:'''
−	'''''<Add Page>''''' - adds the HTML page ''index.html'' from the selected HTML asset	+	'''Execute child rules when:''' - select one of two option buttons:-
−	'''''<index.html>''''' - click to change the page name. The extension ''.html'' is optional	+	'''( ) DCC mode is Selected'''
−	'''''<Add All>''''' - adds all HTML pages from the session list '''(this appears to be disabled in TANE)'''	+	'''( ) Cab mode is Selected'''
−	'''''<Delete All>''''' - delete all HTML pages from this property list	+	'''Execute child rules:''' - select one of two option buttons:-
−	'''[Check Box] Prevent user from exiting browser until all pages viewed'''	+	'''( ) Every time control method is set'''
−	'''[Check Box] Disable closing of browser window by user'''	+	'''( ) Once only'''
−	'''[Check Box] Disable browser window scrolling'''	+
−	'''[Check Box] Make browser window invisible'''	+
−	'''[Check Box] Set position-Under Construction!!!''' - not implemented	+
−	'''[Check Box] Set size-Under Construction!!!''' - not implemented	+
−	'''Use the page ''<index.html>'' from asset ''<select>'' as the hidden button''' - the link buttons at the bottom of the page will be taken from the selected page in the selected HTML asset	+
	*'''Related Rules:'''		*'''Related Rules:'''
−	**'''[[#Close Message Popup Rule|Close Message Popup Rule]]''' - closes a displayed pop-up browser window.	+	**'''[[#Control Type Rule|Control Type Rule]]''' - sets the control method
−	**'''[[#Message Popup Rule|Message Popup Rule]]''' - displays a pop-up browser window and waits for it to be closed.	+
−	**'''[[#Set HTML Page Rule|Set HTML Page Rule]]''' - sets parameters for the '''Display HTML Pages Rule'''	+
−	**'''[[#Timed Limited Display HTML Rule (SP2 and later)|Timed Limited Display HTML Rule (SP2 and later)]]''' - displays a HTML page in a browser window for a set time.	+
−	==='''Display Video Rule'''===	+	==='''Control Type Rule'''===
−	Displays a page containing a video clip from a HTML asset in a browser window.	+	Sets the control method
−	*'''<kuid:-25:138>'''	+	*'''<kuid:-16:2030>'''
−	*'''Built-in Rule'''	+	*'''Base Rule'''
	'''Properties:'''		'''Properties:'''
−	'''Display page ''<index.html>'' of html asset ''<click to select>'' in a new browser window	+	'''Current control method is: ''<select>''''' - click to select one of
−	'''''index.html''''' - enter the filename of a HTML page in the selected HTML asset. The ''.html'' is optional in the filename.	+	'''''Easy Mode''''' - DCC (standard keyboard and mouse) control
−	'''''<click to select>''''' - select the HTML asset from those installed.	+	'''''Ask User''''' - let the user decide
−		+	'''''Realistic Mode''''' - Cab controls (on screen levers, throttles, buttons, etc)
−	*'''Notes:'''	+
−	:Video must be in a valid web format.	+
	*'''Related Rules:'''		*'''Related Rules:'''
−	**'''[[#Play Sound Rule|Play Sound Rule]]''' - plays a wav sound file	+	**'''[[#Control Check Rule|Control Check Rule]]''' - executes child rules if the train control method changes
−	==='''DisplayIndustryStatus Rule (color modified)'''===	+	==='''Disallow AI Rule'''===
−	Displays a summary of industry product levels when the "k" key is pressed.	+	Cancels (deletes) all current and waiting AI commands for all drivers
−	*'''<kuid:622415:100001>'''	+	*'''<kuid:400048:100603>'''
−	*'''DLS Rule''' by '''lockheed02''' and '''marzipan'''	+	*'''DLS Rule''' by '''callavsg'''
	'''Properties:'''		'''Properties:'''
−	'''None'''	+	'''None'''
−		+
−	*'''Notes:'''	+
−	:Pressing the '''k''' key in Driver mode will bring up a small window with a single link '''''Display Industry Status''''' (there may also be other links). Clicking this link will show the product levels of all industries.	+
	*'''Related Rules:'''		*'''Related Rules:'''
−	**'''[[#ExTrainz Manager Rule - TANE SP2|ExTrainz Manager Rule - TANE SP2]]''' - displays information on consists, industries and products in Driver and Surveyor.	+	**'''[[#AI Start Rule|AI Start Rule]]''' - restarts all halted AI drivers
		+	**'''[[#AI Stop Rule|AI Stop Rule]]''' - halts all AI drivers
	==='''Driver Command Check Rule'''===		==='''Driver Command Check Rule'''===
Line 658:		Line 955:
	*'''Trainz Wiki Links:'''		*'''Trainz Wiki Links:'''
	**'''http://online.ts2009.com/mediaWiki/index.php/Driver_Setup_Rule'''		**'''http://online.ts2009.com/mediaWiki/index.php/Driver_Setup_Rule'''
−	----
−	'''[[#top|Back to Top]]''' | '''[[#A, B|A, B]]''' | '''[[#C|C]]''' | '''[[#D|D]]''' | '''[[#E, F, G|E, F, G]]''' | '''[[#H, I, J|H, I, J]]''' | '''[[#K, L, M|K, L, M]]''' | '''[[#N, O|N, O]]''' | '''[[#P, Q|P, Q]]''' | '''[[#R|R]]''' | '''[[#S-Se|S-Se]]''' | '''[[#Sh-Sz|Sh-Sz]]''' | '''[[#T|T]]''' | '''[[#U, V|U, V]]''' | '''[[#W, X, Y, Z|W, X, Y, Z]]'''
−
−	=='''E, F, G'''==
−
−	==='''EIRS Weather Rule NE USA Rule'''===
−
−	Customize random weather rule relative to the North East Region of the United States.
−
−	*'''<kuid2:487222:1037:3>'''
−
−	*'''Built-in Rule'''
−
−	'''Properties:'''
−	'''Season ''<select>''''' - select one of:-
−	'''''Summer'''''
−	'''''Fall'''''
−	'''''Winter'''''
−	'''''Spring'''''
−	'''Random Changeability (minutes) ''<value>''''' - select one of:-
−	'''''2/5/10/15/20/30/45/60''''' - minutes''
−	'''Environment Settings ''<select>''''' - select one of:-
−	'''''Disable/Enable'''''
−
−	*'''Notes:'''
−	:Minutes are Trainz clock times, not real times
−
−	*'''Related Rules:'''
−	**'''[[#Random Weather Rule v2|Random Weather Rule v2]]''' - randomly changes the weather according to entered parameters
−	**'''[[#Startup Options Rule|Startup Options Rule]]''' - sets the weather conditions at the start of a Session
−	**'''[[#Weather Rule|Weather Rule]]''' - changes the weather conditions during Session play
	==='''Enable/Disable Driver Commands Rule'''===		==='''Enable/Disable Driver Commands Rule'''===
Line 729:		Line 995:
	**'''http://online.ts2009.com/mediaWiki/index.php/Enable/Disable_Driver_Commands_Rule'''		**'''http://online.ts2009.com/mediaWiki/index.php/Enable/Disable_Driver_Commands_Rule'''
−	==='''End Session Rule'''===	+	==='''JTG Correct Vehicle Lights'''===
−	End the Session with a fade out.	+	Corrects the brightness of vehicle headlights. Now obsolete.
−	*'''<kuid:-25:482>'''	+	*'''<kuid2:478657:999103:1>'''
−	*'''Built-in Rule'''	+	*'''DLS Rule''' by '''jtg-trainz'''
		+
		+	*''' Obsolete Rule''' (function is now built into TANE Driver Additional Tools Menu)
	'''Properties:'''		'''Properties:'''
−	'''Fade out over ''<value>'' seconds''' - enter number of seconds for fade out.	+	'''None'''
−	*'''Notes:'''	+	==='''Quick Portal Manager Standard Edition Rule (SP2 and later)'''===
−	:Seconds are Trainz clock time, not real time.	+
		+	Manages portals and adds flexible timetables.
		+
		+	*'''<kuid2:61392:5011:45>'''
		+
		+	*'''DLS Rule''' by '''pguy'''
		+
		+	'''Properties:'''
		+	'''Target date is ''day-of-week'' ''&<nowiki />lt;dd/mm/yyyy&<nowiki />gt;''''' - ''day-of-week'' and ''date'' shown are for today's date. Click '''''dd/mm/yyyy''''' to change date.
		+	'''''<Copy rule data to Clipboard>''''' - click to copy the currently entered data to a special clipboard area used by the rules created by '''pguy'''.
		+	This is NOT the standard OS clipboard.
		+	'''''<Paste rule data from Clipboard>''''' - if data is held in the special clipboard area, then click to paste that data into the rule.
		+	This is NOT the standard OS clipboard.
		+	'''[Check Box] This rule is enabled''' - check to activate (enable) the rule.
		+	'''[Check Box] Avoid duplicated driver if possible''' - check to prevent the same driver being used again. If a driver name is reused, the rule will select a different driver name.
		+	'''[Check Box] Disable locomotives/vehicles enhanced mode''' - check to save vehicle properties when a train is removed by a portal.
		+	These properties will be restored if the same train is emitted by a portal. If checked then a new command will appear:
		+	'''''<for all vehicles/for only locomotives/for only tagged vehicles>''''' - click to select one.
		+	'''Portal selected: ''<portal name> [...]''''' - select a portal to manage by clicking '''''<portal name>''''' or '''''[...]''''' and selecting a portal from the Session list.
		+	'''Portal output link: ''<[no link]> [...]''''' - leave blank.
		+	'''Portal input link: ''<[no link]> [...]''''' - leave blank unless you want to connect to a Global Input Queue. Click to select an input queue from the Session list.
		+	'''Default schedule for input trains is named: ''<schedule>''''' - click to enter a schedule name.
		+	'''Today's schedule: ''<Insert new schedule>''''' - click to enter a new schedule
		+	For each schedule:-
		+	'''''<hh:mm>''''' - click to set the time when a train will be emitted from the portal. Times use the 24hr clock.
		+	'''''<train name>''''' - click to enter the train name
		+	'''''<mission code>''''' - click to enter the '''Mission Code''' created by the '''MissionCode Manager Rule (SP2 and later)'''.
		+	'''''<schedule>''''' - click to enter the re-occurrence schedule in ''hh:mm'' (24hr clock) where, for example:
		+	''02:30'' means every 2 hrs 30 minutes,
		+	''00:00'' means once only,
		+	''24:00'' means once each day.
		+	'''''<driver>''''' - click to select a driver name or select '''''auto-driver''''' to let the rule select a driver.
		+	'''Current driver order bar is named ''<schedule>''''' - click to enter a name for the order (Driver Command) bar used in this schedule.
		+	'''''<hud>''''' - click to select a HUD for this train. HUDs must be created using the '''Quick CustomHud Manager Rule (SP2 and later)'''.
		+	'''Driver Command Bar''' - enter driver commands for this train.
		+	Choose one of two consist sets:
		+	'''''<mono consist>'' consist for every day''' - if selected the same consist will be used each day.
		+	'''''<no consist selected>''''' - click to select a consist from those saved in your install.
		+	'''''<multi consists>''''' - if selected a different consist will be used each day.
		+	For each day of the week:
		+	'''Day-of-week ''<no consist selected>''''' - click to select a consist from those saved in your install.
	*'''Related Rules:'''		*'''Related Rules:'''
−	**'''[[#Session Complete Rule|Session Complete Rule]]''' - set the session to a percentage of completion	+	**'''[[#MissionCode Manager Rule (SP2 and later)|MissionCode Manager Rule (SP2 and later)]]''' - creates and manages '''Mission Codes''' for '''Interlocking Tower''' paths
		+	**'''[[#Quick CustomHud Manager Rule (SP2 and later)|Quick CustomHud Manager Rule (SP2 and later)]]''' - create driver HUDs
−	==='''ExTrainz Manager Rule - TANE SP2'''===	+	*'''Trainz Wiki Links:'''
		+	**'''http://online.ts2009.com/mediaWiki/index.php/Quick_Portal_Manager'''
−	Provides information on consists, industries and products in both Surveyor and Driver modes. Once activated, the rule creates an additional short menu bar below the main menu bar.	+	==='''QuickDrive Rule'''===
−	*'''<kuid:160293:10029>'''	+	Changes the Session settings.
−	*'''DLS Rule''' by '''trev999'''	+	*'''<kuid:401543:1184>'''
		+
		+	*'''Base Rule'''
	'''Properties:'''		'''Properties:'''
−	'''Diagnostic mode is ''<On/Off>''''' - click to select ''On'' or ''Off''. When set ''On'' diagnostic messages will be added to the Trainz Log file.	+	'''Open QuickDrive window when session is started          [Check Box]''' - check to set
−	'''Turn on message overlay ''<Yes/No>''''' - click to select ''Yes'' or ''No''. When set to ''Yes'' the message overlay (lower left of screen) will be active.	+	'''Set time to ''<hours:minutes>'' with a rate of ''<speed x>''''' - set start time and rate at which time advances
−	'''Show rolling stock in Driver mode ''<Yes/No>''''' - click to select ''Yes'' or ''No''. When set to ''Yes'' rolling stock can be searched in Driver.	+	'''Enable gameplay Session Mode                            [Check Box]''' - check to set. Gameplay mode restricts the players options
−	'''Search only rolling stock already in session ''<Yes/No>''''' - click to select ''Yes'' or ''No''. When set to ''Yes'' only those rolling stock assets	+	'''Enable in game help by default                          [Check Box]''' - check to allow help options to be displayed
−	installed in the session can be searched.	+	'''Set the default Control method to:''' - select one of two option buttons:-
−	'''Graphic colours: ''<When Red, the industry does not require service/When Green, the industry does not require service>''''' - click to switch	+	'''( ) Easy Mode'''
−	between the two colour options.	+	'''( ) Realistic Mode'''
−	'''Industry page size: ''<value>''''' - enter the number of industries to be displayed in the Industry List window (maximum 250).	+	'''[Check Box] Prevent player from changing this setting''' - check to set
−	'''The following industries are excluded: ''<Add an industry to be excluded>''''' - name can be complete (e.g. "Coal Mine 2")	+	'''Realistic mode requires achievement: ''<text>'' in asset ''<asset name>''''' - enter achievement name and select an asset from Aurans Achievements
−	which will exclude that specific industry from the management list, or partial (e.g. "Coal") which will exclude all	+	'''Set the default derailment realism to:''' - select one of three option buttons:-
−	industries with the word "Coal" in their names. Entries are not case sensitive.	+	'''( ) None'''
−	Once industries have been excluded, additional commands will appear for each excluded industry:-	+	'''( ) Arcade'''
−	'''''<delete> <industry name begins with/class name begins with> <name>''''' - click ''delete'' to remove this entry.	+	'''( ) Realistic'''
−	- click ''industry name begins with/class name begins with'' to select between the two (see ''notes'' below).	+	'''[Check Box] Prevent player from changing this setting''' - check to set
−	- click ''name'' to edit the name.	+	'''Set the default units to:''' - select one of three option buttons:-
		+	'''( ) Imperial'''
		+	'''( ) Metric'''
		+	'''( ) Default'''
−	*'''Notes:'''	+	*'''Trainz Wiki Links:'''
−	#Rolling stock installed in '''TANE''' or in the current session only (see settings above) can be searched to find a match for any selected product from any industry. In Surveyor (and Driver if that setting is enabled) click on the '''View Products''' sub menu link and click on a product name in the '''Product Window''' to display a list of all compatible rolling stock for that product.	+	**'''http://online.ts2009.com/mediaWiki/index.php/QuickDrive_Rule'''
−	#Alternatively, click on the '''View Industries''' sub menu link and then click on a ''Product Icon'' to open a '''Product Window''', then click    on the '''''View Rolling Stock''''' link at the top of the window.	+
−	#Industry class names are defined in the config.txt file of industry assets and are not normally accessible by users. However, you can exclude an entire group of related "industry asset classes" such as ''station'', ''coalingtower'', ''watertank'', etc regardless of their actual names provided those assets have been given that "class name" by their creators.	+
−	*'''Known Issues:'''	+	==='''Wait for Driver On/Off Train Rule'''===
−	:This rule is NOT compatible with all industries.	+
		+	Executes child rules when a driver gets on or off a train
		+
		+	*'''<kuid:-25:953>'''
		+
		+	*'''Built-in Rule'''
		+
		+	*'''Parent Rule'''
		+
		+	'''Properties:'''
		+	'''[Check Box] Trigger Rule Once''' - click to set''
		+	'''Wait for a driver character to get ''<On/Off>''''' a train that matches the following criteria''' - select '''On''' or '''Off'''
		+	Select one of two option buttons:-
		+	'''( ) click to accept all trains'''
		+	'''( ) click to accept trains matching specific criteria'''
		+	Selecting the second option will produce the following selection controls:-
		+	'''Specific vehicle''' - identify the specific vehicle or set of specific vehicles that will trigger the rule
		+	'''''+''''' - click to add a ''specific'' vehicle from the session list
		+	'''''x''''' - click to remove the ''specific'' vehicle from the rule
		+	'''Vehicle types''''' - identify the ''type'' of vehicle or a set of vehicle ''types'' that will trigger the rule
		+	'''''+''''' - click to add a ''type'' of vehicle from the session list
		+	'''''x''''' - click to remove the ''type'' of vehicle from the rule
		+	'''Drivers''''' - identify the ''drivers'' that will trigger the rule
		+	'''''+''''' - click to add a ''driver'' from the session list
		+	'''''x''''' - click to remove a ''driver'' from the rule
	*'''Related Rules:'''		*'''Related Rules:'''
−	**'''[[#DisplayIndustryStatus Rule (color modified)|DisplayIndustryStatus Rule (color modified)]]''' - displays information on industry product levels.	+	**'''[[#Wait for Driver/Train to be Locally Owned Rule|Wait for Driver/Train to be Locally Owned Rule]]''' - executes child rules when a vehicle or driver changes ownership
−	==='''Fade In/Out Rule'''===	+	==='''Wait for Driver/Train to be Locally Owned Rule'''===
−	Fade in or out within seconds, using specified color and opacity values.	+	Executes child rules when a specific driver or vehicle is locally owned. If the driver/vehicle becomes unowned again the child rules are paused
−	*'''<kuid2:190611:200000:2>'''	+	*'''<kuid2:401543:1173:1>'''
	*'''Built-in Rule'''		*'''Built-in Rule'''
		+
		+	*'''Parent Rule'''
	'''Properties:'''		'''Properties:'''
−	'''Red percentage:             ''<value>''''' - enter the final % of red (0 = none, 100 = maximum)	+	'''Assets Ownership:''' - select one of two option buttons:-
−	'''Green percentage:           ''<value>''''' - enter the final % of green	+	'''( ) Wait for ownership of a specific Driver'''
−	'''Blue percentage:            ''<value>''''' - enter the final % of blue	+	'''( ) Wait for ownership of Driver'''
−	'''Alpha percentage (opacity): ''<value>''''' - enter the final % of opacity (0 = invisible, 100 = solid)	+	'''Driver or Vehicle ''<select>''''' - choose from session list
−	'''Fading duration:            ''<value>''''' - enter the number of seconds required for the fade	+
−	'''''<help>''''' - click to bring up help instructions	+
−	*'''Notes:'''	+	*'''Related Rules:'''
−	:Seconds are Trainz clock time, not real time.	+	**'''[[#Wait for Driver On/Off Train Rule|Wait for Driver On/Off Train Rule]]''' -  executes child rules when a driver gets on or off a train
		+
		+	'''[[#top|Back to Top]]'''
		+	----
		+	=='''HUD (Heads Up Display) Rules'''==
		+
		+	==='''Cab Controls HUD Rule'''===
		+
		+	Was used to provide the HUD controls for the cabin view. Now obsolete.
		+
		+	*'''<kuid:-16:287428>'''
		+
		+	*'''Base Rule'''
		+
		+	*'''Obsolete Rule''' (function is now built into TANE)
		+
		+	'''Properties:'''
		+	'''None'''
		+
		+	==='''Coupler Breakage HUD Rule'''===
		+
		+	HUD displays warning about coupler stress and breakage
		+
		+	*'''<kuid:-25:423>'''
		+
		+	*'''Built-in Rule'''
		+
		+	'''Properties:'''
		+	Select one of two option buttons:-
		+	'''( ) Show the Coupler Breakage Display'''
		+	'''( ) Hide the Coupler Breakage Display'''
		+
		+	*'''Related Rules:'''
		+	**'''[[#Coupler Breakage Check Rule|Coupler Breakage Check Rule]]''' - executes child rules if a coupler breaks
		+	**'''[[#Set Coupler Masks Rule|Set Coupler Masks Rule]]''' - sets the coupling/decoupling masks on selected vehicles
		+
		+	==='''Display Custom HUD Rule'''===
		+
		+	Show or hide the Custom Heads Up Display.
		+
		+	*'''<kuid:-3:10206>'''
		+
		+	*'''Base Rule'''
		+
		+	'''Properties:'''
		+	'''Show or Hide the Custom Heads up Display''' - select one of two option buttons:-
		+	'''( ) Show the Custom Heads up Display'''
		+	'''( ) Hide the Custom Heads up Display'''
		+
		+	*'''Related Rules:'''
		+	**'''[[#Flash HUD Icon Rule|Flash HUD Icon Rule]]''' - flashes a HUD panel icon for a set duration.
		+	**'''[[#mc Display Custom HUD V2 Rule (SP2 and later)|mc Display Custom HUD V2 Rule (SP2 and later)]]''' - shows or hides a graphical HUD.
		+	**'''[[#Quick CustomHud Manager Rule (SP2 and later)|Quick CustomHud Manager Rule (SP2 and later)]]''' - creates custom HUDs that can be assigned to different drivers
		+	**'''[[#Show/Hide HUD Panel Rule|Show/Hide HUD Panel Rule]]''' - shows or hides a HUD panel.
		+	**'''[[#Variable Show Rule|Variable Show Rule]]''' - adds or removes a specified variable and a descriptive label to the custom HUD.
		+	**'''[[#Wait for Click on HUD Icon Rule|Wait for Click on HUD Icon Rule]]''' - executes child rules when a HUD icon is clicked
		+
		+	*'''Trainz Wiki Links:'''
		+	**'''http://online.ts2009.com/mediaWiki/index.php/Display_Custom_HUD_Rule'''
	==='''Flash HUD Icon Rule'''===		==='''Flash HUD Icon Rule'''===
Line 836:		Line 1,231:
	**'''[[#Wait for Click on HUD Icon Rule|Wait for Click on HUD Icon Rule]]''' - executes child rules when a HUD icon is clicked		**'''[[#Wait for Click on HUD Icon Rule|Wait for Click on HUD Icon Rule]]''' - executes child rules when a HUD icon is clicked
−	==='''Focus Camera Rule'''===	+	==='''mc Display Custom HUD V2 Rule (SP2 and later)'''===
−	Sets the initial camera view and starting vehicle for a session.	+	Shows or hides a graphical HUD which includes junction direction for the junction ahead. This rule has been superseded by the '''Quick CustomHUD Manager Rule (SP2 and later)'''
−	*'''<kuid2:122381:10014:1>'''	+	*'''<kuid2:61392:1072:10>'''
−	*'''DLS Rule''' by '''mizi'''	+	*'''Legacy Rule''' (replaced by '''Quick CustomHUD Manager Rule (SP2 and later)''')
		+
		+	*'''DLS Rule''' by '''pguy'''
	'''Properties:'''		'''Properties:'''
−	'''Focus camera to:''' - select one of two option buttons	+	'''Show or Hide the Custom Heads up Display''' - select one of two option buttons:-
−	'''( ) Map object'''	+	'''( ) Show the Custom Heads up Display'''
−	'''( ) Vehicle'''	+	'''( ) Hide the Custom Heads up Display'''
−	'''Named ''<?????>''''' - enter name of object or vehicle from session list	+
−	'''Additionally:'''	+
−	'''[Check Box] set view mode to''' - check to select one of four option buttons	+
−	'''( ) Internal view'''	+
−	'''( ) External view'''	+
−	'''( ) Tracking view'''	+
−	'''( ) Roaming view'''	+
−	'''[Check Box] restrict user to manipulate the camera''' - check to set user limits on camera controls	+
−	'''[Check Box] allow internal view'''	+
−	'''[Check Box] allow external view'''	+
−	'''[Check Box] allow tracking view'''	+
−	'''[Check Box] allow roaming view'''	+
−	'''[Check Box] allow change of view mode'''	+
−	'''[Check Box] allow change vehicle in train'''	+
−	'''[Check Box] allow change trains'''	+
−	'''[Check Box] allow adjust camera viewpoint'''	+
−	'''[Check Box] set camera angles''' - check to set the initial camera view point	+
−	'''Yaw (90 = look at front of train): ''<value>'' degrees''' - enter yaw angle	+
−	'''Pitch (-90 = down, 90 = up): ''<value>'' degrees''' - enter pitch angle	+
−	'''Distance from the focused object: ''<value>'' metres''' - enter distance from camera to object	+
	*'''Related Rules:'''		*'''Related Rules:'''
−	**'''[[#Cinematic Camera Rule|Cinematic Camera Rule]]''' - provides several different cinematic style cameras with animations	+	**'''[[#Display Custom HUD Rule|Display Custom HUD Rule]]''' - shows or hides the Custom Heads Up Display.
−	**'''[[#Set Camera Rule|Set Camera Rule]]]''' - sets the target object and properties of the camera	+	**'''[[#Flash HUD Icon Rule|Flash HUD Icon Rule]]''' - flashes a HUD panel icon for a set duration.
−	**'''[[#Wait for Camera View Mode Rule|Wait for Camera View Mode Rule]]''' - executes child rules when the camera view is changed	+	**'''[[#Quick CustomHud Manager Rule (SP2 and later)|Quick CustomHud Manager Rule (SP2 and later)]]''' - creates custom HUDs that can be assigned to different drivers
		+	**'''[[#Show/Hide HUD Panel Rule|Show/Hide HUD Panel Rule]]''' - shows or hides a HUD panel.
		+	**'''[[#Variable Show Rule|Variable Show Rule]]''' - adds or removes a specified variable and a descriptive label to the custom HUD.
		+	**'''[[#Wait for Click on HUD Icon Rule|Wait for Click on HUD Icon Rule]]''' - executes child rules when a HUD icon is clicked
−	==='''Generic TreeNode Debug Window Rule'''===	+	==='''Quick CustomHud Manager Rule (SP2 and later)'''===
−	No description.	+	Allows the creation of new graphical heads up displays which are assigned to the drivers in Driver Mode. Replaces the '''mc Display Custom HUD V2 Rule (SP2 and later)'''
−	*'''<kuid:30501:1042>'''	+	*'''<kuid2:61392:5020:47>'''
		+
		+	*'''DLS Rule''' by '''pguy'''
		+
		+	'''Properties:'''
		+	'''''<Copy rule to data Clipboard>''''' - click to copy the data from the selected HUD to a special clipboard area used by the rules created by '''pguy'''.
		+	This is NOT the standard OS clipboard.
		+	'''''<Paste rule data from Clipboard>''''' - if data is held in the special clipboard area, then click to paste that data into the selected HUD.
		+	This is NOT the standard OS clipboard.
		+	'''Current HUD Parameters'''
		+	'''HUD to select: ''<HUD name>''''' - click to select a HUD from those available. One or two default HUDs will be supplied.
		+	'''''new HUD''''' - click to create a new HUD display with default properties. You will be required to enter a name for the new HUD
		+	'''''clone HUD''''' - click to create a new HUD using the properties of the currently selected HUD. You will be required to enter a name for the new HUD
		+	'''''copy HUD''''' - copies (overwrites) the currently selected HUD with the properties of another HUD. You will be required to enter the name of the HUD to be copied
		+	For new, cloned or copied HUDs, additional commands will be shown:
		+	'''''rename HUD''''' - rename the selected HUD. You will be required to enter a new name for the HUD
		+	'''''delete HUD''''' - delete the currently displayed HUD
		+	In '''Driver Mode''' an additional command will be shown:
		+	'''''Assign hud to current train''''' - click to assign the currently selected HUD to the currently selected driver
		+	'''[Check Box] hud is displayed (on)''' - check to display HUD in '''Driver Mode'''
		+	'''hud items nb entries max: ''<value>''''' - enter the maximum number of items to be displayed in the HUD. Maximum is 30.
		+	'''hud view limit: ''<value>''''' - enter the maximum look-ahead distance in metres for the HUD. Minimum value is 1000, maximum value is 10000.
		+	'''[Check Box] display data in a centred window above orderbar''' - check to display the HUD centred on the screen just above the driver command bar in '''Driver Mode'''
		+	For each individual HUD property:
		+	'''[Check Box] ''HUD property''''' - check to add this property to the HUD
		+
		+	*'''Notes:'''
		+	:HUDs are assigned to drivers in '''Driver Mode''' by either adding a '''SetCustomHud (SP2 and later)''' command to individual drivers command lists or manually by clicking a green '''RM''' tool button displayed on the top menu and selecting '''Quick CustomHUD Manager''' from the menu.
		+
		+	*'''Related Rules:'''
		+	**'''[[#Display Custom HUD Rule|Display Custom HUD Rule]]''' - shows or hides the Custom Heads Up Display.
		+	**'''[[#Flash HUD Icon Rule|Flash HUD Icon Rule]]''' - flashes a HUD panel icon for a set duration.
		+	**'''[[#mc Display Custom HUD V2 Rule (SP2 and later)|mc Display Custom HUD V2 Rule (SP2 and later)]]''' - shows or hides a graphical HUD.
		+	**'''[[#Show/Hide HUD Panel Rule|Show/Hide HUD Panel Rule]]''' - shows or hides a HUD panel.
		+	**'''[[#Variable Show Rule|Variable Show Rule]]''' - adds or removes a specified variable and a descriptive label to the custom HUD.
		+	**'''[[#Wait for Click on HUD Icon Rule|Wait for Click on HUD Icon Rule]]''' - executes child rules when a HUD icon is clicked
		+
		+	==='''Show/Hide HUD Panel Rule'''===
		+
		+	Shows or hides a HUD panel.
		+
		+	*'''<kuid:-25:1047>'''
		+
		+	*'''Built-in Rule'''
		+
		+	'''Properties:'''
		+	'''''<Show/Hide>'' the ''<click to select>'' HUD panel''' - select '''''Show''''' or '''''Hide''''' and then select the HUD panel
		+
		+	*'''Related Rules:'''
		+	**'''[[#Display Custom HUD Rule|Display Custom HUD Rule]]''' - shows or hides the Custom Heads Up Display.
		+	**'''[[#Flash HUD Icon Rule|Flash HUD Icon Rule]]''' - flashes a HUD panel icon for a set duration.
		+	**'''[[#mc Display Custom HUD V2 Rule (SP2 and later)|mc Display Custom HUD V2 Rule (SP2 and later)]]''' - shows or hides a graphical HUD.
		+	**'''[[#Quick CustomHud Manager Rule (SP2 and later)|Quick CustomHud Manager Rule (SP2 and later)]]''' - creates custom HUDs that can be assigned to different drivers
		+	**'''[[#Variable Show Rule|Variable Show Rule]]''' - adds or removes a specified variable and a descriptive label to the custom HUD.
		+	**'''[[#Wait for Click on HUD Icon Rule|Wait for Click on HUD Icon Rule]]''' - executes child rules when a HUD icon is clicked
		+
		+	==='''Variable Show Rule'''===
		+
		+	Adds or removes a specified variable and a descriptive label to the custom HUD. This rule does not make the custom HUD appear on the screen.
		+
		+	*'''<kuid:-25:971>'''
		+
		+	*'''Built-in Rule'''
		+
		+	'''Properties:'''
		+	'''[Check Box] Add'''
		+	'''''<variable-name>''''' - enter variable-name to add to HUD. Variable-name is case sensitive.
		+	'''''<label>''''' - (optional) enter a short label to be displayed on the HUD in front of the variable value.
		+	'''[Check Box] Remove'''
		+	'''''<variable-name>''''' - enter variable-name to remove from HUD. Variable-name is case sensitive.
		+
		+	*'''Related Rules:'''
		+	**'''[[#Display Custom HUD Rule|Display Custom HUD Rule]]''' - shows or hides the Custom Heads Up Display.
		+	**'''[[#Quick Session Variables Rule|Quick Session Variables Rule]]''' - allows the editing of session variables.
		+	**'''[[#Variable Check Rule|Variable Check Rule]]''' - executes child rules according to the value of a specified variable.
		+	**'''[[#Variable Modify Rule|Variable Modify Rule]]''' - changes the value of a specified variable.
		+	**'''[[#Variable Modify Continuous Rule|Variable Modify Continuous Rule]]''' - continuously changes the value of a specified variable.
		+	**'''[[#Variable Random Rule|Variable Random Rule]]''' - assigns a random value to a variable.
		+
		+	*'''Trainz Wiki Links:'''
		+	**'''[[How to Use Variables in Sessions (Examples)]]
		+
		+	==='''Wait for Click on HUD Icon Rule'''===
		+
		+	Executes child rules when the user clicks on a selected HUD icon
		+
		+	*'''<kuid:-25:951> <kuid:-25:970>''' - two versions built-in with different kuids, both have the same properties
		+
		+	*'''Built-in Rule'''
		+
		+	*'''Parent Rule'''
		+
		+	'''Properties:'''
		+	'''[Check Box] Trigger Once'''
		+	'''HUD Panel ''<Click>''''' - click choose from list:-
		+	'''Bottom Right Menu'''
		+	'''Camera Controls'''
		+	'''DCC Controls'''
		+	'''Icon ''<Click>''''' - click to choose from list. Selections depends on HUD Panel chosen
		+
		+	*'''Related Rules:'''
		+	**'''[[#Display Custom HUD Rule|Display Custom HUD Rule]]''' - shows or hides the Custom Heads Up Display.
		+	**'''[[#Flash HUD Icon Rule|Flash HUD Icon Rule]]''' - flashes a HUD panel icon for a set duration.
		+	**'''[[#mc Display Custom HUD V2 Rule (SP2 and later)|mc Display Custom HUD V2 Rule (SP2 and later)]]''' - shows or hides a graphical HUD.
		+	**'''[[#Quick CustomHud Manager Rule (SP2 and later)|Quick CustomHud Manager Rule (SP2 and later)]]''' - creates custom HUDs that can be assigned to different drivers
		+	**'''[[#Show/Hide HUD Panel Rule|Show/Hide HUD Panel Rule]]''' - shows or hides a HUD panel.
		+	**'''[[#Variable Show Rule|Variable Show Rule]]''' - adds or removes a specified variable and a descriptive label to the custom HUD.
		+
		+	'''[[#top|Back to Top]]'''
		+	----
		+	=='''Industry Rules'''==
		+
		+	==='''Advanced Industry Load Configuration Rule'''===
		+
		+	Locks train controls when loading/unloading at an industry, overrides time settings for begin load and begin unload operations
		+
		+	*'''<kuid:30501:100007>'''
	*'''Base Rule'''		*'''Base Rule'''
		+
		+	'''Properties:'''
		+	'''Target object ''<select>''''' - select industry object from session list
		+	'''[Check Box] Lock the train's controls during a stopped load/unload operation''' - check to disable driver controls while train is stopped and loading/unloading
		+	'''[Check Box] Override 'begin load' and 'begin unload' durations to ''<value>'' seconds''' - if checked enter number of seconds to override
		+
		+	*'''Notes:'''
		+	:Times are Trainz clock time, not real time
		+
		+	==='''Disable/Enable Industry Rule'''===
		+
		+	Enables/Disables vehicle load/unload for industry
		+
		+	*'''<kuid2:401543:1171:1>'''
		+
		+	*'''Built-in Rule'''
		+
		+	'''Properties:'''
		+	'''Load/unload ''<Disable/Enable>''''' - click to set to '''Disable''' or '''Enable'''
		+	'''Which Industry? ''<select>''''' - click to set Industry from Session List
		+	'''Which Vehicles:''' - select one of two option buttons:-
		+	'''( ) Apply to every vehicle in the session'''
		+	'''( ) Apply only to a specific vehicles from Session List'''
		+
		+	==='''DisplayIndustryStatus Rule (color modified)'''===
		+
		+	Displays a summary of industry product levels when the "k" key is pressed.
		+
		+	*'''<kuid:622415:100001>'''
		+
		+	*'''DLS Rule''' by '''lockheed02''' and '''marzipan'''
	'''Properties:'''		'''Properties:'''
	'''None'''		'''None'''
−	----
−	'''[[#top|Back to Top]]''' | '''[[#A, B|A, B]]''' | '''[[#C|C]]''' | '''[[#D|D]]''' | '''[[#E, F, G|E, F, G]]''' | '''[[#H, I, J|H, I, J]]''' | '''[[#K, L, M|K, L, M]]''' | '''[[#N, O|N, O]]''' | '''[[#P, Q|P, Q]]''' | '''[[#R|R]]''' | '''[[#S-Se|S-Se]]''' | '''[[#Sh-Sz|Sh-Sz]]''' | '''[[#T|T]]''' | '''[[#U, V|U, V]]''' | '''[[#W, X, Y, Z|W, X, Y, Z]]'''
−	=='''H, I, J'''==	+	*'''Notes:'''
		+	:Pressing the '''k''' key in Driver mode will bring up a small window with a single link '''''Display Industry Status''''' (there may also be other links). Clicking this link will show the product levels of all industries.
−	==='''Hide Product Overlays Rule'''===	+	*'''Related Rules:'''
		+	**'''[[#ExTrainz Manager Rule - TANE SP2|ExTrainz Manager Rule - TANE SP2]]''' - displays information on consists, industries and products in Driver and Surveyor.
−	Hides the commodity or product bar graphs that appear on active industries	+	==='''ExTrainz Manager Rule - TANE SP2'''===
−	*'''<kuid:400048:100970>'''	+	Provides information on consists, industries and products in both Surveyor and Driver modes. Once activated, the rule creates an additional short menu bar below the main menu bar.
−	*'''DLS Rule''' by '''callavsg'''	+	*'''<kuid:160293:10029>'''
		+
		+	*'''DLS Rule''' by '''trev999'''
	'''Properties:'''		'''Properties:'''
−	'''None'''	+	'''Diagnostic mode is ''<On/Off>''''' - click to select ''On'' or ''Off''. When set ''On'' diagnostic messages will be added to the Trainz Log file.
		+	'''Turn on message overlay ''<Yes/No>''''' - click to select ''Yes'' or ''No''. When set to ''Yes'' the message overlay (lower left of screen) will be active.
		+	'''Show rolling stock in Driver mode ''<Yes/No>''''' - click to select ''Yes'' or ''No''. When set to ''Yes'' rolling stock can be searched in Driver.
		+	'''Search only rolling stock already in session ''<Yes/No>''''' - click to select ''Yes'' or ''No''. When set to ''Yes'' only those rolling stock assets
		+	installed in the session can be searched.
		+	'''Graphic colours: ''<When Red, the industry does not require service/When Green, the industry does not require service>''''' - click to switch
		+	between the two colour options.
		+	'''Industry page size: ''<value>''''' - enter the number of industries to be displayed in the Industry List window (maximum 250).
		+	'''The following industries are excluded: ''<Add an industry to be excluded>''''' - name can be complete (e.g. "Coal Mine 2")
		+	which will exclude that specific industry from the management list, or partial (e.g. "Coal") which will exclude all
		+	industries with the word "Coal" in their names. Entries are not case sensitive.
		+	Once industries have been excluded, additional commands will appear for each excluded industry:-
		+	'''''<delete> <industry name begins with/class name begins with> <name>''''' - click ''delete'' to remove this entry.
		+	- click ''industry name begins with/class name begins with'' to select between the two (see ''notes'' below).
		+	- click ''name'' to edit the name.
−	==='''InputTable Rule'''===	+	*'''Notes:'''
		+	#Rolling stock installed in '''TANE''' or in the current session only (see settings above) can be searched to find a match for any selected product from any industry. In Surveyor (and Driver if that setting is enabled) click on the '''View Products''' sub menu link and click on a product name in the '''Product Window''' to display a list of all compatible rolling stock for that product.
		+	#Alternatively, click on the '''View Industries''' sub menu link and then click on a ''Product Icon'' to open a '''Product Window''', then click    on the '''''View Rolling Stock''''' link at the top of the window.
		+	#Industry class names are defined in the config.txt file of industry assets and are not normally accessible by users. However, you can exclude an entire group of related "industry asset classes" such as ''station'', ''coalingtower'', ''watertank'', etc regardless of their actual names provided those assets have been given that "class name" by their creators.
−	Creates a list of message names to be used for various purposes including passing data to '''Driver Commands'''	+	*'''Known Issues:'''
		+	:This rule is NOT compatible with all industries.
−	*'''<kuid2:131986:1012:1>'''	+	*'''Related Rules:'''
		+	**'''[[#DisplayIndustryStatus Rule (color modified)|DisplayIndustryStatus Rule (color modified)]]''' - displays information on industry product levels.
		+
		+	==='''Multiple Resource Check Rule'''===
		+
		+	Executes child rules if industries or vehicles reach set commodity levels. This rule replaces the older '''Resource Check Rule'''
		+
		+	*'''<kuid:-25:656>'''
	*'''Built-in Rule'''		*'''Built-in Rule'''
		+
		+	*'''Parent Rule'''
	'''Properties:'''		'''Properties:'''
−	'''''<add>''''' - click to add a new entry to the table	+	'''<Product Level>''' - click to select a product test from two choices:-
−	Each new entry will require an input message	+	'''''Reach/Exceed''''' - sets an upper limit for the resources being monitored.
−	'''''<short message>''''' - enter a message. The message must be in a format that is specific for each purpose	+	For example: the rule will be triggered if the quantity of coal in a coal loader stockpile or a coal wagon reaches or exceeds a specified level.
−	For the '''MoveTurntable''' driver command the message must be formatted as:-	+	The initial level in the object must be below the set upper limit.
−	'''turntable,name_of_turntable,number_of_connecting_roads''' - the first entry must be the word ''turntable'' in lower case.	+	'''''Fall below''''' - sets a lower limit for the resources being monitored.
−	''name_of_turntable'' is the name of the turntable,	+	For example: the rule will be triggered if the quantity of coal in a coal loader stockpile or a coal wagon falls below a specified level.
−	''number_of_connecting_roads'' is the number of tracks connecting to the turntable	+	The initial level in the object must be above the set lower limit.
−	For the '''WaitUntilTime''' driver command the message must be formatted as:-	+	To test when a resource level reaches zero (i.e. is empty) set the lower limit to a very low value but not zero as the level can never fall below zero.
−	'''time,hour,minute''' - the first entry must be the word ''time'' in lower case,	+	'''''<value>''''' - enter required quantity value
−	''hour'' must be from 0 to 23,	+	'''''<select>''''' - select a product from session list of products
−	''minute'' must be from 0 to 59.	+	'''''<Add object>''''' - click to select a source or target object. Multiple objects and their queues can be added to the rule.
−	For the '''WaitUntilSVariable''' driver command the message must be formatted as:-	+	ALL the entered products must reach/exceed or fall below the specified value for the rule to be triggered.
−	'''svar,svar_name,svar_condition,value''' - the first entry must be the word ''svar'' in lower case,	+	For each object:-
−	''svar_name'' is the name of the session variable,	+	'''''<Object>''''' - click to select session active industry or product enabled rail vehicle
−	''svar_condition'' is an equality (eg eq for equal, gt for greater than, etc)	+	'''''<Queue>''''' - select product queue (there may be only one available)
−	''value'' is an integer value to be compared to the session variable.	+	'''''<Remove>''''' - removes the object and its product queue from the rule
−	Each entry in the table will be followed by the commands:-	+
−	'''''cp''''' - click to copy this entry to a new entry	+	*'''Notes:'''
−	'''''up''''' - click to move this entry up one level	+	:This rule only checks for ''changing'' commodity levels during loading and unloading operations. It cannot be used to test, for example, if a vehicle is ''full'' or ''empty''.
−	'''''dn''''' - click to move this entry down one level	+
−	'''''rm''''' - click to remove this entry from the table	+	*'''Related Rules:'''
		+	**'''[[#Resource Check Rule|Resource Check Rule]]''' - executes child rules when set resource (commodity) levels are reached
		+	**'''[[#Resource Verify Rule (fixed)|Resource Verify Rule (fixed)]]''' - executes child rules when a set resource (commodity) level is reached
		+
		+	*'''Trainz Wiki Links:'''
		+	**'''[[How to Use Navigation Point Rules (Applications)#Application 3: Wait for Loading to be Completed|How to Use Navigation Point Rules (Applications): Wait for Loading to be Completed]]'''
		+
		+	==='''Power Station Rule'''===
		+
		+	Sets up a Power Station and its electricity consumers
		+
		+	*'''<kuid:-25:746>'''
		+
		+	*'''Base Rule'''
		+
		+	'''Properties:'''
		+	'''Power station ''<select>''''' - select a Power Station from the session list.
		+	'''Consumers:'''
		+	'''''<add object>''''' - add power consumers from the session list
		+
		+	==='''Resource Check Rule'''===
		+
		+	Executes child rules if a selected industry or vehicle reaches a set commodity level. This rule has been superseded by the '''Multiple Resource Check Rule'''
		+
		+	*'''<kuid:-25:1067>'''
		+
		+	*'''Legacy Rule''' (replaced by '''Multiple Resource Check Rule''')
		+
		+	*'''Built-in Rule'''
		+
		+	*'''Parent Rule'''
		+
		+	'''Properties:'''
		+	Select one of two option buttons:-
		+	'''( ) Watch industry queue'''
		+	'''Target Object ''<select>''''' - select an industry from the session list
		+	'''Queue ''<select>''''' - select a product queue from the selected industry
		+	'''Product ''<select>''''' - select a product from the selected queue
		+	'''Amount ''<value>''''' - enter a quantity
		+	Select one of two option buttons:-
		+	'''( ) Complete when designated queue equals or exceeds required amount'''
		+	'''( ) Complete when designated queue falls below required amount'''
		+	'''( ) Watch vehicle'''
		+	'''Target Object ''<select>''''' - select a rolling stock asset from the session list
		+	'''Queue ''<select>''''' - select a product queue from the selected rolling stock
		+	'''Product ''<select>''''' - select a product from the selected queue
		+	'''Amount ''<value>''''' - enter a quantity
		+	Select one of two option buttons:-
		+	'''( ) Complete when designated queue equals or exceeds required amount'''
		+	'''( ) Complete when designated queue falls below required amount'''
		+
		+	*'''Notes:'''
		+	:This rule only checks for ''changing'' commodity levels during loading and unloading operations. It cannot be used to test, for example, if a vehicle is ''full'' or ''empty''.
		+
		+	*'''Related Rules:'''
		+	**'''[[#Multiple Resource Check Rule|Multiple Resource Check Rule]]''' - executes child rules when set resource (commodity) levels are reached
		+	**'''[[#Resource Verify Rule (fixed)|Resource Verify Rule (fixed)]]''' - executes child rules when a set resource (commodity) level is reached
		+
		+	*'''Trainz Wiki Links:'''
		+	**'''http://online.ts2009.com/mediaWiki/index.php/Resource_Check_Rule'''
		+
		+	==='''Resource Verify Rule (fixed)'''===
		+
		+	Executes child rules if a selected industry or vehicle reaches a set commodity level. The rule resets when all child rules have completed.
		+
		+	*'''<kuid:160293:10060>'''
		+
		+	*'''DLS Rule''' by '''trev999
		+
		+	*'''Parent Rule'''
		+
		+	'''Properties:'''
		+	Select one of two option buttons:-
		+	'''( ) Watch industry queue'''
		+	'''Target object ''<click to select>''''' - click to select an industry from the session list.
		+	'''Product ''<click to select>''''' - click to select an industry product.
		+	'''Amount ''<value>''''' - enter a quantity for the selected product.
		+	Select one of two option buttons:-
		+	'''( ) Complete when designated queue equals or exceeds designated amount'''
		+	'''( ) Complete when designated queue falls below designated amount'''
		+	'''( ) Watch vehicle queue'''
		+	'''Target object ''<click to select>''''' - click to select a rolling stock vehicle from the session list.
		+	'''Product ''<click to select>''''' - click to select a commodity product.
		+	'''Amount ''<value>''''' - enter a quantity for the selected product.
		+	Select one of two option buttons:-
		+	'''( ) Complete when designated queue equals or exceeds designated amount'''
		+	'''( ) Complete when designated queue falls below designated amount'''
		+
		+	*'''Notes:'''
		+	#This rule will only monitor a single commodity in a single industry or vehicle.
		+	#This rule only checks for ''changing'' commodity levels during loading and unloading operations. It cannot be used to test, for example, if a vehicle is ''full'' or ''empty''.
		+
		+	*'''Related Rules:'''
		+	**'''[[#Multiple Resource Check Rule|Multiple Resource Check Rule]]''' - executes child rules when set resource (commodity) levels are reached
		+	**'''[[#Resource Check Rule|Resource Check Rule]]''' - executes child rules when set resource (commodity) levels are reached
		+
		+	==='''Station Visited Check Rule'''===
		+
		+	Executes child rules if specific trains call at set stations or industries
		+
		+	*'''<kuid2:60850:89005:3>'''
		+
		+	*'''Built-in Rule'''
		+
		+	*'''Parent Rule'''
		+
		+	'''Properties:'''
		+	'''Trigger: ''<select>''''' - click to select one of the following
		+	'''''Never''''' - stopping at the selected industries will never trigger the rule.
		+	'''''Once only''''' - the rule is triggered on the first visit only to any one of the selected industries
		+	'''''Once per industry''''' - the rule is triggered on the first visit to each industry with each individual product
		+	'''''Once per visit''''' - the rule is triggered on the first visit to each industry regardless of the product
		+	'''''Once per vehicle''''' - each vehicle can only trigger the rule once.
		+	'''''<select industry>''''' - select industry or industries from session list
		+	Select one of two option buttons:-
		+	'''( ) click to accept all trains'''
		+	'''( ) click to accept trains matching specific criteria'''
		+	Selecting the second option will produce the following selection controls:-
		+	'''Specific vehicle''' - identify the specific vehicle or set of specific vehicles that will trigger the rule
		+	'''''+''''' - click to add a ''specific'' vehicle from the session list
		+	'''''x''''' - click to remove the ''specific'' vehicle from the rule
		+	'''Vehicle types''''' - identify the ''type'' of vehicle or a set of vehicle ''types'' that will trigger the rule
		+	'''''+''''' - click to add a ''type'' of vehicle from the session list
		+	'''''x''''' - click to remove the ''type'' of vehicle from the rule
		+	'''Drivers''''' - identify the ''drivers'' that will trigger the rule
		+	'''''+''''' - click to add a ''driver'' from the session list
		+	'''''x''''' - click to remove a ''driver'' from the rule
		+
		+	'''[[#top|Back to Top]]'''
		+	----
		+	=='''Interlocking Tower, Junction and Signal Rules'''==
	==='''Interlocking Tower Configure Path Rule'''===		==='''Interlocking Tower Configure Path Rule'''===
Line 1,002:		Line 1,688:
	*'''Trainz Wiki Links:'''		*'''Trainz Wiki Links:'''
	**'''http://online.ts2009.com/mediaWiki/index.php/Enhanced_Interlocking_Tower_Manager_Rule'''		**'''http://online.ts2009.com/mediaWiki/index.php/Enhanced_Interlocking_Tower_Manager_Rule'''
−
−	==='''JTG Correct Vehicle Lights'''===
−
−	Corrects the brightness of vehicle headlights. Now obsolete.
−
−	*'''<kuid2:478657:999103:1>'''
−
−	*'''DLS Rule''' by '''jtg-trainz'''
−
−	*''' Obsolete Rule''' (function is now built into TANE Driver Additional Tools Menu)
−
−	'''Properties:'''
−	'''None'''
	==='''Junction Derailment Prevention Rule'''===		==='''Junction Derailment Prevention Rule'''===
Line 1,034:		Line 1,707:
	**'''[[#Set Cleared Junctions Rule|Set Cleared Junctions Rule]]''' - sets selected junctions to specific states (direction, locked/unlocked, allow/prevent AI control) while they are unoccupied.		**'''[[#Set Cleared Junctions Rule|Set Cleared Junctions Rule]]''' - sets selected junctions to specific states (direction, locked/unlocked, allow/prevent AI control) while they are unoccupied.
	**'''[[#Set Junctions Rule|Set Junctions Rule]]''' - sets selected junctions to specific states (direction, locked/unlocked, allow/prevent AI control).		**'''[[#Set Junctions Rule|Set Junctions Rule]]''' - sets selected junctions to specific states (direction, locked/unlocked, allow/prevent AI control).
−	----
−	'''[[#top|Back to Top]]''' | '''[[#A, B|A, B]]''' | '''[[#C|C]]''' | '''[[#D|D]]''' | '''[[#E, F, G|E, F, G]]''' | '''[[#H, I, J|H, I, J]]''' | '''[[#K, L, M|K, L, M]]''' | '''[[#N, O|N, O]]''' | '''[[#P, Q|P, Q]]''' | '''[[#R|R]]''' | '''[[#S-Se|S-Se]]''' | '''[[#Sh-Sz|Sh-Sz]]''' | '''[[#T|T]]''' | '''[[#U, V|U, V]]''' | '''[[#W, X, Y, Z|W, X, Y, Z]]'''
−
−	=='''K, L, M'''==
	==='''Lock All Junctions Rule'''===		==='''Lock All Junctions Rule'''===
Line 1,057:		Line 1,726:
	**'''[[#Set Junctions Rule|Set Junctions Rule]]''' - sets selected junctions to specific states (direction, locked/unlocked, allow/prevent AI control).		**'''[[#Set Junctions Rule|Set Junctions Rule]]''' - sets selected junctions to specific states (direction, locked/unlocked, allow/prevent AI control).
−	==='''MaxPermittedSpeed Rule'''===	+	==='''MissionCode Manager Rule (SP2 and later)'''===
−	Sets the maximum permitted speed of locomotives under AI control	+	Enables the addition, editing and management of Mission Codes used to auto select paths in '''Interlocking Towers'''.
−	*'''<kuid2:60850:89000:7>'''	+	*'''<kuid2:61392:8200:50>'''
		+
		+	*'''DLS Rule''' by '''pguy'''
		+
		+	ENTRY UNDER CONSTRUCTION
		+
		+	*'''Trainz Wiki Links:'''
		+	**'''http://online.ts2009.com/mediaWiki/index.php/MissionCodes_Manager'''
		+
		+	==='''MissionCode Stops and Timetable Manager Rule (SP2 and later)'''===
		+
		+	Enables the creation, editing and management of stop zones and timetables for trains following a path defined using mission codes.
		+
		+	*'''<kuid2:61392:8300:50>'''
		+
		+	*'''DLS Rule''' by '''pguy'''
		+
		+	ENTRY UNDER CONSTRUCTION
		+
		+	*'''Trainz Wiki Links:'''
		+	**'''http://online.ts2009.com/mediaWiki/index.php/Mission_Code_Stops_and_TimeTables_Manager'''
		+
		+	==='''Multiple Junction Alignment Check Rule'''===
		+
		+	Executes child rules if specific junctions are set.
		+
		+	*'''<kuid:-25:168>'''
	*'''Built-in Rule'''		*'''Built-in Rule'''
		+
		+	*'''Parent Rule'''
		+
		+	'''Properties:'''
		+	'''Wait until ''<selection>''''' - select from:-
		+	'''any one''' - any of the junctions in the rule list (below) is set correctly
		+	'''all''' - ALL of the junctions in the rule list are set correctly
		+	'''''<Add junction>''''' - click to select a junction from the session list
		+	'''''<Add all>''''' - click to select ALL junctions in the session list
		+	'''''<Delete all>''''' - click to delete ALL selected junctions from the rule list
		+	For each selected junction:-
		+	'''''<setting>''''' - click to select one switch direction from:-
		+	'''Left'''
		+	'''Right'''
		+	'''Center'''
		+	'''Any'''
		+	'''''<remove>''''' - to delete this junction from the rule list
		+
		+	*'''Related Rules:'''
		+	**'''[[#Lock All Junctions Rule|Lock All Junctions Rule]]''' - locks all junctions against user control
		+	**'''[[#Set Cleared Junctions Rule|Set Cleared Junctions Rule]]''' - sets selected junctions to specific states (direction, locked/unlocked, allow/prevent AI control) while they are unoccupied.
		+	**'''[[#Set Junctions Rule|Set Junctions Rule]]''' - sets selected junctions to specific states (direction, locked/unlocked, allow/prevent AI control).
		+
		+	*'''Trainz Wiki Links:'''
		+	**'''[[How to Control Junctions in Sessions]]'''
		+
		+	==='''Set Cleared Junctions Rule'''===
		+
		+	Sets selected junctions to specific states (direction, locked/unlocked, allow/prevent AI control) while they are unoccupied. If a junction is occupied it waits until the junction is cleared. '''''Warning:'' not compatible with Interlocking Tower Assets'''
		+
		+	*'''<kuid2:131986:157661:1>'''
		+
		+	*'''DLS Rule''' by '''atilabarut'''
		+
		+	'''Properties:'''
		+	'''''Add Junction''''' - click to select a junction from the session junction list
		+	'''''Add All''''' - click to add ALL junctions in the session junction list
		+	'''''Delete All''''' - click to remove ALL entered junctions from the rule
		+	'''Junction Options:''' - for each selected junction:-
		+	'''''<direction>''''' - click to select the junction direction
		+	'''Left'''
		+	'''Center'''
		+	'''Right'''
		+	'''Don't change'''
		+	'''''<user control>''''' - click to select a user control option
		+	'''Locked''' - the junction setting cannot be changed by the user
		+	'''Unlocked''' - the junction setting can be changed by the user
		+	'''''<AI control>''''' - click to select AI control
		+	'''Allows AI control''' - an AI train can switch the junction
		+	'''Blocks AI control''' - an AI train cannot switch the junction
		+	'''''Remove''''' - click to remove this junction from the rule list
		+
		+	*'''Related Rules:'''
		+	**'''[[#Junction Derailment Prevention Rule|Junction Derailment Prevention Rule]]''' - sets opposing junctions ahead of a train to prevent derailments
		+	**'''[[#Lock All Junctions Rule|Lock All Junctions Rule]]''' - locks all junctions against user control
		+	**'''[[#Multiple Junction Alignment Check Rule|Multiple Junction Alignment Check Rule]]''' - executes child rules when junctions are aligned
		+	**'''[[#Set Junctions Rule|Set Junctions Rule]]''' - sets selected junctions to specific states (direction, locked/unlocked, allow/prevent AI control).
		+
		+	*'''Trainz Wiki Links:'''
		+	**'''[[How to Control Junctions in Sessions]]'''
		+
		+	==='''Set Junctions Rule'''===
		+
		+	Sets selected junctions to specific states (direction, locked/unlocked, allow/prevent AI control). '''''Warning:'' not compatible with Interlocking Tower Assets'''
		+
		+	*'''<kuid:-25:1065>'''
		+
		+	*'''Built-in Rule'''
		+
		+	'''Properties:'''
		+	'''''Add Junction''''' - click to select a junction from the session junction list
		+	'''''Add All''''' - click to add ALL junctions in the session junction list
		+	'''''Delete All''''' - click to remove ALL entered junctions from the rule
		+	'''Junction Options:''' - for each selected junction:-
		+	'''''<direction>''''' - click to select the junction direction
		+	'''Left'''
		+	'''Center'''
		+	'''Right'''
		+	'''Don't change'''
		+	'''''<user control>''''' - click to select a user control option
		+	'''Locked''' - the junction setting cannot be changed by the user
		+	'''Unlocked''' - the junction setting can be changed by the user
		+	'''''<AI control>''''' - click to select AI control
		+	'''Allows AI control''' - an AI train can switch the junction
		+	'''Blocks AI control''' - an AI train cannot switch the junction
		+	'''''Remove''''' - click to remove this junction from the rule list
		+
		+	*'''Related Rules:'''
		+	**'''[[#Junction Derailment Prevention Rule|Junction Derailment Prevention Rule]]''' - sets opposing junctions ahead of a train to prevent derailments
		+	**'''[[#Lock All Junctions Rule|Lock All Junctions Rule]]''' - locks all junctions against user control
		+	**'''[[#Multiple Junction Alignment Check Rule|Multiple Junction Alignment Check Rule]]''' - executes child rules when junctions are aligned
		+	**'''[[#Set Cleared Junctions Rule|Set Cleared Junctions Rule]]''' - sets selected junctions to specific states (direction, locked/unlocked, allow/prevent AI control) while they are unoccupied.
		+
		+	*'''Trainz Wiki Links:'''
		+	**'''[[How to Control Junctions in Sessions]]'''
		+
		+	==='''Set Signal Extended Rule'''===
		+
		+	Sets the state of a selected signal '''''Warning:'' not compatible with Interlocking Tower Assets'''
		+
		+	*'''<kuid2:47662:20002:4>'''
		+
		+	*'''Built-in Rule'''
		+
		+	'''Properties:'''
		+	'''''<Select signal>'' to ''<signal state>''''' - click to select a signal from the session list and click to select a state from the list -
		+	'''Automatic'''
		+	'''Stop'''
		+	'''Stop then Continue'''
		+	'''Caution Left'''
		+	'''Caution Right'''
		+	'''Caution'''
		+	'''Advance Caution Left'''
		+	'''Advance Caution Right'''
		+	'''Advance Caution'''
		+	'''Proceed Left'''
		+	'''Proceed Right'''
		+	'''Proceed'''
		+	'''Slow'''
		+	'''Medium'''
		+
		+	*'''Notes:'''
		+	:The signal must support the state selected otherwise there will be no change in the signal
		+
		+	*'''Related Rules:'''
		+	**'''[[#Trigger Multiple Signals Rule|Trigger Multiple Signals Rule]]''' - sets selected signals to DANGER (STOP) when selected triggers are activated
		+
		+	==='''Trigger Multiple Signals Rule'''===
		+
		+	Sets selected signals to DANGER (STOP) when selected triggers are activated. Signals will be at AUTOMATIC when the triggers are not activated.
		+
		+	*'''<kuid2:116387:26:1>'''
		+
		+	*'''DLS Rule''' by '''maggs'''
		+
		+	'''Properties:'''
		+	'''<add signal>''' - select a signal from the Session List. More than one signal can be added.
		+	'''<delete>''' - remove a signal from the rule.
		+	'''<add trigger>''' - select a trigger from the Session List. More than one trigger can be added.
		+	'''<delete>''' - remove a trigger from the rule.
		+
		+	*'''Related Rules:'''
		+	**'''[[#Set Signal Extended Rule|Set Signal Extended Rule]]''' -  sets a selected signal to a specific signal state
		+
		+	'''[[#top|Back to Top]]'''
		+	----
		+	=='''Message Rules'''==
		+
		+	==='''Close Message Popup Rule'''===
		+
		+	Closes open message popups
		+
		+	*'''<kuid:447264:1526>'''
		+
		+	*'''Built-in Rule'''
		+
		+	'''Properties:'''
		+	'''None'''
		+
		+	*'''Known Issues:'''
		+	:This rule only appears to work if it is a child of the rule that triggered the Message Popup Rule
		+
		+	*'''Related Rule:'''
		+	**'''[[#Message Popup Rule|Message Popup Rule]]''' - displays a pop-up browser window and waits for it to be closed.
		+
		+	*'''Trainz Wiki Links:'''
		+	**'''[[Message Popup Rule Applications]]'''
		+	**'''[[Message Popup Example|Message Popup Examples]]'''
		+
		+	==='''DestSign Table Rule'''===
		+
		+	Creates a list of destination names for a destination sign
		+
		+	*'''<kuid2:206816:99004:2>'''
		+
		+	*'''Built-in Rule'''
		+
		+	'''Properties:'''
		+	'''''<add destination>''''' - enter a destination name to be added to the destination sign roll
		+	'''''<import destinations from texture-group>''''' - select a list of destination names from session
		+	'''[Check Box] Enable industries/stations as destination''' - check to set
		+	'''[Check Box] Enable Track Marks as destinations''' - check to set
		+	'''[Check Box] Enable table of destinations''' - check to set
		+
		+	==='''Display HTML Pages Rule'''===
		+
		+	Creates a browser to display the listed HTML files in order as a navigable sequence of pages. This rule has been superseded by the '''Message Popup Rule'''
		+
		+	*'''<kuid:-25:442>'''
		+
		+	*'''Legacy Rule''' (replaced by '''Message Popup Rule''')
		+
		+	*'''Base Rule'''
		+
		+	'''Properties:'''
		+	'''''<Add Page>''''' - adds the HTML page ''index.html'' from the selected HTML asset
		+	'''''<index.html>''''' - click to change the page name. The extension ''.html'' is optional
		+	'''''<Add All>''''' - adds all HTML pages from the session list '''(this appears to be disabled in TANE)'''
		+	'''''<Delete All>''''' - delete all HTML pages from this property list
		+	'''[Check Box] Prevent user from exiting browser until all pages viewed'''
		+	'''[Check Box] Disable closing of browser window by user'''
		+	'''[Check Box] Disable browser window scrolling'''
		+	'''[Check Box] Make browser window invisible'''
		+	'''[Check Box] Set position-Under Construction!!!''' - not implemented
		+	'''[Check Box] Set size-Under Construction!!!''' - not implemented
		+	'''Use the page ''<index.html>'' from asset ''<select>'' as the hidden button''' - the link buttons at the bottom of the page will be taken from the selected page in the selected HTML asset
		+
		+	*'''Related Rules:'''
		+	**'''[[#Close Message Popup Rule|Close Message Popup Rule]]''' - closes a displayed pop-up browser window.
		+	**'''[[#Message Popup Rule|Message Popup Rule]]''' - displays a pop-up browser window and waits for it to be closed.
		+	**'''[[#Set HTML Page Rule|Set HTML Page Rule]]''' - sets parameters for the '''Display HTML Pages Rule'''
		+	**'''[[#Timed Limited Display HTML Rule (SP2 and later)|Timed Limited Display HTML Rule (SP2 and later)]]''' - displays a HTML page in a browser window for a set time.
		+
		+	==='''Display Video Rule'''===
		+
		+	Displays a page containing a video clip from a HTML asset in a browser window.
		+
		+	*'''<kuid:-25:138>'''
		+
		+	*'''Built-in Rule'''
		+
		+	'''Properties:'''
		+	'''Display page ''<index.html>'' of html asset ''<click to select>'' in a new browser window
		+	'''''index.html''''' - enter the filename of a HTML page in the selected HTML asset. The ''.html'' is optional in the filename.
		+	'''''<click to select>''''' - select the HTML asset from those installed.
		+
		+	*'''Notes:'''
		+	:Video must be in a valid web format.
		+
		+	*'''Related Rules:'''
		+	**'''[[#Play Sound Rule|Play Sound Rule]]''' - plays a wav sound file
		+
		+	==='''DisplayIndustryStatus Rule (color modified)'''===
		+
		+	Displays a summary of industry product levels when the "k" key is pressed.
		+
		+	*'''<kuid:622415:100001>'''
		+
		+	*'''DLS Rule''' by '''lockheed02''' and '''marzipan'''
	'''Properties:'''		'''Properties:'''
Line 1,069:		Line 2,003:
	*'''Notes:'''		*'''Notes:'''
−	:This rule cannot be configured from the Session Rules list. It must be configured in the '''config.txt''' file of each locomotive. Instructions with an example are shown in the rule Properties	+	:Pressing the '''k''' key in Driver mode will bring up a small window with a single link '''''Display Industry Status''''' (there may also be other links). Clicking this link will show the product levels of all industries.
−	==='''mc Display Custom HUD V2 Rule (SP2 and later)'''===	+	*'''Related Rules:'''
		+	**'''[[#ExTrainz Manager Rule - TANE SP2|ExTrainz Manager Rule - TANE SP2]]''' - displays information on consists, industries and products in Driver and Surveyor.
−	Shows or hides a graphical HUD which includes junction direction for the junction ahead. This rule has been superseded by the '''Quick CustomHUD Manager Rule (SP2 and later)'''	+	==='''ExTrainz Manager Rule - TANE SP2'''===
−	*'''<kuid2:61392:1072:10>'''	+	Provides information on consists, industries and products in both Surveyor and Driver modes. Once activated, the rule creates an additional short menu bar below the main menu bar.
−	*'''Legacy Rule''' (replaced by '''Quick CustomHUD Manager Rule (SP2 and later)''')	+	*'''<kuid:160293:10029>'''
−	*'''DLS Rule''' by '''pguy'''	+	*'''DLS Rule''' by '''trev999'''
	'''Properties:'''		'''Properties:'''
−	'''Show or Hide the Custom Heads up Display''' - select one of two option buttons:-	+	'''Diagnostic mode is ''<On/Off>''''' - click to select ''On'' or ''Off''. When set ''On'' diagnostic messages will be added to the Trainz Log file.
−	'''( ) Show the Custom Heads up Display'''	+	'''Turn on message overlay ''<Yes/No>''''' - click to select ''Yes'' or ''No''. When set to ''Yes'' the message overlay (lower left of screen) will be active.
−	'''( ) Hide the Custom Heads up Display'''	+	'''Show rolling stock in Driver mode ''<Yes/No>''''' - click to select ''Yes'' or ''No''. When set to ''Yes'' rolling stock can be searched in Driver.
		+	'''Search only rolling stock already in session ''<Yes/No>''''' - click to select ''Yes'' or ''No''. When set to ''Yes'' only those rolling stock assets
		+	installed in the session can be searched.
		+	'''Graphic colours: ''<When Red, the industry does not require service/When Green, the industry does not require service>''''' - click to switch
		+	between the two colour options.
		+	'''Industry page size: ''<value>''''' - enter the number of industries to be displayed in the Industry List window (maximum 250).
		+	'''The following industries are excluded: ''<Add an industry to be excluded>''''' - name can be complete (e.g. "Coal Mine 2")
		+	which will exclude that specific industry from the management list, or partial (e.g. "Coal") which will exclude all
		+	industries with the word "Coal" in their names. Entries are not case sensitive.
		+	Once industries have been excluded, additional commands will appear for each excluded industry:-
		+	'''''<delete> <industry name begins with/class name begins with> <name>''''' - click ''delete'' to remove this entry.
		+	- click ''industry name begins with/class name begins with'' to select between the two (see ''notes'' below).
		+	- click ''name'' to edit the name.
		+
		+	*'''Notes:'''
		+	#Rolling stock installed in '''TANE''' or in the current session only (see settings above) can be searched to find a match for any selected product from any industry. In Surveyor (and Driver if that setting is enabled) click on the '''View Products''' sub menu link and click on a product name in the '''Product Window''' to display a list of all compatible rolling stock for that product.
		+	#Alternatively, click on the '''View Industries''' sub menu link and then click on a ''Product Icon'' to open a '''Product Window''', then click    on the '''''View Rolling Stock''''' link at the top of the window.
		+	#Industry class names are defined in the config.txt file of industry assets and are not normally accessible by users. However, you can exclude an entire group of related "industry asset classes" such as ''station'', ''coalingtower'', ''watertank'', etc regardless of their actual names provided those assets have been given that "class name" by their creators.
		+
		+	*'''Known Issues:'''
		+	:This rule is NOT compatible with all industries.
	*'''Related Rules:'''		*'''Related Rules:'''
−	**'''[[#Display Custom HUD Rule|Display Custom HUD Rule]]''' - shows or hides the Custom Heads Up Display.	+	**'''[[#DisplayIndustryStatus Rule (color modified)|DisplayIndustryStatus Rule (color modified)]]''' - displays information on industry product levels.
−	**'''[[#Flash HUD Icon Rule|Flash HUD Icon Rule]]''' - flashes a HUD panel icon for a set duration.	+
−	**'''[[#Quick CustomHud Manager Rule (SP2 and later)|Quick CustomHud Manager Rule (SP2 and later)]]''' - creates custom HUDs that can be assigned to different drivers	+	==='''Fade In/Out Rule'''===
−	**'''[[#Show/Hide HUD Panel Rule|Show/Hide HUD Panel Rule]]''' - shows or hides a HUD panel.	+
−	**'''[[#Variable Show Rule|Variable Show Rule]]''' - adds or removes a specified variable and a descriptive label to the custom HUD.	+	Fade in or out within seconds, using specified color and opacity values.
−	**'''[[#Wait for Click on HUD Icon Rule|Wait for Click on HUD Icon Rule]]''' - executes child rules when a HUD icon is clicked	+
		+	*'''<kuid2:190611:200000:2>'''
		+
		+	*'''Built-in Rule'''
		+
		+	'''Properties:'''
		+	'''Red percentage:            ''<value>''''' - enter the final % of red (0 = none, 100 = maximum)
		+	'''Green percentage:          ''<value>''''' - enter the final % of green
		+	'''Blue percentage:            ''<value>''''' - enter the final % of blue
		+	'''Alpha percentage (opacity): ''<value>''''' - enter the final % of opacity (0 = invisible, 100 = solid)
		+	'''Fading duration:            ''<value>''''' - enter the number of seconds required for the fade
		+	'''''<help>''''' - click to bring up help instructions
		+
		+	*'''Notes:'''
		+	:Seconds are Trainz clock time, not real time.
		+
		+	==='''Hide Product Overlays Rule'''===
		+
		+	Hides the commodity or product bar graphs that appear on active industries
		+
		+	*'''<kuid:400048:100970>'''
		+
		+	*'''DLS Rule''' by '''callavsg'''
		+
		+	'''Properties:'''
		+	'''None'''
		+
		+	==='''InputTable Rule'''===
		+
		+	Creates a list of message names to be used for various purposes including passing data to '''Driver Commands'''
		+
		+	*'''<kuid2:131986:1012:1>'''
		+
		+	*'''Built-in Rule'''
		+
		+	'''Properties:'''
		+	'''''<add>''''' - click to add a new entry to the table
		+	Each new entry will require an input message
		+	'''''<short message>''''' - enter a message. The message must be in a format that is specific for each purpose
		+	For the '''MoveTurntable''' driver command the message must be formatted as:-
		+	'''turntable,name_of_turntable,number_of_connecting_roads''' - the first entry must be the word ''turntable'' in lower case.
		+	''name_of_turntable'' is the name of the turntable,
		+	''number_of_connecting_roads'' is the number of tracks connecting to the turntable
		+	For the '''WaitUntilTime''' driver command the message must be formatted as:-
		+	'''time,hour,minute''' - the first entry must be the word ''time'' in lower case,
		+	''hour'' must be from 0 to 23,
		+	''minute'' must be from 0 to 59.
		+	For the '''WaitUntilSVariable''' driver command the message must be formatted as:-
		+	'''svar,svar_name,svar_condition,value''' - the first entry must be the word ''svar'' in lower case,
		+	''svar_name'' is the name of the session variable,
		+	''svar_condition'' is an equality (eg eq for equal, gt for greater than, etc)
		+	''value'' is an integer value to be compared to the session variable.
		+	Each entry in the table will be followed by the commands:-
		+	'''''cp''''' - click to copy this entry to a new entry
		+	'''''up''''' - click to move this entry up one level
		+	'''''dn''''' - click to move this entry down one level
		+	'''''rm''''' - click to remove this entry from the table
	==='''Message Popup Rule'''===		==='''Message Popup Rule'''===
Line 1,174:		Line 2,185:
	**'''[[#Show/Hide Minimap Rule|Show/Hide Minimap Rule]]''' - shows the minimap window in Driver.		**'''[[#Show/Hide Minimap Rule|Show/Hide Minimap Rule]]''' - shows the minimap window in Driver.
−	==='''MissionCode Manager Rule (SP2 and later)'''===	+	==='''Play Sound Rule'''===
−	Enables the addition, editing and management of Mission Codes used to auto select paths in '''Interlocking Towers'''.	+	Plays a wav sound file.
−	*'''<kuid2:61392:8200:50>'''	+	*'''<kuid:-25:1045>'''
−	*'''DLS Rule''' by '''pguy'''	+	*'''Built-in Rule'''
−	ENTRY UNDER CONSTRUCTION	+	'''Properties:'''
		+	'''Default HTML ''<Click>''''' - click to to enter Sound File Name
		+	'''HTML Assets ''<Click>''''' - click to select HTML asset
		+	'''Rule Completes ''<Click>''''' -  to select one of:-
		+	'''sound has just started'''
		+	'''sound has finished playing'''
−	*'''Trainz Wiki Links:'''	+	*'''Related Rules:'''
−	**'''http://online.ts2009.com/mediaWiki/index.php/MissionCodes_Manager'''	+	**'''[[#Display Video Rule|Display Video Rule]]''' - displays a page containing a video clip from a HTML asset in a browser window
−	==='''MissionCode Stops and Timetable Manager Rule (SP2 and later)'''===	+	==='''Session Metadata Rule'''===
−	Enables the creation, editing and management of stop zones and timetables for trains following a path defined using mission codes.	+	Sets session metadata in the config file. Info can be read by other systems and displayed to the player.
−	*'''<kuid2:61392:8300:50>'''	+	*'''<kuid:401543:2036>'''
−	*'''DLS Rule''' by '''pguy'''	+	*'''Base Rule'''
−	ENTRY UNDER CONSTRUCTION	+	'''Properties:'''
		+	'''Type ''<Click>''''' - click to select one of:-
		+	'''Simulation'''
		+	'''Challenge'''
		+	'''Length ''<value>''''' - to enter number of minutes, default is 30 minutes
		+	'''Difficulty ''<Click>''''' - click to select one of:-
		+	'''Normal''' - default
		+	'''Tutorial'''
		+	'''Easy'''
		+	'''Hard'''
		+	'''Expert'''
−	*'''Trainz Wiki Links:'''	+	*'''Notes:'''
−	**'''http://online.ts2009.com/mediaWiki/index.php/Mission_Code_Stops_and_TimeTables_Manager'''	+	:Time is Trainz clock time, not real time
−	==='''Multiplayer Rule'''===	+	==='''Set Helper Icon Size Rule'''===
−	Enables the session to be taken online in a Multiplayer environment.	+	Sets the size of helper icons such as the junction lever arrows.
−	*'''<kuid:447264:1045>'''	+	*'''<kuid:-25:791>'''
	*'''Built-in Rule'''		*'''Built-in Rule'''
	'''Properties:'''		'''Properties:'''
−	'''Suggested maximum number of players for this session ''<value>''''' - enter a number	+	'''Junction Arrows Size ''<Click>''''' - to set scale ratio smaller than default, default is 100%
−	'''Maximum number of drivers per player ''<value>''''' - enter a number	+
−	'''Players are permitted to claim drivers            [Check Box]''' - check to allow players to select a driver	+
−	'''Players can see each other's driver orders        [Check Box]''' - check to allow players to view orders for other players	+
−	'''Automatically target an available train on clients [Check Box]''' - automatically assign a driver to each player	+
−	==='''Multiple Junction Alignment Check Rule'''===	+	==='''Set HTML Pages Rule'''===
−	Executes child rules if specific junctions are set.	+	Instructs the Display HTML Pages rule to perform specific operations. This rule has been superseded by the '''Message Popup Rule'''
−	*'''<kuid:-25:168>'''	+	*'''<kuid:-25:792>'''
		+
		+	*'''Legacy Rule''' (replaced by '''Message Popup Rule''')
	*'''Built-in Rule'''		*'''Built-in Rule'''
−
−	*'''Parent Rule'''
	'''Properties:'''		'''Properties:'''
−	'''Wait until ''<selection>''''' - select from:-	+	'''Operations to preform on the display HTML pages sequence browser'''
−	'''any one''' - any of the junctions in the rule list (below) is set correctly	+	Select one of six option buttons:-
−	'''all''' - ALL of the junctions in the rule list are set correctly	+	'''( ) to instruct the sequence browser to ''<select>''''' - to choose page operations
−	'''''<Add junction>''''' - click to select a junction from the session list	+	'''( ) to instruct the sequence browser to open the page ''<select>''''' - enter the HTML page name
−	'''''<Add all>''''' - click to select ALL junctions in the session list	+	'''( ) to set browser parameters ''<select>''''' - choose one of:-
−	'''''<Delete all>''''' - click to delete ALL selected junctions from the rule list	+	'''to Enable/Disable closing of the browser window by the user'''
−	For each selected junction:-	+	'''to Enable/Disable scrolling on the sequence browser window'''
−	'''''<setting>''''' - click to select one switch direction from:-	+	'''to Show/Hide the sequence browser window'''
−	'''Left'''	+	'''( ) Set the following flag for the page named ''<select>''''' - enter the HTML page name
−	'''Right'''	+	'''[Check Box] Hide/Close window on 'done' action'''
−	'''Center'''	+	'''[Check Box] Window has no 'done' button'''
−	'''Any'''	+	'''[Check Box] Disable scrolling(not implemented yet)'''
−	'''''<remove>''''' - to delete this junction from the rule list	+	'''[Check Box] Spare setting 1'''
		+	'''[Check Box] Spare setting 2'''
		+	'''[Check Box] Spare setting 3'''
		+	'''[Check Box] Spare setting 4'''
		+	'''[Check Box] Spare setting 5'''
		+	'''( ) Use the page ''<select>''''' (enter HTML page name) '''from the HTML asset ''<select>''''' (select HTML asset)
		+	'''( ) Use the string table entry ''<select>''''' (enter Index) '''from the HTML asset ''<select>''''' (select HTML asset)
	*'''Related Rules:'''		*'''Related Rules:'''
−	**'''[[#Lock All Junctions Rule|Lock All Junctions Rule]]''' - locks all junctions against user control	+	**'''[[#Display HTML Pages Rule|Display HTML Pages Rule]]''' - displays HTML pages in a browser window.
−	**'''[[#Set Cleared Junctions Rule|Set Cleared Junctions Rule]]''' - sets selected junctions to specific states (direction, locked/unlocked, allow/prevent AI control) while they are unoccupied.	+	**'''[[#Message Popup Rule|Message Popup Rule]]''' - displays a pop-up browser window and waits for it to be closed.
−	**'''[[#Set Junctions Rule|Set Junctions Rule]]''' - sets selected junctions to specific states (direction, locked/unlocked, allow/prevent AI control).	+	**'''[[#Timed Limited Display HTML Rule (SP2 and later)|Timed Limited Display HTML Rule (SP2 and later)]]''' - displays a HTML page in a browser window for a set time.
		+
		+	==='''Show/Hide Layer Rule'''===
		+
		+	Shows or hides a layer from Driver.
		+
		+	*'''<kuid2:401543:1170:1>'''
		+
		+	*'''Built-in Rule'''
		+
		+	'''Properties:'''
		+	'''''<visibility>''''' - select one of two options
		+	'''Show''' - select to make the layer visible
		+	'''Hide''' - select to make the layer invisible
		+	'''''<click here to set>''''' - enter name of layer. Name is case sensitive.
		+
		+	*'''Known Bugs:'''
		+	:Layers set to '''Hide''' when a game is saved will be '''Shown''' when the game is reloaded
		+
		+	*'''Known Issues:'''
		+	:Rule will NOT check to see if the named layer exists or not
	*'''Trainz Wiki Links:'''		*'''Trainz Wiki Links:'''
−	**'''[[How to Control Junctions in Sessions]]'''	+	**'''[[How to Use Layers#Layers in Driver Mode|How to Use Layers: Layers in Driver Mode]]
−	==='''Multiple Resource Check Rule'''===	+	==='''Show/Hide Minimap Rule'''===
−	Executes child rules if industries or vehicles reach set commodity levels. This rule replaces the older '''Resource Check Rule'''	+	Shows the minimap window in Driver.
−	*'''<kuid:-25:656>'''	+	*'''<kuid:-25:794>'''
		+
		+	*'''Built-in Rule'''
		+
		+	'''Properties:'''
		+	'''''<Show/Hide>'' the driver Minimap Window''' - click to switch between '''Show''' and '''Hide'''.
		+
		+	*'''Related Rules:'''
		+	**'''[[#Minimap Options Rule|Minimap Options Rule]]''' - sets the display options for the minimap.
		+
		+	==='''Show/Hide On-screen Help Rule'''===
		+
		+	Shows or hides On-screen help in Driver.
		+
		+	*'''<kuid:401543:2020>'''
		+
		+	*'''Built-in Rule'''
		+
		+	'''Properties:'''
		+	'''On screen help (junction overlays, etc)''' - select one of three option buttons:-
		+	'''( ) Show
		+	'''( ) Hide
		+	'''( ) Leave Unchanged
		+	'''On Screen Vehicle Names:''' -  - select one of three option buttons:-
		+	'''( ) Show
		+	'''( ) Hide
		+	'''( ) Leave Unchanged
		+
		+	==='''Timed Limited Display HTML Rule (SP2 and later)'''===
		+
		+	Displays an HTML browser window for a limited time.
		+
		+	*'''<kuid2:61392:2005:32>'''
		+
		+	*'''DLS Rule''' by '''pguy'''
		+
		+	'''Properties:'''
		+	'''HTML Asset Name : ''<[Click to select HTML asset]>''''' - click to select an HTML asset from those installed
		+	'''Page filename : ''<value>''''' - click to enter the filename of the HTML page in the selected HTML asset. The ''.html'' filename extension is optional.
		+	'''Play duration (SessVar or duration in seconds) : ''<value>''''' - enter a SessVar name or the number of seconds.
		+	'''Browser left position (SessVar or position) : ''<value>''''' - enter a SessVar name or the number of pixels from the left screen edge.
		+	'''Browser top position (SessVar or position) : ''<value>''''' - enter a SessVar name or the number of pixels from the top screen edge.
		+	'''Browser width (SessVar or position) : ''<value>''''' - enter a SessVar name or the width in pixels.
		+	'''Browser height (SessVar or position) : ''<value>''''' - enter a SessVar name or the browser height.
		+	'''[Check Box] ''<Alert is not reshowable on request/Alert is showable on request>''''' - check or click to allow or prevent the user viewing the page again.
		+
		+	*'''Notes:'''
		+	:Seconds are Trainz clock time, not real time.
		+
		+	*'''Related Rules:'''
		+	**'''[[#Close Message Popup Rule|Close Message Popup Rule]]''' - closes open message popups
		+	**'''[[#Display HTML Pages Rule|Display HTML Pages Rule]]''' - displays HTML pages in a browser window.
		+	**'''[[#Message Popup Rule|Message Popup Rule]]''' - displays a pop-up browser window and waits for it to be closed.
		+	**'''[[#Set HTML Page Rule|Set HTML Page Rule]]''' - sets parameters for the '''[[#Display HTML Pages Rule|Display HTML Pages Rule]]'''
		+	==='''Wait on Waybill Screen/Main Screen Rule'''===
		+
		+	Executes child rules when the Waybill window is opened or closed
		+
		+	*'''<kuid:-25:957>'''
	*'''Built-in Rule'''		*'''Built-in Rule'''
Line 1,259:		Line 2,365:
	'''Properties:'''		'''Properties:'''
−	'''<Product Level>''' - click to select a product test from two choices:-	+	'''[Check Box] Trigger rule once''' - check to trigger the rule once only
−	'''''Reach/Exceed''''' - sets an upper limit for the resources being monitored.	+	'''Wait for the Waybill window to be ''<opened/closed>''''' - select either '''opened''' or '''closed'''.
−	For example: the rule will be triggered if the quantity of coal in a coal loader stockpile or a coal wagon reaches or exceeds a specified level.	+
−	The initial level in the object must be below the set upper limit.	+	'''[[#top|Back to Top]]'''
−	'''''Fall below''''' - sets a lower limit for the resources being monitored.	+	----
−	For example: the rule will be triggered if the quantity of coal in a coal loader stockpile or a coal wagon falls below a specified level.	+	=='''Miscellaneous Rules'''==
−	The initial level in the object must be above the set lower limit.	+
−	To test when a resource level reaches zero (i.e. is empty) set the lower limit to a very low value but not zero as the level can never fall below zero.	+	Some of these rules have no user accessible functions but may be used by other rules. Others do not fit in any other category.
−	'''''<value>''''' - enter required quantity value	+
−	'''''<select>''''' - select a product from session list of products	+	==='''ConsistDataHandler Rule'''===
−	'''''<Add object>''''' - click to select a source or target object. Multiple objects and their queues can be added to the rule.	+
−	ALL the entered products must reach/exceed or fall below the specified value for the rule to be triggered.	+	Was used by the '''QuickDrive Rule''' to place consists onto a route. Now obsolete.
−	For each object:-	+
−	'''''<Object>''''' - click to select session active industry or product enabled rail vehicle	+	*'''<kuid:401543:1180>'''
−	'''''<Queue>''''' - select product queue (there may be only one available)	+
−	'''''<Remove>''''' - removes the object and its product queue from the rule	+	*'''Obsolete Rule''' (function is now built into '''TANE''')
		+
		+	*'''Base Rule'''
		+
		+	'''Properties:'''
		+	'''None'''
		+
		+	==='''Custom Script Rule'''===
		+
		+	No description
		+
		+	*'''<kuid:447264:1526>'''
		+
		+	*'''Built-in Rule'''
		+
		+	'''Properties:'''
		+	'''None'''
		+
		+	==='''Generic TreeNode Debug Window Rule'''===
		+
		+	No description.
		+
		+	*'''<kuid:30501:1042>'''
		+
		+	*'''Base Rule'''
		+
		+	'''Properties:'''
		+	'''None'''
		+
		+	==='''Session Debug Rule'''===
		+
		+	Executes the first child if ''Debug'' mode is selected. Otherwise executes the second child rule.
		+
		+	*'''<kuid:30501:100180>'''
		+
		+	*'''Built-in Rule'''
		+
		+	*'''Parent Rule'''
		+
		+	'''Properties:'''
		+	'''None'''
		+
		+	*'''Notes:'''
		+	:When a session starts with this rule enabled, the player will be given the choice of running the session in '''''Debug''''' or '''''Normal''''' mode. Selecting ''Debug'' will execute the first child rule. Selecting ''Normal'' will execute the second child rule.
		+
		+	'''[[#top|Back to Top]]'''
		+	----
		+	=='''Navigation Rules'''==
		+
		+	==='''Directional Trigger Check Rule'''===
		+
		+	Executes child rules when a set train enters a set trigger in a set direction. Adds direction to the '''Trigger Check Rule'''.
		+
		+	*'''<kuid2:532391:100003:1>'''
		+
		+	*'''DLS Rule''' by '''bobhahn'''
		+
		+	'''Properties:'''
		+	'''[Check Box] Trigger only once '''
		+	'''[Check Box] Wait for child rules to complete even if no trains are present in rule trigger'''
		+	'''[Check Box] Only activate when the entering vehicle of the train is heading ''<select direction>'' into the trigger''' - select one of two directions:-
		+	'''''forward'''''
		+	'''''backward'''''
		+	'''Triggers List'''
		+	'''''<add trigger>''''' - select a trigger from the session list
		+	'''''<delete trigger>''''' - delete a selected trigger from the rule
		+	Select one of two option buttons:-
		+	'''( ) click to accept all trains'''
		+	'''( ) click to accept trains matching specific criteria'''
		+	Selecting the second option will produce the following selection controls:-
		+	'''Specific vehicle''' - identify the specific vehicle(s) that will trigger the rule
		+	'''''+''''' - click to add a ''specific'' vehicle from the session list
		+	'''''x''''' - click to remove the ''specific'' vehicle from the rule
		+	'''Vehicle types''''' - identify the ''type'' of vehicle(s) that will trigger the rule
		+	'''''+''''' - click to add a ''type'' of vehicle from the session list
		+	'''''x''''' - click to remove the ''type'' of vehicle from the rule
		+	'''Drivers''''' - identify the ''driver(s)'' that will trigger the rule
		+	'''''+''''' - click to add a ''driver'' from the session list
		+	'''''x''''' - click to remove a ''driver'' from the rule
	*'''Notes:'''		*'''Notes:'''
−	:This rule only checks for ''changing'' commodity levels during loading and unloading operations. It cannot be used to test, for example, if a vehicle is ''full'' or ''empty''.	+	#This rule works best when used with the '''Directional Trigger''' track object available on the DLS.
		+	#The Directional Trigger, when installed, will appear as a ''Signal'' not as a ''Trackmark''.
		+	#Normal (non directional) triggers can be used with this rule but the rule will have no direction sensitivity apart from the ''forward'' and ''backward'' in the rule properties.
	*'''Related Rules:'''		*'''Related Rules:'''
−	**'''[[#Resource Check Rule|Resource Check Rule]]''' - executes child rules when set resource (commodity) levels are reached	+	**'''[[#Trackside Check Rule|Trackside Check Rule]]''' - executes child rules when activated by a train. Provides different options to the '''Trigger Check Rule'''
−	**'''[[#Resource Verify Rule (fixed)|Resource Verify Rule (fixed)]]''' - executes child rules when a set resource (commodity) level is reached	+	**'''[[#Trigger Check Rule|Trigger Check Rule]]''' - executes child rules when a set train enters a set trigger (non-directional)
	*'''Trainz Wiki Links:'''		*'''Trainz Wiki Links:'''
		+	**'''[[How to Control Signals in Sessions#Application 2: Halt Before Clear|How to Control Signals in Sessions: Halt Before Clear]]'''
		+	**'''[[Message Popup Rule Applications]]'''
	**'''[[How to Use Navigation Point Rules (Applications)#Application 3: Wait for Loading to be Completed|How to Use Navigation Point Rules (Applications): Wait for Loading to be Completed]]'''		**'''[[How to Use Navigation Point Rules (Applications)#Application 3: Wait for Loading to be Completed|How to Use Navigation Point Rules (Applications): Wait for Loading to be Completed]]'''
−	----	+	**'''[[How to Use Track Triggers]]'''
−	'''[[#top|Back to Top]]''' | '''[[#A, B|A, B]]''' | '''[[#C|C]]''' | '''[[#D|D]]''' | '''[[#E, F, G|E, F, G]]''' | '''[[#H, I, J|H, I, J]]''' | '''[[#K, L, M|K, L, M]]''' | '''[[#N, O|N, O]]''' | '''[[#P, Q|P, Q]]''' | '''[[#R|R]]''' | '''[[#S-Se|S-Se]]''' | '''[[#Sh-Sz|Sh-Sz]]''' | '''[[#T|T]]''' | '''[[#U, V|U, V]]''' | '''[[#W, X, Y, Z|W, X, Y, Z]]'''	+	**'''[[How to Use Variables in Sessions (Examples)]]'''
−		+
−	=='''N, O'''==	+
	==='''Navigation Display Rule'''===		==='''Navigation Display Rule'''===
Line 1,443:		Line 2,629:
	**'''[[How to Use Navigation Point Rules]]'''		**'''[[How to Use Navigation Point Rules]]'''
−	==='''Objective Add Rule'''===	+	==='''Schedule Rule'''===
−	Sets up a game Objective with ID and display Name	+	Allows a schedule of timed events to be applied to a train
−	*'''<kuid:401543:2001>'''	+	*'''<kuid:-3:10185>'''
	*'''Base Rule'''		*'''Base Rule'''
	'''Properties:'''		'''Properties:'''
−	'''Priority ''<Select>''''' - select one of:-	+	'''Insert track mark ''<select>''''' - select a track mark from the Session List
−	'''''Above Normal'''''	+	'''Arrival and Departure Time ''<Select>''''' - set time
−	'''''Below Normal'''''	+	'''''hh:mm:ss''''' - in hours/minutes/seconds
−	'''''Normal'''''	+	'''Current Train ''<select>''''' - select from session list
−	'''''Optional'''''	+	'''Insert destination ''<select>''''' - select from session list
−	'''''Urgent'''''	+
−	'''Completion Target Number ''<value>''''' - to set Completion Target Number	+	*'''Notes:'''
−	'''Icon ''<select>''''' - to select Icon from list	+	:Times are Trainz clock times, not real time
−	'''Display Name ''<enter>''''' - to insert Name	+
−	'''Unique Objective ID ''<enter>''''' - enter a unique objective ID	+
−	'''Custom Message ''<Text Box>''''' - insert typed message in text area	+
	*'''Related Rules:'''		*'''Related Rules:'''
−	**'''[[#Objective Check Rule|Objective Check Rule]]''' - executes child rules if an objective is completed	+	**'''[[#Driver Command Check Rule|Driver Command Check Rule]]''' - executes child rules if the driver commands match a set list
−	**'''[[#Objective Update Rule|Objective Update Rule]]''' - changes the progress of a game objective	+	**'''[[#Driver Command Rule|Driver Command Rule]]''' - specifies which commands will be available for the drivers
		+	**'''[[#Driver Schedule Rule|Driver Schedule Rule]]''' - sets up a list of basic scheduled driver commands
		+	**'''[[#Driver Setup Rule|Driver Setup Rule]]''' - creates a list of drivers and assign them their orders
		+	**'''[[#Enable/Disable Driver Commands Rule|Enable/Disable Driver Commands Rule]]''' - enable/disable specific driver commands on certain drivers
−	==='''Objective Check Rule'''===	+	==='''Trackside Check Rule'''===
−	Executes child rules if an objective created with the '''Objective Add Rule''' is complete.	+	Executes child rules when a set train enters a set trigger. Similar to the '''Trigger Check Rule''' but provides different options.
−	*'''<kuid:401543:2003>'''	+	*'''<kuid2:46162:100207:1>'''
−	*'''Base Rule'''	+	*'''DLS Rule''' by '''Josefpav'''
	*'''Parent Rule'''		*'''Parent Rule'''
	'''Properties:'''		'''Properties:'''
−	'''Unique Objective ID ''<value>''''' - enter the unique ID created with the '''Objective Add Rule'''	+	'''Applies to:''' - select one of three option buttons:-
−	'''Mode ''<select>''''' - select one of three:-	+	'''( ) Junction'''
−	'''''Wait for completion'''''	+	'''( ) Trigger'''
−	'''''Wait for failure'''''	+	'''( ) Trackmark'''
−	'''''Wait for progress'''''	+	'''Trackside object name: ''<specify>''''' - select object name from session list
		+	'''Wait for train to:''' - select one of three option buttons:-
		+	'''( ) Enter'''
		+	'''( ) Stop at'''
		+	'''( ) Leave'''
		+	'''[Check Box] Auto reset this rule''' - check to execute the rule continuously
		+	'''Applies to train containing:'''
		+	'''''<Add vehicle>''''' - click to select a rail vehicle from the session list
		+	'''''del''''' - click to remove a selected vehicle from the rule
	*'''Related Rules:'''		*'''Related Rules:'''
−	**'''[[#Objective Add Rule|Objective Add Rule]]''' - sets up a game objective	+	**'''[[#Directional Trigger Check Rule|Directional Trigger Check Rule]]''' - executes child rules when activated by a train moving in a set direction.
−	**'''[[#Objective Update Rule|Objective Update Rule]]''' - changes the progress of a game objective	+	**'''[[#Trigger Check Rule|Trigger Check Rule]]''' - executes child rules when activated by a train
−	==='''Objective Update Rule'''===	+	==='''Trigger Check Rule'''===
−	Changes progress of an objective outcome created with the '''Objective Add Rule''' according to Property choices	+	Executes child rules when a set train enters a set trigger. This rule replaces the older and less versatile '''Trigger Rule'''.
−	*'''<kuid:401543:2002>'''	+	*'''<kuid:-25:1071>'''
−		+
−	*'''Base Rule'''	+
−		+
−	'''Properties:'''	+
−	'''Unique Objective ID ''<value>''''' - enter the unique ID created with the '''Objective Add Rule'''	+
−	'''Mode ''<select>''''' - select one from the following options	+
−	'''''Decrement progress'''''	+
−	'''''Increment progress'''''	+
−	'''''Reset Objective'''''	+
−	'''''Set objects as complete'''''	+
−	'''''Set objects as failed'''''	+
−	'''''Set progress'''''	+
−	'''''Set progress only if greater'''''	+
−	'''Amount ''<value>''''' - click to enter a value	+
−		+
−	*'''Related Rules:'''	+
−	**'''[[#Objective Add Rule|Objective Add Rule]]''' - sets up a game objective	+
−	**'''[[#Objective Check Rule|Objective Check Rule]]''' - executes child rules if an objective is completed	+
−		+
−	==='''Ordered List Rule'''===	+
−		+
−	Executes child rules in order once this rule starts	+
−		+
−	*'''<kuid:-25:171>'''	+
	*'''Built-in Rule'''		*'''Built-in Rule'''
Line 1,524:		Line 2,694:
	'''Properties:'''		'''Properties:'''
		+	'''[Check Box] Trigger only once '''
		+	'''[Check Box] Wait for child rules to complete even if no trains are present in rule trigger'''
		+	'''[Check Box] Only activate when the entering vehicle of the train is heading ''<select direction>'' into the trigger''' - select one of two directions:-
		+	'''''forward'''''
		+	'''''backward'''''
		+	'''Triggers List'''
		+	'''''<add trigger>''''' - select a trigger from the session list
		+	'''''<delete trigger>''''' - delete a selected trigger from the rule
	Select one of two option buttons:-		Select one of two option buttons:-
−	'''( ) This process will repeat ''<value>'' time(s)''' - enter the number of times this rule is to be repeated	+	'''( ) click to accept all trains'''
−	'''( ) This process will repeat forever'''	+	'''( ) click to accept trains matching specific criteria'''
−		+	Selecting the second option will produce the following selection controls:-
−	*'''Known Issues:'''	+	'''Specific vehicle''' - identify the specific vehicle(s) that will trigger the rule
−	:Some child rules will force a "wait" until certain conditions have been met (e.g. a mouse click or a set time has passed). These rules will delay the completion of any following child rules in the '''Ordered List Rule'''. If possible, place these rules last in the Ordered List.	+	'''''+''''' - click to add a ''specific'' vehicle from the session list
−	::For example: The '''Message Popup Rule''' will wait until it is closed before allowing the next child rule to be executed.	+	'''''x''''' - click to remove the ''specific'' vehicle from the rule
		+	'''Vehicle types''''' - identify the ''type'' of vehicle(s) that will trigger the rule
		+	'''''+''''' - click to add a ''type'' of vehicle from the session list
		+	'''''x''''' - click to remove the ''type'' of vehicle from the rule
		+	'''Drivers''''' - identify the ''driver(s)'' that will trigger the rule
		+	'''''+''''' - click to add a ''driver'' from the session list
		+	'''''x''''' - click to remove a ''driver'' from the rule
	*'''Related Rules:'''		*'''Related Rules:'''
−	**'''[[#Progressive List Rule|Progressive List Rule]]''' - executes the first child rule on the first run, the second child on the second run, etc	+	**'''[[#Directional Trigger Check Rule|Directional Trigger Check Rule]]''' - executes child rules when activated by a train moving in a set direction.
−	**'''[[#Random List Rule|Random List Rule]]''' - executes ONE randomly selected child rule	+	**'''[[#Trackside Check Rule|Trackside Check Rule]]''' - executes child rules when activated by a train. Provides different options to the '''Trigger Check Rule'''
−	**'''[[#Reset List Rule|Reset List Rule]]''' - executes all child rules continuously	+
−	**'''[[#Simultaneous List Rule|Simultaneous List Rule]]''' - executes all child rules simultaneously	+
	*'''Trainz Wiki Links:'''		*'''Trainz Wiki Links:'''
−	**'''http://online.ts2009.com/mediaWiki/index.php/Ordered_List'''	+	**'''[[Message Popup Rule Applications]]
−	**'''[[How to Use Parent and Child Rules]]'''	+	**'''[[How to Use Navigation Point Rules (Applications)#Application 3: Wait for Loading to be Completed|How to Use Navigation Point Rules (Applications): Wait for Loading to be Completed]]
−	----	+	**'''[[How to Use Track Triggers]]'''
−	'''[[#top|Back to Top]]''' | '''[[#A, B|A, B]]''' | '''[[#C|C]]''' | '''[[#D|D]]''' | '''[[#E, F, G|E, F, G]]''' | '''[[#H, I, J|H, I, J]]''' | '''[[#K, L, M|K, L, M]]''' | '''[[#N, O|N, O]]''' | '''[[#P, Q|P, Q]]''' | '''[[#R|R]]''' | '''[[#S-Se|S-Se]]''' | '''[[#Sh-Sz|Sh-Sz]]''' | '''[[#T|T]]''' | '''[[#U, V|U, V]]''' | '''[[#W, X, Y, Z|W, X, Y, Z]]'''	+	**'''[[How to Use Variables in Sessions (Examples)]]
−	=='''P, Q'''==	+	==='''Wait on Navigation Point Rule'''===
−	==='''Play Sound Rule'''===	+	Executes child rules when a specific navigation point is completed
−	Plays a wav sound file.	+	*'''<kuid:401543:1168>'''
−		+
−	*'''<kuid:-25:1045>'''	+
−		+
−	*'''Built-in Rule'''	+
−		+
−	'''Properties:'''	+
−	'''Default HTML ''<Click>''''' - click to to enter Sound File Name	+
−	'''HTML Assets ''<Click>''''' - click to select HTML asset	+
−	'''Rule Completes ''<Click>''''' -  to select one of:-	+
−	'''sound has just started'''	+
−	'''sound has finished playing'''	+
−		+
−	*'''Related Rules:'''	+
−	**'''[[#Display Video Rule|Display Video Rule]]''' - displays a page containing a video clip from a HTML asset in a browser window	+
−		+
−	==='''Power Station Rule'''===	+
−		+
−	Sets up a Power Station and its electricity consumers	+
−		+
−	*'''<kuid:-25:746>'''	+
	*'''Base Rule'''		*'''Base Rule'''
−
−	'''Properties:'''
−	'''Power station ''<select>''''' - select a Power Station from the session list.
−	'''Consumers:'''
−	'''''<add object>''''' - add power consumers from the session list
−
−	==='''Progressive List Rule'''===
−
−	Executes the first child rule on the first run, the second child on the second run, the third child on the third run, etc.
−
−	*'''<kuid:-25:754>'''
−
−	*'''Built-in Rule'''
	*'''Parent Rule'''		*'''Parent Rule'''
	'''Properties:'''		'''Properties:'''
−	'''After last child has been executed ...'''	+	'''navigation point ''<click here to set>''''' - enter the number of the navigation point to be completed
−	'''''<successive runs will do nothing/the first child is chosen again>''''' - click to select one	+	'''in set ''<click here to set>''''' - enter the unique name for the navigation set created using the '''Navigation Display Rule'''.
		+	Name must be in lowercase and have no spaces.
−	*'''Related Rules:'''	+	*'''Known Issues:'''
−	**'''[[#Ordered List Rule|Ordered List Rule]]''' - executes child rules in order	+	:The rule will '''NOT''' check to see if the named navigation set and point exists or not.
−	**'''[[#Random List Rule|Random List Rule]]''' - executes ONE randomly selected child rule	+
−	**'''[[#Reset List Rule|Reset List Rule]]''' - executes all child rules continuously	+
−	**'''[[#Simultaneous List Rule|Simultaneous List Rule]]''' - executes all child rules simultaneously	+
−		+
−	*'''Trainz Wiki Links:'''	+
−	**'''http://online.ts2009.com/mediaWiki/index.php/Progressive_List'''	+
−	**'''[[How to Use Parent and Child Rules]]'''	+
−		+
−	==='''Quick CustomHud Manager Rule (SP2 and later)'''===	+
−		+
−	Allows the creation of new graphical heads up displays which are assigned to the drivers in Driver Mode. Replaces the '''mc Display Custom HUD V2 Rule (SP2 and later)'''	+
−		+
−	*'''<kuid2:61392:5020:47>'''	+
−		+
−	*'''DLS Rule''' by '''pguy'''	+
−		+
−	'''Properties:'''	+
−	'''''<Copy rule to data Clipboard>''''' - click to copy the data from the selected HUD to a special clipboard area used by the rules created by '''pguy'''.	+
−	This is NOT the standard OS clipboard.	+
−	'''''<Paste rule data from Clipboard>''''' - if data is held in the special clipboard area, then click to paste that data into the selected HUD.	+
−	This is NOT the standard OS clipboard.	+
−	'''Current HUD Parameters'''	+
−	'''HUD to select: ''<HUD name>''''' - click to select a HUD from those available. One or two default HUDs will be supplied.	+
−	'''''new HUD''''' - click to create a new HUD display with default properties. You will be required to enter a name for the new HUD	+
−	'''''clone HUD''''' - click to create a new HUD using the properties of the currently selected HUD. You will be required to enter a name for the new HUD	+
−	'''''copy HUD''''' - copies (overwrites) the currently selected HUD with the properties of another HUD. You will be required to enter the name of the HUD to be copied	+
−	For new, cloned or copied HUDs, additional commands will be shown:	+
−	'''''rename HUD''''' - rename the selected HUD. You will be required to enter a new name for the HUD	+
−	'''''delete HUD''''' - delete the currently displayed HUD	+
−	In '''Driver Mode''' an additional command will be shown:	+
−	'''''Assign hud to current train''''' - click to assign the currently selected HUD to the currently selected driver	+
−	'''[Check Box] hud is displayed (on)''' - check to display HUD in '''Driver Mode'''	+
−	'''hud items nb entries max: ''<value>''''' - enter the maximum number of items to be displayed in the HUD. Maximum is 30.	+
−	'''hud view limit: ''<value>''''' - enter the maximum look-ahead distance in metres for the HUD. Minimum value is 1000, maximum value is 10000.	+
−	'''[Check Box] display data in a centred window above orderbar''' - check to display the HUD centred on the screen just above the driver command bar in '''Driver Mode'''	+
−	For each individual HUD property:	+
−	'''[Check Box] ''HUD property''''' - check to add this property to the HUD	+
−		+
−	*'''Notes:'''	+
−	:HUDs are assigned to drivers in '''Driver Mode''' by either adding a '''SetCustomHud (SP2 and later)''' command to individual drivers command lists or manually by clicking a green '''RM''' tool button displayed on the top menu and selecting '''Quick CustomHUD Manager''' from the menu.	+
	*'''Related Rules:'''		*'''Related Rules:'''
−	**'''[[#Display Custom HUD Rule|Display Custom HUD Rule]]''' - shows or hides the Custom Heads Up Display.	+	**'''[[#Navigation Display Rule|Navigation Display Rule]]''' - creates a set of navigation points.
−	**'''[[#Flash HUD Icon Rule|Flash HUD Icon Rule]]''' - flashes a HUD panel icon for a set duration.	+	**'''[[#Navigation Set Hide/Show Rule|Navigation Set Hide/Show Rule]]''' - makes a navigation set visible/invisible.
−	**'''[[#mc Display Custom HUD V2 Rule (SP2 and later)|mc Display Custom HUD V2 Rule (SP2 and later)]]''' - shows or hides a graphical HUD.	+	**'''[[#Navigation Set Check Rule|Navigation Set Check Rule]]''' - executes child rules if a navigation set is complete or incomplete.
−	**'''[[#Show/Hide HUD Panel Rule|Show/Hide HUD Panel Rule]]''' - shows or hides a HUD panel.	+	**'''[[#Navigation Set Clear Rule|Navigation Set Clear Rule]]''' - completes (terminates) a navigation set.
−	**'''[[#Variable Show Rule|Variable Show Rule]]''' - adds or removes a specified variable and a descriptive label to the custom HUD.	+	**'''[[#Navigation Point Complete Rule|Navigation Point Complete Rule]]''' - manually completes (terminates) a specific navigation point in a set.
−	**'''[[#Wait for Click on HUD Icon Rule|Wait for Click on HUD Icon Rule]]''' - executes child rules when a HUD icon is clicked	+
−		+
−	==='''Quick Portal Manager Standard Edition Rule (SP2 and later)'''===	+
−		+
−	Manages portals and adds flexible timetables.	+
−		+
−	*'''<kuid2:61392:5011:45>'''	+
−		+
−	*'''DLS Rule''' by '''pguy'''	+
−		+
−	'''Properties:'''	+
−	'''Target date is ''day-of-week'' ''&<nowiki />lt;dd/mm/yyyy&<nowiki />gt;''''' - ''day-of-week'' and ''date'' shown are for today's date. Click '''''dd/mm/yyyy''''' to change date.	+
−	'''''<Copy rule data to Clipboard>''''' - click to copy the currently entered data to a special clipboard area used by the rules created by '''pguy'''.	+
−	This is NOT the standard OS clipboard.	+
−	'''''<Paste rule data from Clipboard>''''' - if data is held in the special clipboard area, then click to paste that data into the rule.	+
−	This is NOT the standard OS clipboard.	+
−	'''[Check Box] This rule is enabled''' - check to activate (enable) the rule.	+
−	'''[Check Box] Avoid duplicated driver if possible''' - check to prevent the same driver being used again. If a driver name is reused, the rule will select a different driver name.	+
−	'''[Check Box] Disable locomotives/vehicles enhanced mode''' - check to save vehicle properties when a train is removed by a portal.	+
−	These properties will be restored if the same train is emitted by a portal. If checked then a new command will appear:	+
−	'''''<for all vehicles/for only locomotives/for only tagged vehicles>''''' - click to select one.	+
−	'''Portal selected: ''<portal name> [...]''''' - select a portal to manage by clicking '''''<portal name>''''' or '''''[...]''''' and selecting a portal from the Session list.	+
−	'''Portal output link: ''<[no link]> [...]''''' - leave blank.	+
−	'''Portal input link: ''<[no link]> [...]''''' - leave blank unless you want to connect to a Global Input Queue. Click to select an input queue from the Session list.	+
−	'''Default schedule for input trains is named: ''<schedule>''''' - click to enter a schedule name.	+
−	'''Today's schedule: ''<Insert new schedule>''''' - click to enter a new schedule	+
−	For each schedule:-	+
−	'''''<hh:mm>''''' - click to set the time when a train will be emitted from the portal. Times use the 24hr clock.	+
−	'''''<train name>''''' - click to enter the train name	+
−	'''''<mission code>''''' - click to enter the '''Mission Code''' created by the '''MissionCode Manager Rule (SP2 and later)'''.	+
−	'''''<schedule>''''' - click to enter the re-occurrence schedule in ''hh:mm'' (24hr clock) where, for example:	+
−	''02:30'' means every 2 hrs 30 minutes,	+
−	''00:00'' means once only,	+
−	''24:00'' means once each day.	+
−	'''''<driver>''''' - click to select a driver name or select '''''auto-driver''''' to let the rule select a driver.	+
−	'''Current driver order bar is named ''<schedule>''''' - click to enter a name for the order (Driver Command) bar used in this schedule.	+
−	'''''<hud>''''' - click to select a HUD for this train. HUDs must be created using the '''Quick CustomHud Manager Rule (SP2 and later)'''.	+
−	'''Driver Command Bar''' - enter driver commands for this train.	+
−	Choose one of two consist sets:	+
−	'''''<mono consist>'' consist for every day''' - if selected the same consist will be used each day.	+
−	'''''<no consist selected>''''' - click to select a consist from those saved in your install.	+
−	'''''<multi consists>''''' - if selected a different consist will be used each day.	+
−	For each day of the week:	+
−	'''Day-of-week ''<no consist selected>''''' - click to select a consist from those saved in your install.	+
−		+
−	*'''Related Rules:'''	+
−	**'''[[#MissionCode Manager Rule (SP2 and later)|MissionCode Manager Rule (SP2 and later)]]''' - creates and manages '''Mission Codes''' for '''Interlocking Tower''' paths	+
−	**'''[[#Quick CustomHud Manager Rule (SP2 and later)|Quick CustomHud Manager Rule (SP2 and later)]]''' - create driver HUDs	+
	*'''Trainz Wiki Links:'''		*'''Trainz Wiki Links:'''
−	**'''http://online.ts2009.com/mediaWiki/index.php/Quick_Portal_Manager'''	+	**'''[[Message Popup Rule Applications#Application 2: Navigation Point and Train Stopped Event Message|Message Popup Rule Applications: Navigation Point and Train Stopped Event Message]]
		+	**'''[[How to Use Navigation Point Rules (Applications)]]'''
		+	**'''[[How to Use Navigation Point Rules]]'''
−	==='''Quick Session Variables Rule'''===	+	==='''Wait on Train Stop/Start Rule'''===
−	Allows the editing of session variables	+	Executes child rules when a train stops or starts moving
−	*'''<kuid2:61392:5003:30>'''	+	*'''<kuid:-25:1069>'''
−		+
−	*'''DLS Rule''' by '''pguy'''	+
−		+
−	'''Properties:'''	+
−	'''''<local>''''' - click to edit local variables	+
−	'''''<add new session variable>''''' - click to enter the name of new local variable	+
−	for each variable:-	+
−	'''''<variable-name>''''' - click to change variable name	+
−	'''''<type>''''' - click to select one of:-	+
−	'''string''' - text characters	+
−	'''int''' - integer	+
−	'''float''' - real (decimal) numbers	+
−	'''bool''' - boolean (true/false)	+
−	'''stringset''' - ''meaning not known at this time''	+
−	'''stringlist''' - ''meaning not known at this time''	+
−	'''tkmlist''' - trackmark list (no longer supported in TANE SP2)	+
−	'''platformlist''' - platform list (no longer supported in TANE SP2)	+
−	'''''del''''' - delete variable	+
−	'''''edit''''' - edit variable	+
−	'''''<trains>''''' - click to edit a train variable	+
−	'''''<train selected>''''' - click to select a train from the session list. Initially none is selected	+
−	'''''<select train>''''' - click to select a locomotive	+
−	'''''<select vehicle>''''' - click to select a rail vehicle	+
−	for the selected loco/vehicle:-	+
−	'''''<Add new session variable>''''' - click to enter the name of a new variable	+
−	for the entered variable:-	+
−	'''''<variable-name>''''' - click to change variable name	+
−	'''''<type>''''' - click to select type (see list above)	+
−	'''''<objects>''''' - no longer supported in TANE SP2	+
−	'''''<global>''''' - no longer supported in TANE SP2	+
−		+
−	*'''Known Issues:'''	+
−	:Rule creator, '''pguy''', has indicated that the future of this rule is uncertain as parts of it have been devalued in the latest release of TANE.	+
−		+
−	*'''Related Rules:'''	+
−	**'''[[#Variable Check Rule|Variable Check Rule]]''' - executes child rules according to the value of a specified variable.	+
−	**'''[[#Variable Modify Rule|Variable Modify Rule]]''' - changes the value of a specified variable.	+
−	**'''[[#Variable Modify Continuous Rule|Variable Modify Continuous Rule]]''' - continuously changes the value of a specified variable.	+
−	**'''[[#Variable Random Rule|Variable Random Rule]]''' - assigns a random value to a variable.	+
−	**'''[[#Variable Show Rule|Variable Show Rule]]''' - adds or removes a specified variable and a descriptive label to the custom HUD.	+
−		+
−	==='''QuickDrive Rule'''===	+
−		+
−	Changes the Session settings.	+
−		+
−	*'''<kuid:401543:1184>'''	+
−		+
−	*'''Base Rule'''	+
−		+
−	'''Properties:'''	+
−	'''Open QuickDrive window when session is started          [Check Box]''' - check to set	+
−	'''Set time to ''<hours:minutes>'' with a rate of ''<speed x>''''' - set start time and rate at which time advances	+
−	'''Enable gameplay Session Mode                            [Check Box]''' - check to set. Gameplay mode restricts the players options	+
−	'''Enable in game help by default                          [Check Box]''' - check to allow help options to be displayed	+
−	'''Set the default Control method to:''' - select one of two option buttons:-	+
−	'''( ) Easy Mode'''	+
−	'''( ) Realistic Mode'''	+
−	'''[Check Box] Prevent player from changing this setting''' - check to set	+
−	'''Realistic mode requires achievement: ''<text>'' in asset ''<asset name>''''' - enter achievement name and select an asset from Aurans Achievements	+
−	'''Set the default derailment realism to:''' - select one of three option buttons:-	+
−	'''( ) None'''	+
−	'''( ) Arcade'''	+
−	'''( ) Realistic'''	+
−	'''[Check Box] Prevent player from changing this setting''' - check to set	+
−	'''Set the default units to:''' - select one of three option buttons:-	+
−	'''( ) Imperial'''	+
−	'''( ) Metric'''	+
−	'''( ) Default'''	+
−		+
−	*'''Trainz Wiki Links:'''	+
−	**'''http://online.ts2009.com/mediaWiki/index.php/QuickDrive_Rule'''	+
−	----	+
−	'''[[#top|Back to Top]]''' | '''[[#A, B|A, B]]''' | '''[[#C|C]]''' | '''[[#D|D]]''' | '''[[#E, F, G|E, F, G]]''' | '''[[#H, I, J|H, I, J]]''' | '''[[#K, L, M|K, L, M]]''' | '''[[#N, O|N, O]]''' | '''[[#P, Q|P, Q]]''' | '''[[#R|R]]''' | '''[[#S-Se|S-Se]]''' | '''[[#Sh-Sz|Sh-Sz]]''' | '''[[#T|T]]''' | '''[[#U, V|U, V]]''' | '''[[#W, X, Y, Z|W, X, Y, Z]]'''	+
−		+
−	=='''R'''==	+
−		+
−	==='''Random List Rule'''===	+
−		+
−	Executes ONE randomly selected child rule once only. The rule will not repeat to randomly select another child rule	+
−		+
−	*'''<kuid:-25:758>'''	+
	*'''Built-in Rule'''		*'''Built-in Rule'''
Line 1,784:		Line 2,767:
	'''Properties:'''		'''Properties:'''
−	'''None'''	+	'''[Check Box] Trigger rule once'''
−		+	'''Wait for a train that matches the following criteria to ''<select>''''' - select one of:-
−	*'''Related Rules:'''	+	'''''start moving'''''
−	**'''[[#Ordered List Rule|Ordered List Rule]]''' - executes child rules in order	+	'''''stop moving'''''
−	**'''[[#Progressive List Rule|Progressive List Rule]]''' - executes the first child rule on the first run, the second child rule on the second run, etc	+	Select one of two option buttons:-
−	**'''[[#Reset List Rule|Reset List Rule]]''' - executes all child rules continuously	+	'''( ) click to accept all trains'''
−	**'''[[#Simultaneous List Rule|Simultaneous List Rule]]''' - executes all child rules simultaneously	+	'''( ) click to accept trains matching specific criteria'''
		+	Selecting the second option will produce the following selection controls:-
		+	'''Specific vehicle''' - identify the specific vehicle or set of specific vehicles that will trigger the rule
		+	'''''+''''' - click to add a ''specific'' vehicle from the session list
		+	'''''x''''' - click to remove the ''specific'' vehicle from the rule
		+	'''Vehicle types''''' - identify the ''type'' of vehicle or a set of vehicle ''types'' that will trigger the rule
		+	'''''+''''' - click to add a ''type'' of vehicle from the session list
		+	'''''x''''' - click to remove the ''type'' of vehicle from the rule
		+	'''Drivers''''' - identify the ''drivers'' that will trigger the rule
		+	'''''+''''' - click to add a ''driver'' from the session list
		+	'''''x''''' - click to remove a ''driver'' from the rule
	*'''Trainz Wiki Links:'''		*'''Trainz Wiki Links:'''
−	**'''[[How to Use Parent and Child Rules]]'''	+	**'''[[Message Popup Rule Applications#Application 2: Navigation Point and Train Stopped Event Message|Message Popup Rule Applications: Navigation Point and Train Stopped Event Message]]'''
−	**'''http://online.ts2009.com/mediaWiki/index.php/Random_List'''	+
−	==='''Random Weather Rule v2'''===	+	'''[[#top|Back to Top]]'''
		+	----
		+	=='''Resources Rules'''==
−	Randomly changes the weather conditions between set values over a set duration.	+	==='''DisplayIndustryStatus Rule (color modified)'''===
−	*'''<kuid:169301:100132>'''	+	Displays a summary of industry product levels when the "k" key is pressed.
−	*'''DLS Rule''' by '''terry_wagstaff'''	+	*'''<kuid:622415:100001>'''
−	'''Properties:'''	+	*'''DLS Rule''' by '''lockheed02''' and '''marzipan'''
−	'''Starting weather ''<select>'' - select one of:-	+
−	'''''Clear weather, no clouds, rain or snow'''''	+
−	'''''Cloudy weather, no rain'''''	+
−	'''''Drizzle, light rain'''''	+
−	'''''Rain'''''	+
−	'''''Stormy weather that includes lightning and thunder'''''	+
−	'''''Snowing lightly'''''	+
−	'''''Medium snowfall'''''	+
−	'''''Heavy snow'''''	+
−	'''Best weather ''<select>'' - select one of:-	+
−	'''''Clear weather, no clouds, rain or snow'''''	+
−	'''''Cloudy weather, no rain'''''	+
−	'''''Drizzle, light rain'''''	+
−	'''''Rain'''''	+
−	'''''Stormy weather that includes lightning and thunder'''''	+
−	'''''Snowing lightly'''''	+
−	'''''Medium snowfall'''''	+
−	'''''Heavy snow'''''	+
−	'''Worst weather ''<select>'' - select one of:-	+
−	'''''Clear weather, no clouds, rain or snow'''''	+
−	'''''Cloudy weather, no rain'''''	+
−	'''''Drizzle, light rain'''''	+
−	'''''Rain'''''	+
−	'''''Stormy weather that includes lightning and thunder'''''	+
−	'''''Snowing lightly'''''	+
−	'''''Medium snowfall'''''	+
−	'''''Heavy snow'''''	+
−	'''Changing about every: ''<value>'' mins''' - enter number of minutes between weather changes	+
−		+
−	*'''Known issues:'''	+
−	:This rule, once started, will run continuously and will not terminate so do NOT use this rule as a child rule in an '''Ordered List Rule''' because any following child rules will never be executed.	+
−		+
−	*'''Related Rules:'''	+
−	**'''[[#EIRS Weather Rule NE USA Rule|EIRS Weather Rule NE USA Rule]]''' - customize random weather rule relative to the North East Region of the United States	+
−	**'''[[#Startup Options Rule|Startup Options Rule]]''' - sets the weather conditions at the start of a Session	+
−		+
−	==='''Randomize Rule'''===	+
−		+
−	Generates a different set of random numbers each time the session is run.	+
−		+
−	*'''<kuid:169301:100129>'''	+
−		+
−	*'''DLS Rule''' by '''Terry_Wagstaff'''	+
	'''Properties:'''		'''Properties:'''
Line 1,853:		Line 2,804:
	*'''Notes:'''		*'''Notes:'''
−	:Place this rule near the top of the Session Rules list and ensure that there is at least 5 seconds before the call to a Random function.	+	:Pressing the '''k''' key in Driver mode will bring up a small window with a single link '''''Display Industry Status''''' (there may also be other links). Clicking this link will show the product levels of all industries.
	*'''Related Rules:'''		*'''Related Rules:'''
−	**'''[[#Variable Random|Variable Random]]''' - sets a variable to a random integer value.	+	**'''[[#ExTrainz Manager Rule - TANE SP2|ExTrainz Manager Rule - TANE SP2]]''' - displays information on consists, industries and products in Driver and Surveyor.
−	==='''Ranked Session Begin Rule'''===	+	==='''ExTrainz Manager Rule - TANE SP2'''===
−	Begins a ranked Session	+	Provides information on consists, industries and products in both Surveyor and Driver modes. Once activated, the rule creates an additional short menu bar below the main menu bar.
−	*'''<kuid:401543:2031>'''	+	*'''<kuid:160293:10029>'''
−	*'''Base Rule'''	+	*'''DLS Rule''' by '''trev999'''
	'''Properties:'''		'''Properties:'''
−	'''Countdown Starting Value ''<value>'''''	+	'''Diagnostic mode is ''<On/Off>''''' - click to select ''On'' or ''Off''. When set ''On'' diagnostic messages will be added to the Trainz Log file.
−	'''''hrs:'''''	+	'''Turn on message overlay ''<Yes/No>''''' - click to select ''Yes'' or ''No''. When set to ''Yes'' the message overlay (lower left of screen) will be active.
−	'''''min:'''''	+	'''Show rolling stock in Driver mode ''<Yes/No>''''' - click to select ''Yes'' or ''No''. When set to ''Yes'' rolling stock can be searched in Driver.
−	'''''sec:'''''	+	'''Search only rolling stock already in session ''<Yes/No>''''' - click to select ''Yes'' or ''No''. When set to ''Yes'' only those rolling stock assets
−	'''1 through 5 stars, points for each star ''<value>''''' - enter number of points for each star rating	+	installed in the session can be searched.
−	'''Session timer mode:''' - select one of three option buttons:-	+	'''Graphic colours: ''<When Red, the industry does not require service/When Green, the industry does not require service>''''' - click to switch
−	'''( ) Timer'''	+	between the two colour options.
−	'''( ) Countdown Starting value ''<value>''''' - enter time ''hh:mm:ss''	+	'''Industry page size: ''<value>''''' - enter the number of industries to be displayed in the Industry List window (maximum 250).
−	'''( ) None'''	+	'''The following industries are excluded: ''<Add an industry to be excluded>''''' - name can be complete (e.g. "Coal Mine 2")
		+	which will exclude that specific industry from the management list, or partial (e.g. "Coal") which will exclude all
		+	industries with the word "Coal" in their names. Entries are not case sensitive.
		+	Once industries have been excluded, additional commands will appear for each excluded industry:-
		+	'''''<delete> <industry name begins with/class name begins with> <name>''''' - click ''delete'' to remove this entry.
		+	- click ''industry name begins with/class name begins with'' to select between the two (see ''notes'' below).
		+	- click ''name'' to edit the name.
	*'''Notes:'''		*'''Notes:'''
−	:Times are Trainz clock time, not real time	+	#Rolling stock installed in '''TANE''' or in the current session only (see settings above) can be searched to find a match for any selected product from any industry. In Surveyor (and Driver if that setting is enabled) click on the '''View Products''' sub menu link and click on a product name in the '''Product Window''' to display a list of all compatible rolling stock for that product.
		+	#Alternatively, click on the '''View Industries''' sub menu link and then click on a ''Product Icon'' to open a '''Product Window''', then click    on the '''''View Rolling Stock''''' link at the top of the window.
		+	#Industry class names are defined in the config.txt file of industry assets and are not normally accessible by users. However, you can exclude an entire group of related "industry asset classes" such as ''station'', ''coalingtower'', ''watertank'', etc regardless of their actual names provided those assets have been given that "class name" by their creators.
−	*'''Related Rules:'''	+	*'''Known Issues:'''
−	**'''[[#Ranked Session Complete Rule|Ranked Session Complete Rule]]''' - completes the active ranked Session	+	:This rule is NOT compatible with all industries.
−		+
−	==='''Ranked Session Complete Rule'''===	+
−		+
−	Completes the active ranked Session	+
−		+
−	*'''<kuid:401543:2032>'''	+
−		+
−	*'''Base Rule'''	+
−		+
−	'''Properties:'''	+
−	'''Set the active ranked session as:''' - select one of two option buttons:-	+
−	'''( ) Complete'''	+
−	'''( ) Failed'''	+
−	'''[Check Box] Customize the completion message ''<text>''''' - enter a text message	+
	*'''Related Rules:'''		*'''Related Rules:'''
−	**'''[[#Ranked Session Begin Rule|Ranked Session Begin Rule]]''' - begins a ranked Session	+	**'''[[#DisplayIndustryStatus Rule (color modified)|DisplayIndustryStatus Rule (color modified)]]''' - displays information on industry product levels.
−	==='''Replace Missing Vehicles Rule'''===	+	==='''Hide Product Overlays Rule'''===
−	Produces new trains to replace missing vehicles that have been removed from the session by the '''Clean Up Derailed Trains Rule'''	+	Hides the commodity or product bar graphs that appear on active industries
−	*'''<kuid:447264:1214>'''	+	*'''<kuid:400048:100970>'''
−	*'''Built-in Rule'''	+	*'''DLS Rule''' by '''callavsg'''
	'''Properties:'''		'''Properties:'''
−	'''[Check Box] Respawn trains if they are abandoned for 10 minutes'''	+	'''None'''
−	If checked:-	+
−	Select one of two option buttons:-	+
−	'''( ) Respawn trains at their original locations'''	+
−	'''( ) Respawn trains from portals'''	+
−	'''''<+ Add a new portal>''''' - click to enter the name of a portal, there can be more than one portal.	+
−	Entered portal names that appear in red have not been found in the session	+
−	*'''Related Rules:'''	+	==='''Multiple Resource Check Rule'''===
−	**'''[[#Clean Up Derailed Trains Rule|Clean Up Derailed Trains Rule]]''' - cleans up derailed train cars after a set time delay	+
−	**'''[[#Wait for Derailment Rule|Wait for Derailment Rule]]''' - executes child rules when a derailment occurs	+
−	==='''Reset List Rule'''===	+	Executes child rules if industries or vehicles reach set commodity levels. This rule replaces the older '''Resource Check Rule'''
−	Executes ALL child rules continuously in an ongoing infinite cycle	+	*'''<kuid:-25:656>'''
−		+
−	*'''<kuid:-25:762>'''	+
	*'''Built-in Rule'''		*'''Built-in Rule'''
Line 1,932:		Line 2,867:
	'''Properties:'''		'''Properties:'''
−	'''None'''	+	'''<Product Level>''' - click to select a product test from two choices:-
		+	'''''Reach/Exceed''''' - sets an upper limit for the resources being monitored.
		+	For example: the rule will be triggered if the quantity of coal in a coal loader stockpile or a coal wagon reaches or exceeds a specified level.
		+	The initial level in the object must be below the set upper limit.
		+	'''''Fall below''''' - sets a lower limit for the resources being monitored.
		+	For example: the rule will be triggered if the quantity of coal in a coal loader stockpile or a coal wagon falls below a specified level.
		+	The initial level in the object must be above the set lower limit.
		+	To test when a resource level reaches zero (i.e. is empty) set the lower limit to a very low value but not zero as the level can never fall below zero.
		+	'''''<value>''''' - enter required quantity value
		+	'''''<select>''''' - select a product from session list of products
		+	'''''<Add object>''''' - click to select a source or target object. Multiple objects and their queues can be added to the rule.
		+	ALL the entered products must reach/exceed or fall below the specified value for the rule to be triggered.
		+	For each object:-
		+	'''''<Object>''''' - click to select session active industry or product enabled rail vehicle
		+	'''''<Queue>''''' - select product queue (there may be only one available)
		+	'''''<Remove>''''' - removes the object and its product queue from the rule
		+
		+	*'''Notes:'''
		+	:This rule only checks for ''changing'' commodity levels during loading and unloading operations. It cannot be used to test, for example, if a vehicle is ''full'' or ''empty''.
	*'''Related Rules:'''		*'''Related Rules:'''
−	**'''[[#Ordered List Rule|Ordered List Rule]]''' - executes child rules in order	+	**'''[[#Resource Check Rule|Resource Check Rule]]''' - executes child rules when set resource (commodity) levels are reached
−	**'''[[#Progressive List Rule|Progressive List Rule]]''' - executes the first child rule on the first run, the second child rule on the second run, etc	+	**'''[[#Resource Verify Rule (fixed)|Resource Verify Rule (fixed)]]''' - executes child rules when a set resource (commodity) level is reached
−	**'''[[#Random List Rule|Random List Rule]]''' - executes ONE randomly selected child rule	+
−	**'''[[#Simultaneous List Rule|Simultaneous List Rule]]''' - executes all child rules simultaneously	+
	*'''Trainz Wiki Links:'''		*'''Trainz Wiki Links:'''
−	**'''http://online.ts2009.com/mediaWiki/index.php/Reset_List'''	+	**'''[[How to Use Navigation Point Rules (Applications)#Application 3: Wait for Loading to be Completed|How to Use Navigation Point Rules (Applications): Wait for Loading to be Completed]]'''
−	**'''[[How to Use Parent and Child Rules]]'''	+
	==='''Resource Check Rule'''===		==='''Resource Check Rule'''===
Line 2,019:		Line 2,969:
	**'''[[#Multiple Resource Check Rule|Multiple Resource Check Rule]]''' - executes child rules when set resource (commodity) levels are reached		**'''[[#Multiple Resource Check Rule|Multiple Resource Check Rule]]''' - executes child rules when set resource (commodity) levels are reached
	**'''[[#Resource Check Rule|Resource Check Rule]]''' - executes child rules when set resource (commodity) levels are reached		**'''[[#Resource Check Rule|Resource Check Rule]]''' - executes child rules when set resource (commodity) levels are reached
		+
		+	'''[[#top|Back to Top]]'''
	----		----
−	'''[[#top|Back to Top]]''' | '''[[#A, B|A, B]]''' | '''[[#C|C]]''' | '''[[#D|D]]''' | '''[[#E, F, G|E, F, G]]''' | '''[[#H, I, J|H, I, J]]''' | '''[[#K, L, M|K, L, M]]''' | '''[[#N, O|N, O]]''' | '''[[#P, Q|P, Q]]''' | '''[[#R|R]]''' | '''[[#S-Se|S-Se]]''' | '''[[#Sh-Sz|Sh-Sz]]''' | '''[[#T|T]]''' | '''[[#U, V|U, V]]''' | '''[[#W, X, Y, Z|W, X, Y, Z]]'''	+	=='''Session Sequence Rules'''==
−	=='''S-Se'''==	+	==='''Ordered List Rule'''===
−	==='''Safety System Engaged Check Rule'''===	+	Executes child rules in order once this rule starts
−	Executes child rules if safety systems are applied.	+	*'''<kuid:-25:171>'''
−		+
−	*'''<kuid:447264:1216>'''	+
	*'''Built-in Rule'''		*'''Built-in Rule'''
Line 2,035:		Line 2,985:
	'''Properties:'''		'''Properties:'''
−	'''[Check Box] Trigger only once'''	+	Select one of two option buttons:-
		+	'''( ) This process will repeat ''<value>'' time(s)''' - enter the number of times this rule is to be repeated
		+	'''( ) This process will repeat forever'''
		+
		+	*'''Known Issues:'''
		+	:Some child rules will force a "wait" until certain conditions have been met (e.g. a mouse click or a set time has passed). These rules will delay the completion of any following child rules in the '''Ordered List Rule'''. If possible, place these rules last in the Ordered List.
		+	::For example: The '''Message Popup Rule''' will wait until it is closed before allowing the next child rule to be executed.
	*'''Related Rules:'''		*'''Related Rules:'''
−	**'''[[#Safety System Isolated Check Rule|Safety System Isolated Check Rule]]''' - executes child rules if safety systems have been isolated	+	**'''[[#Progressive List Rule|Progressive List Rule]]''' - executes the first child rule on the first run, the second child on the second run, etc
		+	**'''[[#Random List Rule|Random List Rule]]''' - executes ONE randomly selected child rule
		+	**'''[[#Reset List Rule|Reset List Rule]]''' - executes all child rules continuously
		+	**'''[[#Simultaneous List Rule|Simultaneous List Rule]]''' - executes all child rules simultaneously
−	==='''Safety System Isolated Check Rule'''===	+	*'''Trainz Wiki Links:'''
		+	**'''http://online.ts2009.com/mediaWiki/index.php/Ordered_List'''
		+	**'''[[How to Use Parent and Child Rules]]'''
−	Executes child rules if safety systems are isolated (disengaged).	+	==='''Progressive List Rule'''===
−	*'''<kuid:447264:1217>'''	+	Executes the first child rule on the first run, the second child on the second run, the third child on the third run, etc.
		+
		+	*'''<kuid:-25:754>'''
	*'''Built-in Rule'''		*'''Built-in Rule'''
Line 2,051:		Line 3,014:
	'''Properties:'''		'''Properties:'''
−	'''[Check Box] Trigger only once'''	+	'''After last child has been executed ...'''
		+	'''''<successive runs will do nothing/the first child is chosen again>''''' - click to select one
	*'''Related Rules:'''		*'''Related Rules:'''
−	**'''[[#Safety System Engaged Check Rule|Safety System Engaged Check Rule]]''' - executes child rules if safety systems have been engaged	+	**'''[[#Ordered List Rule|Ordered List Rule]]''' - executes child rules in order
		+	**'''[[#Random List Rule|Random List Rule]]''' - executes ONE randomly selected child rule
		+	**'''[[#Reset List Rule|Reset List Rule]]''' - executes all child rules continuously
		+	**'''[[#Simultaneous List Rule|Simultaneous List Rule]]''' - executes all child rules simultaneously
−	==='''Schedule Rule'''===	+	*'''Trainz Wiki Links:'''
		+	**'''http://online.ts2009.com/mediaWiki/index.php/Progressive_List'''
		+	**'''[[How to Use Parent and Child Rules]]'''
−	Allows a schedule of timed events to be applied to a train	+	==='''Random List Rule'''===
−	*'''<kuid:-3:10185>'''	+	Executes ONE randomly selected child rule once only. The rule will not repeat to randomly select another child rule
−	*'''Base Rule'''	+	*'''<kuid:-25:758>'''
−	'''Properties:'''	+	*'''Built-in Rule'''
−	'''Insert track mark ''<select>''''' - select a track mark from the Session List	+
−	'''Arrival and Departure Time ''<Select>''''' - set time	+
−	'''''hh:mm:ss''''' - in hours/minutes/seconds	+
−	'''Current Train ''<select>''''' - select from session list	+
−	'''Insert destination ''<select>''''' - select from session list	+
−	*'''Notes:'''	+	*'''Parent Rule'''
−	:Times are Trainz clock times, not real time	+
−		+
−	*'''Related Rules:'''	+
−	**'''[[#Driver Command Check Rule|Driver Command Check Rule]]''' - executes child rules if the driver commands match a set list	+
−	**'''[[#Driver Command Rule|Driver Command Rule]]''' - specifies which commands will be available for the drivers	+
−	**'''[[#Driver Schedule Rule|Driver Schedule Rule]]''' - sets up a list of basic scheduled driver commands	+
−	**'''[[#Driver Setup Rule|Driver Setup Rule]]''' - creates a list of drivers and assign them their orders	+
−	**'''[[#Enable/Disable Driver Commands Rule|Enable/Disable Driver Commands Rule]]''' - enable/disable specific driver commands on certain drivers	+
−		+
−	==='''Session Complete Rule'''===	+
−		+
−	Set session to a percentage of completion.	+
−		+
−	*'''<kuid:447264:1011>'''	+
−		+
−	*'''Base Rule'''	+
	'''Properties:'''		'''Properties:'''
−	'''Set session to percent complete ''<value>''''' - enter number as a percentage	+	'''None'''
−	'''[Check Box] Separate achievements for completion''' - check to set	+
	*'''Related Rules:'''		*'''Related Rules:'''
−	**'''[[#End Session Rule|End Session Rule]]''' - end the Session with a fade out.	+	**'''[[#Ordered List Rule|Ordered List Rule]]''' - executes child rules in order
		+	**'''[[#Progressive List Rule|Progressive List Rule]]''' - executes the first child rule on the first run, the second child rule on the second run, etc
		+	**'''[[#Reset List Rule|Reset List Rule]]''' - executes all child rules continuously
		+	**'''[[#Simultaneous List Rule|Simultaneous List Rule]]''' - executes all child rules simultaneously
−	==='''Session Debug Rule'''===	+	*'''Trainz Wiki Links:'''
		+	**'''[[How to Use Parent and Child Rules]]'''
		+	**'''http://online.ts2009.com/mediaWiki/index.php/Random_List'''
−	Executes the first child if ''Debug'' mode is selected. Otherwise executes the second child rule.	+	==='''Reset List Rule'''===
−	*'''<kuid:30501:100180>'''	+	Executes ALL child rules continuously in an ongoing infinite cycle
		+
		+	*'''<kuid:-25:762>'''
	*'''Built-in Rule'''		*'''Built-in Rule'''
−	*'''Parent Rule'''	+	*'''Parent Rule'''
	'''Properties:'''		'''Properties:'''
	'''None'''		'''None'''
−	*'''Notes:'''	+	*'''Related Rules:'''
−	:When a session starts with this rule enabled, the player will be given the choice of running the session in '''''Debug''''' or '''''Normal''''' mode. Selecting ''Debug'' will execute the first child rule. Selecting ''Normal'' will execute the second child rule.	+	**'''[[#Ordered List Rule|Ordered List Rule]]''' - executes child rules in order
		+	**'''[[#Progressive List Rule|Progressive List Rule]]''' - executes the first child rule on the first run, the second child rule on the second run, etc
		+	**'''[[#Random List Rule|Random List Rule]]''' - executes ONE randomly selected child rule
		+	**'''[[#Simultaneous List Rule|Simultaneous List Rule]]''' - executes all child rules simultaneously
−	==='''Session Metadata Rule'''===	+	*'''Trainz Wiki Links:'''
		+	**'''http://online.ts2009.com/mediaWiki/index.php/Reset_List'''
		+	**'''[[How to Use Parent and Child Rules]]'''
−	Sets session metadata in the config file. Info can be read by other systems and displayed to the player.	+	==='''Simultaneous List Rule'''===
−	*'''<kuid:401543:2036>'''	+	Executes child rules simultaneously once this rule starts
−	*'''Base Rule'''	+	*'''<kuid:-25:1048>'''
−		+
−	'''Properties:'''	+
−	'''Type ''<Click>''''' - click to select one of:-	+
−	'''Simulation'''	+
−	'''Challenge'''	+
−	'''Length ''<value>''''' - to enter number of minutes, default is 30 minutes	+
−	'''Difficulty ''<Click>''''' - click to select one of:-	+
−	'''Normal''' - default	+
−	'''Tutorial'''	+
−	'''Easy'''	+
−	'''Hard'''	+
−	'''Expert'''	+
−		+
−	*'''Notes:'''	+
−	:Time is Trainz clock time, not real time	+
−		+
−	==='''Set Camera Rule'''===	+
−		+
−	Sets the target object and properties of the camera.	+
−		+
−	*'''<kuid:-25:179>'''	+
	*'''Built-in Rule'''		*'''Built-in Rule'''
−	'''Properties:'''	+	*'''Parent Rule'''
−	'''[Check Box] Set the target object of the camera to:''' - if checked, select one of three option buttons:-	+
−	'''( ) Vehicle ''<click to select>''''' - select a vehicle from the Session list	+
−	'''( ) Junction ''<click to select>''''' - select a junction from the Session list	+
−	'''( ) Map Object ''<click to select>''''' - select a named map object from the Session list	+
−	'''[Check Box] Change the camera view mode to ''<click to select>''''' - if checked, select one camera view mode from	+
−	'''Cab View'''	+
−	'''External View'''	+
−	'''Tracking View'''	+
−	'''Free Roaming'''	+
−	'''[Check Box] Set the camera flags to enable/disable user access to''' - if checked, select as many of the following check boxes as needed	+
−	'''[Check Box] Internal view mode''' - check to enable, uncheck to disable	+
−	'''[Check Box] External view mode''' - check to enable, uncheck to disable	+
−	'''[Check Box] Tracking view mode''' - check to enable, uncheck to disable	+
−	'''[Check Box] Roaming view mode''' - check to enable, uncheck to disable	+
−	'''[Check Box] View switching''' - check to enable, uncheck to disable	+
−	'''[Check Box] Vehicle view switching''' - check to enable, uncheck to disable	+
−	'''[Check Box] Train view switching''' - check to enable, uncheck to disable	+
−	'''[Check Box] Camera adjustments (pan, zoom, etc)''' - check to enable, uncheck to disable	+
−		+
−	*'''Related Rules:'''	+
−	**'''[[#Cinematic Camera Rule|Cinematic Camera Rule]]''' - provides several different cinematic style cameras with animations	+
−	**'''[[#Focus Camera Rule|Focus Camera Rule]]''' - sets the initial camera view and starting vehicle for a session	+
−	**'''[[#Wait for Camera View Mode Rule|Wait for Camera View Mode Rule]]''' - executes child rules when the camera view is changed	+
−		+
−	==='''Set Coupler Masks Rule'''===	+
−		+
−	Set the coupling/decoupling  masks on the selected vehicles	+
−		+
−	*'''<kuid:-25:980>'''	+
−		+
−	*'''Built-in Rule'''	+
	'''Properties:'''		'''Properties:'''
−	'''''<Add vehicle>''''' - click to select a vehicle from the session list	+	'''Rule completes when ...''' - click to chose one of the following:-
−	'''''<Add All>''''' - click to add all vehicles in the session list	+	'''''one of the child rules has completed'''''
−	'''''<Delete All>''''' - click to remove all added vehicles from this rule	+	'''''all child rules have reached a completed state'''''
−	For each selected vehicle:-	+	'''''all child rules have reached a "was completed" state'''''
−	'''Coupling Mask'''	+
−	'''Front''' and '''Back''' - choose for each	+
−	'''''Locked'''''	+
−	'''''Unlocked'''''	+
−	'''Decoupling Mask'''	+
−	'''Front''' and '''Back''' - choose for each	+
−	'''''Locked'''''	+
−	'''''Unlocked'''''	+
−	'''''<Remove>''''' - click to remove this vehicle from the rule	+
	*'''Related Rules:'''		*'''Related Rules:'''
−	**'''[[#Coupler Breakage Check Rule|Coupler Breakage Check Rule]]''' - executes child rules when a coupler breaks	+	**'''[[#Ordered List Rule|Ordered List Rule]]''' - executes child rules in order
−	**'''[[#Coupler Breakage HUD Rule|Coupler Breakage HUD Rule]]''' - adds a coupler stress and breakage warning to the HUD	+	**'''[[#Progressive List Rule|Progressive List Rule]]''' - executes the first child rule on the first run, the second child on the second run, etc
		+	**'''[[#Random List Rule|Random List Rule]]''' - executes ONE randomly selected child rule
		+	**'''[[#Reset List Rule|Reset List Rule]]''' - executes all child rules continuously
−	==='''Set Cleared Junctions Rule'''===	+	*'''Trainz Wiki Links:'''
		+	**'''[[Message Popup Rule Applications#Application 1: Event Counter and Message Selection|Message Popup Applications: Timed Message]]
		+	**'''[[How to Use Parent and Child Rules]]'''
		+	**'''[[How to Use Variables in Sessions (Examples)#Example 2: Event Counter and Message Selection|How to Use Variables in Sessions (Examples): Event Counter and Message Selection]]
		+	**'''http://online.ts2009.com/mediaWiki/index.php/Simultaneous_List'''
−	Sets selected junctions to specific states (direction, locked/unlocked, allow/prevent AI control) while they are unoccupied. If a junction is occupied it waits until the junction is cleared. '''''Warning:'' not compatible with Interlocking Tower Assets'''	+	'''[[#top|Back to Top]]'''
		+	----
		+	=='''Speed Rules'''==
−	*'''<kuid2:131986:157661:1>'''	+	==='''ATP Speed Limiter Rule'''===
−	*'''DLS Rule''' by '''atilabarut'''	+	Limits allowable speed over set limit
−	'''Properties:'''	+	*'''<kuid2:321959:1000:1>'''
−	'''''Add Junction''''' - click to select a junction from the session junction list	+
−	'''''Add All''''' - click to add ALL junctions in the session junction list	+
−	'''''Delete All''''' - click to remove ALL entered junctions from the rule	+
−	'''Junction Options:''' - for each selected junction:-	+
−	'''''<direction>''''' - click to select the junction direction	+
−	'''Left'''	+
−	'''Center'''	+
−	'''Right'''	+
−	'''Don't change'''	+
−	'''''<user control>''''' - click to select a user control option	+
−	'''Locked''' - the junction setting cannot be changed by the user	+
−	'''Unlocked''' - the junction setting can be changed by the user	+
−	'''''<AI control>''''' - click to select AI control	+
−	'''Allows AI control''' - an AI train can switch the junction	+
−	'''Blocks AI control''' - an AI train cannot switch the junction	+
−	'''''Remove''''' - click to remove this junction from the rule list	+
−		+
−	*'''Related Rules:'''	+
−	**'''[[#Junction Derailment Prevention Rule|Junction Derailment Prevention Rule]]''' - sets opposing junctions ahead of a train to prevent derailments	+
−	**'''[[#Lock All Junctions Rule|Lock All Junctions Rule]]''' - locks all junctions against user control	+
−	**'''[[#Multiple Junction Alignment Check Rule|Multiple Junction Alignment Check Rule]]''' - executes child rules when junctions are aligned	+
−	**'''[[#Set Junctions Rule|Set Junctions Rule]]''' - sets selected junctions to specific states (direction, locked/unlocked, allow/prevent AI control).	+
−		+
−	*'''Trainz Wiki Links:'''	+
−	**'''[[How to Control Junctions in Sessions]]'''	+
−		+
−	==='''Set Helper Icon Size Rule'''===	+
−		+
−	Sets the size of helper icons such as the junction lever arrows.	+
−		+
−	*'''<kuid:-25:791>'''	+
	*'''Built-in Rule'''		*'''Built-in Rule'''
	'''Properties:'''		'''Properties:'''
−	'''Junction Arrows Size ''<Click>''''' - to set scale ratio smaller than default, default is 100%	+	'''Limits the speed to ''<value>'' mph over the set limit''' - enter speed value in mph
−	==='''Set HTML Pages Rule'''===	+	==='''Speeding Check Rule'''===
−	Instructs the Display HTML Pages rule to perform specific operations. This rule has been superseded by the '''Message Popup Rule'''	+	Executes child rules if player controlled trains are over the local speed limit or over a set (custom) speed
−	*'''<kuid:-25:792>'''	+	*'''<kuid2:60850:89004:3>'''
−		+
−	*'''Legacy Rule''' (replaced by '''Message Popup Rule''')	+
	*'''Built-in Rule'''		*'''Built-in Rule'''
−	'''Properties:'''	+	*'''Parent Rule'''
−	'''Operations to preform on the display HTML pages sequence browser'''	+
−	Select one of six option buttons:-	+
−	'''( ) to instruct the sequence browser to ''<select>''''' - to choose page operations	+
−	'''( ) to instruct the sequence browser to open the page ''<select>''''' - enter the HTML page name	+
−	'''( ) to set browser parameters ''<select>''''' - choose one of:-	+
−	'''to Enable/Disable closing of the browser window by the user'''	+
−	'''to Enable/Disable scrolling on the sequence browser window'''	+
−	'''to Show/Hide the sequence browser window'''	+
−	'''( ) Set the following flag for the page named ''<select>''''' - enter the HTML page name	+
−	'''[Check Box] Hide/Close window on 'done' action'''	+
−	'''[Check Box] Window has no 'done' button'''	+
−	'''[Check Box] Disable scrolling(not implemented yet)'''	+
−	'''[Check Box] Spare setting 1'''	+
−	'''[Check Box] Spare setting 2'''	+
−	'''[Check Box] Spare setting 3'''	+
−	'''[Check Box] Spare setting 4'''	+
−	'''[Check Box] Spare setting 5'''	+
−	'''( ) Use the page ''<select>''''' (enter HTML page name) '''from the HTML asset ''<select>''''' (select HTML asset)	+
−	'''( ) Use the string table entry ''<select>''''' (enter Index) '''from the HTML asset ''<select>''''' (select HTML asset)	+
−		+
−	*'''Related Rules:'''	+
−	**'''[[#Display HTML Pages Rule|Display HTML Pages Rule]]''' - displays HTML pages in a browser window.	+
−	**'''[[#Message Popup Rule|Message Popup Rule]]''' - displays a pop-up browser window and waits for it to be closed.	+
−	**'''[[#Timed Limited Display HTML Rule (SP2 and later)|Timed Limited Display HTML Rule (SP2 and later)]]''' - displays a HTML page in a browser window for a set time.	+
−		+
−	==='''Set Junctions Rule'''===	+
−		+
−	Sets selected junctions to specific states (direction, locked/unlocked, allow/prevent AI control). '''''Warning:'' not compatible with Interlocking Tower Assets'''	+
−		+
−	*'''<kuid:-25:1065>'''	+
−		+
−	*'''Built-in Rule'''	+
	'''Properties:'''		'''Properties:'''
−	'''''Add Junction''''' - click to select a junction from the session junction list	+	Select one of two options to set a speed limit to be observed
−	'''''Add All''''' - click to add ALL junctions in the session junction list	+	'''( ) Watch for trains travelling above the posted speed limit'''
−	'''''Delete All''''' - click to remove ALL entered junctions from the rule	+	'''''<speed value>''''' - click to enter a new overspeed tolerance value
−	'''Junction Options:''' - for each selected junction:-	+	'''''<speed units>''''' - click to select one from the list:-
−	'''''<direction>''''' - click to select the junction direction	+	'''''Km/h''''' - Kilometres per hour
−	'''Left'''	+	'''''MPH''''' - Miles per hour
−	'''Center'''	+	'''''mps''''' - metres per second
−	'''Right'''	+	'''( ) Watch for trains travelling above a custom speed'''
−	'''Don't change'''	+	'''''<speed value>''''' - click to enter a new custom speed value
−	'''''<user control>''''' - click to select a user control option	+	'''''<speed units>''''' - click to select one from the list:-
−	'''Locked''' - the junction setting cannot be changed by the user	+	'''''Km/h''''' - Kilometres per hour
−	'''Unlocked''' - the junction setting can be changed by the user	+	'''''MPH''''' - Miles per hour
−	'''''<AI control>''''' - click to select AI control	+	'''''mps''''' - metres per second
−	'''Allows AI control''' - an AI train can switch the junction	+	'''Warning: This option is very performance intensive and should only be used in sessions with few trains'''
−	'''Blocks AI control''' - an AI train cannot switch the junction	+
−	'''''Remove''''' - click to remove this junction from the rule list	+
−	*'''Related Rules:'''	+	==='''MaxPermittedSpeed Rule'''===
−	**'''[[#Junction Derailment Prevention Rule|Junction Derailment Prevention Rule]]''' - sets opposing junctions ahead of a train to prevent derailments	+
−	**'''[[#Lock All Junctions Rule|Lock All Junctions Rule]]''' - locks all junctions against user control	+
−	**'''[[#Multiple Junction Alignment Check Rule|Multiple Junction Alignment Check Rule]]''' - executes child rules when junctions are aligned	+
−	**'''[[#Set Cleared Junctions Rule|Set Cleared Junctions Rule]]''' - sets selected junctions to specific states (direction, locked/unlocked, allow/prevent AI control) while they are unoccupied.	+
−	*'''Trainz Wiki Links:'''	+	Sets the maximum permitted speed of locomotives under AI control
−	**'''[[How to Control Junctions in Sessions]]'''	+
−	==='''Set Signal Extended Rule'''===	+	*'''<kuid2:60850:89000:7>'''
−		+
−	Sets the state of a selected signal '''''Warning:'' not compatible with Interlocking Tower Assets'''	+
−		+
−	*'''<kuid2:47662:20002:4>'''	+
	*'''Built-in Rule'''		*'''Built-in Rule'''
	'''Properties:'''		'''Properties:'''
−	'''''<Select signal>'' to ''<signal state>''''' - click to select a signal from the session list and click to select a state from the list -	+	'''None'''
−	'''Automatic'''	+
−	'''Stop'''	+
−	'''Stop then Continue'''	+
−	'''Caution Left'''	+
−	'''Caution Right'''	+
−	'''Caution'''	+
−	'''Advance Caution Left'''	+
−	'''Advance Caution Right'''	+
−	'''Advance Caution'''	+
−	'''Proceed Left'''	+
−	'''Proceed Right'''	+
−	'''Proceed'''	+
−	'''Slow'''	+
−	'''Medium'''	+
	*'''Notes:'''		*'''Notes:'''
−	:The signal must support the state selected otherwise there will be no change in the signal	+	:This rule cannot be configured from the Session Rules list. It must be configured in the '''config.txt''' file of each locomotive. Instructions with an example are shown in the rule Properties
−	*'''Related Rules:'''	+	'''[[#top|Back to Top]]'''
−	**'''[[#Trigger Multiple Signals Rule|Trigger Multiple Signals Rule]]''' - sets selected signals to DANGER (STOP) when selected triggers are activated	+
	----		----
−	'''[[#top|Back to Top]]''' | '''[[#A, B|A, B]]''' | '''[[#C|C]]''' | '''[[#D|D]]''' | '''[[#E, F, G|E, F, G]]''' | '''[[#H, I, J|H, I, J]]''' | '''[[#K, L, M|K, L, M]]''' | '''[[#N, O|N, O]]''' | '''[[#P, Q|P, Q]]''' | '''[[#R|R]]''' | '''[[#S-Se|S-Se]]''' | '''[[#Sh-Sz|Sh-Sz]]''' | '''[[#T|T]]''' | '''[[#U, V|U, V]]''' | '''[[#W, X, Y, Z|W, X, Y, Z]]'''	+	=='''Startup and Termination Rules'''==
−	=='''Sh-Sz'''==	+	==='''End Session Rule'''===
−	==='''Show/Hide HUD Panel Rule'''===	+	End the Session with a fade out.
−	Shows or hides a HUD panel.	+	*'''<kuid:-25:482>'''
−		+
−	*'''<kuid:-25:1047>'''	+
	*'''Built-in Rule'''		*'''Built-in Rule'''
	'''Properties:'''		'''Properties:'''
−	'''''<Show/Hide>'' the ''<click to select>'' HUD panel''' - select '''''Show''''' or '''''Hide''''' and then select the HUD panel	+	'''Fade out over ''<value>'' seconds''' - enter number of seconds for fade out.
−	*'''Related Rules:'''	+	*'''Notes:'''
−	**'''[[#Display Custom HUD Rule|Display Custom HUD Rule]]''' - shows or hides the Custom Heads Up Display.	+	:Seconds are Trainz clock time, not real time.
−	**'''[[#Flash HUD Icon Rule|Flash HUD Icon Rule]]''' - flashes a HUD panel icon for a set duration.	+
−	**'''[[#mc Display Custom HUD V2 Rule (SP2 and later)|mc Display Custom HUD V2 Rule (SP2 and later)]]''' - shows or hides a graphical HUD.	+
−	**'''[[#Quick CustomHud Manager Rule (SP2 and later)|Quick CustomHud Manager Rule (SP2 and later)]]''' - creates custom HUDs that can be assigned to different drivers	+
−	**'''[[#Variable Show Rule|Variable Show Rule]]''' - adds or removes a specified variable and a descriptive label to the custom HUD.	+
−	**'''[[#Wait for Click on HUD Icon Rule|Wait for Click on HUD Icon Rule]]''' - executes child rules when a HUD icon is clicked	+
−		+
−	==='''Show/Hide Layer Rule'''===	+
−		+
−	Shows or hides a layer from Driver.	+
−		+
−	*'''<kuid2:401543:1170:1>'''	+
−		+
−	*'''Built-in Rule'''	+
−		+
−	'''Properties:'''	+
−	'''''<visibility>''''' - select one of two options	+
−	'''Show''' - select to make the layer visible	+
−	'''Hide''' - select to make the layer invisible	+
−	'''''<click here to set>''''' - enter name of layer. Name is case sensitive.	+
−		+
−	*'''Known Bugs:'''	+
−	:Layers set to '''Hide''' when a game is saved will be '''Shown''' when the game is reloaded	+
−		+
−	*'''Known Issues:'''	+
−	:Rule will NOT check to see if the named layer exists or not	+
−		+
−	*'''Trainz Wiki Links:'''	+
−	**'''[[How to Use Layers#Layers in Driver Mode|How to Use Layers: Layers in Driver Mode]]	+
−		+
−	==='''Show/Hide Minimap Rule'''===	+
−		+
−	Shows the minimap window in Driver.	+
−		+
−	*'''<kuid:-25:794>'''	+
−		+
−	*'''Built-in Rule'''	+
−		+
−	'''Properties:'''	+
−	'''''<Show/Hide>'' the driver Minimap Window''' - click to switch between '''Show''' and '''Hide'''.	+
	*'''Related Rules:'''		*'''Related Rules:'''
−	**'''[[#Minimap Options Rule|Minimap Options Rule]]''' - sets the display options for the minimap.	+	**'''[[#Session Complete Rule|Session Complete Rule]]''' - set the session to a percentage of completion
−	==='''Show/Hide On-screen Help Rule'''===	+	==='''Multiplayer Rule'''===
−	Shows or hides On-screen help in Driver.	+	Enables the session to be taken online in a Multiplayer environment.
−	*'''<kuid:401543:2020>'''	+	*'''<kuid:447264:1045>'''
	*'''Built-in Rule'''		*'''Built-in Rule'''
	'''Properties:'''		'''Properties:'''
−	'''On screen help (junction overlays, etc)''' - select one of three option buttons:-	+	'''Suggested maximum number of players for this session ''<value>''''' - enter a number
−	'''( ) Show	+	'''Maximum number of drivers per player ''<value>''''' - enter a number
−	'''( ) Hide	+	'''Players are permitted to claim drivers            [Check Box]''' - check to allow players to select a driver
−	'''( ) Leave Unchanged	+	'''Players can see each other's driver orders        [Check Box]''' - check to allow players to view orders for other players
−	'''On Screen Vehicle Names:''' - - select one of three option buttons:-	+	'''Automatically target an available train on clients [Check Box]''' - automatically assign a driver to each player
−	'''( ) Show	+
−	'''( ) Hide	+
−	'''( ) Leave Unchanged	+
−	==='''Signal Passed At Danger Check Rule'''===	+	==='''Randomize Rule'''===
−	Executes child rules if a signal or stop mark is ''Passed at Danger (STOP)''.	+	Generates a different set of random numbers each time the session is run.
−	*'''<kuid2:60850:89007:2>'''	+	*'''<kuid:169301:100129>'''
−	*'''Built-in Rule'''	+	*'''DLS Rule''' by '''Terry_Wagstaff'''
−		+
−	*'''Parent Rule'''	+
	'''Properties:'''		'''Properties:'''
−	'''[Check Box] Trigger only once'''	+	'''None'''
−	*'''Trainz Wiki Links:'''	+	*'''Notes:'''
−	**'''[[How to Use Variables in Sessions (Examples)#Example 2: Event Counter and Message Selection|How to Use Variables in Sessions (Examples): Event Counter and Message Selection]]	+	:Place this rule near the top of the Session Rules list and ensure that there is at least 5 seconds before the call to a Random function.
−	==='''Simultaneous List Rule'''===	+	*'''Related Rules:'''
		+	**'''[[#Variable Random|Variable Random]]''' - sets a variable to a random integer value.
−	Executes child rules simultaneously once this rule starts	+	==='''Session Complete Rule'''===
−	*'''<kuid:-25:1048>'''	+	Set session to a percentage of completion.
−	*'''Built-in Rule'''	+	*'''<kuid:447264:1011>'''
−	*'''Parent Rule'''	+	*'''Base Rule'''
	'''Properties:'''		'''Properties:'''
−	'''Rule completes when ...''' - click to chose one of the following:-	+	'''Set session to percent complete ''<value>''''' - enter number as a percentage
−	'''''one of the child rules has completed'''''	+	'''[Check Box] Separate achievements for completion''' - check to set
−	'''''all child rules have reached a completed state'''''	+
−	'''''all child rules have reached a "was completed" state'''''	+
	*'''Related Rules:'''		*'''Related Rules:'''
−	**'''[[#Ordered List Rule|Ordered List Rule]]''' - executes child rules in order	+	**'''[[#End Session Rule|End Session Rule]]''' - end the Session with a fade out.
−	**'''[[#Progressive List Rule|Progressive List Rule]]''' - executes the first child rule on the first run, the second child on the second run, etc	+
−	**'''[[#Random List Rule|Random List Rule]]''' - executes ONE randomly selected child rule	+
−	**'''[[#Reset List Rule|Reset List Rule]]''' - executes all child rules continuously	+
−		+
−	*'''Trainz Wiki Links:'''	+
−	**'''[[Message Popup Rule Applications#Application 1: Event Counter and Message Selection|Message Popup Applications: Timed Message]]	+
−	**'''[[How to Use Parent and Child Rules]]'''	+
−	**'''[[How to Use Variables in Sessions (Examples)#Example 2: Event Counter and Message Selection|How to Use Variables in Sessions (Examples): Event Counter and Message Selection]]	+
−	**'''http://online.ts2009.com/mediaWiki/index.php/Simultaneous_List'''	+
−		+
−	==='''Speeding Check Rule'''===	+
−		+
−	Executes child rules if player controlled trains are over the local speed limit or over a set (custom) speed	+
−		+
−	*'''<kuid2:60850:89004:3>'''	+
−		+
−	*'''Built-in Rule'''	+
−		+
−	*'''Parent Rule'''	+
−		+
−	'''Properties:'''	+
−	Select one of two options to set a speed limit to be observed	+
−	'''( ) Watch for trains travelling above the posted speed limit'''	+
−	'''''<speed value>''''' - click to enter a new overspeed tolerance value	+
−	'''''<speed units>''''' - click to select one from the list:-	+
−	'''''Km/h''''' - Kilometres per hour	+
−	'''''MPH''''' - Miles per hour	+
−	'''''mps''''' - metres per second	+
−	'''( ) Watch for trains travelling above a custom speed'''	+
−	'''''<speed value>''''' - click to enter a new custom speed value	+
−	'''''<speed units>''''' - click to select one from the list:-	+
−	'''''Km/h''''' - Kilometres per hour	+
−	'''''MPH''''' - Miles per hour	+
−	'''''mps''''' - metres per second	+
−	'''Warning: This option is very performance intensive and should only be used in sessions with few trains'''	+
	==='''Startup Options Rule'''===		==='''Startup Options Rule'''===
Line 2,536:		Line 3,269:
	**'''[[#Weather Rule|Weather Rule]]''' - changes weather conditions during Session play		**'''[[#Weather Rule|Weather Rule]]''' - changes weather conditions during Session play
−	==='''Station Visited Check Rule'''===	+	'''[[#top|Back to Top]]'''
		+	----
		+	=='''Time Rules'''==
−	Executes child rules if specific trains call at set stations or industries	+	==='''Clock Rule'''===
−	*'''<kuid2:60850:89005:3>'''	+	Rule needed for animated clocks.
		+
		+	*'''<kuid2:62310:30041:2>'''
	*'''Built-in Rule'''		*'''Built-in Rule'''
−
−	*'''Parent Rule'''
	'''Properties:'''		'''Properties:'''
−	'''Trigger: ''<select>''''' - click to select one of the following	+	'''None'''
−	'''''Never''''' - stopping at the selected industries will never trigger the rule.	+
−	'''''Once only''''' - the rule is triggered on the first visit only to any one of the selected industries	+	*'''Notes:'''
−	'''''Once per industry''''' - the rule is triggered on the first visit to each industry with each individual product	+	:Apply this rule to your session to make use of the animated clocks. See the forum for code to include in your clock object to work with this rule.
−	'''''Once per visit''''' - the rule is triggered on the first visit to each industry regardless of the product	+
−	'''''Once per vehicle''''' - each vehicle can only trigger the rule once.	+
−	'''''<select industry>''''' - select industry or industries from session list	+
−	Select one of two option buttons:-	+
−	'''( ) click to accept all trains'''	+
−	'''( ) click to accept trains matching specific criteria'''	+
−	Selecting the second option will produce the following selection controls:-	+
−	'''Specific vehicle''' - identify the specific vehicle or set of specific vehicles that will trigger the rule	+
−	'''''+''''' - click to add a ''specific'' vehicle from the session list	+
−	'''''x''''' - click to remove the ''specific'' vehicle from the rule	+
−	'''Vehicle types''''' - identify the ''type'' of vehicle or a set of vehicle ''types'' that will trigger the rule	+
−	'''''+''''' - click to add a ''type'' of vehicle from the session list	+
−	'''''x''''' - click to remove the ''type'' of vehicle from the rule	+
−	'''Drivers''''' - identify the ''drivers'' that will trigger the rule	+
−	'''''+''''' - click to add a ''driver'' from the session list	+
−	'''''x''''' - click to remove a ''driver'' from the rule	+
−	----	+
−	'''[[#top|Back to Top]]''' | '''[[#A, B|A, B]]''' | '''[[#C|C]]''' | '''[[#D|D]]''' | '''[[#E, F, G|E, F, G]]''' | '''[[#H, I, J|H, I, J]]''' | '''[[#K, L, M|K, L, M]]''' | '''[[#N, O|N, O]]''' | '''[[#P, Q|P, Q]]''' | '''[[#R|R]]''' | '''[[#S-Se|S-Se]]''' | '''[[#Sh-Sz|Sh-Sz]]''' | '''[[#T|T]]''' | '''[[#U, V|U, V]]''' | '''[[#W, X, Y, Z|W, X, Y, Z]]'''	+
−	=='''T'''==
−
	==='''Time and Rate Rule'''===		==='''Time and Rate Rule'''===
Line 2,612:		Line 3,327:
	**'''[[#Wait Rule|Wait Rule]]''' - executes child rules after waiting for a set number of seconds.		**'''[[#Wait Rule|Wait Rule]]''' - executes child rules after waiting for a set number of seconds.
−	==='''Timed Limited Display HTML Rule (SP2 and later)'''===	+	==='''Wait Rule'''===
−	Displays an HTML browser window for a limited time.	+	Executes child rules after waiting for set number of seconds
−	*'''<kuid2:61392:2005:32>'''	+	*'''<kuid2:122381:10016:2>'''
−	*'''DLS Rule''' by '''pguy'''	+	*'''Built-in Rule'''
−		+
−	'''Properties:'''	+
−	'''HTML Asset Name : ''<[Click to select HTML asset]>''''' - click to select an HTML asset from those installed	+
−	'''Page filename : ''<value>''''' - click to enter the filename of the HTML page in the selected HTML asset. The ''.html'' filename extension is optional.	+
−	'''Play duration (SessVar or duration in seconds) : ''<value>''''' - enter a SessVar name or the number of seconds.	+
−	'''Browser left position (SessVar or position) : ''<value>''''' - enter a SessVar name or the number of pixels from the left screen edge.	+
−	'''Browser top position (SessVar or position) : ''<value>''''' - enter a SessVar name or the number of pixels from the top screen edge.	+
−	'''Browser width (SessVar or position) : ''<value>''''' - enter a SessVar name or the width in pixels.	+
−	'''Browser height (SessVar or position) : ''<value>''''' - enter a SessVar name or the browser height.	+
−	'''[Check Box] ''<Alert is not reshowable on request/Alert is showable on request>''''' - check or click to allow or prevent the user viewing the page again.	+
−		+
−	*'''Notes:'''	+
−	:Seconds are Trainz clock time, not real time.	+
−		+
−	*'''Related Rules:'''	+
−	**'''[[#Close Message Popup Rule|Close Message Popup Rule]]''' - closes open message popups	+
−	**'''[[#Display HTML Pages Rule|Display HTML Pages Rule]]''' - displays HTML pages in a browser window.	+
−	**'''[[#Message Popup Rule|Message Popup Rule]]''' - displays a pop-up browser window and waits for it to be closed.	+
−	**'''[[#Set HTML Page Rule|Set HTML Page Rule]]''' - sets parameters for the '''[[#Display HTML Pages Rule|Display HTML Pages Rule]]'''	+
−		+
−	==='''Trackside Check Rule'''===	+
−		+
−	Executes child rules when a set train enters a set trigger. Similar to the '''Trigger Check Rule''' but provides different options.	+
−		+
−	*'''<kuid2:46162:100207:1>'''	+
−		+
−	*'''DLS Rule''' by '''Josefpav'''	+
	*'''Parent Rule'''		*'''Parent Rule'''
	'''Properties:'''		'''Properties:'''
−	'''Applies to:''' - select one of three option buttons:-	+	'''''<click to set>''''' - enter the number of seconds for the wait delay
−	'''( ) Junction'''	+
−	'''( ) Trigger'''	+
−	'''( ) Trackmark'''	+
−	'''Trackside object name: ''<specify>''''' - select object name from session list	+
−	'''Wait for train to:''' - select one of three option buttons:-	+
−	'''( ) Enter'''	+
−	'''( ) Stop at'''	+
−	'''( ) Leave'''	+
−	'''[Check Box] Auto reset this rule''' - check to execute the rule continuously	+
−	'''Applies to train containing:'''	+
−	'''''<Add vehicle>''''' - click to select a rail vehicle from the session list	+
−	'''''del''''' - click to remove a selected vehicle from the rule	+
−	*'''Related Rules:'''	+	*'''Notes:'''
−	**'''[[#Directional Trigger Check Rule|Directional Trigger Check Rule]]''' - executes child rules when activated by a train moving in a set direction.	+	:Seconds is in Trainz clock time, not real time
−	**'''[[#Trigger Check Rule|Trigger Check Rule]]''' - executes child rules when activated by a train	+
−		+
−	==='''Trigger Check Rule'''===	+
−		+
−	Executes child rules when a set train enters a set trigger. This rule replaces the older and less versatile '''Trigger Rule'''.	+
−		+
−	*'''<kuid:-25:1071>'''	+
−		+
−	*'''Built-in Rule'''	+
−		+
−	*'''Parent Rule'''	+
−		+
−	'''Properties:'''	+
−	'''[Check Box] Trigger only once '''	+
−	'''[Check Box] Wait for child rules to complete even if no trains are present in rule trigger'''	+
−	'''[Check Box] Only activate when the entering vehicle of the train is heading ''<select direction>'' into the trigger''' - select one of two directions:-	+
−	'''''forward'''''	+
−	'''''backward'''''	+
−	'''Triggers List'''	+
−	'''''<add trigger>''''' - select a trigger from the session list	+
−	'''''<delete trigger>''''' - delete a selected trigger from the rule	+
−	Select one of two option buttons:-	+
−	'''( ) click to accept all trains'''	+
−	'''( ) click to accept trains matching specific criteria'''	+
−	Selecting the second option will produce the following selection controls:-	+
−	'''Specific vehicle''' - identify the specific vehicle(s) that will trigger the rule	+
−	'''''+''''' - click to add a ''specific'' vehicle from the session list	+
−	'''''x''''' - click to remove the ''specific'' vehicle from the rule	+
−	'''Vehicle types''''' - identify the ''type'' of vehicle(s) that will trigger the rule	+
−	'''''+''''' - click to add a ''type'' of vehicle from the session list	+
−	'''''x''''' - click to remove the ''type'' of vehicle from the rule	+
−	'''Drivers''''' - identify the ''driver(s)'' that will trigger the rule	+
−	'''''+''''' - click to add a ''driver'' from the session list	+
−	'''''x''''' - click to remove a ''driver'' from the rule	+
	*'''Related Rules:'''		*'''Related Rules:'''
−	**'''[[#Directional Trigger Check Rule|Directional Trigger Check Rule]]''' - executes child rules when activated by a train moving in a set direction.	+	**'''[[#Timecheck Rule|Timecheck Rule]]''' - executes child rules at a set time.
−	**'''[[#Trackside Check Rule|Trackside Check Rule]]''' - executes child rules when activated by a train. Provides different options to the '''Trigger Check Rule'''	+
	*'''Trainz Wiki Links:'''		*'''Trainz Wiki Links:'''
−	**'''[[Message Popup Rule Applications]]	+	**'''[[Message Popup Rule Applications#Application 1: Timed Message|Message Popup Rule Applications: Timed Message]]'''
−	**'''[[How to Use Navigation Point Rules (Applications)#Application 3: Wait for Loading to be Completed|How to Use Navigation Point Rules (Applications): Wait for Loading to be Completed]]	+	**'''[[How to Use Navigation Point Rules (Applications)#Application 4: User Path Selection|How to Use Navigation Point Rules (Applications): User Path Selection]]
−	**'''[[How to Use Track Triggers]]'''	+
−	**'''[[How to Use Variables in Sessions (Examples)]]	+
−	==='''Trigger Multiple Signals Rule'''===	+	'''[[#top|Back to Top]]'''
		+	----
		+	=='''Variable Rules'''==
−	Sets selected signals to DANGER (STOP) when selected triggers are activated. Signals will be at AUTOMATIC when the triggers are not activated.	+	==='''Quick Session Variables Rule'''===
−	*'''<kuid2:116387:26:1>'''	+	Allows the editing of session variables
−	*'''DLS Rule''' by '''maggs'''	+	*'''<kuid2:61392:5003:30>'''
		+
		+	*'''DLS Rule''' by '''pguy'''
	'''Properties:'''		'''Properties:'''
−	'''<add signal>''' - select a signal from the Session List. More than one signal can be added.	+	'''''<local>''''' - click to edit local variables
−	'''<delete>''' - remove a signal from the rule.	+	'''''<add new session variable>''''' - click to enter the name of new local variable
−	'''<add trigger>''' - select a trigger from the Session List. More than one trigger can be added.	+	for each variable:-
−	'''<delete>''' - remove a trigger from the rule.	+	'''''<variable-name>''''' - click to change variable name
		+	'''''<type>''''' - click to select one of:-
		+	'''string''' - text characters
		+	'''int''' - integer
		+	'''float''' - real (decimal) numbers
		+	'''bool''' - boolean (true/false)
		+	'''stringset''' - ''meaning not known at this time''
		+	'''stringlist''' - ''meaning not known at this time''
		+	'''tkmlist''' - trackmark list (no longer supported in TANE SP2)
		+	'''platformlist''' - platform list (no longer supported in TANE SP2)
		+	'''''del''''' - delete variable
		+	'''''edit''''' - edit variable
		+	'''''<trains>''''' - click to edit a train variable
		+	'''''<train selected>''''' - click to select a train from the session list. Initially none is selected
		+	'''''<select train>''''' - click to select a locomotive
		+	'''''<select vehicle>''''' - click to select a rail vehicle
		+	for the selected loco/vehicle:-
		+	'''''<Add new session variable>''''' - click to enter the name of a new variable
		+	for the entered variable:-
		+	'''''<variable-name>''''' - click to change variable name
		+	'''''<type>''''' - click to select type (see list above)
		+	'''''<objects>''''' - no longer supported in TANE SP2
		+	'''''<global>''''' - no longer supported in TANE SP2
		+
		+	*'''Known Issues:'''
		+	:Rule creator, '''pguy''', has indicated that the future of this rule is uncertain as parts of it have been devalued in the latest release of TANE.
	*'''Related Rules:'''		*'''Related Rules:'''
−	**'''[[#Set Signal Extended Rule|Set Signal Extended Rule]]''' - sets a selected signal to a specific signal state	+	**'''[[#Variable Check Rule|Variable Check Rule]]''' - executes child rules according to the value of a specified variable.
−	----	+	**'''[[#Variable Modify Rule|Variable Modify Rule]]''' - changes the value of a specified variable.
−	'''[[#top|Back to Top]]''' | '''[[#A, B|A, B]]''' | '''[[#C|C]]''' | '''[[#D|D]]''' | '''[[#E, F, G|E, F, G]]''' | '''[[#H, I, J|H, I, J]]''' | '''[[#K, L, M|K, L, M]]''' | '''[[#N, O|N, O]]''' | '''[[#P, Q|P, Q]]''' | '''[[#R|R]]''' | '''[[#S-Se|S-Se]]''' | '''[[#Sh-Sz|Sh-Sz]]''' | '''[[#T|T]]''' | '''[[#U, V|U, V]]''' | '''[[#W, X, Y, Z|W, X, Y, Z]]'''	+	**'''[[#Variable Modify Continuous Rule|Variable Modify Continuous Rule]]''' - continuously changes the value of a specified variable.
		+	**'''[[#Variable Random Rule|Variable Random Rule]]''' - assigns a random value to a variable.
		+	**'''[[#Variable Show Rule|Variable Show Rule]]''' - adds or removes a specified variable and a descriptive label to the custom HUD.
−	=='''U, V'''==
−
	==='''Variable Check Rule'''===		==='''Variable Check Rule'''===
Line 2,874:		Line 3,542:
	**'''[[How to Use Variables in Sessions (Examples)]]		**'''[[How to Use Variables in Sessions (Examples)]]
−	==='''Vehicle Physics Rule'''===	+	'''[[#top|Back to Top]]'''
−		+
−	Overrides the default vehicle physics properties for all vehicles or for those matching set criteria	+
−		+
−	*'''<kuid:-25:1052>'''	+
−		+
−	*'''Built-in Rule'''	+
−		+
−	'''Properties:'''	+
−	Select one of two option buttons:-	+
−	'''( ) click to accept all trains'''	+
−	'''( ) click to accept trains matching specific criteria'''	+
−	Selecting the second option will produce the following selection controls:-	+
−	'''Specific vehicle''' - identify the specific vehicle or set of specific vehicles that will trigger the rule	+
−	'''''+''''' - click to add a ''specific'' vehicle from the session list	+
−	'''''x''''' - click to remove the ''specific'' vehicle from the rule	+
−	'''Vehicle types''''' - identify the ''type'' of vehicle or a set of vehicle ''types'' that will trigger the rule	+
−	'''''+''''' - click to add a ''type'' of vehicle from the session list	+
−	'''''x''''' - click to remove the ''type'' of vehicle from the rule	+
−	'''Drivers''''' - identify the ''drivers'' that will trigger the rule	+
−	'''''+''''' - click to add a ''driver'' from the session list	+
−	'''''x''''' - click to remove a ''driver'' from the rule	+
−	'''Coupler Parameters:'''	+
−	'''Couplers break at ''<value>'' kN expansion force''' - enter force value	+
−	'''Couplers break at when coupling above ''<value>'' kph''' - enter speed value	+
−	'''[Check Box] Show coupler breakage in HUD''' - check to display breakage in on-screen HUD	+
−	'''Wheelslip Parameters:'''	+
−	'''Maximum tractive effort adjusted by ''<value>'' %''' - enter adjustment as a %	+
−	'''Traction is reduced to ''<value>'' % while wheelslipping''' - enter value as a %	+
−	'''Traction boost is ''<value>'' % while sanding''' - enter value as a %	+
−	'''Sway Parameters:'''	+
−	'''Cab sway level is set to ''<value>'' %''' - enter value as a %	+
	----		----
−	'''[[#top|Back to Top]]''' | '''[[#A, B|A, B]]''' | '''[[#C|C]]''' | '''[[#D|D]]''' | '''[[#E, F, G|E, F, G]]''' | '''[[#H, I, J|H, I, J]]''' | '''[[#K, L, M|K, L, M]]''' | '''[[#N, O|N, O]]''' | '''[[#P, Q|P, Q]]''' | '''[[#R|R]]''' | '''[[#S-Se|S-Se]]''' | '''[[#Sh-Sz|Sh-Sz]]''' | '''[[#T|T]]''' | '''[[#U, V|U, V]]''' | '''[[#W, X, Y, Z|W, X, Y, Z]]'''	+	=='''Weather Rules'''==
		+
		+	==='''EIRS Weather Rule NE USA Rule'''===
−	=='''W, X, Y, Z'''==	+	Customize random weather rule relative to the North East Region of the United States.
−	==='''Wait for Camera View Mode Rule'''===	+	*'''<kuid2:487222:1037:3>'''
−		+
−	Executes child rules when the camera view is changed to a selected view	+
−		+
−	*'''<kuid:-25:192>'''	+
	*'''Built-in Rule'''		*'''Built-in Rule'''
−
−	*'''Parent Rule'''
	'''Properties:'''		'''Properties:'''
−	'''[Check Box] Trigger rule once''' - check to set	+	'''Season ''<select>''''' - select one of:-
−	'''Wait for the camera to change to the ''<click to select>''''' - select one camera view mode from:-	+	'''''Summer'''''
−	'''Cab View'''	+	'''''Fall'''''
−	'''External View'''	+	'''''Winter'''''
−	'''Tracking View'''	+	'''''Spring'''''
−	'''Free Roaming'''	+	'''Random Changeability (minutes) ''<value>''''' - select one of:-
−	'''[Check Box] Wait for the camera to target vehicle ''<click to select>''''' - if checked, select a vehicle from the Session list	+	'''''2/5/10/15/20/30/45/60''''' - minutes''
		+	'''Environment Settings ''<select>''''' - select one of:-
		+	'''''Disable/Enable'''''
−	*'''Related Rules:'''	+	*'''Notes:'''
−	**'''[[#Cinematic Camera Rule|Cinematic Camera Rule]]''' - provides several different cinematic style cameras with animations	+	:Minutes are Trainz clock times, not real times
−	**'''[[#Focus Camera Rule|Focus Camera Rule]]''' - sets the initial camera view and starting vehicle for a session	+
−	**'''[[#Set Camera Rule|Set Camera Rule]]''' - sets the target object and properties of the camera	+
−		+
−	==='''Wait for Click on HUD Icon Rule'''===	+
−		+
−	Executes child rules when the user clicks on a selected HUD icon	+
−		+
−	*'''<kuid:-25:951> <kuid:-25:970>''' - two versions built-in with different kuids, both have the same properties	+
−		+
−	*'''Built-in Rule'''	+
−		+
−	*'''Parent Rule'''	+
−		+
−	'''Properties:'''	+
−	'''[Check Box] Trigger Once'''	+
−	'''HUD Panel ''<Click>''''' - click choose from list:-	+
−	'''Bottom Right Menu'''	+
−	'''Camera Controls'''	+
−	'''DCC Controls'''	+
−	'''Icon ''<Click>''''' - click to choose from list. Selections depends on HUD Panel chosen	+
	*'''Related Rules:'''		*'''Related Rules:'''
−	**'''[[#Display Custom HUD Rule|Display Custom HUD Rule]]''' - shows or hides the Custom Heads Up Display.	+	**'''[[#Random Weather Rule v2|Random Weather Rule v2]]''' - randomly changes the weather according to entered parameters
−	**'''[[#Flash HUD Icon Rule|Flash HUD Icon Rule]]''' - flashes a HUD panel icon for a set duration.	+	**'''[[#Startup Options Rule|Startup Options Rule]]''' - sets the weather conditions at the start of a Session
−	**'''[[#mc Display Custom HUD V2 Rule (SP2 and later)|mc Display Custom HUD V2 Rule (SP2 and later)]]''' - shows or hides a graphical HUD.	+	**'''[[#Weather Rule|Weather Rule]]''' - changes the weather conditions during Session play
−	**'''[[#Quick CustomHud Manager Rule (SP2 and later)|Quick CustomHud Manager Rule (SP2 and later)]]''' - creates custom HUDs that can be assigned to different drivers	+
−	**'''[[#Show/Hide HUD Panel Rule|Show/Hide HUD Panel Rule]]''' - shows or hides a HUD panel.	+
−	**'''[[#Variable Show Rule|Variable Show Rule]]''' - adds or removes a specified variable and a descriptive label to the custom HUD.	+
−	==='''Wait for Derailment Rule'''===	+	==='''Random Weather Rule v2'''===
−	Executes child rules when a derailment occurs	+	Randomly changes the weather conditions between set values over a set duration.
−	*'''<kuid:-25:1053>'''	+	*'''<kuid:169301:100132>'''
−	*'''Built-in Rule'''	+	*'''DLS Rule''' by '''terry_wagstaff'''
−		+
−	*'''Parent Rule'''	+
	'''Properties:'''		'''Properties:'''
−	'''[Check Box] Trigger derailment watch once''' - check to execute the rule once only	+	'''Starting weather ''<select>'' - select one of:-
		+	'''''Clear weather, no clouds, rain or snow'''''
		+	'''''Cloudy weather, no rain'''''
		+	'''''Drizzle, light rain'''''
		+	'''''Rain'''''
		+	'''''Stormy weather that includes lightning and thunder'''''
		+	'''''Snowing lightly'''''
		+	'''''Medium snowfall'''''
		+	'''''Heavy snow'''''
		+	'''Best weather ''<select>'' - select one of:-
		+	'''''Clear weather, no clouds, rain or snow'''''
		+	'''''Cloudy weather, no rain'''''
		+	'''''Drizzle, light rain'''''
		+	'''''Rain'''''
		+	'''''Stormy weather that includes lightning and thunder'''''
		+	'''''Snowing lightly'''''
		+	'''''Medium snowfall'''''
		+	'''''Heavy snow'''''
		+	'''Worst weather ''<select>'' - select one of:-
		+	'''''Clear weather, no clouds, rain or snow'''''
		+	'''''Cloudy weather, no rain'''''
		+	'''''Drizzle, light rain'''''
		+	'''''Rain'''''
		+	'''''Stormy weather that includes lightning and thunder'''''
		+	'''''Snowing lightly'''''
		+	'''''Medium snowfall'''''
		+	'''''Heavy snow'''''
		+	'''Changing about every: ''<value>'' mins''' - enter number of minutes between weather changes
−	*'''Related Rules:'''	+	*'''Known issues:'''
−	**'''[[#Clean Up Derailed Trains Rule|Clean Up Derailed Trains Rule]]''' - cleans up derailed train cars after a set time delay	+	:This rule, once started, will run continuously and will not terminate so do NOT use this rule as a child rule in an '''Ordered List Rule''' because any following child rules will never be executed.
−	**'''[[#Replace Missing Vehicles Rule|Replace Missing Vehicles Rule]]''' - creates a replacement train after a derailment	+
−		+
−	==='''Wait for Driver On/Off Train Rule'''===	+
−		+
−	Executes child rules when a driver gets on or off a train	+
−		+
−	*'''<kuid:-25:953>'''	+
−		+
−	*'''Built-in Rule'''	+
−		+
−	*'''Parent Rule'''	+
−		+
−	'''Properties:'''	+
−	'''[Check Box] Trigger Rule Once''' - click to set''	+
−	'''Wait for a driver character to get ''<On/Off>''''' a train that matches the following criteria''' - select '''On''' or '''Off'''	+
−	Select one of two option buttons:-	+
−	'''( ) click to accept all trains'''	+
−	'''( ) click to accept trains matching specific criteria'''	+
−	Selecting the second option will produce the following selection controls:-	+
−	'''Specific vehicle''' - identify the specific vehicle or set of specific vehicles that will trigger the rule	+
−	'''''+''''' - click to add a ''specific'' vehicle from the session list	+
−	'''''x''''' - click to remove the ''specific'' vehicle from the rule	+
−	'''Vehicle types''''' - identify the ''type'' of vehicle or a set of vehicle ''types'' that will trigger the rule	+
−	'''''+''''' - click to add a ''type'' of vehicle from the session list	+
−	'''''x''''' - click to remove the ''type'' of vehicle from the rule	+
−	'''Drivers''''' - identify the ''drivers'' that will trigger the rule	+
−	'''''+''''' - click to add a ''driver'' from the session list	+
−	'''''x''''' - click to remove a ''driver'' from the rule	+
	*'''Related Rules:'''		*'''Related Rules:'''
−	**'''[[#Wait for Driver/Train to be Locally Owned Rule|Wait for Driver/Train to be Locally Owned Rule]]''' - executes child rules when a vehicle or driver changes ownership	+	**'''[[#EIRS Weather Rule NE USA Rule|EIRS Weather Rule NE USA Rule]]''' - customize random weather rule relative to the North East Region of the United States
−		+	**'''[[#Startup Options Rule|Startup Options Rule]]''' - sets the weather conditions at the start of a Session
−	==='''Wait for Driver/Train to be Locally Owned Rule'''===	+
−		+
−	Executes child rules when a specific driver or vehicle is locally owned. If the driver/vehicle becomes unowned again the child rules are paused	+
−		+
−	*'''<kuid2:401543:1173:1>'''	+
−		+
−	*'''Built-in Rule'''	+
−		+
−	*'''Parent Rule'''	+
−		+
−	'''Properties:'''	+
−	'''Assets Ownership:''' - select one of two option buttons:-	+
−	'''( ) Wait for ownership of a specific Driver'''	+
−	'''( ) Wait for ownership of Driver'''	+
−	'''Driver or Vehicle ''<select>''''' - choose from session list	+
−		+
−	*'''Related Rules:'''	+
−	**'''[[#Wait for Driver On/Off Train Rule|Wait for Driver On/Off Train Rule]]''' - executes child rules when a driver gets on or off a train	+
−		+
−	==='''Wait on Navigation Point Rule'''===	+
−		+
−	Executes child rules when a specific navigation point is completed	+
−		+
−	*'''<kuid:401543:1168>'''	+
−		+
−	*'''Base Rule'''	+
−		+
−	*'''Parent Rule'''	+
−		+
−	'''Properties:'''	+
−	'''navigation point ''<click here to set>''''' - enter the number of the navigation point to be completed	+
−	'''in set ''<click here to set>''''' - enter the unique name for the navigation set created using the '''Navigation Display Rule'''.	+
−	Name must be in lowercase and have no spaces.	+
−		+
−	*'''Known Issues:'''	+
−	:The rule will '''NOT''' check to see if the named navigation set and point exists or not.	+
−		+
−	*'''Related Rules:'''	+
−	**'''[[#Navigation Display Rule|Navigation Display Rule]]''' - creates a set of navigation points.	+
−	**'''[[#Navigation Set Hide/Show Rule|Navigation Set Hide/Show Rule]]''' - makes a navigation set visible/invisible.	+
−	**'''[[#Navigation Set Check Rule|Navigation Set Check Rule]]''' - executes child rules if a navigation set is complete or incomplete.	+
−	**'''[[#Navigation Set Clear Rule|Navigation Set Clear Rule]]''' - completes (terminates) a navigation set.	+
−	**'''[[#Navigation Point Complete Rule|Navigation Point Complete Rule]]''' - manually completes (terminates) a specific navigation point in a set.	+
−		+
−	*'''Trainz Wiki Links:'''	+
−	**'''[[Message Popup Rule Applications#Application 2: Navigation Point and Train Stopped Event Message|Message Popup Rule Applications: Navigation Point and Train Stopped Event Message]]	+
−	**'''[[How to Use Navigation Point Rules (Applications)]]'''	+
−	**'''[[How to Use Navigation Point Rules]]'''	+
−		+
−	==='''Wait on Train Stop/Start Rule'''===	+
−		+
−	Executes child rules when a train stops or starts moving	+
−		+
−	*'''<kuid:-25:1069>'''	+
−		+
−	*'''Built-in Rule'''	+
−		+
−	*'''Parent Rule'''	+
−		+
−	'''Properties:'''	+
−	'''[Check Box] Trigger rule once'''	+
−	'''Wait for a train that matches the following criteria to ''<select>''''' - select one of:-	+
−	'''''start moving'''''	+
−	'''''stop moving'''''	+
−	Select one of two option buttons:-	+
−	'''( ) click to accept all trains'''	+
−	'''( ) click to accept trains matching specific criteria'''	+
−	Selecting the second option will produce the following selection controls:-	+
−	'''Specific vehicle''' - identify the specific vehicle or set of specific vehicles that will trigger the rule	+
−	'''''+''''' - click to add a ''specific'' vehicle from the session list	+
−	'''''x''''' - click to remove the ''specific'' vehicle from the rule	+
−	'''Vehicle types''''' - identify the ''type'' of vehicle or a set of vehicle ''types'' that will trigger the rule	+
−	'''''+''''' - click to add a ''type'' of vehicle from the session list	+
−	'''''x''''' - click to remove the ''type'' of vehicle from the rule	+
−	'''Drivers''''' - identify the ''drivers'' that will trigger the rule	+
−	'''''+''''' - click to add a ''driver'' from the session list	+
−	'''''x''''' - click to remove a ''driver'' from the rule	+
−		+
−	*'''Trainz Wiki Links:'''	+
−	**'''[[Message Popup Rule Applications#Application 2: Navigation Point and Train Stopped Event Message|Message Popup Rule Applications: Navigation Point and Train Stopped Event Message]]'''	+
−		+
−	==='''Wait on Waybill Screen/Main Screen Rule'''===	+
−		+
−	Executes child rules when the Waybill window is opened or closed	+
−		+
−	*'''<kuid:-25:957>'''	+
−		+
−	*'''Built-in Rule'''	+
−		+
−	*'''Parent Rule'''	+
−		+
−	'''Properties:'''	+
−	'''[Check Box] Trigger rule once''' - check to trigger the rule once only	+
−	'''Wait for the Waybill window to be ''<opened/closed>''''' - select either '''opened''' or '''closed'''.	+
−		+
−	==='''Wait Rule'''===	+
−		+
−	Executes child rules after waiting for set number of seconds	+
−		+
−	*'''<kuid2:122381:10016:2>'''	+
−		+
−	*'''Built-in Rule'''	+
−		+
−	*'''Parent Rule'''	+
−		+
−	'''Properties:'''	+
−	'''''<click to set>''''' - enter the number of seconds for the wait delay	+
−		+
−	*'''Notes:'''	+
−	:Seconds is in Trainz clock time, not real time	+
−		+
−	*'''Related Rules:'''	+
−	**'''[[#Timecheck Rule|Timecheck Rule]]''' - executes child rules at a set time.	+
−		+
−	*'''Trainz Wiki Links:'''	+
−	**'''[[Message Popup Rule Applications#Application 1: Timed Message|Message Popup Rule Applications: Timed Message]]'''	+
−	**'''[[How to Use Navigation Point Rules (Applications)#Application 4: User Path Selection|How to Use Navigation Point Rules (Applications): User Path Selection]]	+
	==='''Weather Rule'''===		==='''Weather Rule'''===
Line 3,154:		Line 3,646:
	**'''[[#Random Weather Rule v2|Random Weather Rule v2]]''' - randomly changes the weather according to entered parameters		**'''[[#Random Weather Rule v2|Random Weather Rule v2]]''' - randomly changes the weather according to entered parameters
	**'''[[#Startup Options Rule|Startup Options Rule]]''' - sets the weather conditions at the start of a Session		**'''[[#Startup Options Rule|Startup Options Rule]]''' - sets the weather conditions at the start of a Session
		+
		+	'''[[#top|Back to Top]]'''
	----		----
−	'''[[#top|Back to Top]]''' | '''[[#A, B|A, B]]''' | '''[[#C|C]]''' | '''[[#D|D]]''' | '''[[#E, F, G|E, F, G]]''' | '''[[#H, I, J|H, I, J]]''' | '''[[#K, L, M|K, L, M]]''' | '''[[#N, O|N, O]]''' | '''[[#P, Q|P, Q]]''' | '''[[#R|R]]''' | '''[[#S-Se|S-Se]]''' | '''[[#Sh-Sz|Sh-Sz]]''' | '''[[#T|T]]''' | '''[[#U, V|U, V]]''' | '''[[#W, X, Y, Z|W, X, Y, Z]]'''

---

Revision as of 08:00, 16 June 2018

TRAINZ A New Era (TANE) SP2. List of Trainz Session Rules by Categories with Properties. All rules are the Copyright of N3V Games

This page is always under construction. As new rules appear they will be added to this list.

Only rules supplied with TANE or on the DLS are covered in this document.

Also available Session Rule List (Alphabetical) with Parameters

---

Description Key:

• <kuid number> is for the rule version at the time of writing. This number will change if the rule is updated.
• DLS Rule must be downloaded and installed from the DLS.
• Base Rule and Built-in Rule is installed with TANE.
• Parent Rule will execute child rules if it returns a true result.
• Obsolete Rule is no longer required (explanation given).
• Legacy Rule has been replaced by another rule (new rule will be identified).

Contents 1 Achievement Rules 1.1 Achievement Check Rule 1.2 Consist Check Rule 1.3 Multiple Resource Check Rule 1.4 Objective Add Rule 1.5 Objective Check Rule 1.6 Objective Update Rule 1.7 Ranked Session Begin Rule 1.8 Ranked Session Complete Rule 1.9 Resource Check Rule 1.10 Resource Verify Rule (fixed) 1.11 Station Visited Check Rule 2 Camera Rules 2.1 Cinematic Camera Rule 2.2 Focus Camera Rule 2.3 Set Camera Rule 2.4 Wait for Camera View Mode Rule 3 Danger, Derailment and Safety Rules 3.1 ATP Speed Limiter Rule 3.2 AWS Configuration Rule 3.3 Clean Up Derailed Trains Rule 3.4 Coupler Breakage Check Rule 3.5 Coupler Breakage HUD Rule 3.6 Junction Derailment Prevention Rule 3.7 Replace Missing Vehicles Rule 3.8 Safety System Engaged Check Rule 3.9 Safety System Isolated Check Rule 3.10 Set Coupler Masks Rule 3.11 Signal Passed At Danger Check Rule 3.12 Speeding Check Rule 3.13 Vehicle Physics Rule 3.14 Wait for Derailment Rule 4 Driver Rules 4.1 AI Start Rule 4.2 AI Stop Rule 4.3 Control Check Rule 4.4 Control Type Rule 4.5 Disallow AI Rule 4.6 Driver Command Check Rule 4.7 Driver Command Rule 4.8 Driver Main Menu Options Rule 4.9 Driver Schedule Rule 4.10 Driver Setup Rule 4.11 Enable/Disable Driver Commands Rule 4.12 JTG Correct Vehicle Lights 4.13 Quick Portal Manager Standard Edition Rule (SP2 and later) 4.14 QuickDrive Rule 4.15 Wait for Driver On/Off Train Rule 4.16 Wait for Driver/Train to be Locally Owned Rule 5 HUD (Heads Up Display) Rules 5.1 Cab Controls HUD Rule 5.2 Coupler Breakage HUD Rule 5.3 Display Custom HUD Rule 5.4 Flash HUD Icon Rule 5.5 mc Display Custom HUD V2 Rule (SP2 and later) 5.6 Quick CustomHud Manager Rule (SP2 and later) 5.7 Show/Hide HUD Panel Rule 5.8 Variable Show Rule 5.9 Wait for Click on HUD Icon Rule 6 Industry Rules 6.1 Advanced Industry Load Configuration Rule 6.2 Disable/Enable Industry Rule 6.3 DisplayIndustryStatus Rule (color modified) 6.4 ExTrainz Manager Rule - TANE SP2 6.5 Multiple Resource Check Rule 6.6 Power Station Rule 6.7 Resource Check Rule 6.8 Resource Verify Rule (fixed) 6.9 Station Visited Check Rule 7 Interlocking Tower, Junction and Signal Rules 7.1 Interlocking Tower Configure Path Rule 7.2 Interlocking Tower Path Selection UI Rule 7.3 Interlocking Tower Set Path Rule 7.4 Interlocking Tower Enhanced Manager Rule (SP2 and later) 7.5 Junction Derailment Prevention Rule 7.6 Lock All Junctions Rule 7.7 MissionCode Manager Rule (SP2 and later) 7.8 MissionCode Stops and Timetable Manager Rule (SP2 and later) 7.9 Multiple Junction Alignment Check Rule 7.10 Set Cleared Junctions Rule 7.11 Set Junctions Rule 7.12 Set Signal Extended Rule 7.13 Trigger Multiple Signals Rule 8 Message Rules 8.1 Close Message Popup Rule 8.2 DestSign Table Rule 8.3 Display HTML Pages Rule 8.4 Display Video Rule 8.5 DisplayIndustryStatus Rule (color modified) 8.6 ExTrainz Manager Rule - TANE SP2 8.7 Fade In/Out Rule 8.8 Hide Product Overlays Rule 8.9 InputTable Rule 8.10 Message Popup Rule 8.11 Minimap Options Rule 8.12 Play Sound Rule 8.13 Session Metadata Rule 8.14 Set Helper Icon Size Rule 8.15 Set HTML Pages Rule 8.16 Show/Hide Layer Rule 8.17 Show/Hide Minimap Rule 8.18 Show/Hide On-screen Help Rule 8.19 Timed Limited Display HTML Rule (SP2 and later) 8.20 Wait on Waybill Screen/Main Screen Rule 9 Miscellaneous Rules 9.1 ConsistDataHandler Rule 9.2 Custom Script Rule 9.3 Generic TreeNode Debug Window Rule 9.4 Session Debug Rule 10 Navigation Rules 10.1 Directional Trigger Check Rule 10.2 Navigation Display Rule 10.3 Navigation Point Complete Rule 10.4 Navigation Set Check Rule 10.5 Navigation Set Clear Rule 10.6 Navigation Set Hide/Show Rule 10.7 Schedule Rule 10.8 Trackside Check Rule 10.9 Trigger Check Rule 10.10 Wait on Navigation Point Rule 10.11 Wait on Train Stop/Start Rule 11 Resources Rules 11.1 DisplayIndustryStatus Rule (color modified) 11.2 ExTrainz Manager Rule - TANE SP2 11.3 Hide Product Overlays Rule 11.4 Multiple Resource Check Rule 11.5 Resource Check Rule 11.6 Resource Verify Rule (fixed) 12 Session Sequence Rules 12.1 Ordered List Rule 12.2 Progressive List Rule 12.3 Random List Rule 12.4 Reset List Rule 12.5 Simultaneous List Rule 13 Speed Rules 13.1 ATP Speed Limiter Rule 13.2 Speeding Check Rule 13.3 MaxPermittedSpeed Rule 14 Startup and Termination Rules 14.1 End Session Rule 14.2 Multiplayer Rule 14.3 Randomize Rule 14.4 Session Complete Rule 14.5 Startup Options Rule 15 Time Rules 15.1 Clock Rule 15.2 Time and Rate Rule 15.3 Timecheck Rule 15.4 Wait Rule 16 Variable Rules 16.1 Quick Session Variables Rule 16.2 Variable Check Rule 16.3 Variable Modify Continuous Rule 16.4 Variable Modify Rule 16.5 Variable Random Rule 16.6 Variable Show Rule 17 Weather Rules 17.1 EIRS Weather Rule NE USA Rule 17.2 Random Weather Rule v2 17.3 Weather Rule

Achievement Rules

Achievement Check Rule

Executes child rules when achievement conditions have been met

• <kuid:401543:1190>

• Built-in Rule

• Parent Rule

Properties:
   <Not configured, click here to select an achievement asset> - click to select an Achievement Asset from those installed
      When an Achievement Asset has been selected, the following will appear:-
      Achievement KUID: <selected asset name> - click to change the selected Achievement Asset
      Achievement name: <not set> - click to select the achievement name from the selected asset
      Trigger if achievement: <select> - choose one of:-
         has been gained - the rule will be triggered when this achievement has been gained
         has not been gained - the rule will be triggered when this achievement has NOT been gained

Consist Check Rule

Executes child rules when a matching consist is found. The order of the vehicles in the consists is not important.

• <kuid:-25:1068>

• Built-in Rule

• Parent Rule

Properties:
   [Check Box] Enforce strict exclusive testing - check to only accept an exact match with no unspecified vehicles in the consist.
      - leave unchecked to accept any consist that contains the specified vehicles. 
   Select one of two option buttons:-
   ( ) Rule disabled - select to disable the operation of this rule
   ( ) Complete whenever a train matching the description exists - When selected, enter the consist description:-
      Specific vehicle - identify the specific vehicle(s) that will trigger the rule
         + - click to add a specific vehicle from the session list
         x - click to remove the specific vehicle from the rule
      Vehicle types - identify the type of vehicle(s) that will trigger the rule
         + - click to add a type of vehicle from the session list
         x - click to remove the type of vehicle from the rule
      Drivers - identify the driver(s) that will trigger the rule
         + - click to add a driver from the session list
         x - click to remove a driver from the rule

• Known Issues:

When used as a top level parent rule it does not terminate after triggering but will continue to check all consists for a match and will trigger every time another match is found.

• Trainz Wiki Links:
  • http://online.ts2009.com/mediaWiki/index.php/Consist_Check_Rule
  • How to Use Variables in Sessions (Examples): Counting Consist Checks

Multiple Resource Check Rule

Executes child rules if industries or vehicles reach set commodity levels. This rule replaces the older Resource Check Rule

• <kuid:-25:656>

• Built-in Rule

• Parent Rule

Properties:
   <Product Level> - click to select a product test from two choices:-
      Reach/Exceed - sets an upper limit for the resources being monitored. 
         For example: the rule will be triggered if the quantity of coal in a coal loader stockpile or a coal wagon reaches or exceeds a specified level.
         The initial level in the object must be below the set upper limit.
      Fall below - sets a lower limit for the resources being monitored. 
         For example: the rule will be triggered if the quantity of coal in a coal loader stockpile or a coal wagon falls below a specified level. 
         The initial level in the object must be above the set lower limit. 
         To test when a resource level reaches zero (i.e. is empty) set the lower limit to a very low value but not zero as the level can never fall below zero. 
   <value> - enter required quantity value
   <select> - select a product from session list of products
   <Add object> - click to select a source or target object. Multiple objects and their queues can be added to the rule. 
      ALL the entered products must reach/exceed or fall below the specified value for the rule to be triggered. 
      For each object:-
         <Object> - click to select session active industry or product enabled rail vehicle 
         <Queue> - select product queue (there may be only one available)
         <Remove> - removes the object and its product queue from the rule

• Notes:

This rule only checks for changing commodity levels during loading and unloading operations. It cannot be used to test, for example, if a vehicle is full or empty.

• Related Rules:
  • Resource Check Rulehttp: executes child rules when set resource (commodity) levels are reached
  • Resource Verify Rule (fixed) - executes child rules when a set resource (commodity) level is reached

• Trainz Wiki Links:
  • How to Use Navigation Point Rules (Applications): Wait for Loading to be Completed

Objective Add Rule

Sets up a game Objective with ID and display Name

• <kuid:401543:2001>

• Base Rule

Properties:
   Priority <Select> - select one of:-
      Above Normal
      Below Normal
      Normal
      Optional
      Urgent
   Completion Target Number <value> - to set Completion Target Number
   Icon <select> - to select Icon from list
   Display Name <enter> - to insert Name
   Unique Objective ID <enter> - enter a unique objective ID
   Custom Message <Text Box> - insert typed message in text area

• Related Rules:
  • Objective Check Rule - executes child rules if an objective is completed
  • Objective Update Rule - changes the progress of a game objective

Objective Check Rule

Executes child rules if an objective created with the Objective Add Rule is complete.

• <kuid:401543:2003>

• Base Rule

• Parent Rule

Properties:
   Unique Objective ID <value> - enter the unique ID created with the Objective Add Rule 
   Mode <select> - select one of three:-
      Wait for completion
      Wait for failure
      Wait for progress

• Related Rules:
  • Objective Add Rule - sets up a game objective
  • Objective Update Rule - changes the progress of a game objective

Objective Update Rule

Changes progress of an objective outcome created with the Objective Add Rule according to Property choices

• <kuid:401543:2002>

• Base Rule

Properties:
   Unique Objective ID <value> - enter the unique ID created with the Objective Add Rule 
   Mode <select> - select one from the following options
      Decrement progress
      Increment progress
      Reset Objective
      Set objects as complete
      Set objects as failed
      Set progress
      Set progress only if greater
   Amount <value> - click to enter a value

• Related Rules:
  • Objective Add Rule - sets up a game objective
  • Objective Check Rule - executes child rules if an objective is completed

Ranked Session Begin Rule

Begins a ranked Session

• <kuid:401543:2031>

• Base Rule

Properties:
   Countdown Starting Value <value>
      hrs:
      min:
      sec:
   1 through 5 stars, points for each star <value> - enter number of points for each star rating
   Session timer mode: - select one of three option buttons:-
      ( ) Timer
      ( ) Countdown Starting value <value> - enter time hh:mm:ss
      ( ) None

• Notes:

Times are Trainz clock time, not real time

• Related Rules:
  • Ranked Session Complete Rule - completes the active ranked Session

Ranked Session Complete Rule

Completes the active ranked Session

• <kuid:401543:2032>

• Base Rule

Properties:
   Set the active ranked session as: - select one of two option buttons:-
      ( ) Complete
      ( ) Failed
   [Check Box] Customize the completion message <text> - enter a text message

• Related Rules:
  • Ranked Session Begin Rule - begins a ranked Session

Resource Check Rule

Executes child rules if a selected industry or vehicle reaches a set commodity level. This rule has been superseded by the Multiple Resource Check Rule

• <kuid:-25:1067>

• Legacy Rule (replaced by Multiple Resource Check Rule)

• Built-in Rule

• Parent Rule

Properties:
   Select one of two option buttons:-
      ( ) Watch industry queue
         Target Object <select> - select an industry from the session list
         Queue <select> - select a product queue from the selected industry
         Product <select> - select a product from the selected queue
         Amount <value> - enter a quantity
         Select one of two option buttons:-
            ( ) Complete when designated queue equals or exceeds required amount
            ( ) Complete when designated queue falls below required amount
      ( ) Watch vehicle
         Target Object <select> - select a rolling stock asset from the session list
         Queue <select> - select a product queue from the selected rolling stock
         Product <select> - select a product from the selected queue
         Amount <value> - enter a quantity
         Select one of two option buttons:-
            ( ) Complete when designated queue equals or exceeds required amount
            ( ) Complete when designated queue falls below required amount

• Notes:

This rule only checks for changing commodity levels during loading and unloading operations. It cannot be used to test, for example, if a vehicle is full or empty.

• Related Rules:
  • Multiple Resource Check Rule - executes child rules when set resource (commodity) levels are reached
  • Resource Verify Rule (fixed) - executes child rules when a set resource (commodity) level is reached

• Trainz Wiki Links:
  • http://online.ts2009.com/mediaWiki/index.php/Resource_Check_Rule

Resource Verify Rule (fixed)

Executes child rules if a selected industry or vehicle reaches a set commodity level. The rule resets when all child rules have completed.

• <kuid:160293:10060>

• DLS Rule by trev999

• Parent Rule

Properties:
   Select one of two option buttons:-
   ( ) Watch industry queue
      Target object <click to select> - click to select an industry from the session list.
      Product <click to select> - click to select an industry product.
      Amount <value> - enter a quantity for the selected product.
      Select one of two option buttons:-
      ( ) Complete when designated queue equals or exceeds designated amount
      ( ) Complete when designated queue falls below designated amount
   ( ) Watch vehicle queue
      Target object <click to select> - click to select a rolling stock vehicle from the session list.
      Product <click to select> - click to select a commodity product.
      Amount <value> - enter a quantity for the selected product.
      Select one of two option buttons:-
      ( ) Complete when designated queue equals or exceeds designated amount
      ( ) Complete when designated queue falls below designated amount

• Notes:

1. This rule will only monitor a single commodity in a single industry or vehicle.
2. This rule only checks for changing commodity levels during loading and unloading operations. It cannot be used to test, for example, if a vehicle is full or empty.

• Related Rules:
  • Multiple Resource Check Rule - executes child rules when set resource (commodity) levels are reached
  • Resource Check Rule - executes child rules when set resource (commodity) levels are reached

Station Visited Check Rule

Executes child rules if specific trains call at set stations or industries

• <kuid2:60850:89005:3>

• Built-in Rule

• Parent Rule

Properties:
   Trigger: <select> - click to select one of the following
      Never - stopping at the selected industries will never trigger the rule.
      Once only - the rule is triggered on the first visit only to any one of the selected industries
      Once per industry - the rule is triggered on the first visit to each industry with each individual product
      Once per visit - the rule is triggered on the first visit to each industry regardless of the product
      Once per vehicle - each vehicle can only trigger the rule once. 
   <select industry> - select industry or industries from session list
   Select one of two option buttons:-
      ( ) click to accept all trains
      ( ) click to accept trains matching specific criteria
         Selecting the second option will produce the following selection controls:-          
         Specific vehicle - identify the specific vehicle or set of specific vehicles that will trigger the rule
            + - click to add a specific vehicle from the session list
            x - click to remove the specific vehicle from the rule
         Vehicle types - identify the type of vehicle or a set of vehicle types that will trigger the rule
            + - click to add a type of vehicle from the session list
            x - click to remove the type of vehicle from the rule
         Drivers - identify the drivers that will trigger the rule
            + - click to add a driver from the session list
            x - click to remove a driver from the rule

Back to Top

---

Camera Rules

Cinematic Camera Rule

Provides several different cinematic style cameras with animations. Best used at the start of a session. Use the Trackside Camera (tracking view) found in the Set Camera Rule during session play.

• <kuid2:401543:1166:3>

• Built-in Rule

Properties:
   [Check Box] Lock camera controls for the duration - if checked user cannot alter camera view
   [Check Box] Prevent train control for duration - if checked user cannot control train
   Camera target: <click to select> - click to select the object from the session list that will be the camera target
   Camera mode: - select one of three option buttons:-
      ( ) Stationary
      ( ) Circle targeted object
      ( ) Move from one point to another (zoom, pan, etc)
   Initial camera values:
      [Check Box] Pitch: <value> - check to select then click value to enter a pitch value
      [Check Box] Yaw:   <value> - check to select then click value to enter a yaw value
      [Check Box] Zoom:  <value> - check to select then click value to enter a zoom value
   Total time to animate:  <value> - enter an animation time in seconds

• Notes:

Times are Trainz clock times, not real times

• Related Rules:
  • Focus Camera Rule - sets the initial camera view and starting vehicle for a session
  • Set Camera Rule - sets the target object and properties of the camera
  • Wait for Camera View Mode Rule - executes child rules when the camera view is changed

Focus Camera Rule

Sets the initial camera view and starting vehicle for a session.

• <kuid2:122381:10014:1>

• DLS Rule by mizi

Properties:
   Focus camera to: - select one of two option buttons
      ( ) Map object
      ( ) Vehicle
   Named <?????> - enter name of object or vehicle from session list
   Additionally:
      [Check Box] set view mode to - check to select one of four option buttons
         ( ) Internal view
         ( ) External view
         ( ) Tracking view
         ( ) Roaming view
      [Check Box] restrict user to manipulate the camera - check to set user limits on camera controls
         [Check Box] allow internal view
         [Check Box] allow external view
         [Check Box] allow tracking view
         [Check Box] allow roaming view
         [Check Box] allow change of view mode
         [Check Box] allow change vehicle in train
         [Check Box] allow change trains
         [Check Box] allow adjust camera viewpoint
      [Check Box] set camera angles - check to set the initial camera view point
         Yaw (90 = look at front of train): <value> degrees - enter yaw angle 
         Pitch (-90 = down, 90 = up): <value> degrees - enter pitch angle
         Distance from the focused object: <value> metres - enter distance from camera to object

• Related Rules:
  • Cinematic Camera Rule - provides several different cinematic style cameras with animations
  • Set Camera Rule] - sets the target object and properties of the camera
  • Wait for Camera View Mode Rule - executes child rules when the camera view is changed

Set Camera Rule

Sets the target object and properties of the camera.

• <kuid:-25:179>

• Built-in Rule

Properties:
   [Check Box] Set the target object of the camera to: - if checked, select one of three option buttons:-
      ( ) Vehicle <click to select> - select a vehicle from the Session list
      ( ) Junction <click to select> - select a junction from the Session list
      ( ) Map Object <click to select> - select a named map object from the Session list
   [Check Box] Change the camera view mode to <click to select> - if checked, select one camera view mode from
      Cab View
      External View
      Tracking View
      Free Roaming
   [Check Box] Set the camera flags to enable/disable user access to - if checked, select as many of the following check boxes as needed
      [Check Box] Internal view mode - check to enable, uncheck to disable
      [Check Box] External view mode - check to enable, uncheck to disable
      [Check Box] Tracking view mode - check to enable, uncheck to disable
      [Check Box] Roaming view mode - check to enable, uncheck to disable
      [Check Box] View switching - check to enable, uncheck to disable
      [Check Box] Vehicle view switching - check to enable, uncheck to disable
      [Check Box] Train view switching - check to enable, uncheck to disable
      [Check Box] Camera adjustments (pan, zoom, etc) - check to enable, uncheck to disable

• Related Rules:
  • Cinematic Camera Rule - provides several different cinematic style cameras with animations
  • Focus Camera Rule - sets the initial camera view and starting vehicle for a session
  • Wait for Camera View Mode Rule - executes child rules when the camera view is changed

Wait for Camera View Mode Rule

Executes child rules when the camera view is changed to a selected view

• <kuid:-25:192>

• Built-in Rule

• Parent Rule

Properties:
   [Check Box] Trigger rule once - check to set
   Wait for the camera to change to the <click to select> - select one camera view mode from:-
      Cab View
      External View
      Tracking View
      Free Roaming
   [Check Box] Wait for the camera to target vehicle <click to select> - if checked, select a vehicle from the Session list

• Related Rules:
  • Cinematic Camera Rule - provides several different cinematic style cameras with animations
  • Focus Camera Rule - sets the initial camera view and starting vehicle for a session
  • Set Camera Rule - sets the target object and properties of the camera

Back to Top

---

Danger, Derailment and Safety Rules

ATP Speed Limiter Rule

Limits allowable speed over set limit

• <kuid2:321959:1000:1>

• Built-in Rule

Properties:
   Limits the speed to <value> mph over the set limit - enter speed value in mph

Related Rules:
   AWS Configuration Rule - configures the Trainz implementation of the Automatic Warning System when approaching signals

AWS Configuration Rule

This rule configures the Trainz implementation of the Automatic Warning System when approaching signals

• <kuid2:60850:89002:3>

• Built-in Rule

Properties:
   Select one of three option buttons:-
      ( ) Active
      ( ) Passive
      ( ) Passive with HUD hidden
   [Check Box] Simulate AWS for unfitted cabs?
   [Check Box] Use modern sound set for unfitted cabs?

Clean Up Derailed Trains Rule

Cleans up derailed train cars after a set time delay

• <kuid2:60850:89003:1>

• Base Rule

Properties:
   Set delay to clean up derailed traincars to
      <h>: - click to enter the number of hours (0-23) to wait
      <mm>: - click to enter the number of minutes (0-59) to wait
      <ss>: - click to enter the number of seconds (0-59) to wait

• Notes:

Time is Trainz clock time, not real time.

• Related Rules:
  • Replace Missing Vehicles Rule - creates a replacement train after a derailment
  • Wait for Derailment Rule - executes child rules when a derailment occurs

• Trainz Wiki Links:
  • http://online.ts2009.com/mediaWiki/index.php/Clean_up_Derailed_Trains_Rule

Coupler Breakage Check Rule

Executes child rules if there is a coupler breakage

• <kuid2:447264:1017:1>

• Built-in Rule

• Parent Rule

Properties:
   None

• Related Rules:
  • Coupler Breakage HUD Rule - adds a coupler stress and breakage warning to the HUD
  • Set Coupler Masks Rule - sets the coupling/decoupling masks on selected vehicles

Coupler Breakage HUD Rule

HUD displays warning about coupler stress and breakage

• <kuid:-25:423>

• Built-in Rule

Properties:
   Select one of two option buttons:-
      ( ) Show the Coupler Breakage Display
      ( ) Hide the Coupler Breakage Display

• Related Rules:
  • Coupler Breakage Check Rule - executes child rules if a coupler breaks
  • Set Coupler Masks Rule - sets the coupling/decoupling masks on selected vehicles

Junction Derailment Prevention Rule

Sets opposing (trailing) junctions ahead of a train to prevent derailments. Works with both AI and manually driven trains.

• <kuid2:121843:100282:1>

• DLS Rule by pitkin

Properties:
   None

• Notes:

This rule will not overrule a junction already locked by another AI train or locked against AI control using the Set Junctions Rule.

• Related Rules:
  • Lock All Junctions Rule - locks all junctions against user control
  • Set Cleared Junctions Rule - sets selected junctions to specific states (direction, locked/unlocked, allow/prevent AI control) while they are unoccupied.
  • Set Junctions Rule - sets selected junctions to specific states (direction, locked/unlocked, allow/prevent AI control).

Replace Missing Vehicles Rule

Produces new trains to replace missing vehicles that have been removed from the session by the Clean Up Derailed Trains Rule

• <kuid:447264:1214>

• Built-in Rule

Properties:
   [Check Box] Respawn trains if they are abandoned for 10 minutes
   If checked:-
      Select one of two option buttons:-
         ( ) Respawn trains at their original locations
         ( ) Respawn trains from portals
            <+ Add a new portal> - click to enter the name of a portal, there can be more than one portal.
            Entered portal names that appear in red have not been found in the session

• Related Rules:
  • Clean Up Derailed Trains Rule - cleans up derailed train cars after a set time delay
  • Wait for Derailment Rule - executes child rules when a derailment occurs

Safety System Engaged Check Rule

Executes child rules if safety systems are applied.

• <kuid:447264:1216>

• Built-in Rule

• Parent Rule

Properties:
   [Check Box] Trigger only once

• Related Rules:
  • Safety System Isolated Check Rule - executes child rules if safety systems have been isolated

Safety System Isolated Check Rule

Executes child rules if safety systems are isolated (disengaged).

• <kuid:447264:1217>

• Built-in Rule

• Parent Rule

Properties:
   [Check Box] Trigger only once

• Related Rules:
  • Safety System Engaged Check Rule - executes child rules if safety systems have been engaged

Set Coupler Masks Rule

Set the coupling/decoupling masks on the selected vehicles

• <kuid:-25:980>

• Built-in Rule

Properties:
   <Add vehicle> - click to select a vehicle from the session list
   <Add All> - click to add all vehicles in the session list
   <Delete All> - click to remove all added vehicles from this rule
      For each selected vehicle:-
      Coupling Mask
         Front and Back - choose for each
            Locked
            Unlocked
      Decoupling Mask
         Front and Back - choose for each
            Locked
            Unlocked
      <Remove> - click to remove this vehicle from the rule

• Related Rules:
  • Coupler Breakage Check Rule - executes child rules when a coupler breaks
  • Coupler Breakage HUD Rule - adds a coupler stress and breakage warning to the HUD

Signal Passed At Danger Check Rule

Executes child rules if a signal or stop mark is Passed at Danger (STOP).

• <kuid2:60850:89007:2>

• Built-in Rule

• Parent Rule

Properties:
   [Check Box] Trigger only once

• Trainz Wiki Links:
  • How to Use Variables in Sessions (Examples): Event Counter and Message Selection

Speeding Check Rule

Executes child rules if player controlled trains are over the local speed limit or over a set (custom) speed

• <kuid2:60850:89004:3>

• Built-in Rule

• Parent Rule

Properties:
   Select one of two options to set a speed limit to be observed
      ( ) Watch for trains travelling above the posted speed limit
         <speed value> - click to enter a new overspeed tolerance value
         <speed units> - click to select one from the list:-
            Km/h - Kilometres per hour
            MPH - Miles per hour
            mps - metres per second
      ( ) Watch for trains travelling above a custom speed
         <speed value> - click to enter a new custom speed value
         <speed units> - click to select one from the list:-
            Km/h - Kilometres per hour
            MPH - Miles per hour
            mps - metres per second
            Warning: This option is very performance intensive and should only be used in sessions with few trains

Vehicle Physics Rule

Overrides the default vehicle physics properties for all vehicles or for those matching set criteria

• <kuid:-25:1052>

• Built-in Rule

Properties:  
   Select one of two option buttons:-
      ( ) click to accept all trains
      ( ) click to accept trains matching specific criteria
         Selecting the second option will produce the following selection controls:-
         Specific vehicle - identify the specific vehicle or set of specific vehicles that will trigger the rule
            + - click to add a specific vehicle from the session list
            x - click to remove the specific vehicle from the rule
         Vehicle types - identify the type of vehicle or a set of vehicle types that will trigger the rule
            + - click to add a type of vehicle from the session list
            x - click to remove the type of vehicle from the rule
         Drivers - identify the drivers that will trigger the rule
            + - click to add a driver from the session list
            x - click to remove a driver from the rule
   Coupler Parameters:
      Couplers break at <value> kN expansion force - enter force value
      Couplers break at when coupling above <value> kph - enter speed value
      [Check Box] Show coupler breakage in HUD - check to display breakage in on-screen HUD
   Wheelslip Parameters:
      Maximum tractive effort adjusted by <value> % - enter adjustment as a %
      Traction is reduced to <value> % while wheelslipping - enter value as a %
      Traction boost is <value> % while sanding - enter value as a %
   Sway Parameters:
      Cab sway level is set to <value> % - enter value as a %

Wait for Derailment Rule

Executes child rules when a derailment occurs

• <kuid:-25:1053>

• Built-in Rule

• Parent Rule

Properties:
   [Check Box] Trigger derailment watch once - check to execute the rule once only

• Related Rules:
  • Clean Up Derailed Trains Rule - cleans up derailed train cars after a set time delay
  • Replace Missing Vehicles Rule - creates a replacement train after a derailment

Back to Top

---

Driver Rules

AI Start Rule

Restarts all halted AI controlled trains. Drivers will continue with the commands in their driver command list.

• <kuid2:400048:100981:1>

• DLS Rule by callavsg

Properties:
   None

• Related Rules:
  • AI Stop Rule - halts all AI drivers
  • Disallow AI Rule - cancels all AI driver commands

AI Stop Rule

Halts all AI controlled trains but does not delete their driver commands. AI trains can be restarted with the AI Start Rule or by issuing individual Continue Schedule commands.

• <kuid2:400048:100980:1>

• DLS Rule by callavsg

Properties:
   None

• Related Rules:
  • AI Start Rule - restarts all halted AI drivers
  • Disallow AI Rule - cancels all AI driver commands

Control Check Rule

Executes child rules if the train control method has been altered or a specific method has been selected.

• <kuid:401543:1191>

• Built-in Rule

• Parent Rule

Properties:
 Execute child rules when: - select one of two option buttons:-
    ( ) DCC mode is Selected
    ( ) Cab mode is Selected
 Execute child rules: - select one of two option buttons:-
    ( ) Every time control method is set
    ( ) Once only

• Related Rules:
  • Control Type Rule - sets the control method

Control Type Rule

Sets the control method

• <kuid:-16:2030>

• Base Rule

Properties:
 Current control method is: <select> - click to select one of
    Easy Mode - DCC (standard keyboard and mouse) control
    Ask User - let the user decide
    Realistic Mode - Cab controls (on screen levers, throttles, buttons, etc)

• Related Rules:
  • Control Check Rule - executes child rules if the train control method changes

Disallow AI Rule

Cancels (deletes) all current and waiting AI commands for all drivers

• <kuid:400048:100603>

• DLS Rule by callavsg

Properties:
  None

• Related Rules:
  • AI Start Rule - restarts all halted AI drivers
  • AI Stop Rule - halts all AI drivers

Driver Command Check Rule

Executes child rules if the driver commands match a set list.

• <kuid:-25:447>

• Built-in Rule

• Parent Rule

Properties:
 [Check Box] Trigger rule once - check to allow the rule to execute only once
 Driver character to watch the command list of <select> - select a driver name from the Session List
 Wait for driver character to have a command list that matches this:
    <add driver command> - add a driver command from the session list. More commands can be added. Commands can be deleted.
    <add all> - adds ALL driver commands in the session list. Individual commands can be removed.
    <delete all> - deletes all entered driver commands from the session rule

• Related Rules:
  • Driver Command Rule - specifies which commands will be available for the drivers
  • Driver Schedule Rule - sets up a list of basic scheduled driver commands
  • Driver Setup Rule - creates a list of drivers and assign them their orders
  • Enable/Disable Driver Commands Rule - enable/disable specific driver commands on certain drivers
  • Schedule Rule - allows a schedule of timed events to be applied to a train

• Trainz Wiki Links:
  • http://online.ts2009.com/mediaWiki/index.php/Driver_Command_Rule

Driver Command Rule

Specifies which commands will be available for the drivers

• <kuid:-3:10057>

• Base Rule

Properties::
   For each installed Driver Command:-
   [Check Box] Name of Driver Command and Description (if available) - check to make that command available to the drivers

• Notes:

Some Driver Commands that have been checked will not appear in the Command Lists for drivers if there is no target for their action. For example:

The Wait For Trigger command will not be available to any drivers if there are no triggers set.

The Call At command will not be available to any drivers if there are no industry active assets or passenger enabled stations.

• Related Rules:
  • Driver Command Check Rule - executes child rules if the driver commands match a set list
  • Driver Schedule Rule - sets up a list of basic scheduled driver commands
  • Driver Setup Rule - creates a list of drivers and assign them their orders
  • Enable/Disable Driver Commands Rule - enable/disable specific driver commands on certain drivers
  • Schedule Rule - allows a schedule of timed events to be applied to a train

Driver Main Menu Options Rule

Show/Hide the Driver Main Menu Bar

• <kuid:-25:448>

• Built-in Rule

Properties:
   <Show/Hide> the Driver Main Menu Bar - click Show or Hide to select

Driver Schedule Rule

Sets up a list of basic scheduled commands

• <kuid2:82445:90001:9>

• Built-in Rule

Properties: 
   Driver Schedule Assigned to name of driver <icon> - click icon to select a driver from those assigned in the Driver Setup Rule
   Next commands, will be executed  
      >> - click to enter driver commands from those specified in the Driver Command Rule
   Style: - select one of four option buttons:-
      ( ) Classic style: If there is a schedule do not emit a new schedule - any currently assigned set of driver commands will not be replaced
      ( ) Killer style: If there is a schedule clean it and emit a new one - replace any currently assigned driver commands with the new commands
      ( ) Cooperative style: If there is a schedule append the new one - add the new driver commands to the end of any existing commands
      ( ) Active style: Emit a new schedule, only if already a schedule running - only add the new commands if commands are currently running

• Related Rules:
  • Driver Command Check Rule - executes child rules if the driver commands match a set list
  • Driver Command Rule - specifies which commands will be available for the drivers
  • Driver Setup Rule - creates a list of drivers and assign them their orders
  • Enable/Disable Driver Commands Rule - enable/disable specific driver commands on certain drivers
  • Schedule Rule - allows a schedule of timed events to be applied to a train

• Trainz Wiki Links:
  • How to Use Variables in Sessions (Examples): Event Counter and Message Selection

Driver Setup Rule

Creates the list of drivers for this session and assign them their orders

• <kuid:-16:2025>

• Base Rule

Properties:
   <driver icon> - click to select a new driver from the list of installed and built in drivers
   <loco> - click to select a new locomotive from the session list and assign it to this driver. Locos displayed in red have not been found in the session list
   <driver name> - click to enter a new name for the selected driver
   <driver mode> - click to select one of:-
      Autodetect - the program will detect the driver mode to be used. For example, if driver commands have been entered for this driver
         then the AI driver mode will be selected
      First Human Player - the driver will wait until he/she has been selected by the player
      AI driver - the AI will be given control even if no commands are present
      Multiplayer Driver - the driver will be assigned to a multiplayer user
   <remove> - this driver will be removed from the rule
   >> - click to enter driver commands from those specified in the Driver Command Rule
    --> Scroll down to the bottom of the list of entered drivers for more options
 <Add another driver> - click to add another driver 
 [Check Box] Remove all existing Drivers first
 [Check Box] Generate new Drivers for empty Trains  

• Related Rules:
  • Driver Command Check Rule - executes child rules if the driver commands match a set list
  • Driver Command Rule - specifies which commands will be available for the drivers
  • Driver Schedule Rule - sets up a list of basic scheduled driver commands
  • Enable/Disable Driver Commands Rule - enable/disable specific driver commands on certain drivers
  • Schedule Rule - allows a schedule of timed events to be applied to a train

• Trainz Wiki Links:
  • http://online.ts2009.com/mediaWiki/index.php/Driver_Setup_Rule

Enable/Disable Driver Commands Rule

Enable/Disable specific driver commands on certain drivers. Multiple copies of the rule can be used to give different drivers or consists different command lists

• <kuid:-25:480>

• Built-in Rule

Properties:
   <Enable/Disable> the following driver commands ... - click to select Enable or Disable
   For each driver command:-
   [Check Box] command name - check to enable or disable
   [Check Box] command name - check to enable or disable
   [Check Box] command name - check to enable or disable
   etc
   Select one of two option buttons:-
      ( ) click to accept all trains
      ( ) click to accept trains matching specific criteria
         Selecting the second option will produce the following selection controls:-
         Specific vehicle - identify the specific vehicle or set of specific vehicles that will trigger the rule
            + - click to add a specific vehicle from the session list
            x - click to remove the specific vehicle from the rule
         Vehicle types - identify the type of vehicle or a set of vehicle types that will trigger the rule
            + - click to add a type of vehicle from the session list
            x - click to remove the type of vehicle from the rule
         Drivers - identify the drivers that will trigger the rule
            + - click to add a driver from the session list
            x - click to remove a driver from the rule

• Related Rules:
  • Driver Command Check Rule - executes child rules if the driver commands match a set list
  • Driver Command Rule - specifies which commands will be available for the drivers
  • Driver Schedule Rule - sets up a list of basic scheduled driver commands
  • Driver Setup Rule - creates a list of drivers and assign them their orders
  • Schedule Rule - allows a schedule of timed events to be applied to a train

• Trainz Wiki Links:
  • http://online.ts2009.com/mediaWiki/index.php/Enable/Disable_Driver_Commands_Rule

JTG Correct Vehicle Lights

Corrects the brightness of vehicle headlights. Now obsolete.

• <kuid2:478657:999103:1>

• DLS Rule by jtg-trainz

• Obsolete Rule (function is now built into TANE Driver Additional Tools Menu)

Properties:
   None

Quick Portal Manager Standard Edition Rule (SP2 and later)

Manages portals and adds flexible timetables.

• <kuid2:61392:5011:45>

• DLS Rule by pguy

Properties:
   Target date is day-of-week <dd/mm/yyyy> - day-of-week and date shown are for today's date. Click dd/mm/yyyy to change date.
   <Copy rule data to Clipboard> - click to copy the currently entered data to a special clipboard area used by the rules created by pguy. 
      This is NOT the standard OS clipboard.
   <Paste rule data from Clipboard> - if data is held in the special clipboard area, then click to paste that data into the rule.
      This is NOT the standard OS clipboard.
   [Check Box] This rule is enabled - check to activate (enable) the rule.
   [Check Box] Avoid duplicated driver if possible - check to prevent the same driver being used again. If a driver name is reused, the rule will select a different driver name.
   [Check Box] Disable locomotives/vehicles enhanced mode - check to save vehicle properties when a train is removed by a portal. 
      These properties will be restored if the same train is emitted by a portal. If checked then a new command will appear:
      <for all vehicles/for only locomotives/for only tagged vehicles> - click to select one.
   Portal selected: <portal name> [...] - select a portal to manage by clicking <portal name> or [...] and selecting a portal from the Session list.
   Portal output link: <[no link]> [...] - leave blank.
   Portal input link: <[no link]> [...] - leave blank unless you want to connect to a Global Input Queue. Click to select an input queue from the Session list.
   Default schedule for input trains is named: <schedule> - click to enter a schedule name.
   Today's schedule: <Insert new schedule> - click to enter a new schedule
   For each schedule:-
      <hh:mm> - click to set the time when a train will be emitted from the portal. Times use the 24hr clock.
      <train name> - click to enter the train name
      <mission code> - click to enter the Mission Code created by the MissionCode Manager Rule (SP2 and later).
      <schedule> - click to enter the re-occurrence schedule in hh:mm (24hr clock) where, for example:
         02:30 means every 2 hrs 30 minutes,
         00:00 means once only,
         24:00 means once each day.
      <driver> - click to select a driver name or select auto-driver to let the rule select a driver.
         Current driver order bar is named <schedule> - click to enter a name for the order (Driver Command) bar used in this schedule.
      <hud> - click to select a HUD for this train. HUDs must be created using the Quick CustomHud Manager Rule (SP2 and later).
      Driver Command Bar - enter driver commands for this train.
      Choose one of two consist sets:
      <mono consist> consist for every day - if selected the same consist will be used each day.
         <no consist selected> - click to select a consist from those saved in your install.
      <multi consists> - if selected a different consist will be used each day. 
         For each day of the week:
            Day-of-week <no consist selected> - click to select a consist from those saved in your install.

• Related Rules:
  • MissionCode Manager Rule (SP2 and later) - creates and manages Mission Codes for Interlocking Tower paths
  • Quick CustomHud Manager Rule (SP2 and later) - create driver HUDs

• Trainz Wiki Links:
  • http://online.ts2009.com/mediaWiki/index.php/Quick_Portal_Manager

QuickDrive Rule

Changes the Session settings.

• <kuid:401543:1184>

• Base Rule

Properties:
  Open QuickDrive window when session is started          [Check Box] - check to set
  Set time to <hours:minutes> with a rate of <speed x> - set start time and rate at which time advances
  Enable gameplay Session Mode                            [Check Box] - check to set. Gameplay mode restricts the players options
  Enable in game help by default                          [Check Box] - check to allow help options to be displayed
  Set the default Control method to: - select one of two option buttons:-
     ( ) Easy Mode
     ( ) Realistic Mode
     [Check Box] Prevent player from changing this setting - check to set
  Realistic mode requires achievement: <text> in asset <asset name> - enter achievement name and select an asset from Aurans Achievements
  Set the default derailment realism to: - select one of three option buttons:-
     ( ) None
     ( ) Arcade
     ( ) Realistic
     [Check Box] Prevent player from changing this setting - check to set
  Set the default units to: - select one of three option buttons:-
     ( ) Imperial
     ( ) Metric
     ( ) Default

• Trainz Wiki Links:
  • http://online.ts2009.com/mediaWiki/index.php/QuickDrive_Rule

Wait for Driver On/Off Train Rule

Executes child rules when a driver gets on or off a train

• <kuid:-25:953>

• Built-in Rule

• Parent Rule

Properties:
 [Check Box] Trigger Rule Once - click to set 
 Wait for a driver character to get <On/Off> a train that matches the following criteria - select On or Off
 Select one of two option buttons:-
    ( ) click to accept all trains
    ( ) click to accept trains matching specific criteria
       Selecting the second option will produce the following selection controls:-
       Specific vehicle - identify the specific vehicle or set of specific vehicles that will trigger the rule
          + - click to add a specific vehicle from the session list
          x - click to remove the specific vehicle from the rule
       Vehicle types - identify the type of vehicle or a set of vehicle types that will trigger the rule
          + - click to add a type of vehicle from the session list
          x - click to remove the type of vehicle from the rule
       Drivers - identify the drivers that will trigger the rule
          + - click to add a driver from the session list
          x - click to remove a driver from the rule

• Related Rules:
  • Wait for Driver/Train to be Locally Owned Rule - executes child rules when a vehicle or driver changes ownership

Wait for Driver/Train to be Locally Owned Rule

Executes child rules when a specific driver or vehicle is locally owned. If the driver/vehicle becomes unowned again the child rules are paused

• <kuid2:401543:1173:1>

• Built-in Rule

• Parent Rule

Properties:
 Assets Ownership: - select one of two option buttons:-
    ( ) Wait for ownership of a specific Driver
    ( ) Wait for ownership of Driver
 Driver or Vehicle <select> - choose from session list

• Related Rules:
  • Wait for Driver On/Off Train Rule - executes child rules when a driver gets on or off a train

Back to Top

---

HUD (Heads Up Display) Rules

Cab Controls HUD Rule

Was used to provide the HUD controls for the cabin view. Now obsolete.

• <kuid:-16:287428>

• Base Rule

• Obsolete Rule (function is now built into TANE)

Properties:
   None

Coupler Breakage HUD Rule

HUD displays warning about coupler stress and breakage

• <kuid:-25:423>

• Built-in Rule

Properties:
   Select one of two option buttons:-
      ( ) Show the Coupler Breakage Display
      ( ) Hide the Coupler Breakage Display

• Related Rules:
  • Coupler Breakage Check Rule - executes child rules if a coupler breaks
  • Set Coupler Masks Rule - sets the coupling/decoupling masks on selected vehicles

Display Custom HUD Rule

Show or hide the Custom Heads Up Display.

• <kuid:-3:10206>

• Base Rule

Properties:
   Show or Hide the Custom Heads up Display - select one of two option buttons:-
      ( ) Show the Custom Heads up Display
      ( ) Hide the Custom Heads up Display

• Related Rules:
  • Flash HUD Icon Rule - flashes a HUD panel icon for a set duration.
  • mc Display Custom HUD V2 Rule (SP2 and later) - shows or hides a graphical HUD.
  • Quick CustomHud Manager Rule (SP2 and later) - creates custom HUDs that can be assigned to different drivers
  • Show/Hide HUD Panel Rule - shows or hides a HUD panel.
  • Variable Show Rule - adds or removes a specified variable and a descriptive label to the custom HUD.
  • Wait for Click on HUD Icon Rule - executes child rules when a HUD icon is clicked

• Trainz Wiki Links:
  • http://online.ts2009.com/mediaWiki/index.php/Display_Custom_HUD_Rule

Flash HUD Icon Rule

Flashes a HUD panel icon for a set duration of time or instructs a HUD panel icon to start/stop.

• <kuid:-25:968>

• Built-in Rule

Properties:
   Select one of two option buttons:-
   ( ) Flash the <click to select> icon on the <click to select> HUD panel for a period of <value> seconds
      TIP: Select the HUD panel first (the second <click to select> link).
      Available HUD panels are (select one):-
         Bottom Right Menu
         Camera Controls
         DCC Controls
         Driver Main Menu
      Available icons will depend on the HUD panel selected.
   ( ) <Start/Stop> flashing the <click to select> icon on the <click to select> HUD panel
      TIP: Select the HUD panel first (the second <click to select> link).
      Available HUD panels are (select one):-
         Bottom Right Menu
         Camera Controls
         DCC Controls
         Driver Main Menu
      Available icons will depend on the HUD panel selected.

• Related Rules:
  • Display Custom HUD Rule - shows or hides the Custom Heads Up Display.
  • mc Display Custom HUD V2 Rule (SP2 and later) - shows or hides a graphical HUD.
  • Quick CustomHud Manager Rule (SP2 and later) - creates custom HUDs that can be assigned to different drivers
  • Show/Hide HUD Panel Rule - shows or hides a HUD panel.
  • Variable Show Rule - adds or removes a specified variable and a descriptive label to the custom HUD.
  • Wait for Click on HUD Icon Rule - executes child rules when a HUD icon is clicked

mc Display Custom HUD V2 Rule (SP2 and later)

Shows or hides a graphical HUD which includes junction direction for the junction ahead. This rule has been superseded by the Quick CustomHUD Manager Rule (SP2 and later)

• <kuid2:61392:1072:10>

• Legacy Rule (replaced by Quick CustomHUD Manager Rule (SP2 and later))

• DLS Rule by pguy

Properties:
    Show or Hide the Custom Heads up Display - select one of two option buttons:-
    ( ) Show the Custom Heads up Display
    ( ) Hide the Custom Heads up Display

• Related Rules:
  • Display Custom HUD Rule - shows or hides the Custom Heads Up Display.
  • Flash HUD Icon Rule - flashes a HUD panel icon for a set duration.
  • Quick CustomHud Manager Rule (SP2 and later) - creates custom HUDs that can be assigned to different drivers
  • Show/Hide HUD Panel Rule - shows or hides a HUD panel.
  • Variable Show Rule - adds or removes a specified variable and a descriptive label to the custom HUD.
  • Wait for Click on HUD Icon Rule - executes child rules when a HUD icon is clicked

Quick CustomHud Manager Rule (SP2 and later)

Allows the creation of new graphical heads up displays which are assigned to the drivers in Driver Mode. Replaces the mc Display Custom HUD V2 Rule (SP2 and later)

• <kuid2:61392:5020:47>

• DLS Rule by pguy

Properties:
   <Copy rule to data Clipboard> - click to copy the data from the selected HUD to a special clipboard area used by the rules created by pguy. 
      This is NOT the standard OS clipboard.
   <Paste rule data from Clipboard> - if data is held in the special clipboard area, then click to paste that data into the selected HUD.
      This is NOT the standard OS clipboard.
   Current HUD Parameters
      HUD to select: <HUD name> - click to select a HUD from those available. One or two default HUDs will be supplied.
      new HUD - click to create a new HUD display with default properties. You will be required to enter a name for the new HUD
      clone HUD - click to create a new HUD using the properties of the currently selected HUD. You will be required to enter a name for the new HUD
      copy HUD - copies (overwrites) the currently selected HUD with the properties of another HUD. You will be required to enter the name of the HUD to be copied
   For new, cloned or copied HUDs, additional commands will be shown:
      rename HUD - rename the selected HUD. You will be required to enter a new name for the HUD
      delete HUD - delete the currently displayed HUD
   In Driver Mode an additional command will be shown:
      Assign hud to current train - click to assign the currently selected HUD to the currently selected driver
   [Check Box] hud is displayed (on) - check to display HUD in Driver Mode
   hud items nb entries max: <value> - enter the maximum number of items to be displayed in the HUD. Maximum is 30.
   hud view limit: <value> - enter the maximum look-ahead distance in metres for the HUD. Minimum value is 1000, maximum value is 10000.
   [Check Box] display data in a centred window above orderbar - check to display the HUD centred on the screen just above the driver command bar in Driver Mode
   For each individual HUD property:
      [Check Box] HUD property - check to add this property to the HUD

• Notes:

HUDs are assigned to drivers in Driver Mode by either adding a SetCustomHud (SP2 and later) command to individual drivers command lists or manually by clicking a green RM tool button displayed on the top menu and selecting Quick CustomHUD Manager from the menu.

• Related Rules:
  • Display Custom HUD Rule - shows or hides the Custom Heads Up Display.
  • Flash HUD Icon Rule - flashes a HUD panel icon for a set duration.
  • mc Display Custom HUD V2 Rule (SP2 and later) - shows or hides a graphical HUD.
  • Show/Hide HUD Panel Rule - shows or hides a HUD panel.
  • Variable Show Rule - adds or removes a specified variable and a descriptive label to the custom HUD.
  • Wait for Click on HUD Icon Rule - executes child rules when a HUD icon is clicked

Show/Hide HUD Panel Rule

Shows or hides a HUD panel.

• <kuid:-25:1047>

• Built-in Rule

Properties:
   <Show/Hide> the <click to select> HUD panel - select Show or Hide and then select the HUD panel

• Related Rules:
  • Display Custom HUD Rule - shows or hides the Custom Heads Up Display.
  • Flash HUD Icon Rule - flashes a HUD panel icon for a set duration.
  • mc Display Custom HUD V2 Rule (SP2 and later) - shows or hides a graphical HUD.
  • Quick CustomHud Manager Rule (SP2 and later) - creates custom HUDs that can be assigned to different drivers
  • Variable Show Rule - adds or removes a specified variable and a descriptive label to the custom HUD.
  • Wait for Click on HUD Icon Rule - executes child rules when a HUD icon is clicked

Variable Show Rule

Adds or removes a specified variable and a descriptive label to the custom HUD. This rule does not make the custom HUD appear on the screen.

• <kuid:-25:971>

• Built-in Rule

Properties:
  [Check Box] Add
     <variable-name> - enter variable-name to add to HUD. Variable-name is case sensitive.
     <label> - (optional) enter a short label to be displayed on the HUD in front of the variable value.
  [Check Box] Remove
     <variable-name> - enter variable-name to remove from HUD. Variable-name is case sensitive.

• Related Rules:
  • Display Custom HUD Rule - shows or hides the Custom Heads Up Display.
  • Quick Session Variables Rule - allows the editing of session variables.
  • Variable Check Rule - executes child rules according to the value of a specified variable.
  • Variable Modify Rule - changes the value of a specified variable.
  • Variable Modify Continuous Rule - continuously changes the value of a specified variable.
  • Variable Random Rule - assigns a random value to a variable.

• Trainz Wiki Links:
  • How to Use Variables in Sessions (Examples)

Wait for Click on HUD Icon Rule

Executes child rules when the user clicks on a selected HUD icon

• <kuid:-25:951> <kuid:-25:970> - two versions built-in with different kuids, both have the same properties

• Built-in Rule

• Parent Rule

Properties:
   [Check Box] Trigger Once
   HUD Panel <Click> - click choose from list:-
      Bottom Right Menu
      Camera Controls
      DCC Controls
   Icon <Click> - click to choose from list. Selections depends on HUD Panel chosen

• Related Rules:
  • Display Custom HUD Rule - shows or hides the Custom Heads Up Display.
  • Flash HUD Icon Rule - flashes a HUD panel icon for a set duration.
  • mc Display Custom HUD V2 Rule (SP2 and later) - shows or hides a graphical HUD.
  • Quick CustomHud Manager Rule (SP2 and later) - creates custom HUDs that can be assigned to different drivers
  • Show/Hide HUD Panel Rule - shows or hides a HUD panel.
  • Variable Show Rule - adds or removes a specified variable and a descriptive label to the custom HUD.

Back to Top

---

Industry Rules

Advanced Industry Load Configuration Rule

Locks train controls when loading/unloading at an industry, overrides time settings for begin load and begin unload operations

• <kuid:30501:100007>

• Base Rule

Properties:
   Target object <select> - select industry object from session list
   [Check Box] Lock the train's controls during a stopped load/unload operation - check to disable driver controls while train is stopped and loading/unloading
   [Check Box] Override 'begin load' and 'begin unload' durations to <value> seconds - if checked enter number of seconds to override

• Notes:

Times are Trainz clock time, not real time

Disable/Enable Industry Rule

Enables/Disables vehicle load/unload for industry

• <kuid2:401543:1171:1>

• Built-in Rule

Properties:
  Load/unload <Disable/Enable> - click to set to Disable or Enable
  Which Industry? <select> - click to set Industry from Session List
  Which Vehicles: - select one of two option buttons:-
     ( ) Apply to every vehicle in the session
     ( ) Apply only to a specific vehicles from Session List

DisplayIndustryStatus Rule (color modified)

Displays a summary of industry product levels when the "k" key is pressed.

• <kuid:622415:100001>

• DLS Rule by lockheed02 and marzipan

Properties:
   None

• Notes:

Pressing the k key in Driver mode will bring up a small window with a single link Display Industry Status (there may also be other links). Clicking this link will show the product levels of all industries.

• Related Rules:
  • ExTrainz Manager Rule - TANE SP2 - displays information on consists, industries and products in Driver and Surveyor.

ExTrainz Manager Rule - TANE SP2

Provides information on consists, industries and products in both Surveyor and Driver modes. Once activated, the rule creates an additional short menu bar below the main menu bar.

• <kuid:160293:10029>

• DLS Rule by trev999

Properties:
   Diagnostic mode is <On/Off> - click to select On or Off. When set On diagnostic messages will be added to the Trainz Log file.
   Turn on message overlay <Yes/No> - click to select Yes or No. When set to Yes the message overlay (lower left of screen) will be active.
   Show rolling stock in Driver mode <Yes/No> - click to select Yes or No. When set to Yes rolling stock can be searched in Driver.
   Search only rolling stock already in session <Yes/No> - click to select Yes or No. When set to Yes only those rolling stock assets
      installed in the session can be searched.
   Graphic colours: <When Red, the industry does not require service/When Green, the industry does not require service> - click to switch 
      between the two colour options.
   Industry page size: <value> - enter the number of industries to be displayed in the Industry List window (maximum 250).
   The following industries are excluded: <Add an industry to be excluded> - name can be complete (e.g. "Coal Mine 2") 
      which will exclude that specific industry from the management list, or partial (e.g. "Coal") which will exclude all 
      industries with the word "Coal" in their names. Entries are not case sensitive.
      Once industries have been excluded, additional commands will appear for each excluded industry:-
      <delete> <industry name begins with/class name begins with> <name> - click delete to remove this entry. 
         - click industry name begins with/class name begins with to select between the two (see notes below).
         - click name to edit the name.

• Notes:

1. Rolling stock installed in TANE or in the current session only (see settings above) can be searched to find a match for any selected product from any industry. In Surveyor (and Driver if that setting is enabled) click on the View Products sub menu link and click on a product name in the Product Window to display a list of all compatible rolling stock for that product.
2. Alternatively, click on the View Industries sub menu link and then click on a Product Icon to open a Product Window, then click on the View Rolling Stock link at the top of the window.
3. Industry class names are defined in the config.txt file of industry assets and are not normally accessible by users. However, you can exclude an entire group of related "industry asset classes" such as station, coalingtower, watertank, etc regardless of their actual names provided those assets have been given that "class name" by their creators.

• Known Issues:

This rule is NOT compatible with all industries.

• Related Rules:
  • DisplayIndustryStatus Rule (color modified) - displays information on industry product levels.

Multiple Resource Check Rule

Executes child rules if industries or vehicles reach set commodity levels. This rule replaces the older Resource Check Rule

• <kuid:-25:656>

• Built-in Rule

• Parent Rule

Properties:
   <Product Level> - click to select a product test from two choices:-
      Reach/Exceed - sets an upper limit for the resources being monitored. 
         For example: the rule will be triggered if the quantity of coal in a coal loader stockpile or a coal wagon reaches or exceeds a specified level.
         The initial level in the object must be below the set upper limit.
      Fall below - sets a lower limit for the resources being monitored. 
         For example: the rule will be triggered if the quantity of coal in a coal loader stockpile or a coal wagon falls below a specified level. 
         The initial level in the object must be above the set lower limit. 
         To test when a resource level reaches zero (i.e. is empty) set the lower limit to a very low value but not zero as the level can never fall below zero. 
   <value> - enter required quantity value
   <select> - select a product from session list of products
   <Add object> - click to select a source or target object. Multiple objects and their queues can be added to the rule. 
      ALL the entered products must reach/exceed or fall below the specified value for the rule to be triggered. 
      For each object:-
         <Object> - click to select session active industry or product enabled rail vehicle 
         <Queue> - select product queue (there may be only one available)
         <Remove> - removes the object and its product queue from the rule

• Notes:

This rule only checks for changing commodity levels during loading and unloading operations. It cannot be used to test, for example, if a vehicle is full or empty.

• Related Rules:
  • Resource Check Rule - executes child rules when set resource (commodity) levels are reached
  • Resource Verify Rule (fixed) - executes child rules when a set resource (commodity) level is reached

• Trainz Wiki Links:
  • How to Use Navigation Point Rules (Applications): Wait for Loading to be Completed

Power Station Rule

Sets up a Power Station and its electricity consumers

• <kuid:-25:746>

• Base Rule

Properties:
   Power station <select> - select a Power Station from the session list.
   Consumers:
      <add object> - add power consumers from the session list

Resource Check Rule

Executes child rules if a selected industry or vehicle reaches a set commodity level. This rule has been superseded by the Multiple Resource Check Rule

• <kuid:-25:1067>

• Legacy Rule (replaced by Multiple Resource Check Rule)

• Built-in Rule

• Parent Rule

Properties:
   Select one of two option buttons:-
      ( ) Watch industry queue
         Target Object <select> - select an industry from the session list
         Queue <select> - select a product queue from the selected industry
         Product <select> - select a product from the selected queue
         Amount <value> - enter a quantity
         Select one of two option buttons:-
            ( ) Complete when designated queue equals or exceeds required amount
            ( ) Complete when designated queue falls below required amount
      ( ) Watch vehicle
         Target Object <select> - select a rolling stock asset from the session list
         Queue <select> - select a product queue from the selected rolling stock
         Product <select> - select a product from the selected queue
         Amount <value> - enter a quantity
         Select one of two option buttons:-
            ( ) Complete when designated queue equals or exceeds required amount
            ( ) Complete when designated queue falls below required amount

• Notes:

This rule only checks for changing commodity levels during loading and unloading operations. It cannot be used to test, for example, if a vehicle is full or empty.

• Related Rules:
  • Multiple Resource Check Rule - executes child rules when set resource (commodity) levels are reached
  • Resource Verify Rule (fixed) - executes child rules when a set resource (commodity) level is reached

• Trainz Wiki Links:
  • http://online.ts2009.com/mediaWiki/index.php/Resource_Check_Rule

Resource Verify Rule (fixed)

Executes child rules if a selected industry or vehicle reaches a set commodity level. The rule resets when all child rules have completed.

• <kuid:160293:10060>

• DLS Rule by trev999

• Parent Rule

Properties:
   Select one of two option buttons:-
   ( ) Watch industry queue
      Target object <click to select> - click to select an industry from the session list.
      Product <click to select> - click to select an industry product.
      Amount <value> - enter a quantity for the selected product.
      Select one of two option buttons:-
      ( ) Complete when designated queue equals or exceeds designated amount
      ( ) Complete when designated queue falls below designated amount
   ( ) Watch vehicle queue
      Target object <click to select> - click to select a rolling stock vehicle from the session list.
      Product <click to select> - click to select a commodity product.
      Amount <value> - enter a quantity for the selected product.
      Select one of two option buttons:-
      ( ) Complete when designated queue equals or exceeds designated amount
      ( ) Complete when designated queue falls below designated amount

• Notes:

1. This rule will only monitor a single commodity in a single industry or vehicle.
2. This rule only checks for changing commodity levels during loading and unloading operations. It cannot be used to test, for example, if a vehicle is full or empty.

• Related Rules:
  • Multiple Resource Check Rule - executes child rules when set resource (commodity) levels are reached
  • Resource Check Rule - executes child rules when set resource (commodity) levels are reached

Station Visited Check Rule

Executes child rules if specific trains call at set stations or industries

• <kuid2:60850:89005:3>

• Built-in Rule

• Parent Rule

Properties:
   Trigger: <select> - click to select one of the following
      Never - stopping at the selected industries will never trigger the rule.
      Once only - the rule is triggered on the first visit only to any one of the selected industries
      Once per industry - the rule is triggered on the first visit to each industry with each individual product
      Once per visit - the rule is triggered on the first visit to each industry regardless of the product
      Once per vehicle - each vehicle can only trigger the rule once. 
   <select industry> - select industry or industries from session list
   Select one of two option buttons:-
      ( ) click to accept all trains
      ( ) click to accept trains matching specific criteria
         Selecting the second option will produce the following selection controls:-          
         Specific vehicle - identify the specific vehicle or set of specific vehicles that will trigger the rule
            + - click to add a specific vehicle from the session list
            x - click to remove the specific vehicle from the rule
         Vehicle types - identify the type of vehicle or a set of vehicle types that will trigger the rule
            + - click to add a type of vehicle from the session list
            x - click to remove the type of vehicle from the rule
         Drivers - identify the drivers that will trigger the rule
            + - click to add a driver from the session list
            x - click to remove a driver from the rule

Back to Top

---

Interlocking Tower, Junction and Signal Rules

Interlocking Tower Configure Path Rule

Alters settings on an interlocking tower path

• <kuid:401543:3205>

• Base Rule

Properties:
  Interlocking Tower <select> - to set Name and Objects

• Related Rules:
  • Interlocking Tower Path Selection UI Rule - automatically reacts to messages from Interlocking Towers and displays a path selection dialog to the player.
  • Interlocking Tower Set Path Rule - sets the state of an interlocking tower path for a train
  • Interlocking Tower Enhanced Manager Rule (SP2 and later) - more management and control options for interlocking towers.

Interlocking Tower Path Selection UI Rule

Will automatically react to messages from Interlocking Towers and display a path selection dialog to the player. Disable by removing rule from session

• <kuid:401543:3203>

• Base Rule

Properties:
  [Checkbox] Show path activation message in Driver

• Related Rules:
  • Interlocking Tower Configure Path Rule - alters the settings on an interlocking tower path
  • Interlocking Tower Set Path Rule - sets the state of an interlocking tower path for a train
  • Interlocking Tower Enhanced Manager Rule (SP2 and later) - more management and control options for interlocking towers.

Interlocking Tower Set Path Rule

Will set the state of an interlocking tower path for a train

• <kuid:401543:3204>

• Base Rule

Properties:
  Interlocking Tower <select> - to set Name and Objects

• Related Rules:
  • Interlocking Tower Configure Path Rule - alters the settings on an interlocking tower path
  • Interlocking Tower Path Selection UI Rule - automatically reacts to messages from Interlocking Towers and displays a path selection dialog to the player.
  • Interlocking Tower Enhanced Manager Rule (SP2 and later) - more management and control options for interlocking towers.

Interlocking Tower Enhanced Manager Rule (SP2 and later)

Provides more management and control options for interlocking towers.

• <kuid2:61392:8130:41>

• DLS Rule by pguy

Properties:
   <towers> - click to select interlocking towers from the session list
      <do full check again> - click to run an error check on all interlocking towers
      List of all available interlocking towers - for each tower:-
         <view details> - click to view and edit the tower properties
         <copy from> - click to copy properties from another tower selected from the session list
   <debug log> - click to set the debug log properties

• Related Rules:
  • Interlocking Tower Configure Path Rule - alters the settings on an interlocking tower path
  • Interlocking Tower Path Selection UI Rule - automatically reacts to messages from Interlocking Towers and displays a path selection dialog to the player.
  • Interlocking Tower Set Path Rule - sets the state of an interlocking tower path for a train

• Trainz Wiki Links:
  • http://online.ts2009.com/mediaWiki/index.php/Enhanced_Interlocking_Tower_Manager_Rule

Junction Derailment Prevention Rule

Sets opposing (trailing) junctions ahead of a train to prevent derailments. Works with both AI and manually driven trains.

• <kuid2:121843:100282:1>

• DLS Rule by pitkin

Properties:
   None

• Notes:

This rule will not overrule a junction already locked by another AI train or locked against AI control using the Set Junctions Rule.

• Related Rules:
  • Lock All Junctions Rule - locks all junctions against user control
  • Set Cleared Junctions Rule - sets selected junctions to specific states (direction, locked/unlocked, allow/prevent AI control) while they are unoccupied.
  • Set Junctions Rule - sets selected junctions to specific states (direction, locked/unlocked, allow/prevent AI control).

Lock All Junctions Rule

Locks all junctions against user actions. AI operations are not affected. Once the AI releases a junction, it will be returned to its previous locked state.

• <kuid:400048:100971>

• DLS Rule by callavsg

Properties:
   None

• Notes:

Individual junctions can still be set, locked and unlocked by using the Set Junction Rule

• Related Rules:
  • Set Cleared Junctions Rule - sets selected junctions to specific states (direction, locked/unlocked, allow/prevent AI control) while they are unoccupied.
  • Set Junctions Rule - sets selected junctions to specific states (direction, locked/unlocked, allow/prevent AI control).

MissionCode Manager Rule (SP2 and later)

Enables the addition, editing and management of Mission Codes used to auto select paths in Interlocking Towers.

• <kuid2:61392:8200:50>

• DLS Rule by pguy

ENTRY UNDER CONSTRUCTION

• Trainz Wiki Links:
  • http://online.ts2009.com/mediaWiki/index.php/MissionCodes_Manager

MissionCode Stops and Timetable Manager Rule (SP2 and later)

Enables the creation, editing and management of stop zones and timetables for trains following a path defined using mission codes.

• <kuid2:61392:8300:50>

• DLS Rule by pguy

ENTRY UNDER CONSTRUCTION

• Trainz Wiki Links:
  • http://online.ts2009.com/mediaWiki/index.php/Mission_Code_Stops_and_TimeTables_Manager

Multiple Junction Alignment Check Rule

Executes child rules if specific junctions are set.

• <kuid:-25:168>

• Built-in Rule

• Parent Rule

Properties:
   Wait until <selection> - select from:-
      any one - any of the junctions in the rule list (below) is set correctly
      all - ALL of the junctions in the rule list are set correctly
   <Add junction> - click to select a junction from the session list
   <Add all> - click to select ALL junctions in the session list
   <Delete all> - click to delete ALL selected junctions from the rule list
      For each selected junction:-
      <setting> - click to select one switch direction from:-
         Left
         Right
         Center
         Any
      <remove> - to delete this junction from the rule list

• Related Rules:
  • Lock All Junctions Rule - locks all junctions against user control
  • Set Cleared Junctions Rule - sets selected junctions to specific states (direction, locked/unlocked, allow/prevent AI control) while they are unoccupied.
  • Set Junctions Rule - sets selected junctions to specific states (direction, locked/unlocked, allow/prevent AI control).

• Trainz Wiki Links:
  • How to Control Junctions in Sessions

Set Cleared Junctions Rule

Sets selected junctions to specific states (direction, locked/unlocked, allow/prevent AI control) while they are unoccupied. If a junction is occupied it waits until the junction is cleared. Warning: not compatible with Interlocking Tower Assets

• <kuid2:131986:157661:1>

• DLS Rule by atilabarut

Properties:
   Add Junction - click to select a junction from the session junction list
   Add All - click to add ALL junctions in the session junction list
   Delete All - click to remove ALL entered junctions from the rule
      Junction Options: - for each selected junction:-
         <direction> - click to select the junction direction
            Left
            Center
            Right
            Don't change
         <user control> - click to select a user control option
            Locked - the junction setting cannot be changed by the user
            Unlocked - the junction setting can be changed by the user
         <AI control> - click to select AI control
            Allows AI control - an AI train can switch the junction
            Blocks AI control - an AI train cannot switch the junction
         Remove - click to remove this junction from the rule list

• Related Rules:
  • Junction Derailment Prevention Rule - sets opposing junctions ahead of a train to prevent derailments
  • Lock All Junctions Rule - locks all junctions against user control
  • Multiple Junction Alignment Check Rule - executes child rules when junctions are aligned
  • Set Junctions Rule - sets selected junctions to specific states (direction, locked/unlocked, allow/prevent AI control).

• Trainz Wiki Links:
  • How to Control Junctions in Sessions

Set Junctions Rule

Sets selected junctions to specific states (direction, locked/unlocked, allow/prevent AI control). Warning: not compatible with Interlocking Tower Assets

• <kuid:-25:1065>

• Built-in Rule

Properties:
   Add Junction - click to select a junction from the session junction list
   Add All - click to add ALL junctions in the session junction list
   Delete All - click to remove ALL entered junctions from the rule
      Junction Options: - for each selected junction:-
         <direction> - click to select the junction direction
            Left
            Center
            Right
            Don't change
         <user control> - click to select a user control option
            Locked - the junction setting cannot be changed by the user
            Unlocked - the junction setting can be changed by the user
         <AI control> - click to select AI control
            Allows AI control - an AI train can switch the junction
            Blocks AI control - an AI train cannot switch the junction
         Remove - click to remove this junction from the rule list

• Related Rules:
  • Junction Derailment Prevention Rule - sets opposing junctions ahead of a train to prevent derailments
  • Lock All Junctions Rule - locks all junctions against user control
  • Multiple Junction Alignment Check Rule - executes child rules when junctions are aligned
  • Set Cleared Junctions Rule - sets selected junctions to specific states (direction, locked/unlocked, allow/prevent AI control) while they are unoccupied.

• Trainz Wiki Links:
  • How to Control Junctions in Sessions

Set Signal Extended Rule

Sets the state of a selected signal Warning: not compatible with Interlocking Tower Assets

• <kuid2:47662:20002:4>

• Built-in Rule

Properties:
   <Select signal> to <signal state> - click to select a signal from the session list and click to select a state from the list -
      Automatic
      Stop
      Stop then Continue
      Caution Left
      Caution Right
      Caution
      Advance Caution Left
      Advance Caution Right
      Advance Caution
      Proceed Left
      Proceed Right
      Proceed
      Slow
      Medium

• Notes:

The signal must support the state selected otherwise there will be no change in the signal

• Related Rules:
  • Trigger Multiple Signals Rule - sets selected signals to DANGER (STOP) when selected triggers are activated

Trigger Multiple Signals Rule

Sets selected signals to DANGER (STOP) when selected triggers are activated. Signals will be at AUTOMATIC when the triggers are not activated.

• <kuid2:116387:26:1>

• DLS Rule by maggs

Properties:
   <add signal> - select a signal from the Session List. More than one signal can be added.
      <delete> - remove a signal from the rule.
   <add trigger> - select a trigger from the Session List. More than one trigger can be added.
      <delete> - remove a trigger from the rule.

• Related Rules:
  • Set Signal Extended Rule - sets a selected signal to a specific signal state

Back to Top

---

Message Rules

Close Message Popup Rule

Closes open message popups

• <kuid:447264:1526>

• Built-in Rule

Properties:
  None

• Known Issues:

This rule only appears to work if it is a child of the rule that triggered the Message Popup Rule

• Related Rule:
  • Message Popup Rule - displays a pop-up browser window and waits for it to be closed.

• Trainz Wiki Links:
  • Message Popup Rule Applications
  • Message Popup Examples

DestSign Table Rule

Creates a list of destination names for a destination sign

• <kuid2:206816:99004:2>

• Built-in Rule

Properties:
  <add destination> - enter a destination name to be added to the destination sign roll
  <import destinations from texture-group> - select a list of destination names from session
  [Check Box] Enable industries/stations as destination - check to set
  [Check Box] Enable Track Marks as destinations - check to set
  [Check Box] Enable table of destinations - check to set

Display HTML Pages Rule

Creates a browser to display the listed HTML files in order as a navigable sequence of pages. This rule has been superseded by the Message Popup Rule

• <kuid:-25:442>

• Legacy Rule (replaced by Message Popup Rule)

• Base Rule

Properties:
   <Add Page> - adds the HTML page index.html from the selected HTML asset
      <index.html> - click to change the page name. The extension .html is optional
   <Add All> - adds all HTML pages from the session list (this appears to be disabled in TANE)
   <Delete All> - delete all HTML pages from this property list
   [Check Box] Prevent user from exiting browser until all pages viewed
   [Check Box] Disable closing of browser window by user
   [Check Box] Disable browser window scrolling
   [Check Box] Make browser window invisible
   [Check Box] Set position-Under Construction!!! - not implemented
   [Check Box] Set size-Under Construction!!! - not implemented
   Use the page <index.html> from asset <select> as the hidden button - the link buttons at the bottom of the page will be taken from the selected page in the selected HTML asset

• Related Rules:
  • Close Message Popup Rule - closes a displayed pop-up browser window.
  • Message Popup Rule - displays a pop-up browser window and waits for it to be closed.
  • Set HTML Page Rule - sets parameters for the Display HTML Pages Rule
  • Timed Limited Display HTML Rule (SP2 and later) - displays a HTML page in a browser window for a set time.

Display Video Rule

Displays a page containing a video clip from a HTML asset in a browser window.

• <kuid:-25:138>

• Built-in Rule

Properties:
   Display page <index.html> of html asset <click to select> in a new browser window
      index.html - enter the filename of a HTML page in the selected HTML asset. The .html is optional in the filename.
      <click to select> - select the HTML asset from those installed.

• Notes:

Video must be in a valid web format.

• Related Rules:
  • Play Sound Rule - plays a wav sound file

DisplayIndustryStatus Rule (color modified)

Displays a summary of industry product levels when the "k" key is pressed.

• <kuid:622415:100001>

• DLS Rule by lockheed02 and marzipan

Properties:
   None

• Notes:

Pressing the k key in Driver mode will bring up a small window with a single link Display Industry Status (there may also be other links). Clicking this link will show the product levels of all industries.

• Related Rules:
  • ExTrainz Manager Rule - TANE SP2 - displays information on consists, industries and products in Driver and Surveyor.

ExTrainz Manager Rule - TANE SP2

Provides information on consists, industries and products in both Surveyor and Driver modes. Once activated, the rule creates an additional short menu bar below the main menu bar.

• <kuid:160293:10029>

• DLS Rule by trev999

Properties:
   Diagnostic mode is <On/Off> - click to select On or Off. When set On diagnostic messages will be added to the Trainz Log file.
   Turn on message overlay <Yes/No> - click to select Yes or No. When set to Yes the message overlay (lower left of screen) will be active.
   Show rolling stock in Driver mode <Yes/No> - click to select Yes or No. When set to Yes rolling stock can be searched in Driver.
   Search only rolling stock already in session <Yes/No> - click to select Yes or No. When set to Yes only those rolling stock assets
      installed in the session can be searched.
   Graphic colours: <When Red, the industry does not require service/When Green, the industry does not require service> - click to switch 
      between the two colour options.
   Industry page size: <value> - enter the number of industries to be displayed in the Industry List window (maximum 250).
   The following industries are excluded: <Add an industry to be excluded> - name can be complete (e.g. "Coal Mine 2") 
      which will exclude that specific industry from the management list, or partial (e.g. "Coal") which will exclude all 
      industries with the word "Coal" in their names. Entries are not case sensitive.
      Once industries have been excluded, additional commands will appear for each excluded industry:-
      <delete> <industry name begins with/class name begins with> <name> - click delete to remove this entry. 
         - click industry name begins with/class name begins with to select between the two (see notes below).
         - click name to edit the name.

• Notes:

1. Rolling stock installed in TANE or in the current session only (see settings above) can be searched to find a match for any selected product from any industry. In Surveyor (and Driver if that setting is enabled) click on the View Products sub menu link and click on a product name in the Product Window to display a list of all compatible rolling stock for that product.
2. Alternatively, click on the View Industries sub menu link and then click on a Product Icon to open a Product Window, then click on the View Rolling Stock link at the top of the window.
3. Industry class names are defined in the config.txt file of industry assets and are not normally accessible by users. However, you can exclude an entire group of related "industry asset classes" such as station, coalingtower, watertank, etc regardless of their actual names provided those assets have been given that "class name" by their creators.

• Known Issues:

This rule is NOT compatible with all industries.

• Related Rules:
  • DisplayIndustryStatus Rule (color modified) - displays information on industry product levels.

Fade In/Out Rule

Fade in or out within seconds, using specified color and opacity values.

• <kuid2:190611:200000:2>

• Built-in Rule

Properties:
   Red percentage:             <value> - enter the final % of red (0 = none, 100 = maximum)
   Green percentage:           <value> - enter the final % of green
   Blue percentage:            <value> - enter the final % of blue
   Alpha percentage (opacity): <value> - enter the final % of opacity (0 = invisible, 100 = solid)
   Fading duration:            <value> - enter the number of seconds required for the fade
   <help> - click to bring up help instructions

• Notes:

Seconds are Trainz clock time, not real time.

Hide Product Overlays Rule

Hides the commodity or product bar graphs that appear on active industries

• <kuid:400048:100970>

• DLS Rule by callavsg

Properties:
  None

InputTable Rule

Creates a list of message names to be used for various purposes including passing data to Driver Commands

• <kuid2:131986:1012:1>

• Built-in Rule

Properties:
   <add> - click to add a new entry to the table
   Each new entry will require an input message
      <short message> - enter a message. The message must be in a format that is specific for each purpose
      For the MoveTurntable driver command the message must be formatted as:-
         turntable,name_of_turntable,number_of_connecting_roads - the first entry must be the word turntable in lower case.
            name_of_turntable is the name of the turntable, 
            number_of_connecting_roads is the number of tracks connecting to the turntable
      For the WaitUntilTime driver command the message must be formatted as:-
         time,hour,minute - the first entry must be the word time in lower case, 
            hour must be from 0 to 23, 
            minute must be from 0 to 59.
      For the WaitUntilSVariable driver command the message must be formatted as:-
         svar,svar_name,svar_condition,value - the first entry must be the word svar in lower case, 
            svar_name is the name of the session variable, 
            svar_condition is an equality (eg eq for equal, gt for greater than, etc)
            value is an integer value to be compared to the session variable.
   Each entry in the table will be followed by the commands:-
      cp - click to copy this entry to a new entry
      up - click to move this entry up one level
      dn - click to move this entry down one level
      rm - click to remove this entry from the table

Message Popup Rule

Displays a pop-up browser window and waits for it to be closed. Closure can be manual (by the user) or by another rule.

• <kuid:-25:1003>

• Built-in Rule

Properties:
   [Check Box] Pause game while message is displayed - stops the game until this message is closed
   [Check Box] Close previous popup windows - closes any Message Popups currently displayed before this message is shown
   Message location <Top Left/Top Right/Bottom Left/Bottom Right> - select one to position the browser window on the screen
   Message Source: - select one of three option buttons:-
      ( ) Custom text - the simplest and easiest option
         Icon <Click here to set> - (optional) shows a list of message icons. Select one to be displayed with the message
         Icon <Clear icon> - clears any currently displayed message icon
         Custom text box Enter text to be displayed. You will be limited to about 6 lines of text. 
             For longer messages or to include graphics, use the A predefined HTML page option.
         <HTML Wave> - (optional) select the name of the HTML asset from the list shown that contains the wave file to be played.
         <Wave Name> - (optional) enter the name of a wave (.wav) sound file to be played. 
             The sound file must be in the HTML asset identified above. Filename is not case sensitive. Extension ".wav" is optional
         [Check Box] Autoplay Wave: - plays the .wav sound file as soon as message is displayed. 
             If unchecked the sound will not be played.
      ( ) A predefined HTML page - requires a working knowledge of HTML
         <HTML Asset> - select the name of the HTML asset that contains the required HTML page from the list shown.
         <HTML Page> - enter the filename of the HTML page to be displayed. The page must be in the HTML asset identified above. 
             Filename is not case sensitive. Extension ".html" is optional.
         <HTML Wave> - (optional) select the name of the HTML file containing the wave file to be played. 
             The page must be in the HTML asset identified above. Filename is not case sensitive. Extension ".html" is optional.
         <Wave Name> - (optional) enter the name of a wave (.wav) sound file to be played. 
             The sound file must be in the HTML asset identified above. Filename is not case sensitive. Extension ".wav" is optional
         [Check Box] Autoplay Wave: - plays the .wav sound file as soon as message is displayed. 
           If unchecked sound will not be played.
      ( ) A predefined string-table entry from a HTML asset
         <HTML Asset> - select the name of the HTML asset from those installed that contains the required string-table.
         <String Table Token> - enter the "tag name" of the text in the string-table of the HTML assets config.txt file.
         <HTML Wave> - (optional) select the name of the HTML file containing the wave file to be played. 
             The page must be in the HTML asset identified above. Filename is not case sensitive. Extension ".html" is optional.
         <Wave Name> - (optional) enter the name of a wave (.wav) sound file to be played. 
             The sound file must be in the HTML asset identified above. Filename is not case sensitive. Extension ".wav" is optional
         [Check Box] Autoplay Wave: - plays the .wav sound file as soon as message is displayed. 
             If unchecked sound will not be played.

• Known Issues:

Because this rule will wait until it is closed (terminated) then it is not recommended for use in an Ordered List because you cannot guarantee that any following child rules will be executed. If it MUST be used in an Ordered List then place it last.

• Related Rules:
  • Close Message Popup Rule - closes a displayed pop-up browser window.
  • Display HTML Pages Rule - display listed HTML files in order as a navigable sequence of pages.
  • Timed Limited Display HTML Rule (SP2 and later) - displays a HTML page in a browser window for a set time.

• Trainz Wiki Links:
  • How to Create a HTML Asset
  • Message Popup Applications
  • Message Popup Examples

Minimap Options Rule

Sets the display options for the minimap.

• <kuid:-25:636>

• Built-in Rule

Properties: Default values - all checked
   [Check Box] Map Textures
   [Check Box] Gradients
   [Check Box] Junctions
   [Check Box] Signals
   [Check Box] Triggers
   [Check Box] Markers
   [Check Box] Trackside Labels
   [Check Box] Terrain Objects
   [Check Box] Industrial Names
   [Check Box] Named Objects
   [Check Box] Consists

• Related Rules:
  • Show/Hide Minimap Rule - shows the minimap window in Driver.

Play Sound Rule

Plays a wav sound file.

• <kuid:-25:1045>

• Built-in Rule

Properties:
   Default HTML <Click> - click to to enter Sound File Name
   HTML Assets <Click> - click to select HTML asset
   Rule Completes <Click> -  to select one of:-
      sound has just started
      sound has finished playing

• Related Rules:
  • Display Video Rule - displays a page containing a video clip from a HTML asset in a browser window

Session Metadata Rule

Sets session metadata in the config file. Info can be read by other systems and displayed to the player.

• <kuid:401543:2036>

• Base Rule

Properties:
   Type <Click> - click to select one of:-
      Simulation
      Challenge
   Length <value> - to enter number of minutes, default is 30 minutes
   Difficulty <Click> - click to select one of:-
      Normal - default
      Tutorial
      Easy
      Hard
      Expert

• Notes:

Time is Trainz clock time, not real time

Set Helper Icon Size Rule

Sets the size of helper icons such as the junction lever arrows.

• <kuid:-25:791>

• Built-in Rule

Properties:
  Junction Arrows Size <Click> - to set scale ratio smaller than default, default is 100%

Set HTML Pages Rule

Instructs the Display HTML Pages rule to perform specific operations. This rule has been superseded by the Message Popup Rule

• <kuid:-25:792>

• Legacy Rule (replaced by Message Popup Rule)

• Built-in Rule

Properties:
   Operations to preform on the display HTML pages sequence browser
   Select one of six option buttons:-
      ( ) to instruct the sequence browser to <select> - to choose page operations
      ( ) to instruct the sequence browser to open the page <select> - enter the HTML page name
      ( ) to set browser parameters <select> - choose one of:-
         to Enable/Disable closing of the browser window by the user
         to Enable/Disable scrolling on the sequence browser window
         to Show/Hide the sequence browser window
      ( ) Set the following flag for the page named <select> - enter the HTML page name
         [Check Box] Hide/Close window on 'done' action
         [Check Box] Window has no 'done' button
         [Check Box] Disable scrolling(not implemented yet)
         [Check Box] Spare setting 1
         [Check Box] Spare setting 2
         [Check Box] Spare setting 3
         [Check Box] Spare setting 4
         [Check Box] Spare setting 5
      ( ) Use the page <select> (enter HTML page name) from the HTML asset <select> (select HTML asset)
      ( ) Use the string table entry <select> (enter Index) from the HTML asset <select> (select HTML asset)

• Related Rules:
  • Display HTML Pages Rule - displays HTML pages in a browser window.
  • Message Popup Rule - displays a pop-up browser window and waits for it to be closed.
  • Timed Limited Display HTML Rule (SP2 and later) - displays a HTML page in a browser window for a set time.

Show/Hide Layer Rule

Shows or hides a layer from Driver.

• <kuid2:401543:1170:1>

• Built-in Rule

Properties:
  <visibility> - select one of two options
     Show - select to make the layer visible
     Hide - select to make the layer invisible
  <click here to set> - enter name of layer. Name is case sensitive.

• Known Bugs:

Layers set to Hide when a game is saved will be Shown when the game is reloaded

• Known Issues:

Rule will NOT check to see if the named layer exists or not

• Trainz Wiki Links:
  • How to Use Layers: Layers in Driver Mode

Show/Hide Minimap Rule

Shows the minimap window in Driver.

• <kuid:-25:794>

• Built-in Rule

Properties:
   <Show/Hide> the driver Minimap Window - click to switch between Show and Hide.

• Related Rules:
  • Minimap Options Rule - sets the display options for the minimap.

Show/Hide On-screen Help Rule

Shows or hides On-screen help in Driver.

• <kuid:401543:2020>

• Built-in Rule

Properties:
   On screen help (junction overlays, etc) - select one of three option buttons:-
      ( ) Show
      ( ) Hide
      ( ) Leave Unchanged
   On Screen Vehicle Names: -  - select one of three option buttons:-
      ( ) Show
      ( ) Hide
      ( ) Leave Unchanged

Timed Limited Display HTML Rule (SP2 and later)

Displays an HTML browser window for a limited time.

• <kuid2:61392:2005:32>

• DLS Rule by pguy

Properties:
  HTML Asset Name : <[Click to select HTML asset]> - click to select an HTML asset from those installed
  Page filename : <value> - click to enter the filename of the HTML page in the selected HTML asset. The .html filename extension is optional.
  Play duration (SessVar or duration in seconds) : <value> - enter a SessVar name or the number of seconds.
  Browser left position (SessVar or position) : <value> - enter a SessVar name or the number of pixels from the left screen edge.
  Browser top position (SessVar or position) : <value> - enter a SessVar name or the number of pixels from the top screen edge.
  Browser width (SessVar or position) : <value> - enter a SessVar name or the width in pixels.
  Browser height (SessVar or position) : <value> - enter a SessVar name or the browser height.
  [Check Box] <Alert is not reshowable on request/Alert is showable on request> - check or click to allow or prevent the user viewing the page again.

• Notes:

Seconds are Trainz clock time, not real time.

• Related Rules:
  • Close Message Popup Rule - closes open message popups
  • Display HTML Pages Rule - displays HTML pages in a browser window.
  • Message Popup Rule - displays a pop-up browser window and waits for it to be closed.
  • Set HTML Page Rule - sets parameters for the Display HTML Pages Rule

Wait on Waybill Screen/Main Screen Rule

Executes child rules when the Waybill window is opened or closed

• <kuid:-25:957>

• Built-in Rule

• Parent Rule

Properties:
   [Check Box] Trigger rule once - check to trigger the rule once only
   Wait for the Waybill window to be <opened/closed> - select either opened or closed.

Back to Top

---

Miscellaneous Rules

Some of these rules have no user accessible functions but may be used by other rules. Others do not fit in any other category.

ConsistDataHandler Rule

Was used by the QuickDrive Rule to place consists onto a route. Now obsolete.

• <kuid:401543:1180>

• Obsolete Rule (function is now built into TANE)

• Base Rule

Properties:
   None

Custom Script Rule

No description

• <kuid:447264:1526>

• Built-in Rule

Properties:
  None

Generic TreeNode Debug Window Rule

No description.

• <kuid:30501:1042>

• Base Rule

Properties:
   None

Session Debug Rule

Executes the first child if Debug mode is selected. Otherwise executes the second child rule.

• <kuid:30501:100180>

• Built-in Rule

• Parent Rule

Properties:
   None

• Notes:

When a session starts with this rule enabled, the player will be given the choice of running the session in Debug or Normal mode. Selecting Debug will execute the first child rule. Selecting Normal will execute the second child rule.

Back to Top

---

Navigation Rules

Directional Trigger Check Rule

Executes child rules when a set train enters a set trigger in a set direction. Adds direction to the Trigger Check Rule.

• <kuid2:532391:100003:1>

• DLS Rule by bobhahn

Properties:
   [Check Box] Trigger only once 
   [Check Box] Wait for child rules to complete even if no trains are present in rule trigger
   [Check Box] Only activate when the entering vehicle of the train is heading <select direction> into the trigger - select one of two directions:-
      forward
      backward
   Triggers List
      <add trigger> - select a trigger from the session list
      <delete trigger> - delete a selected trigger from the rule
   Select one of two option buttons:-
      ( ) click to accept all trains
      ( ) click to accept trains matching specific criteria
         Selecting the second option will produce the following selection controls:-
         Specific vehicle - identify the specific vehicle(s) that will trigger the rule
            + - click to add a specific vehicle from the session list
            x - click to remove the specific vehicle from the rule
         Vehicle types - identify the type of vehicle(s) that will trigger the rule
            + - click to add a type of vehicle from the session list
            x - click to remove the type of vehicle from the rule
         Drivers - identify the driver(s) that will trigger the rule
            + - click to add a driver from the session list
            x - click to remove a driver from the rule

• Notes:

1. This rule works best when used with the Directional Trigger track object available on the DLS.
2. The Directional Trigger, when installed, will appear as a Signal not as a Trackmark.
3. Normal (non directional) triggers can be used with this rule but the rule will have no direction sensitivity apart from the forward and backward in the rule properties.

• Related Rules:
  • Trackside Check Rule - executes child rules when activated by a train. Provides different options to the Trigger Check Rule
  • Trigger Check Rule - executes child rules when a set train enters a set trigger (non-directional)

• Trainz Wiki Links:
  • How to Control Signals in Sessions: Halt Before Clear
  • Message Popup Rule Applications
  • How to Use Navigation Point Rules (Applications): Wait for Loading to be Completed
  • How to Use Track Triggers
  • How to Use Variables in Sessions (Examples)

Navigation Display Rule

Creates a set of navigation points. Multiple sets can be created by adding additional copies of this rule. This rule creates the navigation set, it does not display it.

• <kuid2:401543:1161:1>

• Base Rule

Properties:
   Unique set ID: <click here to set> - enter a unique name for the navigation set. Name must be in lowercase and have no spaces.
   Train (optional): <click here to set> - select a rolling stock asset from the session list shown.
   Select one of three option buttons:-
   ( ) All points must be completed in sequence:
      - the first uncompleted navigation point will be shown and must be completed next.
      - the next point (if any) will also be shown partly transparent.
   ( ) Points will be completed in sequence, but can be skipped:
      - navigation points can be skipped but must be completed in order.
      - you cannot go back to complete a missed point.
   ( ) All points must be completed, but in any order:
      - all uncompleted navigation points will be shown.
      - you may complete them in any order.
  For each navigation point:
     <Click here to set> - select an item (trigger, trackmark, track object, rolling stock) from the session list to become the navigation point.
     <Display text> - enter a text message to display with the navigation point. You are limited to 25 characters.
     Icon <icon list> - select an icon for the navigation point.
     <Style> - click to select one from three choices
        Automatic - the navigation point will be completed as soon as the consist reaches the point.
        Manual - the navigation point must be set as complete by using the Navigation point complete rule or the Navigation set clear rule.
           The Manual style option allows you to execute other rules (e.g. consist check, wait, etc) before completing the navigation point.
        Require Stop - the navigation point will be completed when the consist comes to a complete stop on the point.

• Related Rules:
  • Navigation Set Hide/Show Rule - makes a navigation set visible/invisible.
  • Navigation Set Check Rule - executes child rules if a navigation set has completed or is incomplete.
  • Navigation Set Clear Rule - completes (terminates) a navigation set.
  • Navigation Point Complete Rule - manually completes (terminates) a specific navigation point in a set.
  • Wait on Navigation Point Rule - executes child rules when a navigation point has been completed

• Trainz Wiki Links:
  • How to Use Navigation Point Rules (Applications)
  • How to Use Navigation Point Rules

Navigation Point Complete Rule

Manually completes a navigation point in a set

• <kuid:401543:1167>

• Base Rule

Properties:
   Mark navigation point <click here to set> - enter the navigation point number to be completed
   complete in set <click here to set> - enter the unique name for the navigation set created using the Navigation Display Rule.
        Name must be in lowercase and have no spaces.

• Known Issues:

The rule will NOT check to see if the named navigation set and point exists or not.

• Related Rules:
  • Navigation Display Rule - creates a set of navigation points.
  • Navigation Set Hide/Show Rule - makes a navigation set visible/invisible.
  • Navigation Set Check Rule - executes child rules if a navigation set has completed or is incomplete.
  • Navigation Set Clear Rule - completes (terminates) a navigation set.
  • Wait on Navigation Point Rule - executes child rules when a navigation point has been completed

• Trainz Wiki Links:
  • How to Use Navigation Point Rules (Applications)
  • How to Use Navigation Point Rules

Navigation Set Check Rule

Executes child rules if a navigation set created with the Navigation Display Rule is complete (or incomplete).

• <kuid:401543:1165>

• Base Rule

• Parent Rule

Properties:
   Checks if navigation point set <name>: - enter the unique name for the navigation set created using the Navigation Display Rule.
        Name must be in lowercase and have no spaces.
   is <Complete/Incomplete> - click to select one

• Known Issues:

The rule will NOT check to see if the named navigation set exists or not.

• Related Rules:
  • Navigation Display Rule - creates a set of navigation points.
  • Navigation Set Hide/Show Rule - makes a navigation set visible/invisible.
  • Navigation Set Clear Rule - completes (terminates) a navigation set.
  • Navigation Point Complete Rule - manually completes (terminates) a specific navigation point in a set.
  • Wait on Navigation Point Rule - executes child rules when a navigation point has been completed

• Trainz Wiki Links:
  • How to Use Navigation Point Rules (Applications)
  • How to Use Navigation Point Rules

Navigation Set Clear Rule

Clears a navigation set removing any uncompleted navigation points

• <kuid:401543:1164>

• Base Rule

Properties:
   <Click here to set> - enter the unique name for the navigation set created using the Navigation Display Rule.
       Name must be in lowercase and have no spaces.

• Known Issues:

The rule will NOT check to see if the named navigation set exists or not.

• Related Rules:
  • Navigation Display Rule - creates a set of navigation points.
  • Navigation Set Hide/Show Rule - makes a navigation set visible/invisible.
  • Navigation Set Check Rule - executes child rules if a navigation set has completed or is incomplete.
  • Navigation Point Complete Rule - manually completes (terminates) a specific navigation point in a set.
  • Wait on Navigation Point Rule - executes child rules when a navigation point has been completed

• Trainz Wiki Links:
  • How to Use Navigation Point Rules (Applications)
  • How to Use Navigation Point Rules

Navigation Set Hide/Show Rule

Shows and hides navigation sets. You can have multiple sets visible and hidden at the same time.

• <kuid:401543:1163>

• Base rule

Properties:
   <visibility> - click to select one
      Hide - select to make the navigation set invisible
      Show - select to make the navigation set visible
   <click here to set> - enter the unique name for the navigation set created using the Navigation Display Rule.
        Name must be in lowercase and have no spaces.

• Known Issues:

The rule will NOT check to see if the named navigation set exists or not.

• Related Rules:
  • Navigation Display Rule - creates a set of navigation points.
  • Navigation Set Check Rule - executes child rules if a navigation set has completed or is incomplete.
  • Navigation Set Clear Rule - completes (terminates) a navigation set.
  • Navigation Point Complete Rule - manually completes (terminates) a specific navigation point in a set.
  • Wait on Navigation Point Rule - executes child rules when a navigation point has been completed

• Trainz Wiki Links:
  • How to Use Navigation Point Rules (Applications)
  • How to Use Navigation Point Rules

Schedule Rule

Allows a schedule of timed events to be applied to a train

• <kuid:-3:10185>

• Base Rule

Properties:
   Insert track mark <select> - select a track mark from the Session List
   Arrival and Departure Time <Select> - set time
      hh:mm:ss - in hours/minutes/seconds
   Current Train <select> - select from session list
   Insert destination <select> - select from session list

• Notes:

Times are Trainz clock times, not real time

• Related Rules:
  • Driver Command Check Rule - executes child rules if the driver commands match a set list
  • Driver Command Rule - specifies which commands will be available for the drivers
  • Driver Schedule Rule - sets up a list of basic scheduled driver commands
  • Driver Setup Rule - creates a list of drivers and assign them their orders
  • Enable/Disable Driver Commands Rule - enable/disable specific driver commands on certain drivers

Trackside Check Rule

Executes child rules when a set train enters a set trigger. Similar to the Trigger Check Rule but provides different options.

• <kuid2:46162:100207:1>

• DLS Rule by Josefpav

• Parent Rule

Properties:
   Applies to: - select one of three option buttons:-
      ( ) Junction
      ( ) Trigger
      ( ) Trackmark
   Trackside object name: <specify> - select object name from session list
   Wait for train to: - select one of three option buttons:-
      ( ) Enter
      ( ) Stop at
      ( ) Leave
   [Check Box] Auto reset this rule - check to execute the rule continuously
   Applies to train containing:
   <Add vehicle> - click to select a rail vehicle from the session list
   del - click to remove a selected vehicle from the rule

• Related Rules:
  • Directional Trigger Check Rule - executes child rules when activated by a train moving in a set direction.
  • Trigger Check Rule - executes child rules when activated by a train

Trigger Check Rule

Executes child rules when a set train enters a set trigger. This rule replaces the older and less versatile Trigger Rule.

• <kuid:-25:1071>

• Built-in Rule

• Parent Rule

Properties:
   [Check Box] Trigger only once 
   [Check Box] Wait for child rules to complete even if no trains are present in rule trigger
   [Check Box] Only activate when the entering vehicle of the train is heading <select direction> into the trigger - select one of two directions:-
      forward
      backward
   Triggers List
      <add trigger> - select a trigger from the session list
      <delete trigger> - delete a selected trigger from the rule
   Select one of two option buttons:-
      ( ) click to accept all trains
      ( ) click to accept trains matching specific criteria
         Selecting the second option will produce the following selection controls:-
         Specific vehicle - identify the specific vehicle(s) that will trigger the rule
            + - click to add a specific vehicle from the session list
            x - click to remove the specific vehicle from the rule
         Vehicle types - identify the type of vehicle(s) that will trigger the rule
            + - click to add a type of vehicle from the session list
            x - click to remove the type of vehicle from the rule
         Drivers - identify the driver(s) that will trigger the rule
            + - click to add a driver from the session list
            x - click to remove a driver from the rule

• Related Rules:
  • Directional Trigger Check Rule - executes child rules when activated by a train moving in a set direction.
  • Trackside Check Rule - executes child rules when activated by a train. Provides different options to the Trigger Check Rule

• Trainz Wiki Links:
  • Message Popup Rule Applications
  • How to Use Navigation Point Rules (Applications): Wait for Loading to be Completed
  • How to Use Track Triggers
  • How to Use Variables in Sessions (Examples)

Wait on Navigation Point Rule

Executes child rules when a specific navigation point is completed

• <kuid:401543:1168>

• Base Rule

• Parent Rule

Properties:
   navigation point <click here to set> - enter the number of the navigation point to be completed
   in set <click here to set> - enter the unique name for the navigation set created using the Navigation Display Rule.
      Name must be in lowercase and have no spaces.

• Known Issues:

The rule will NOT check to see if the named navigation set and point exists or not.

• Related Rules:
  • Navigation Display Rule - creates a set of navigation points.
  • Navigation Set Hide/Show Rule - makes a navigation set visible/invisible.
  • Navigation Set Check Rule - executes child rules if a navigation set is complete or incomplete.
  • Navigation Set Clear Rule - completes (terminates) a navigation set.
  • Navigation Point Complete Rule - manually completes (terminates) a specific navigation point in a set.

• Trainz Wiki Links:
  • Message Popup Rule Applications: Navigation Point and Train Stopped Event Message
  • How to Use Navigation Point Rules (Applications)
  • How to Use Navigation Point Rules

Wait on Train Stop/Start Rule

Executes child rules when a train stops or starts moving

• <kuid:-25:1069>

• Built-in Rule

• Parent Rule

Properties:
   [Check Box] Trigger rule once 
   Wait for a train that matches the following criteria to <select> - select one of:-
      start moving
      stop moving
   Select one of two option buttons:-
      ( ) click to accept all trains
      ( ) click to accept trains matching specific criteria
         Selecting the second option will produce the following selection controls:-
         Specific vehicle - identify the specific vehicle or set of specific vehicles that will trigger the rule
            + - click to add a specific vehicle from the session list
            x - click to remove the specific vehicle from the rule
         Vehicle types - identify the type of vehicle or a set of vehicle types that will trigger the rule
            + - click to add a type of vehicle from the session list
            x - click to remove the type of vehicle from the rule
         Drivers - identify the drivers that will trigger the rule
            + - click to add a driver from the session list
            x - click to remove a driver from the rule

• Trainz Wiki Links:
  • Message Popup Rule Applications: Navigation Point and Train Stopped Event Message

Back to Top

---

Resources Rules

DisplayIndustryStatus Rule (color modified)

Displays a summary of industry product levels when the "k" key is pressed.

• <kuid:622415:100001>

• DLS Rule by lockheed02 and marzipan

Properties:
   None

• Notes:

Pressing the k key in Driver mode will bring up a small window with a single link Display Industry Status (there may also be other links). Clicking this link will show the product levels of all industries.

• Related Rules:
  • ExTrainz Manager Rule - TANE SP2 - displays information on consists, industries and products in Driver and Surveyor.

ExTrainz Manager Rule - TANE SP2

Provides information on consists, industries and products in both Surveyor and Driver modes. Once activated, the rule creates an additional short menu bar below the main menu bar.

• <kuid:160293:10029>

• DLS Rule by trev999

Properties:
   Diagnostic mode is <On/Off> - click to select On or Off. When set On diagnostic messages will be added to the Trainz Log file.
   Turn on message overlay <Yes/No> - click to select Yes or No. When set to Yes the message overlay (lower left of screen) will be active.
   Show rolling stock in Driver mode <Yes/No> - click to select Yes or No. When set to Yes rolling stock can be searched in Driver.
   Search only rolling stock already in session <Yes/No> - click to select Yes or No. When set to Yes only those rolling stock assets
      installed in the session can be searched.
   Graphic colours: <When Red, the industry does not require service/When Green, the industry does not require service> - click to switch 
      between the two colour options.
   Industry page size: <value> - enter the number of industries to be displayed in the Industry List window (maximum 250).
   The following industries are excluded: <Add an industry to be excluded> - name can be complete (e.g. "Coal Mine 2") 
      which will exclude that specific industry from the management list, or partial (e.g. "Coal") which will exclude all 
      industries with the word "Coal" in their names. Entries are not case sensitive.
      Once industries have been excluded, additional commands will appear for each excluded industry:-
      <delete> <industry name begins with/class name begins with> <name> - click delete to remove this entry. 
         - click industry name begins with/class name begins with to select between the two (see notes below).
         - click name to edit the name.

• Notes:

1. Rolling stock installed in TANE or in the current session only (see settings above) can be searched to find a match for any selected product from any industry. In Surveyor (and Driver if that setting is enabled) click on the View Products sub menu link and click on a product name in the Product Window to display a list of all compatible rolling stock for that product.
2. Alternatively, click on the View Industries sub menu link and then click on a Product Icon to open a Product Window, then click on the View Rolling Stock link at the top of the window.
3. Industry class names are defined in the config.txt file of industry assets and are not normally accessible by users. However, you can exclude an entire group of related "industry asset classes" such as station, coalingtower, watertank, etc regardless of their actual names provided those assets have been given that "class name" by their creators.

• Known Issues:

This rule is NOT compatible with all industries.

• Related Rules:
  • DisplayIndustryStatus Rule (color modified) - displays information on industry product levels.

Hide Product Overlays Rule

Hides the commodity or product bar graphs that appear on active industries

• <kuid:400048:100970>

• DLS Rule by callavsg

Properties:
  None

Multiple Resource Check Rule

Executes child rules if industries or vehicles reach set commodity levels. This rule replaces the older Resource Check Rule

• <kuid:-25:656>

• Built-in Rule

• Parent Rule

Properties:
   <Product Level> - click to select a product test from two choices:-
      Reach/Exceed - sets an upper limit for the resources being monitored. 
         For example: the rule will be triggered if the quantity of coal in a coal loader stockpile or a coal wagon reaches or exceeds a specified level.
         The initial level in the object must be below the set upper limit.
      Fall below - sets a lower limit for the resources being monitored. 
         For example: the rule will be triggered if the quantity of coal in a coal loader stockpile or a coal wagon falls below a specified level. 
         The initial level in the object must be above the set lower limit. 
         To test when a resource level reaches zero (i.e. is empty) set the lower limit to a very low value but not zero as the level can never fall below zero. 
   <value> - enter required quantity value
   <select> - select a product from session list of products
   <Add object> - click to select a source or target object. Multiple objects and their queues can be added to the rule. 
      ALL the entered products must reach/exceed or fall below the specified value for the rule to be triggered. 
      For each object:-
         <Object> - click to select session active industry or product enabled rail vehicle 
         <Queue> - select product queue (there may be only one available)
         <Remove> - removes the object and its product queue from the rule

• Notes:

This rule only checks for changing commodity levels during loading and unloading operations. It cannot be used to test, for example, if a vehicle is full or empty.

• Related Rules:
  • Resource Check Rule - executes child rules when set resource (commodity) levels are reached
  • Resource Verify Rule (fixed) - executes child rules when a set resource (commodity) level is reached

• Trainz Wiki Links:
  • How to Use Navigation Point Rules (Applications): Wait for Loading to be Completed

Resource Check Rule

Executes child rules if a selected industry or vehicle reaches a set commodity level. This rule has been superseded by the Multiple Resource Check Rule

• <kuid:-25:1067>

• Legacy Rule (replaced by Multiple Resource Check Rule)

• Built-in Rule

• Parent Rule

Properties:
   Select one of two option buttons:-
      ( ) Watch industry queue
         Target Object <select> - select an industry from the session list
         Queue <select> - select a product queue from the selected industry
         Product <select> - select a product from the selected queue
         Amount <value> - enter a quantity
         Select one of two option buttons:-
            ( ) Complete when designated queue equals or exceeds required amount
            ( ) Complete when designated queue falls below required amount
      ( ) Watch vehicle
         Target Object <select> - select a rolling stock asset from the session list
         Queue <select> - select a product queue from the selected rolling stock
         Product <select> - select a product from the selected queue
         Amount <value> - enter a quantity
         Select one of two option buttons:-
            ( ) Complete when designated queue equals or exceeds required amount
            ( ) Complete when designated queue falls below required amount

• Notes:

This rule only checks for changing commodity levels during loading and unloading operations. It cannot be used to test, for example, if a vehicle is full or empty.

• Related Rules:
  • Multiple Resource Check Rule - executes child rules when set resource (commodity) levels are reached
  • Resource Verify Rule (fixed) - executes child rules when a set resource (commodity) level is reached

• Trainz Wiki Links:
  • http://online.ts2009.com/mediaWiki/index.php/Resource_Check_Rule

Resource Verify Rule (fixed)

Executes child rules if a selected industry or vehicle reaches a set commodity level. The rule resets when all child rules have completed.

• <kuid:160293:10060>

• DLS Rule by trev999

• Parent Rule

Properties:
   Select one of two option buttons:-
   ( ) Watch industry queue
      Target object <click to select> - click to select an industry from the session list.
      Product <click to select> - click to select an industry product.
      Amount <value> - enter a quantity for the selected product.
      Select one of two option buttons:-
      ( ) Complete when designated queue equals or exceeds designated amount
      ( ) Complete when designated queue falls below designated amount
   ( ) Watch vehicle queue
      Target object <click to select> - click to select a rolling stock vehicle from the session list.
      Product <click to select> - click to select a commodity product.
      Amount <value> - enter a quantity for the selected product.
      Select one of two option buttons:-
      ( ) Complete when designated queue equals or exceeds designated amount
      ( ) Complete when designated queue falls below designated amount

• Notes:

1. This rule will only monitor a single commodity in a single industry or vehicle.
2. This rule only checks for changing commodity levels during loading and unloading operations. It cannot be used to test, for example, if a vehicle is full or empty.

• Related Rules:
  • Multiple Resource Check Rule - executes child rules when set resource (commodity) levels are reached
  • Resource Check Rule - executes child rules when set resource (commodity) levels are reached

Back to Top

---

Session Sequence Rules

Ordered List Rule

Executes child rules in order once this rule starts

• <kuid:-25:171>

• Built-in Rule

• Parent Rule

Properties:
   Select one of two option buttons:-
     ( ) This process will repeat <value> time(s) - enter the number of times this rule is to be repeated
     ( ) This process will repeat forever

• Known Issues:

Some child rules will force a "wait" until certain conditions have been met (e.g. a mouse click or a set time has passed). These rules will delay the completion of any following child rules in the Ordered List Rule. If possible, place these rules last in the Ordered List.

For example: The Message Popup Rule will wait until it is closed before allowing the next child rule to be executed.

• Related Rules:
  • Progressive List Rule - executes the first child rule on the first run, the second child on the second run, etc
  • Random List Rule - executes ONE randomly selected child rule
  • Reset List Rule - executes all child rules continuously
  • Simultaneous List Rule - executes all child rules simultaneously

• Trainz Wiki Links:
  • http://online.ts2009.com/mediaWiki/index.php/Ordered_List
  • How to Use Parent and Child Rules

Progressive List Rule

Executes the first child rule on the first run, the second child on the second run, the third child on the third run, etc.

• <kuid:-25:754>

• Built-in Rule

• Parent Rule

Properties:
  After last child has been executed ...
  <successive runs will do nothing/the first child is chosen again> - click to select one

• Related Rules:
  • Ordered List Rule - executes child rules in order
  • Random List Rule - executes ONE randomly selected child rule
  • Reset List Rule - executes all child rules continuously
  • Simultaneous List Rule - executes all child rules simultaneously

• Trainz Wiki Links:
  • http://online.ts2009.com/mediaWiki/index.php/Progressive_List
  • How to Use Parent and Child Rules

Random List Rule

Executes ONE randomly selected child rule once only. The rule will not repeat to randomly select another child rule

• <kuid:-25:758>

• Built-in Rule

• Parent Rule

Properties:
   None

• Related Rules:
  • Ordered List Rule - executes child rules in order
  • Progressive List Rule - executes the first child rule on the first run, the second child rule on the second run, etc
  • Reset List Rule - executes all child rules continuously
  • Simultaneous List Rule - executes all child rules simultaneously

• Trainz Wiki Links:
  • How to Use Parent and Child Rules
  • http://online.ts2009.com/mediaWiki/index.php/Random_List

Reset List Rule

Executes ALL child rules continuously in an ongoing infinite cycle

• <kuid:-25:762>

• Built-in Rule

• Parent Rule

Properties:
   None

• Related Rules:
  • Ordered List Rule - executes child rules in order
  • Progressive List Rule - executes the first child rule on the first run, the second child rule on the second run, etc
  • Random List Rule - executes ONE randomly selected child rule
  • Simultaneous List Rule - executes all child rules simultaneously

• Trainz Wiki Links:
  • http://online.ts2009.com/mediaWiki/index.php/Reset_List
  • How to Use Parent and Child Rules

Simultaneous List Rule

Executes child rules simultaneously once this rule starts

• <kuid:-25:1048>

• Built-in Rule

• Parent Rule

Properties:
   Rule completes when ... - click to chose one of the following:-
      one of the child rules has completed
      all child rules have reached a completed state
      all child rules have reached a "was completed" state

• Related Rules:
  • Ordered List Rule - executes child rules in order
  • Progressive List Rule - executes the first child rule on the first run, the second child on the second run, etc
  • Random List Rule - executes ONE randomly selected child rule
  • Reset List Rule - executes all child rules continuously

• Trainz Wiki Links:
  • Message Popup Applications: Timed Message
  • How to Use Parent and Child Rules
  • How to Use Variables in Sessions (Examples): Event Counter and Message Selection
  • http://online.ts2009.com/mediaWiki/index.php/Simultaneous_List

Back to Top

---

Speed Rules

ATP Speed Limiter Rule

Limits allowable speed over set limit

• <kuid2:321959:1000:1>

• Built-in Rule

Properties:
   Limits the speed to <value> mph over the set limit - enter speed value in mph

Speeding Check Rule

Executes child rules if player controlled trains are over the local speed limit or over a set (custom) speed

• <kuid2:60850:89004:3>

• Built-in Rule

• Parent Rule

Properties:
   Select one of two options to set a speed limit to be observed
      ( ) Watch for trains travelling above the posted speed limit
         <speed value> - click to enter a new overspeed tolerance value
         <speed units> - click to select one from the list:-
            Km/h - Kilometres per hour
            MPH - Miles per hour
            mps - metres per second
      ( ) Watch for trains travelling above a custom speed
         <speed value> - click to enter a new custom speed value
         <speed units> - click to select one from the list:-
            Km/h - Kilometres per hour
            MPH - Miles per hour
            mps - metres per second
            Warning: This option is very performance intensive and should only be used in sessions with few trains

MaxPermittedSpeed Rule

Sets the maximum permitted speed of locomotives under AI control

• <kuid2:60850:89000:7>

• Built-in Rule

Properties:
   None

• Notes:

This rule cannot be configured from the Session Rules list. It must be configured in the config.txt file of each locomotive. Instructions with an example are shown in the rule Properties

Back to Top

---

Startup and Termination Rules

End Session Rule

End the Session with a fade out.

• <kuid:-25:482>

• Built-in Rule

Properties:
   Fade out over <value> seconds - enter number of seconds for fade out.

• Notes:

Seconds are Trainz clock time, not real time.

• Related Rules:
  • Session Complete Rule - set the session to a percentage of completion

Multiplayer Rule

Enables the session to be taken online in a Multiplayer environment.

• <kuid:447264:1045>

• Built-in Rule

Properties:
   Suggested maximum number of players for this session <value> - enter a number
   Maximum number of drivers per player <value> - enter a number
   Players are permitted to claim drivers             [Check Box] - check to allow players to select a driver
   Players can see each other's driver orders         [Check Box] - check to allow players to view orders for other players
   Automatically target an available train on clients [Check Box] - automatically assign a driver to each player

Randomize Rule

Generates a different set of random numbers each time the session is run.

• <kuid:169301:100129>

• DLS Rule by Terry_Wagstaff

Properties:
   None

• Notes:

Place this rule near the top of the Session Rules list and ensure that there is at least 5 seconds before the call to a Random function.

• Related Rules:
  • Variable Random - sets a variable to a random integer value.

Session Complete Rule

Set session to a percentage of completion.

• <kuid:447264:1011>

• Base Rule

Properties:
   Set session to percent complete <value> - enter number as a percentage
   [Check Box] Separate achievements for completion - check to set

• Related Rules:
  • End Session Rule - end the Session with a fade out.

Startup Options Rule

Specifies the starting options for the session. The weather settings will set the initial conditions, including the variability. To manually change the weather during play, use the Weather Rule.

• <kuid:-16:10212>

• Base Rule

Properties:
   Current control method is <select> - select one from:-
      Easy Mode - DCC (standard keyboard and mouse) control
      Ask User - let the user decide
      Realistic Mode - Cab controls (on screen levers, throttles, buttons, etc)
   Set weather to <select mode> with <select frequency> changeability - select
      Weather mode: - select one of:-
         Clear
         Cloudy 
         Drizzle
         Rain
         Stormy
         Light Snow
         Medium Snow
         Heavy Snow
      Changeability: - select one of:-
         Off - the weather will not change from the mode selected above
         Periodic - slow gradual changes to the weather
         Extreme - rapid and extreme changes to the weather
   Set time to <hours>:<minutes> with a rate of <select speed> - set the starting time and the speed at which the Trainz clock will run
   Set derailment realism to <select reality level> - select one of:-
      None - no train derailments will occur
      Arcade - train derailments will be exaggerated (beyond normal)
      Realistic - train derailments will occur as realistically as possible
   [Check Box] Show in game help - check to switch on help options
   Use <select measurement system> units in Driver - select one of:-
      Metric - kilometres, metres. This will override the default settings in a session
      Imperial - miles, feet. This will override the default settings in a session
      Default - uses the measurement system specified in the session

• Notes:

Times are Trainz clock time, not real time

• Related Rules:
  • Time and Rate Rule - sets the session start time and the rate at which time passes.
  • Weather Rule - changes weather conditions during Session play

Back to Top

---

Time Rules

Clock Rule

Rule needed for animated clocks.

• <kuid2:62310:30041:2>

• Built-in Rule

Properties:
   None

• Notes:

Apply this rule to your session to make use of the animated clocks. See the forum for code to include in your clock object to work with this rule.

Time and Rate Rule

Sets the session start time and the rate at which time passes.

• <kuid:-25:889>

• Built-in Rule

Properties:
   Set time to <hours:minutes> - enter the clock starting time as hours (0-23) and minutes (0-59)
   with a rate of <1x> - select a speed at which time will pass from 1x (normal) to 1440x (extremely fast)

• Related Rules:
  • Startup Options Rule - sets the startup options for a session including time and rate
  • Timecheck Rule - executes child rules at a set time.

Timecheck Rule

Executes child rules at a set time.

• <kuid2:122381:10008:3>

• Built-in Rule

• Parent Rule

Properties:
   <hh:mm:ss> - enter execution time as hours (0-23), minutes (0-59) and seconds (0-59).
   [Check Box] Execution time is on the day after the start time - when checked delays execution until the following day.

• Known Issues:

Do not use this rule as a child of a repeating rule such as the Simultaneous List Rule or the Ordered List Rule.

• Notes:

Times and days are Trainz clock times not real time.

• Related Rules:
  • Time and Rate Rule - sets the session start time and the rate at which time passes.
  • Wait Rule - executes child rules after waiting for a set number of seconds.

Wait Rule

Executes child rules after waiting for set number of seconds

• <kuid2:122381:10016:2>

• Built-in Rule

• Parent Rule

Properties:
   <click to set> - enter the number of seconds for the wait delay

• Notes:

Seconds is in Trainz clock time, not real time

• Related Rules:
  • Timecheck Rule - executes child rules at a set time.

• Trainz Wiki Links:
  • Message Popup Rule Applications: Timed Message
  • How to Use Navigation Point Rules (Applications): User Path Selection

Back to Top

---

Variable Rules

Quick Session Variables Rule

Allows the editing of session variables

• <kuid2:61392:5003:30>

• DLS Rule by pguy

Properties:
   <local> - click to edit local variables
      <add new session variable> - click to enter the name of new local variable
         for each variable:-
         <variable-name> - click to change variable name
         <type> - click to select one of:-
            string - text characters
            int - integer
            float - real (decimal) numbers
            bool - boolean (true/false)
            stringset - meaning not known at this time
            stringlist - meaning not known at this time
            tkmlist - trackmark list (no longer supported in TANE SP2)
            platformlist - platform list (no longer supported in TANE SP2)
            del - delete variable
            edit - edit variable
   <trains> - click to edit a train variable
      <train selected> - click to select a train from the session list. Initially none is selected
         <select train> - click to select a locomotive
         <select vehicle> - click to select a rail vehicle
         for the selected loco/vehicle:-
            <Add new session variable> - click to enter the name of a new variable
              for the entered variable:-
                 <variable-name> - click to change variable name
                 <type> - click to select type (see list above)
   <objects> - no longer supported in TANE SP2
   <global> - no longer supported in TANE SP2

• Known Issues:

Rule creator, pguy, has indicated that the future of this rule is uncertain as parts of it have been devalued in the latest release of TANE.

• Related Rules:
  • Variable Check Rule - executes child rules according to the value of a specified variable.
  • Variable Modify Rule - changes the value of a specified variable.
  • Variable Modify Continuous Rule - continuously changes the value of a specified variable.
  • Variable Random Rule - assigns a random value to a variable.
  • Variable Show Rule - adds or removes a specified variable and a descriptive label to the custom HUD.

Variable Check Rule

Executes child rules when a specific variable matches set conditions

• <kuid:-25:1049>

• Built-in Rule

• Parent Rule

Properties:
   <variable-name> - enter a variable-name. Variable name is case sensitive.
   Mathematical relationship, select one of:-
      is less than - enter a <value> to test against
      is less than or equal to - enter a <value> to test against
      is equal to - enter a <value> to test against
      is greater than or equal to - enter a <value> to test against
      is greater than - enter a <value> to test against
      is not equal to - enter a <value> to test against
      is between x and y - enter a minimum <x-value> and a maximum <y-value>
   Evaluation type. Select one from:-
      <This condition will be evaluated only once ...> - any changes to the variable that occur after
              it has been checked will not change the result of this rule
      <This condition will be evaluated once every second> - the rule will be rerun and the variable 
              rechecked every second

• Related Rules:
  • Quick Session Variables Rule - allows the editing of session variables.
  • Variable Modify Rule - changes the value of a specified variable.
  • Variable Modify Continuous Rule - continuously changes the value of a specified variable.
  • Variable Random Rule - assigns a random value to a variable.
  • Variable Show Rule - adds or removes a specified variable and a descriptive label to the custom HUD.

• Trainz Wiki Links:
  • How to Use Variables in Sessions (Examples)

Variable Modify Continuous Rule

Adds, subtracts or sets a value to a specified variable every second.

• <kuid:-25:1051>

• Built-in Rule

Properties:
  <Add/Subtract/Change variable to> - select one.
     <value> - enter value to add, subtract or apply to <variable-name>
     <variable-name> - enter variable-name. Variable-name is case sensitive.

• Related Rules:
  • Quick Session Variables Rule - allows the editing of session variables.
  • Variable Check Rule - executes child rules according to the value of a specified variable.
  • Variable Modify Rule - changes the value of a specified variable.
  • Variable Random Rule - assigns a random value to a variable.
  • Variable Show Rule - adds or removes a specified variable and a descriptive label to the custom HUD.

Variable Modify Rule

Change the value of a specified variable. This rule can also used to create a new variable and set its initial value by using the "Change variable" option.

• <kuid:-25:1050>

• Built-in Rule

Properties:
   Change <Add to variable/Subtract from variable/Change variable> - click to select one from:-
      Add to variable
         Add <value> to variable <variable-name> - enter value to add to variable, enter variable-name. Variable-name is case sensitive.
         <Do not undo the alteration if the rule is stopped/Undo the alteration if the rule is stopped> - click to select one.
      Subtract from variable
         Subtract <value> from variable <variable-name> - enter value to subtract from variable, enter variable-name.
            Variable-name is case sensitive.
         <Do not undo the alteration if the rule is stopped/Undo the alteration if the rule is stopped> - click to select one.
      Change variable
         Change variable <variable-name> to <value> - enter variable-name, enter new value. 
            Variable-name is case sensitive. This change cannot be undone if the rule is stopped. 
   [Check Box] (optional) Set the minimum value of <variable-name> to <value> - enter variable-name
      (this will already be set by the change option) and a value. Variable-name is case sensitive.
   [Check Box] (optional) Set the maximum value of <variable-name> to <value> - enter variable-name
      (this will already be set by the change option) and a value. Variable-name is case sensitive.

• Related Rules:
  • Quick Session Variables Rule - allows the editing of session variables.
  • Variable Check Rule - executes child rules according to the value of a specified variable.
  • Variable Modify Continuous Rule - continuously changes the value of a specified variable.
  • Variable Random Rule - assigns a random value to a variable.
  • Variable Show Rule - adds or removes a specified variable and a descriptive label to the custom HUD.

• Trainz Wiki Links:
  • How to Use Variables in Sessions (Examples)
  • http://online.ts2009.com/mediaWiki/index.php/Variable_Modify_Rule

Variable Random Rule

Assigns a random integer value to a variable.

• <kuid:400260:100606>

• DLS Rule by tram_

Properties:
   Random variable <name> in minimum to maximum interval - enter name of variable. Variable-name is case sensitive.
   The minimum possible value of variable_name is <value> - enter the minimum value
   The maximum possible value of variable_name is <value> - enter the maximum value

• Related Rules:
  • Quick Session Variables Rule - allows the editing of session variables.
  • Randomize - creates a different set of random numbers for each session run.
  • Variable Check Rule - executes child rules according to the value of a specified variable.
  • Variable Modify Rule - changes the value of a specified variable.
  • Variable Modify Continuous Rule - continuously changes the value of a specified variable.
  • Variable Show Rule - adds or removes a specified variable and a descriptive label to the custom HUD.

• Trainz Wiki Links:
  • How to Use Variables in Sessions (Examples)

Variable Show Rule

Adds or removes a specified variable and a descriptive label to the custom HUD. This rule does not make the custom HUD appear on the screen.

• <kuid:-25:971>

• Built-in Rule

Properties:
  [Check Box] Add
     <variable-name> - enter variable-name to add to HUD. Variable-name is case sensitive.
     <label> - (optional) enter a short label to be displayed on the HUD in front of the variable value.
  [Check Box] Remove
     <variable-name> - enter variable-name to remove from HUD. Variable-name is case sensitive.

• Related Rules:
  • Display Custom HUD Rule - shows or hides the Custom Heads Up Display.
  • Quick Session Variables Rule - allows the editing of session variables.
  • Variable Check Rule - executes child rules according to the value of a specified variable.
  • Variable Modify Rule - changes the value of a specified variable.
  • Variable Modify Continuous Rule - continuously changes the value of a specified variable.
  • Variable Random Rule - assigns a random value to a variable.

• Trainz Wiki Links:
  • How to Use Variables in Sessions (Examples)

Back to Top

---

Weather Rules

EIRS Weather Rule NE USA Rule

Customize random weather rule relative to the North East Region of the United States.

• <kuid2:487222:1037:3>

• Built-in Rule

Properties:
   Season <select> - select one of:-
      Summer
      Fall
      Winter
      Spring
   Random Changeability (minutes) <value> - select one of:-
      2/5/10/15/20/30/45/60 - minutes
   Environment Settings <select> - select one of:-
      Disable/Enable

• Notes:

Minutes are Trainz clock times, not real times

• Related Rules:
  • Random Weather Rule v2 - randomly changes the weather according to entered parameters
  • Startup Options Rule - sets the weather conditions at the start of a Session
  • Weather Rule - changes the weather conditions during Session play

Random Weather Rule v2

Randomly changes the weather conditions between set values over a set duration.

• <kuid:169301:100132>

• DLS Rule by terry_wagstaff

Properties:
   Starting weather <select> - select one of:-
         Clear weather, no clouds, rain or snow
         Cloudy weather, no rain 
         Drizzle, light rain
         Rain
         Stormy weather that includes lightning and thunder
         Snowing lightly
         Medium snowfall
         Heavy snow
   Best weather <select> - select one of:-
         Clear weather, no clouds, rain or snow
         Cloudy weather, no rain 
         Drizzle, light rain
         Rain
         Stormy weather that includes lightning and thunder
         Snowing lightly
         Medium snowfall
         Heavy snow
   Worst weather <select> - select one of:-
         Clear weather, no clouds, rain or snow
         Cloudy weather, no rain 
         Drizzle, light rain
         Rain
         Stormy weather that includes lightning and thunder
         Snowing lightly
         Medium snowfall
         Heavy snow
   Changing about every: <value> mins - enter number of minutes between weather changes

• Known issues:

This rule, once started, will run continuously and will not terminate so do NOT use this rule as a child rule in an Ordered List Rule because any following child rules will never be executed.

• Related Rules:
  • EIRS Weather Rule NE USA Rule - customize random weather rule relative to the North East Region of the United States
  • Startup Options Rule - sets the weather conditions at the start of a Session

Weather Rule

Changes the weather conditions during Session play.

• <kuid:-25:960>

• Built-in Rule

Properties:
   Set weather to <select mode> with <select frequency> changeability - select
      Weather mode: - select one of:-
         Clear
         Cloudy 
         Drizzle
         Rain
         Stormy
         Light Snow
         Medium Snow
         Heavy Snow
    Changeability: - select one of:-
         Off - the weather will not change from the mode selected above
         Periodic - slow gradual changes to the weather
         Extreme - rapid and extreme changes to the weather

• Related Rules:
  • EIRS Weather Rule NE USA Rule - customize random weather rule relative to the North East Region of the United States
  • Random Weather Rule v2 - randomly changes the weather according to entered parameters
  • Startup Options Rule - sets the weather conditions at the start of a Session

Back to Top

---