Skip to content

Commit 0cec6dd

Browse files
committed
Containers: wagon related documentation complete
1 parent 95cbee9 commit 0cec6dd

File tree

1 file changed

+68
-0
lines changed

1 file changed

+68
-0
lines changed

Source/Documentation/Manual/features-rollingstock.rst

Lines changed: 68 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -676,7 +676,75 @@ The real rules to allocate double-stacked containers must be respected:
676676
- only one container above
677677
- at least 40ft of containers below.
678678

679+
How to allocate containers on wagons at start of game
680+
-----------------------------------------------------
681+
The containers may be allocated either by editing the ``.con`` file,
682+
or by editing the ``.wag`` file, or in a mixed mode (some wagons in one mode,
683+
some others in another mode).
684+
685+
Allocation through ``.con`` file
686+
'''''''''''''''''''''''''''''''''
687+
688+
This allocation mode is the recommended one, as it is more flexible and provides
689+
easier visibility.
690+
691+
A wagon entry complete with the data about the containers loaded at startup is
692+
shown here::
693+
694+
Wagon (
695+
WagonData ( DTTX_620040_A ATW.DTTX_620040 )
696+
LoadData ( 20cmacgm common.containerdata CenterFront)
697+
LoadData ( 20hamburgsud common.containerdata CenterRear)
698+
LoadData ( 40msc common.containerdata Above)
699+
UiD ( 11 )
700+
)
701+
702+
703+
As can be seen, for each container loaded at startup a ``LoadData`` entry must be
704+
present. The meaning of the parameters is as follows:
705+
706+
- The first parameter is the name of the ``.loa`` file
707+
- The second parameter is the path (having ``Trainset`` as base path) where the ``.loa``
708+
file resides
709+
- The third parameter indicates where the container is allocated on the wagon.
710+
711+
The entry for the container allocated ``Above`` must be the last one.
712+
713+
CenterFront and CenterRear entries must be entered after Front or Rear entries.
714+
715+
The advantage of this type of allocation is that, for a single ``.wag`` file
716+
(in the example ``DTTX_620040_A.wag``) more possible container configurations are
717+
possible, sparing the time of creating many ``.wag`` files that differ only on the
718+
containers loaded.
719+
720+
721+
Allocation through ``.wag`` file
722+
'''''''''''''''''''''''''''''''''
723+
724+
Content creators might prefer to provide packs of pre-loaded wagons. Therefore
725+
it is also possible to set in ``.wag`` file the containers to be loaded at startup.
726+
727+
A minimum ``FreightAnimations`` entry in a ``.wag`` file to have the same pre-loaded container
728+
set as in the previous paragraph is as follows::
729+
730+
ORTSFreightAnims (
731+
LoadingAreaLength ( 14.6 )
732+
AboveLoadingAreaLength ( 16.15 )
733+
DoubleStacker ()
734+
Offset( 0 0.34 0 )
735+
IntakePoint ( 0 6.0 Container)
736+
LoadData ( 20cmacgm common.containerdata CenterFront)
737+
LoadData ( 20hamburgsud common.containerdata CenterRear)
738+
LoadData ( 40msc common.containerdata Above)
739+
)
740+
741+
As can be seen, the syntax of the ``LoadData`` entries is the same as in the case of
742+
the ``.con`` file.
743+
744+
Obviously, using ``.wag`` files for this type of info, a different ``.wag`` file must
745+
be created for every desired pre-loaded set of containers.
679746

747+
A single ``.con`` file can include Wagon entries for both types of allocation definition.
680748

681749

682750

0 commit comments

Comments
 (0)