Here an update on how things have to be configured.
Let's consider wagon BR_16T_Min_D105_4_Coal1.wag.
An include file has to be inserted in an OpenRails subfolder within the wagon's folder (in this case, UK_mineral).
I have generated this include file, that I use here as an example to explain things:
include ( ../BR_16T_Min_D105_4_Coal1.wag )
Wagon (
ORTSFreightAnims
(
MSTSFreightAnimEnabled (0)
WagonEmptyWeight(7.75t)
FreightAnimContinuous
(
IntakePoint ( 0.0 3.0 FreightCoal )
Shape(..\\common.Loads\\RCH_1923\\RCH1923_7&8P_Coal1.s)
MaxHeight(0.1)
MinHeight(-0.7)
FreightWeightWhenFull(15.75t)
FullAtStart(0)
)
FreightAnimContinuous
(
IntakePoint ( 0.0 3.0 FuelCoal )
Shape(..\\common.Loads\\RCH_1923\\RCH1923_7&8P_Coal1.s)
MaxHeight(0.1)
MinHeight(-0.7)
FreightWeightWhenFull(15.75t)
FullAtStart(0)
)
)
)
Pls. notice that before the "include" line a void line must be present.
As can be seen, an ORTSFreightAnims block has to be generated.
MSTSFreightAnimEnabled (0) , when equal to 0 means that existing MSTS freight animations within this wagon are disabled; when equal 1 it means that they are enabled. As I have used a wagon here that already had a static freight animation, I have disabled them.
WagonEmptyWeight(7.75t) , if present, provides the empty weight of the wagon. If not present, the Mass() parameter within the .eng file is considered.
After these two general parameters, the freight animations are defined. There are three types of freight animations: continuous, static and discrete, each one with a different parameter list.
The continuous freight animations refer to solid or liquid loads that can expand themselves within the wagon, like coal, or gravel, or diesel fuel and so on. A wagon can accept more than one type of load, and in this case a FreightAnimContinuous block is provided for every type of load.
Following parameters are accepted within a FreightAnimContinuous block:
IntakePoint ( 0.0 3.0 FreightCoal ) : this uses the standards already used for the MSTS freight animations. The types of freight available are the ones available within MSTS, that is FreightGravel, FreightCoal, FreightSand, FreightGrain, FuelCoal, FuelDiesel and FuelWater. Notice that by inserting a FuelCoal IntakePoint, standard coal towers can be used to load wagons, without changes needed within the route files.
Shape(..\\common.Loads\\RCH_1923\\RCH1923_7&8P_Coal1.s) : (sorry for the smilie) this line is not mandatory: if using a tank wagon with FuelDiesel the shape obviously isn't needed.
MaxHeight(0.1) : this is the maximum level the shape reaches. It works like the first numeric parameter within the tender coal animations (but without the trick used to display crews)
MinHeight(-0.7) : this is the minimum level the shape reaches.
FreightWeightWhenFull(15.75t) : this indicates the maximum load weight. This is summed to the WagonEmptyWeight to compute the total weight of the wagon (therefore the weight of the wagon varies depending from the amount of load).
FullAtStart(0) : if 0, this type of load is not present in the wagon at simulation start; if 1, it is present; only the first 1 within the various FreightAnimContinuous blocks is considered.
In the example shown, two FreightAnimContinuous blocks are present.
Static freight animations (meaning parts that remain always present during the run) have following block syntax:
FreightAnimStatic
(
SubType(Default)
Shape(xxshape.s)
Offset(XOffset, YOffset, ZOffset)
)
SubType isn't used yet.
Shape is mandatory here.
XOffset, YOffset and ZOffset are the offsets of the shape with respect to its zero position, and are useful to place with precision the shape.
More than one static freight animation can be defined (also together with continuos freight animations), and they should work also for locomotives.
Discrete freight animations are defined as below (to be finalized and debugged)
FreightAnimDiscrete
(
Shape(xxshape.s)
Offset(XOffset, YOffset, ZOffset)
LoadWeight (10t)
LoadedAtStart (1)
)
Meaning of the parameters is obvious.
First implementation of the discrete freight animation isn't yet complete.
Discrete and continuous freight animations can't be present in the same wagon.