@@ -606,6 +606,39 @@ to the oscillation from center point to an oscillation end point. The file shoul
606606one cue point at its beginning and one after the time interval of a complete bell swing
607607forward and backward, and should have a final fadeoff for best result.
608608
609+ Coupler and Airhose Animation
610+ =============================
611+
612+ Open Rails supports animation of couplers and air hoses. Coupler animation will move the
613+ couplers and air hoses as the train moves and the coupler slack increases or decreases.
614+ Couplers will also rotate as the train travels around a curve.
615+
616+ To implement this separate models need to be provided for the couplers and air hoses. A
617+ separate model for the coupled and uncoupled state is suggested.
618+
619+ To enable coupler animation the following parameters need to be included in the coupler
620+ code section of the WAG file:
621+
622+ ``FrontCouplerAnim `` - Coupler shape to be displayed at the front of the car when it is coupled.
623+ ``FrontCouplerOpenAnim `` - Coupler shape to be displayed at the front of the car when it is uncoupled.
624+ ``RearCouplerAnim `` - Coupler shape to be displayed at the rear of the car when it is coupled.
625+ ``RearCouplerOpenAnim `` - Coupler shape to be displayed at the rear of the car when it is uncoupled
626+
627+ All four of the above will have the following format:
628+
629+ CouplerAnimation ( couplershape.s, x, y, z ) where the coupler shape file name is included along with
630+ x, y, z values that offset the coupler in the three axis.
631+
632+ For the airhose animation the following parameters must be included in the coupler code section of
633+ the WAG file:
634+
635+ ``FrontAirHoseAnim `` - Air hose shape to be displayed at the front of the car when it is coupled.
636+ ``FrontAirHoseDisconnectedAnim `` - Air hose shape to be displayed at the front of the car when it is uncoupled.
637+ ``RearAirHoseAnim `` - Air hose shape to be displayed at the rear of the car when it is coupled.
638+ ``RearAirHoseDisconnectedAnim `` - Air hose shape to be displayed at the rear of the car when it is uncoupled.
639+
640+ Each of these parameters will have the same format as indicated above for the coupler shapes.
641+
609642C# engine scripting
610643===================
611644.. _features-scripting-csharp :
0 commit comments