Skip to content

Commit ce99d73

Browse files
authored
Merge pull request #69 from Csantucci/master
Update OR manual with documentation about bell animation.
2 parents fca9546 + ed2f3d9 commit ce99d73

File tree

2 files changed

+27
-2
lines changed

2 files changed

+27
-2
lines changed

Source/Documentation/Manual/features-rollingstock.rst

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -444,4 +444,28 @@ MSTS wagon::
444444
At runtime, when in passenger view, the player may pass from one viewpoint to
445445
the other by pressing Shift-5.
446446

447+
Bell animation
448+
==============
449+
450+
Open Rails supports bell animation. The bell animation matrix must be named
451+
ORTSBELL within the engine's .s file. Its default frame rate is 8 frames per
452+
second. The default frame rate may be modified through the optional parameter
453+
ESD_ORTSBellAnimationFPS (n), to be inserted within the .sd file related to the
454+
.s file. n defines the animation FPS.
455+
It is advisable that the related sound stream within the .sms file is synchronized
456+
with the visible animation. To accomplish this the .wav file should contain two
457+
bell strokes, which time interval is equal to the time interval of a bell swing
458+
from an oscillation end point to the opposite end point. As the first bell stroke
459+
should not start immediately, but when the bell is about at the maximum of the
460+
swing, the first stroke within the .wav file should be at the time distance equivalent
461+
to the oscillation from center point to an oscillation end point. The file should have
462+
one cue point at its beginning and one after the time interval of a complete bell swing
463+
forward and backward, and should have a final fadeoff for best result.
464+
465+
466+
467+
468+
469+
470+
447471

Source/Documentation/Manual/operation.rst

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1671,9 +1671,10 @@ user settings, and as such are kind of an extension to the four available
16711671

16721672
Function call::
16731673

1674-
state = HASHEAD(Index of SignalSubObj);
1674+
state = HASHEAD( n );
16751675

1676-
Function returns 1 if head is set, else 0.
1676+
where n is the SignalSubObj-Number in question.
1677+
Function returns 1 if head SignalSubObj is set, else 0.
16771678

16781679

16791680
Signalling flag OR_NOSPEEDREDUCTION

0 commit comments

Comments
 (0)