Merge branch 'master' into feature/simulator-test

Author: twpol

Source/Documentation/Manual/cabs.rst

@@ -507,6 +507,156 @@ Here an example of use of one of the controls::
 		ORTSScreenPage ( "2300-0" )
 	)
 
+.. _cabs-eot:
+
+EOT (End of Train device)
+-------------------------
+
+See :ref:`here <physics-eot>` for full description of EOT features.
+
+Following EOT controls are available for EOT management:
+
+- ORTS_EOT_BRAKE_PIPE : displays the value of the brake pipe pressure at last wagon. 
+  The display is always enabled (even if the EOT is disarmed), because this display 
+  could be available also in other ways; however it is possible to mask the display 
+  using a texture driven by the EOT state.
+- ORTS_EOT_STATE_DISPLAY : may have values from 0 to 5, corresponding to the states listed :ref:`here <physics-eot-states>`  
+- ORTS_EOT_ID : the EOT ID is generated as a 5-digit random number and can be displayed 
+  in the cab using this control; entering the ID by the train driver is not supported, 
+  as the .cvf files don't support as of now digital data entry
+- ORTS_EOT_COMM_TEST : driver command that starts the communication test between locomotive and EOT
+- ORTS_EOT_ARM_TWO_WAY : driver command passes the EOT from ArmNow to ArmedTwoWay
+- ORTS_EOT_DISARM : passes the EOT to disarmed state
+- ORTS_EOT_EMERGENCY_BRAKE (on-off): lets the EOT venting the brake pipe from the last train car.
+  
+These controls are available only using the mouse; only The last one can also be operated by the 
+``<Ctrl+Backspace>`` key combination.
+
+An example of implementation of the above controls can be seen
+:ref:`in this picture <physics-eot-display>`
+
+The ``ORTS_EOT_EMERGENCY_BRAKE`` control can be implemented in the cab by an ON-OFF switch.
+
+An example of implementation of the above controls in a .cvf file follows::
+
+   		TwoState (
+			Type ( ORTS_EOT_COMM_TEST TWO_STATE )
+			Position ( 474 385 16.25 10 )
+			Graphic ( "..\\..\\Common.Cab\\ES44v3\\softkey5trans.ace" )
+			NumFrames ( 2 2 1 )
+			Style ( WHILE_PRESSED )
+			MouseControl ( 1 )
+			ORTSDisplay ( 0 )
+			ORTSScreenPage ( "2100-0" )
+		)
+		TwoState (
+			Type ( ORTS_EOT_DISARM TWO_STATE )
+			Position ( 493 385 16.25 10 )
+			Graphic ( "..\\..\\Common.Cab\\ES44v3\\softkey5trans.ace" )
+			NumFrames ( 2 2 1 )
+			Style ( WHILE_PRESSED )
+			MouseControl ( 1 )
+			ORTSDisplay ( 0 )
+			ORTSScreenPage ( "2100-0" )
+		)
+		TwoState (
+			Type ( ORTS_EOT_ARM_TWO_WAY TWO_STATE )
+			Position ( 511.7 385.7 16.25 10 )
+			Graphic ( "..\\..\\Common.Cab\\ES44v3\\softkey7trans.ace" )
+			NumFrames ( 2 2 1 )
+			Style ( WHILE_PRESSED )
+			MouseControl ( 1 )
+			ORTSDisplay ( 0 )
+			ORTSScreenPage ( "2100-0" )
+		)
+		MultiStateDisplay (
+			Type ( ORTS_EOT_STATE_DISPLAY MULTI_STATE_DISPLAY )
+			Position ( 516 314.5 17 5.15 )
+			Graphic ( "..\\..\\Common.Cab\\ES44v3\\CommTest.ace" )
+			States ( 2 2 1
+				State (
+					Style ( 0 )
+					SwitchVal ( 0 )
+				)
+				State (
+					Style ( 0 )
+					SwitchVal ( 2 )
+				)
+			)
+			ORTSDisplay ( 0 )
+			ORTSScreenPage ( "2100-0" )
+		)
+			Digital (
+			Type ( ORTS_EOT_ID DIGITAL )
+			Position ( 421 313 22 8 )
+			ScaleRange ( 0 999999 )
+			Accuracy ( 0 )
+			AccuracySwitch ( 0 )
+			LeadingZeros ( 0 )
+			Justification ( 1 )
+			PositiveColour ( 1
+				ControlColour ( 255 255 255 )
+			)
+			NegativeColour ( 1
+				ControlColour ( 255 255 0 )
+			)
+			DecreaseColour ( 0
+				ControlColour ( 0 0 0 )
+			)
+			Units ( KILO_LBS )
+			ORTSFont ( 6 0 "Arial" )
+			ORTSDisplay ( 0 )
+			ORTSScreenPage ( "2100-0" )
+		)
+		MultiStateDisplay (
+			Type ( ORTS_EOT_STATE_DISPLAY MULTI_STATE_DISPLAY )
+			Position ( 513.5 328 22.66 5.15 )
+			Graphic ( "..\\..\\Common.Cab\\ES44v3\\EOTStatus2.ace" )
+			States ( 4 4 1
+				State (
+					Style ( 0 )
+					SwitchVal ( 0 )
+				)
+				State (
+					Style ( 0 )
+					SwitchVal ( 2 )
+				)
+				State (
+					Style ( 0 )
+					SwitchVal ( 4 )
+				)
+				State (
+					Style ( 0 )
+					SwitchVal ( 5 )
+				)
+			)
+			ORTSDisplay ( 0 )
+			ORTSScreenPage ( "2100-0" )
+		)
+		MultiStateDisplay (
+			Type ( ORTS_EOT_STATE_DISPLAY MULTI_STATE_DISPLAY )
+			Position (  431.4 292.1 9 5  )
+			Graphic ( "..\\..\\Common.Cab\\ES44v3\\MaskEOT.ace" )
+			States ( 2 2 1
+				State (
+					Style ( 0 )
+					SwitchVal ( 0 )
+				)
+				State (
+					Style ( 0 )
+					SwitchVal ( 2 )
+				)
+			)
+		)
+		TwoState (
+			Type ( ORTS_EOT_EMERGENCY_BRAKE TWO_STATE )
+			Position ( 53.5 344.2 21.4 42.8 )
+			Graphic ( ..\\..\\Common.Cab\\ES44v3\\EOTEmergency.ace )
+			NumFrames ( 2 2 1 )
+			Style ( ONOFF )
+			MouseControl ( 1 )
+		)
+
 
 Animated 2D Wipers
 ------------------

Source/Documentation/Manual/driving.rst

@@ -9,8 +9,20 @@ Game Loading
 
 Once you have pressed ``Start``, Open Rails loads and processes all the 
 data needed to run the game. During this phase, the route's splash screen 
-is shown. If the same session was loaded previously, a bar showing loading 
-progress is shown at the bottom of the display. During loading, if logging 
+is shown with an indicator bar at the bottom.
+
+.. image:: images/loading_bars.png
+
+The first time a session is loaded, an animated bar just shows activity. 
+Subsequent loads of that session show the bar growing across the screen to indicate
+progress.
+
+If a timetable has been selected, then the game also simulates the progress of the timetable
+from the first train in the timetable up to start time of the player's train.
+This is done at high speed, but may still take some time. A second bar appears
+above the first one to show the progress of this stage.
+
+During loading, if logging 
 is selected, the log file ``OpenRailsLog.txt`` will already begin storing 
 data.
 

Source/Documentation/Manual/images/loading_bars.png

@@ -200,11 +200,11 @@ Video Options
 Dynamic shadows
 ---------------
 
-Check this option to cast shadows from movable objects such as trains.
+This option causes movable objects such as trains to cast shadows.
+Unchecking the option will increase the frame rate.
 
-The default setting is unchecked.
+The default setting is checked.
 
-Note: This may reduce the frame rate.
 
 Shadow for all shapes
 ---------------------
@@ -218,12 +218,14 @@ Note: This may reduce the frame rate.
 Note: Static objects provided with shadows (in the World files) 
 will cast shadows anyway. This option adds shadows for other static objects.
 
+
 Glass on in-game windows
 ------------------------
 
 When this option is checked, the in-game windows are displayed in a
 semitransparent mode.
 
+
 Model instancing
 ----------------
 
@@ -234,11 +236,13 @@ hardware, but this may reduce the frame rate.
 
 The default setting is checked.
 
+
 Overhead wire
 -------------
 
 This option will enable or disable display of the overhead wire.
 
+
 .. _options-double-overhead-wires:
 
 Double overhead wires
@@ -247,21 +251,26 @@ Double overhead wires
 MSTS uses a single wire for electrified routes; you may check this box so
 that OR will show the two overhead wires that are more common.
 
+
 .. _options-vsync:
 
 Vertical sync
 -------------
 
 Vertical Sync (VSync) attempts to lock Open Rails’ output frame rate 
 to your monitor's refresh rate for the smoothest image and to resist 
-image "tearing”.
+image "tearing".
+
 VSync may help keep the frame rate more stable on complex routes, 
 reducing sudden frame rate drops and apparent control lag in some cases.
 If Open Rails' frame rate drops below your monitor's frame rate, you 
-may see stuttering or image "tearing". To prevent this, either turn off 
+may see stuttering or image "tearing". To prevent this, either uncheck 
 the VSync option or reduce the values for video options such as view 
 distance, anti-aliasing, or world object density.
 
+The default setting is checked.
+
+
 Viewing distance
 ----------------