Help/Session Rules

From TrainzOnline
< Help(Difference between revisions)
Jump to: navigation, search
(Created page with "Rules can set basic parameters in a Session including which driver is in each Train, the weather state, control method, set up industry dependencies, what Driver Commands are ...")
 
(File:Down icon.jpg Demote Rule)
 
(5 intermediate revisions by 2 users not shown)
Line 17: Line 17:
  
 
{{clear}}
 
{{clear}}
Click LMB on the Add Rule  
+
Click on the Add Rule  
 
to add a new rule to the session.
 
to add a new rule to the session.
 
A window will open up with the set of rules
 
A window will open up with the set of rules
Line 26: Line 26:
 
{{clear}}
 
{{clear}}
 
Highlight the Rule in the list that you wish to
 
Highlight the Rule in the list that you wish to
modify and Click LMB on the “Edit” button to bring up the
+
modify and Click on the “Edit” button to bring up the
 
Rule’s Properties Window. All editable parameters are made
 
Rule’s Properties Window. All editable parameters are made
 
available to configure in this window. Click on the
 
available to configure in this window. Click on the
 
available hyperlinks to edit the rule’s parameter.
 
available hyperlinks to edit the rule’s parameter.
Any Rule can have its name changed by Clicking LMB on its text
+
Any Rule can have its name changed by Clicking on its text
 
descriptor and typing in its new name. It is possible to have multiple rules of the same type in a
 
descriptor and typing in its new name. It is possible to have multiple rules of the same type in a
 
session where each rule instance has its own configuration.
 
session where each rule instance has its own configuration.
Line 37: Line 37:
 
{{clear}}
 
{{clear}}
 
If you want to remove a Rule from the list
 
If you want to remove a Rule from the list
Click LMB on it and then Click
+
Click on it and then Click
LMB the “Delete” button. A dialogue box
+
the “Delete” button. A dialogue box
pops up confirming the deletion. Click LMB the “Yes” button
+
pops up confirming the deletion. Click the “Yes” button
to confirm the deletion or Click LMB the “No” button to
+
to confirm the deletion or Click the “No” button to
 
cancel.
 
cancel.
  
Line 58: Line 58:
  
 
{{clear}}
 
{{clear}}
Click LMB to highlight it and then Click LMB on
+
Click to highlight it and then Click on
 
the “Outdent” button. This removes the Rule from
 
the “Outdent” button. This removes the Rule from
 
dependency upon the Rule it was Indented under.
 
dependency upon the Rule it was Indented under.
Line 64: Line 64:
  
 
{{clear}}
 
{{clear}}
Click LMB to highlight it and then Click LMB on
+
Click to highlight it and then Click on
 
the “Indent” button. This makes the selected Rule
 
the “Indent” button. This makes the selected Rule
 
dependent on the next higher Outdented Rule above it. The
 
dependent on the next higher Outdented Rule above it. The
Line 72: Line 72:
  
 
{{clear}}
 
{{clear}}
Click LMB to highlight it and then Click LMB on the
+
Click to highlight it and then Click on the
 
“Promote” button. Once the Rule has reached the
 
“Promote” button. Once the Rule has reached the
 
top of the Rule list, it can no longer be Promoted.
 
top of the Rule list, it can no longer be Promoted.
 
=== [[File:Down icon.jpg]] Demote Rule ===
 
=== [[File:Down icon.jpg]] Demote Rule ===
 
{{clear}}
 
{{clear}}
Click LMB to highlight it and then Click LMB on
+
Click to highlight it and then Click on
 
the “Promote” button. Once the Rule has reached
 
the “Promote” button. Once the Rule has reached
 
the bottom of the Rule list, it can no longer be Demoted.
 
the bottom of the Rule list, it can no longer be Demoted.
 +
 +
SEE ALSO:
 +
*[[Session_Rule_Implementation|Session Rule Implementation]]
 +
*[[Session_Rules_Overview|Session Rules Overview]]
 +
*[[Session_Rules_By_Categories_With_Properties|Session Rules By Categories With Properties]]
 +
 +
[[Category:Help]]

Latest revision as of 22:22, 12 September 2019

Rules can set basic parameters in a Session including which driver is in each Train, the weather state, control method, set up industry dependencies, what Driver Commands are available in the Driver Module and set the time and time rate. They can also be combined, so that when a particular train hits a trigger the weather may change or a sound may be played. Then there is the ability to pull HTML pages and sound files into the game. On top of that the Rules can be arranged to occur in a particular order.

Session rules.jpg

Contents

[edit] Add icon.jpg Add Rule

Click on the Add Rule to add a new rule to the session. A window will open up with the set of rules to choose from. Click on any one of the rules to add it to the list of rules to be included in this session.

[edit] Edit icon.jpg Edit Rule

Highlight the Rule in the list that you wish to modify and Click on the “Edit” button to bring up the Rule’s Properties Window. All editable parameters are made available to configure in this window. Click on the available hyperlinks to edit the rule’s parameter. Any Rule can have its name changed by Clicking on its text descriptor and typing in its new name. It is possible to have multiple rules of the same type in a session where each rule instance has its own configuration.

[edit] Delete icon.jpg Delete Rule

If you want to remove a Rule from the list Click on it and then Click the “Delete” button. A dialogue box pops up confirming the deletion. Click the “Yes” button to confirm the deletion or Click the “No” button to cancel.


[edit] Rule managment

The Outdent, Indent, Promote and Demote commands are used to order the Rules in a Hierarchical and Ordered fashion. Some rules require indented child rules immediately below them. This determines what happens when the Trigger Check Rule is activated. Other rules, like use child rules below them to fulfill its purpose. The child rules can be re-ordered by using the “Promote” and “Demote” buttons to alter the order in which they are executed.

[edit] Left icon.jpg Outdent Rule

Click to highlight it and then Click on the “Outdent” button. This removes the Rule from dependency upon the Rule it was Indented under.

[edit] Right icon.jpg Indent Rule

Click to highlight it and then Click on the “Indent” button. This makes the selected Rule dependent on the next higher Outdented Rule above it. The indented Rule will not be executed unless the Rule next up in the Hierarchy is activated.

[edit] Up icon.jpg Promote Rule

Click to highlight it and then Click on the “Promote” button. Once the Rule has reached the top of the Rule list, it can no longer be Promoted.

[edit] Down icon.jpg Demote Rule

Click to highlight it and then Click on the “Promote” button. Once the Rule has reached the bottom of the Rule list, it can no longer be Demoted.

SEE ALSO:

Personal tools