BVEStation Wiki - New pages [en]

Hmmsim

2015-02-07T00:29:41Z

Kevin: Created page with "Recently, a new mobile train simulator dubbed Hmmsim came out a few months ago with the developer pledging Hmmsim to be compatible with existing BVE/openBVE routes. It can be..."

Recently, a new mobile train simulator dubbed Hmmsim came out a few months ago with the developer pledging Hmmsim to be compatible with existing BVE/openBVE routes.

It can be downloaded from the [https://itunes.apple.com/us/app/hmmsim-train-simulator/id863234164?l=ko&ls=1&mt=8 App Store (iOS)] and [https://play.google.com/store/apps/details?id=com.Jeminie.Hmmsim Google Play (Android)] for free. The developer has also announced a version for Windows to come soon as well.

A converter for existing BVE routes can be downloaded [http://m.blog.naver.com/ddc01137/220094899113 here] to make them playable in Hmmsim

== Current List of Compatible Routes ==

*J/Z to Broad Street
*N/Q to Coney Island
*B to Brighton Beach
*D to Bay 50 Street
*F to 179 Street

If you see any compatible routes, please list them [http://forums.bvestation.com/index.php?topic=2670.0 here]

== Current List of Compatible Trains ==

*To Be Announced

Adding New Tutorials On This Wiki

2015-02-07T00:29:25Z

Kevin: Created page with "It's always good to see a new tutorial on the wiki. If you have a tutorial that you made and it was made in a non-wiki site, or if the tutorial you got from a site is '''not''..."

It's always good to see a new tutorial on the wiki. If you have a tutorial that you made and it was made in a non-wiki site, or if the tutorial you got from a site is '''not''' copyrighted, there is an easy way to port HTML-based web pages into the mediawiki format. Please remember to give credit:

==Step 1==
Go to this site below:

[http://toolserver.org/~diberri/cgi-bin/html2wiki/index.cgi HTML to MediaWiki]

Select RAW HTML. Save the webpage containing the tutorial you want.

After saving the page into preferably your desktop, right click the file and highlight open with and click on Notepad.

==Step 2==
Then, press CTRL+A (or edit>select all) to highlight the HTML code. Then press CTRL+C (or edit>copy) and on the provided input box on the converter, press CTRL+V (or edit>paste)

Go to the drop down menu where it says "Dialect", and select Mediawiki.

After this, click on Convert HTML to wiki markup.

==Step 3==
You will see a new box stating "MediaWiki Markup". Click on that box and press CTRL+A (or edit>select all) to highlight the MediaWiki markup code. Then press CTRL+C (or edit>copy) and on the new article page you want to make, select the text box and press CTRL+V (or edit>paste) to paste your tutorial.

==Step 4==
Click on show preview to check whether it appears the way you want it or not. You should also consider revising before clicking Save Page. Once you have ensured it appears the way you want it, click on save page.

Generations (BVE Routes and Trains)

2015-02-07T00:28:59Z

Kevin: Created page with "NYCTBVE has gone through several generations, in terms of graphics and realism. It is definitely interesting to see how we have progressed from our beginnings. Routes must loo..."

NYCTBVE has gone through several generations, in terms of graphics and realism. It is definitely interesting to see how we have progressed from our beginnings. Routes must look like, or better than that generation to fall under it. These definitions, however, do not take into account the quality and precision of the work, as the route can be accurate, and use photo-realistic textures, but fail to have the quality appeal of clean looks, and side-by-side photo comparison. This can be seen with oversized/wrongly measured textures, visual glitches, etc. This term was defined by ipaclansite to grade routes based on their graphical appeal after he released the southbound G.

==First Generation==
[[File:Nycta-e1.jpg|200px|thumb|right|The original E Route]]
The first generation of NYCTBVE was very simple in terms of graphics, stations weren't detailed, and used very little objects. Every station would look the same, and most of the time you would depend on BVE to tell you where you were. Distances were also inaccurate, but there were limitations during this time, and this was the best we had. First Generation routes are no longer made.
One of the most detailed first generation routes is the 7 and the L, which drew the line, and brought us into the second generation of NYCTBVE routes.

As for the trains, The Trains that fall under this generation have no exterior and thus have old sounds

Routes on BVEStation which fall under first generation:

*E Manhattan bound
*S Grand Central Shuttle
*N Queensbound
*G Queensbound
*S Franklin Avenue Shuttle
*7 Line
*L Line

Trains that currently fall in this
*R62
These routes are from the 2001-2004 era.

==Second Generation==
[[File:1275108988.png|200px|thumb|right|181st On the A]]

The second generation of NYCTBVE obviously got more sophisticated, with new objects, and accurate track distances, and curves. During this time, Phantom909 joined and was the leading force of this new advancement. Second Generation NYCTBVE routes, featured more details, including locations of stairs, benches, trash bins, maps, and unique station walls for each station. Most of our routes fall into the second generation category. Most newer generation routes, usually begin as a second generation as a skeleton, which is then detailed into one of the higher generation level routes.

As for the trains, The Trains that fall under this generation have an exterior and have new sounds but no interior

Routes that currently fall into this category:

*2 Line
*A Line
*C Line
*S Franklin Avenue Shuttle

Trains That Fall into this Category

*Low-V (by PuertoRican88)
*R1 (by PuertoRican88)
*R10 (By PuertoRican88)
*R15 (by Puertorican88)
*R16 (by Puertorican88)
*R30 (By Puertorican88)
*R33WF (By PuertroRican88)
*PA-5 (By Puertorican88)
*H4 (By Puertorican88)
*H5 (By Puertorican88)
*H6 (By Puertorican88)
*T1 (By Puertorican88)
*TR(Toronto Rocket) (By Puertorican88)
**Note that PuertoRican88's trains fall into this category for low-memory usage and faster loading times to support legacy PC's

BETA Trains (for the time being until interiors are made, however still photorealistic)
*R17 (by CT1660), includes the garbage train variation
*R21/R22 (by CT1660), includes the R17/R21 GEL train
*R33ML & R33WF (by CT1660)
*R68 (by CT1660)

These routes are from the 2004-2007 Era.

==Third Generation==
[[File:1293834552.png|200px|thumb|right|Flushing Avenue on the G]]

The third generation of NYCTBVE gets even more advanced, with digitally redrawn photo textures, along with the accuracy of second generation routes. They may contain real photo textures, but contain more digitally redrawn ones than photos. These routes are significantly more detailed, and visual enhancements compared to its predecessors. These routes usually dont have the visuals of photo-textured routes, but they are close to their photo counterparts. They can be placed side by side to a photo and look comparable. Routes in this generation may have derived from a skeleton, created during the second generation age.

As for the trains, The Trains that fall under this generation have an exterior with better texture and have new sounds. An interior might be included

Routes that fall into this category:

*G Line

Routes that will be third generation:
*6 Line (border line)

These routes are from the 2007-2009 Era.

Trains That Fall into this Category
*R38 (by DJ Hammers, will be upgraded to 5 ½ generation)
*R142 (by PuertoRican88)
*R143 (by PuertoRican88)
*R160A/B (by PuertoRican88)
*R188 (by PuertoRican88)
*PA 4 (by PuertoRican88)
*All of PuertoRican88's fictional trains
**Note that PuertoRican88's trains fall into this category for low-memory usage and faster loading times to support legacy PC's

==Fourth Generation==
[[File:ConeyIsland.png|200px|thumb|right|Stillwell Avenue on the F]]
The fourth generation of NYCTBVE builds upon the third generation, using photo-textures, or photo-drawing hybrids. The hybrids usually contain a mixture of both photo-textures, and digitally redrawn textures. Mostly, they contain more photo-textures than redrawn textures. This takes the third generation to the next level of visual enhancements, and look alot more visually appealing. Routes in this generation may have derived from a skeleton, created during the second generation age. Routes in this category are comparable to their actual photo counterparts like the third generation routes. Routes in this generation are preferable due to their flexibility between photo and drawn textures. They can also feature use of textures from elsewhere and reworked into the route.

As for the trains, The Trains that fall under this generation have an exterior with better texture and have new sounds with interior

Routes that fall into this category:
*B Line (Brooklyn Bound)
*D Line (Brooklyn Bound)
*F Line (Queens Bound)
*H Line (Far Rockaway Bound)
*N Line (Brooklyn Bound)
*Q Line (Brooklyn Bound)
*V Line (Queens Bound)
*W Line (Queens bound)

Routes that will be 4th generation:

*R Line
*4 Line
*Updated C Line
*E Line (Both Manhattan/Queens Bound)

These routes are from 2008-Present.

==Four and a halfth Generation==

4.5th generation routes will feature up to 85%+ photo textures, objects, and structures are to be accurately depicted, and the route may also finally feature working safety systems. The tracks, tunnels and columns should also be replaced with photo-realistic ones, as seen in some of the London Underground routes. Anything under this category would classify as a fifth generation route.

==Fifth Generation==

Routes that are almost incomprehensible compared to their realistic photo counterparts. An example of a route meeting this definition is the Birmingham Cross-City South in development on RailSimRoutes [1]
It is not possible for a fictional route to be fifth generation unless it has elements that can be compared to actual photos or locations.

Routes that approach or meet the 5th Generation Standard
*Q

==Fifth and a halfth Genration==
[[File:OpenBve_2012-06-09_16-48-44-18.png|200px|thumb|right|The R46 Exterior, a highly detailed exterior and interior. Note the level of detail]]

While this applies for trains made for OpenBVE, they still fall under "Fifth Generation", however, the exterior/interior views have more level of detail and more accurate animation. May be either hand-coded, made in Google Sketchup or Blender, or a hybrid of both.

The '''5 1/2''' generation trains available for download are:

*R46 by error46146, Rikabs and [CT1660]
*R16 by [CT1660]
*R32 by Mudwrestle
*R38 by DJ Hammers / Mudwrestle

Trains to be 5 1/2 generation:

*IRT SMEE Fleet Exteriors (R12/R14/R15/R17/R21/R22/R26/R28/R29/R33ML/R33WF/R36ML/R36WF) by [CT1660] & Mudwrestle
*The Train Of Many Colors by DJ Hammers, Mr. Railfan and [CT1660]
*R142/R142A by BStyles
*Class 323 (new exterior/interior in development) by RailsimRoutes
*R10 by Mudwrestle
*R11/34 by Mudwrestle
*R27/R30 by Mudwrestle

DLL Tricks

2015-02-07T00:28:42Z

Kevin: Created page with "The dll tricks will allow select computers to run BVE without any problems on Vista. 1. 3 Dll files will need to be downloaded '''[http://www.dlldump.com/download-dll-files_n..."

The dll tricks will allow select computers to run BVE without any problems on Vista.

1. 3 Dll files will need to be downloaded '''[http://www.dlldump.com/download-dll-files_new.php/dllfiles/D/dx7vb.dll/5.03.2600.2180/download.html dx7vb.dll]''', '''[http://www.dlldump.com/download-dll-files_new.php/dllfiles/D/dx8vb.dll/5.03.2600.2180/download.html dx8vb.dll]''', '''[http://www.dlldump.com/download-dll-files_new.php/dllfiles/D/d3drm.dll/5.1.2600.0/download.html d3drm.dll]'''

2. If you have Windows Vista 32bit place the 3 files in the C:\Windows\System32 directory. If you have Windows Vista 64bit place the 3 files in the c:\windows\syswow64 directory.

3. Go to Start, in the search box type in CMD, right click cmd.exe and run as administrator.

4a. '''On 32 bit systems (only otherwise check 4b)''' - In the command prompt type in:
<pre><nowiki>
regsvr32 dx7vb.dll
<Then hit enter (It should say the dll register succeeded)>
regsvr32 dx8vb.dll
<Then hit enter (It should say the dll register succeeded)>
exi
</nowiki></pre>

4b. '''On 64 bit systems (only)''' - In the command prompt type in:
<pre><nowiki>
cd c:\windows\syswow64 <enter>
regsvr32 dx7vb.dll <enter>
regsvr32 dx8vb.dll <enter>
exit <enter>
</nowiki></pre>

5. Give BVE a try.

== Selected Systems ==

Windows Vista on a ATI based Video Card will work without a hitch.

Windows Vista on a nVidia based Video Card fails to work (The panel shows, but nothing on the track is displayed or gray/white). Running BVE 2 in 256 bit color mode however does work.

It has been said that Windows 7 is able to run BVE with or without the DLL tricks. Although these users were also ATI as well, and no hope in sight for nVidia users.

== Alternatives to the DLL Tricks ==

The following are proven methods/alternatives which work for running BVE on Vista:

*Run BVE in 256 bit color mode, the color will be terrible, but oddly enough it works for nVidia users on Vista. Aside from BVE saying it could not change to HAL.

*Install Windows XP, removing Vista, this will replace your existing Windows Vista installation, this is recommended if you have a copy of Windows XP laying around, and you haven't done anything with your Vista partition. You are to do this at your own risk.

*Install Windows XP as Dual Boot along with Vista, much safer solution, and uses alot more space, recommended if you have a copy of Windows XP laying around, and you have used Windows Vista frequently, still things can happen, and do this at your own risk.

*Use Virtual PC and Install Windows XP on that, this is probably the safest bet, with your copy of Windows XP, you can install it on a Virtual PC, performance however will take a big hit, as your resources also go toward emulating the operating system.

*Use OpenBVE, with this Open Source BVE alternative you can run most routes along with newer routes, with minor differences. The program is fully compatible with Windows Vista, and other operating systems, that BVE once couldn't be able to run on.

== Other Warnings ==

The newer ATI HD cards with support for DirectX 10, will experience graphical glitches if run on Windows XP.

Multiplayer

2015-02-07T00:28:24Z

Kevin:

OpenBVE Multiplayer Extension was written by [[User:Kevin | ipaclansite]], and adds a multiplayer feature to the game. The program is open source and can be freely downloaded at BVEStation and/or github. The Multiplayer Extension works by taking control of the game's pretrain and AI feature.

==History==
With the lack of multiplayer train simulators in the market at the time, and the Open Source nature of OpenBVE, there was an interest in a multiplayer feature for OpenBVE. It first started out as an April Fools joke on BVEStation, with OpenBVE's option menu showing a new option for multiplayer. It was also requested on the official OpenBVE Forums (no longer online) as a permanent feature for OpenBVE, but was ultimately rejected by michelle, the former head developer of OpenBVE. ipaclansite would decide to add the multiplayer feature himself.
==Versions==
Currently there are two versions written for the game, the original version and a current version, both are internally similar, but rely on a different server model.
===Original Version===
The original version of OpenBVE Multiplayer Classic was written by taking snippet code from a chat program. OpenBVE would capture the distance information of the train ahead of the player from the server and would provide this information for all users. There was also a psuedo-signalling system, that was external, with a separate form. This version would eventually have limited support for actually utilizing the pretrain to display other users.

The original version was very buggy due to the use of code snippet taken from another website, and was built mainly as a proof of concept only. This version allows players to connect to a single route on a single individual server.

===Second Version===
The current version of OpenBVE Multiplayer Codename Newtown was written using a centralized database system, which acts as the server. OpenBVE would capture the distance information from a specific table in a MySQL database, and would force the pretrain/AI train to move into this specified position. Like the original version, this only allowed the player to view a single instance of the player ahead of them.

This version is more stable, due to the large amount of newly written code. This version also allows for clients to connect to a single central server, with multiple routes, and allows for MMO elements. A mapping system, and a signaling system was also written to supplement this multiplayer version, largely feasible due to the use of a database system.

This version unfortunately suffers from limited uptime of the server, and requires multiple users connected at once in order to get a good experience.

===Current===
This version was completely, and rewritten, to provide a more stable server/client model. This version is available for download on github along with the source code. [https://github.com/kev5873/openbvemultiplayer] The server was written in Python, which simply acts as a TCP Server. The client code is embedded loosely within OpenBVE. It too utilizes the pretrain to display other users, which allows for the in-game signaling system to be used with it. This version also only supports single line routes, as this is a BVE limitation, and not a multiplayer one. Ordering is also important, in that users should connect in order, and on a delay so that their trains do not overlap or jump each other.

==Other Versions==
Boss of Games wrote a fork of the original OpenBVE Multiplayer, adding a signaling system to that version based on the client/server model. His version was never released to the BVE community.

A European version of a multiplayer OpenBVE was created, it was suggested that it connected teamspeak into the game, as opposed to it being an actual multiplayer game. Not much is known about this version.

==Pseudo-Multiplayer==
Traditionally multiplayer is done through the use of BVEStation's Chatroom, players would simply broadcast their position after every few stops.

In the past, traditional multiplayer makes use of BVEStation's Teamspeak Server, as players speak to broadcast their positions, this form is the most popular form of pseudo-multiplayer to date, due to its ease of use. Users do not appear to want to use a physical multiplayer system, as it is either too complicated, unstable or incompatible or too limited for their needs, and will resort to this method.

Because BVEStation no longer runs a Teamspeak Server, other communities have sought to replace this service, and run their own multiplayer events.

Extensions.cfg

2015-02-07T00:27:09Z

Kevin: Created page with "The extensions.cfg file allows to define properties for individual cars, like length, axle positions and exterior objects. ==Overview== The file is a plain text file encode..."

The extensions.cfg file allows to define properties for individual cars, like length, axle positions and exterior objects.

==Overview==

The file is a plain text file encoded in any arbitrary encoding, however, UTF-8 with a byte order mark is the preferred choice. The parsing model for numbers is Strict. The file is required to be located inside the train folder and is expected to be named extensions.cfg. The file is interpreted on a per-line basis, from top to bottom.

===Car indices===

----

All cars in the extensions.cfg are enumerated from 0 (front car) to n-1 (rear car), where n is the number of cars the train has in total, according to the train.dat file. For example, on a train with 10 cars, the front car has index 0 and the rear car index 9.

===Coupler indices===

----

A coupler in this document refers to the space between neighboring cars. All couplers in the extensions.cfg are enumerated from 0 (front-most coupler) to n-2 (rear-most coupler), where n is the number of cars the train has in total, according to the train.dat file. Coupler index i corresponds to the coupler between the cars with indices i and i+1, so the coupler between the first two cars (0 and 1) in the train has index 0. Likewise, if a train has 10 cars, the coupler between the last two cars (8 and 9) would have index 8.

==Syntax==

Each line in the file can be empty (or solely consist of white spaces) and will be ignored, can mark the beginning of a new section or contain key-value pairs inside a section. All key-value pairs relate to the last section opened.

A new section is opened by starting the line with an opening bracket (U+005B) and ending it with a closing bracket (U+005D). The text in-between the brackets indicates the name of the section and is case-insensitive. White spaces at the beginning and the end of the line are ignored, as well as at the beginning and the end of the name of the section. Thus, the beginning of the section has the following form:

<pre><nowiki>
[NameOfTheSection]
</nowiki></pre>

Example for the indication of a new section:
<pre><nowiki>
[exterior]
</nowiki></pre>

A key-value pair is indicated by giving the key, an equals sign (U+003D) and then the value. The key is case-insensitive. White spaces at the beginning and the end of the line are ignored, as well as in front and after the equals sign. Alternatively phrased, white spaces surrounding the key and the value are ignored. Thus, a key-value pair as the following form:

<pre><nowiki>
NameOfTheKey = Value
</nowiki></pre>

Example of a key-value pair:
<pre><nowiki>
0 = train.csv
</nowiki></pre>

You can use comments anywhere at the end of a line. A comment is started by a semicolon (U+003B). Comments, if present, are stripped away from all lines before these are processed.

==The Car/Exterior section==

Only one of the two options should be used.

The Car''i'' section is especially handy if your train will use pivoting trucks, or different rail-cars with different lengths. This newer method allows one to define properties specific to a certain car.

The Exterior section provides an easy way of adding exterior objects to the particular train, if the Car''i'' section won't be used.

===The [Car''i''] Section===

----

The Car''i'' section allows to define properties specific to a certain car.

<pre><nowiki>
[Cari]
</nowiki></pre>
''This starts the section for car i, which is an integer between 0 and n-1, where n is the number of cars the train has.''

<pre><nowiki>
Object = File
</nowiki></pre>
''file: The relative file name of the exterior object to use for this car, relative to the train folder.''

This key-value pair defines the exterior object for this car. Within the object file, the coordinate (0,0,0) (x, y, z) corresponds to the center of the car, both horizontally (x) and forward/backward (z), while y=0 corresponds to the top of the rails.

<pre><nowiki>
Length = Value
</nowiki></pre>
''Value: A positive floating-point number representing the length of the car.''

This key-value pair defines the length for this car. This overrides the length as defined in the train.dat for this particular car. If not used, this car will have the default length as defined in the train.dat.

<pre><nowiki>
Axles = Rear, Front
</nowiki></pre>

''Rear: A floating-point number indicating the z-position of the rear axle measured from the center of the car. Usually a negative value.''

''Front: A floating-point number indicating the z-position of the front axle measured from the center of the car. Usually a positive value.''

This key-value pair defines the positions of the axles. While Rear and Front can take any values, the condition Rear < Front must hold.

<pre><nowiki>
Reversed = Value
</nowiki></pre>
''Value: Either True or False to indicate whether to reverse the car.''

With this setting, you can reverse the car in the consist. Please note that axle positions are given as if the car was not reversed.

Example of a Cari section:

<pre><nowiki>
[Car0]
Object = locomotive.b3d
Length = 16
Axles = -6, 6
Reversed = False
</nowiki></pre>

===The [Exterior] Section===

----

The Exterior section provides an easy way of adding exterior objects to the particular train. For more control on the setting of axle positions and individual car lengths, the Cari section has been introduced and should be used instead.

<pre><nowiki>
[Exterior]
</nowiki></pre>
''This starts the Exterior section.''

<pre><nowiki>
i = File
</nowiki></pre>
i'': An integer between 0 and n-1, where n is the number of cars the train has. Index 0 corresponds to the front car and index n-1 to the last car in the train.''

''File: The relative file name of the exterior object to use for car i, relative to the train folder.''

This key-value pair can be used to set up the exterior objects for each individual car. Within the object file, the coordinate (0,0,0) (x, y, z) corresponds to the center of the car, both horizontally (x) and forward/backward (z), while y=0 corresponds to the top of the rails.

Example of an [Exterior] section:
<pre><nowiki>
[Exterior]
0 = cars\engine.csv
1 = cars\passenger_mk1.b3d
2 = cars\passenger_mk1.b3d
3 = cars\passenger_bistro.b3d
4 = cars\passenger_mk2.b3d
5 = cars\postal.x
</nowiki></pre>

===The [Coupler''i''] Section===

----

The Coupler''i'' section allows to define properties specific to a certain coupler.

<pre><nowiki>
[Coupleri]
</nowiki></pre>
''This starts the section for coupler i, which is an integer between 0 and n-2, where n is the number of cars the train has.''

<pre><nowiki>
Distances = Minimum, Maximum
</nowiki></pre>

''Minimum: A floating-point number indicating the minimum allowed distance between the cars.''

''Maximum: A floating-point number indicating the maximum allowed distance between the cars.''

This key-value pair defines the lowest and highest allowed distances between the cars, resembling a buffer and chain coupler. The condition Minimum ≤ Maximum must hold.

Example of a Coupleri section:
<pre><nowiki>
[Coupler0]
Distances = 0.30, 0.35
</nowiki></pre>

Ats.cfg

2015-02-07T00:26:53Z

Kevin: Created page with "The ats.cfg file format The ats.cfg file is a plain text file consisting of a single line: the relative path to the plugin that is to be used. '''''Example of an ats.cfg fil..."

The ats.cfg file format

The ats.cfg file is a plain text file consisting of a single line: the relative path to the plugin that is to be used.

'''''Example of an ats.cfg file:'''''
<pre><nowiki>
myplugin.dll
</nowiki></pre>

If you don't include the ats.cfg file, the default plugin for trains is used which provides basic implementations of ATS and ATC.

Sound.cfg

2015-02-07T00:26:35Z

Kevin: Created page with " The '''sound.cfg''' file format {| style="border: 0px currentColor; margin-right: 10..."

The '''sound.cfg''' file format 

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| 
|}

 

{|
|- style="height: 4px"
|
|}

■ 1. Overview

----

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| 
|}

The sound.cfg file allows to reference which sound files should be used, how they are called and where they are located relative to the train folder. The sound.cfg file is a plain text file encoded in any arbitrary [http://trainsimframework.org/develop/information_encodings.html encoding], however, UTF-8 with a byte order mark is the preferred choice. The [http://trainsimframework.org/develop/information_numberformats.html parsing model] for numbers is '''Strict'''. The file is required to be located inside the train folder and is expected to be named '''sound.cfg'''. The file is interpreted on a per-line basis, from top to bottom. ➟ [http://trainsimframework.org/develop/train_sound_cfg_quick.html See also the quick reference for the sound.cfg...] 

{|
|- style="height: 4px"
|
|}

■ 2. Syntax

----

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| 
|}

 Each line in the file can be empty (or solely consist of white spaces) and will be ignored, can mark the beginning of a new section or contain key-value pairs inside a section. All key-value pairs relate to the last section opened. A new section is opened by starting the line with an opening bracket (U+005B) and ending it with a closing bracket (U+005D). The text in-between the brackets indicates the name of the section and is case-insensitive. White spaces at the beginning and the end of the line are ignored, as well as at the beginning and the end of the name of the section. Thus, the beginning of the section has the following form: 

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | [NameOfTheSection]
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| 
|}

 A key-value pair is indicated by giving the key, an equals sign (U+003D) and then the value. The key is case-insensitive. White spaces at the beginning and the end of the line are ignored, as well as in front and after the equals sign. Alternatively, white spaces surrounding the key and the value are ignored. Thus, a key-value pair as the following form: 

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | NameOfTheKey = Value
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| 
|}

 You can use comments anywhere at the end of a line. A comment is started by a semicolon (U+003B). Comments, if present, are stripped away from all lines before these are processed. 

{|
|- style="height: 4px"
|
|}

■ 3. Content of the file

----

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| 
|}

The first line in the file is required to be the following: 

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | Version 1.0
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| 
|}

 Following the version line, these are the sections that can be used and their key-value pairs. In all key-value pairs, the parameter ''FileName'' corresponds to the file name of the sound to reference, relative to the train folder. 

----

{|
|- style="height: 4px"
|
|}

● [Run]

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| 
|}

{|
|- style="height: 2px"
|
|}

 

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | ''Index'' = ''FileName''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| 
|}

Assigns a run sound. The non-negative integer ''Index'' represents the type of run sound to use. Route developers can choose which run sound to play for a given piece of track. Please see the page about [http://trainsimframework.org/develop/information_standards.html standards] for further information. The sound is played at a pitch proportional to the speed. The recording should correspond to a speed of 90 km/h. 

----

{|
|- style="height: 4px"
|
|}

● [Flange]

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| 
|}

{|
|- style="height: 2px"
|
|}

 

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | ''Index'' = ''FileName''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| 
|}

Assigns a flange sound. The non-negative integer ''Index'' represents the type of flange sound to use. Route developers can choose which flange sound to play for a given piece of track. Please see the page about [http://trainsimframework.org/develop/information_standards.html standards] for further information. The sound is played at a pitch proportional to the speed. The recording should correspond to a speed of 45 km/h. 

----

{|
|- style="height: 4px"
|
|}

● [Motor]

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| 
|}

{|
|- style="height: 2px"
|
|}

 

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | ''Index'' = ''FileName''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| 
|}

Assigns a motor sound. The non-negative integer ''Index'' represents the index of the motor sound that can be referenced in the #MOTOR_''Xn'' sections of the train.dat. Please see the documentation for the [http://trainsimframework.org/develop/train.dat train.dat] for more information. 

----

{|
|- style="height: 4px"
|
|}

● [Switch]

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| 
|}

{|
|- style="height: 2px"
|
|}

 

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | 0 = ''FileName''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| 
|}

Played once per axle when the train crosses a pointwork. 

----

{|
|- style="height: 4px"
|
|}

● [Brake]

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| 
|}

{|
|- style="height: 2px"
|
|}

 

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | BC Release High = ''FileName''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| 
|}

Played occasionally when the pressure in the brake cylinder is decreased from a high value. 

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | BC Release = ''FileName''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| 
|}

Played occasionally when the pressure in the brake cylinder is decreased from a non-high value to a non-zero value. 

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | BC Release Full = ''FileName''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| 
|}

Played occasionally when the pressure in the brake cylinder is decreased to zero value. 

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | Emergency = ''FileName''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| 
|}

Played once when the emergency brakes are activated. 

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | BP Decomp = ''FileName''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| 
|}

For trains with automatic air brake, is played when the handle is moved into the SRV or EMG position. For other trains, is played when the brake notch is decreased. 

----

{|
|- style="height: 4px"
|
|}

● [Compressor]

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| 
|}

{|
|- style="height: 2px"
|
|}

 

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | Attack = ''FileName''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| 
|}

Played once when the air compressor is activated. 

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | Loop = ''FileName''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| 
|}

Played in a loop for the duration the air compressor is active. 

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | Release = ''FileName''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| 
|}

Played once when the air compressor is deactivated. 

----

{|
|- style="height: 4px"
|
|}

● [Suspension]

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| 
|}

{|
|- style="height: 2px"
|
|}

 

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | Left = ''FileName''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| 
|}

Played occasionally when the train sways to the left side. 

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | Right = ''FileName''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| 
|}

Played occasionally when the train sways to the right side. 

----

{|
|- style="height: 4px"
|
|}

● [Horn]

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| 
|}

{|
|- style="height: 2px"
|
|}

 

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | Primary = ''FileName''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| 
|}

Played once when the primary horn is applied. 

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | Secondary = ''FileName''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| 
|}

Played once when the secondary horn is applied. 

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | Music = ''FileName''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| 
|}

Played in a loop when the music horn is applied. 

----

{|
|- style="height: 4px"
|
|}

● [Door]

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| 
|}

{|
|- style="height: 2px"
|
|}

 

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | Open Left = ''FileName''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| 
|}

Played once when the left doors open. 

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | Open Right = ''FileName''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| 
|}

Played once when the right doors open. 

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | Close Left = ''FileName''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| 
|}

Played once when the left doors close. 

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | Close Right = ''FileName''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| 
|}

Played once when the right doors close. 

----

{|
|- style="height: 4px"
|
|}

● [Ats]

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| 
|}

{|
|- style="height: 2px"
|
|}

 

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | ''Index'' = ''FileName''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| 
|}

Assigns a plugin sound. The non-negative integer ''Index'' represents the sound index. Train plugin developers can choose which sound to play. The assignment of sounds needs to be coordinated with the plugin developer. 

----

{|
|- style="height: 4px"
|
|}

● [Buzzer]

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| 
|}

{|
|- style="height: 2px"
|
|}

 

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | Correct = ''FileName''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| 
|}

Played once when the train stops at a station, but needs to correct its stop position. 

----

{|
|- style="height: 4px"
|
|}

● [Pilot Lamp]

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| 
|}

{|
|- style="height: 2px"
|
|}

 

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | On = ''FileName''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| 
|}

Played once as soon as the doors have closed and the train is ready for departure. 

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | Off = ''FileName''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| 
|}

Played once as soon as the doors start to open. 

----

{|
|- style="height: 4px"
|
|}

● [Brake Handle]

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| 
|}

{|
|- style="height: 2px"
|
|}

 

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | Apply = ''FileName''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| 
|}

Played once when the brake notch is increased to any value below the emergency brake position. 

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | Release = ''FileName''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| 
|}

Played once when the brake notch is decreased to any value above brake notch zero. 

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | Min = ''FileName''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| 
|}

Played once when the brake notch is decreased to brake notch zero. 

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | Max = ''FileName''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| 
|}

Played once when the emergency brakes are applied. 

----

{|
|- style="height: 4px"
|
|}

● [Master Controller]

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| 
|}

{|
|- style="height: 2px"
|
|}

 

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | Up = ''FileName''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| 
|}

Played once when the power notch is increased to any value below the maximum power notch. 

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | Down = ''FileName''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| 
|}

Played once when the power notch is decreased to any value above power notch 0. 

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | Min = ''FileName''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| 
|}

Played once when the power notch is decreased to brake notch zero. 

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | Max = ''FileName''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| 
|}

Played once when the power notch is increased to the maximum power notch. 

----

{|
|- style="height: 4px"
|
|}

● [Reverser]

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| 
|}

{|
|- style="height: 2px"
|
|}

 

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | On = ''FileName''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| 
|}

Played once when the reverser is moved into any non-neutral position. 

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | Off = ''FileName''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| 
|}

Played once when the reverser is moved into the neutral position. 

----

{|
|- style="height: 4px"
|
|}

● [Breaker]

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| 
|}

{|
|- style="height: 2px"
|
|}

 

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | On = ''FileName''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| 
|}

Played once when power is resumed (was interrupted before). There is a series of circumstances when that can happen, for example when moving from power notch zero to power notch one, assuming the reverser is non-neutral and the brakes are released. It can also happen when the power notch is already non-zero, but the reverser or brakes previously interrupted the power. The safety systems can also interrupt power. 

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | Off = ''FileName''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| 
|}

Played once when power is interrupted or resumed. There is a series of circumstances when that can happen, for example when moving from power notch zero to power notch one, or vice versa, assuming the reverser is non-neutral and the brakes are released. The safety systems can also interrupt power. 

----

{|
|- style="height: 4px"
|
|}

● [Others]

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| 
|}

{|
|- style="height: 2px"
|
|}

 

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | Noise = ''FileName''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| 
|}

Played in a loop all the time for the duration of the simulation. 

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | Shoe = ''FileName''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| 
|}

Played in a loop when the brake shoe rubs against the wheels. The sound is played at a pitch inversely proportional to the speed, and the volume of the sound decreases with increasing speeds.

Default sounds

2015-02-07T00:26:16Z

Kevin: Created page with "Without using a sound.cfg file, openBVE looks for a series of optional sound files within the train folder. ==Sounds Played Only In-Cab== ===adjust.wav=== Played once when..."

Without using a sound.cfg file, openBVE looks for a series of optional sound files within the train folder.

==Sounds Played Only In-Cab==

===adjust.wav===
Played once when the train stops at a station, but needs to correct its stop position.
----

===ats.wav===
Played in a loop when the built-in security system ATS rings its bell. This happens when passing certain transponders or when the security system is deactivated but power is applied.
----

===atscnt.wav===
Played in a loop when the built-in security system ATS rings its chime. This happens after acknowledging the bell when passing S-type transponders.
----

===brake.wav===
For trains with automatic air brake, is played when the handle is moved into the SRV or EMG position. For other trains, is played when the brake notch is decreased.
----

===ding.wav===
Played once when the built-in security systems ATS-P or ATC change some states, e.g. when ATS-P activates the PTN APPROACH lamp, or when ATC changes the current speed restriction.
----

===eb.wav===
Played in a loop when the built-in EB system rings.
----

===halt.wav===
Played once or in a loop (depending on the train.dat setting) when the pass alarm system warns about an approaching station stop.
----

===klaxon.wav===
Played once when the primary horn is applied.
----

===klaxon0.wav===
Played once when the primary horn is applied. Has precedence over klaxon.wav.
----

===klaxon1.wav===
Played once when the secondary horn is applied.
----

===klaxon2.wav===
Played in a loop when the music horn is applied.
----

===toats.wav===
Played once when the built-in security system is switched from ATC to ATS.
----

===toatc.wav===
Played once when the built-in security system is switched from ATS to ATC.
----

==Sounds played on all cars where applicable==

===air.wav===
Played occasionally when the pressure in the brake cylinder is decreased from a non-high value to a non-zero value.
----

===airhigh.wav===
Played occasionally when the pressure in the brake cylinder is decreased from a high value.
----

===airzero.wav===
Played occasionally when the pressure in the brake cylinder is decreased to zero value.
----

===cpstart.wav===
Played once when the air compressor is activated.
----

===cploop.wav===
Played in a loop for the duration the air compressor is active.
----

===cpend.wav===
Played once when the air compressor is deactivated.
----

===doorcls.wav===
Played once when the doors close.
----

===doorclsl.wav===
Played once when the left doors close. Has precedence over doorscls.wav.
----

===doorclsr.wav===
Played once when the right doors close. Has precedence over doorscls.wav.
----

===dooropn.wav===
Played once when the doors open.
----

===dooropnl.wav===
Played once when the left doors open. Has precedence over doorscls.wav.
----

===dooropnr.wav===
Played once when the right doors open. Has precedence over doorscls.wav.
----

===emrbrake.wav===
Played once when the emergency brakes are activated.
----

===flangei.wav===
Defines a set of sounds played in a loop when the flange of the wheels rub against the rails. The sounds are played at a pitch proportional to the speed. The recordings should correspond to a speed of 45 km/h. The non-negative integer i corresponds to the Train.Flange command in CSV routes where route developers can select which of the flangei.wav sounds to play for a certain type of rail.
----

===loop.wav===
Played in a loop all the time for the duration of the simulation.
----

===point.wav===
Played once per axle when the train crosses a pointwork.
----

===rub.wav===
Played in a loop when the brake shoe rubs against the wheels. The sound is played at a pitch inversely proportional to the speed, and the volume of the sound decreases with increasing speeds.
----

===runi.wav===
Defines a set of sounds played in a loop for the duration the train moves. The sounds are played at a pitch proportional to the speed. The recordings should correspond to a speed of 90 km/h. The non-negative integer i corresponds to the Train.Run command in CSV routes where route developers can select which of the runi.wav sounds to play for a certain type of rail.
----

===springl.wav===
Played once when the train sways to the left side.
----

===springr.wav===
Played once when the train sways to the right side.
----

===motori.wav===
Defines a set of sounds played in a loop as instructed by the train.dat. The pitch, volume and index i are defined in the #MOTOR_Xn sections in the train.dat, and the sounds should be developed in conjunction with the train.dat.
---

Panel.cfg

2015-02-07T00:25:59Z

Kevin: Created page with "The panel.cfg file allows to create 2D panels by defining which elements to use, like speedometers, pressure gauges etc., and where they are to be placed. ==Overview== The p..."

The panel.cfg file allows to create 2D panels by defining which elements to use, like speedometers, pressure gauges etc., and where they are to be placed.

==Overview==

The panel.cfg file is a plain text file encoded in any arbitrary encoding, however, UTF-8 with a byte order mark is the preferred choice. The parsing model for numbers is Loose, however, you are encouraged to produce Strict output nonetheless. The file is required to be located inside the train folder and is expected to be named panel.cfg. The file is interpreted on a per-line basis, from top to bottom.

The panel.cfg has been superseded by the panel2.cfg. You can achieve the full functionality of the panel.cfg and more by using the panel2.cfg instead. If both files are present in the train folder, the panel2.cfg has precedence over the panel.cfg.

The cab is rendered as an overlay. This means that the cab will always appear in front of scenery objects. This is intentional, because this way, rain, walls and other obstructing objects cannot be accidentally rendered inside the cab. Furthermore, lighting in the cab is different than in the scenery. While the ambient brightness is reflected in the cab, the ambient color is not, and the cab always appears as if reflecting white light.

==Syntax==

Each line in the file can be empty (or solely consist of white spaces) and will be ignored, can mark the beginning of a new section or contain key-value pairs inside a section. All key-value pairs relate to the last section opened.

A new section is opened by starting the line with an opening bracket (U+005B) and ending it with a closing bracket (U+005D). The text in-between the brackets indicates the name of the section and is case-insensitive. White spaces at the beginning and the end of the line are ignored, as well as at the beginning and the end of the name of the section. Thus, the beginning of the section has the following form:

===[NameOfTheSection]===
<pre><nowiki>
[NameOfTheSection]
</nowiki></pre>

A key-value pair is indicated by giving the key, an equals sign (U+003D) and then the value. The key is case-insensitive. White spaces at the beginning and the end of the line are ignored, as well as in front and after the equals sign. Alternatively, white spaces surrounding the key and the value are ignored. Thus, a key-value pair as the following form:

===[NameOfTheKey]===
<pre><nowiki>
NameOfTheKey = Value
</nowiki></pre>

Some values are further split into multiple parts, separated by commas (U+002C). Instead of a comma, a colon (U+003A) can be used interchangeably.

You can use comments anywhere at the end of a line. A comment is started by a semicolon (U+003B). Comments, if present, are stripped away from all lines before these are processed.

==The Panel Section==
===[View]===
The View section defines the viewing angle conditions. Only one View section is expected in a panel.cfg file.

<pre><nowiki>
[View]
</nowiki></pre>

This starts the section

===Yaw===
<pre><nowiki>
Yaw = ValueInDegrees
</nowiki></pre>

''ValueInDegrees: A floating-point number measured in degrees indicating the yaw. Positive values represent right, negative ones left. The default value is 0.''

===Pitch===
<pre><nowiki>
Pitch = ValueInDegrees
</nowiki></pre>
''ValueInDegrees: A floating-point number measured in degrees indicating the pitch. Positive values represent up, negative ones down. The default value is 0.''

Defines the pitch of the view. Any value entered will be additionally subtract by 11 degrees, resulting in a slight downward pitch if ValueInDegrees is 0. If this key-value pair is not used, the final viewing angle will be -11 degrees.

==The PressureIndicator Section==

This section creates a pressure indicator. You can use as many of these sections as required.

===[PressureIndicator]===
<pre><nowiki>
[PressureIndicator]
</nowiki></pre>

*''The following spelling variations can be used: PressureIndicator, PressureGauge, PressureMeter, 圧力計''

===Type===
This starts the section.

<pre><nowiki>
Type = Value
</nowiki></pre>

''Value: The type of pressure indicator to use. The default value is 0.''

Options for Value:
0: The pressure indicator is a gauge.
1: The pressure indicator is an LED.

[[File:Illustration_pressuregauge.png]] [[File:Illustration_pressuregauge_led.png]]

This defines the type of the pressure indicator. While both the gauge type and the LED type indicators can show two different pressures, this is not generally useful for the LED type as the upper LED shape will block the view into the lower LED shape.

*''The following spelling variations can be used: Type, 形態''

===LowerNeedle===

<pre><nowiki>
LowerNeedle = Subject, RedValue, GreenValue, BlueValue
</nowiki></pre>

''Subject: The kind of pressure to indicate.''

''RedValue: The red component of the color. Measured from 0 (black) to 255 (red). The default value is 0.''

''GreenValue: The green component of the color. Measured from 0 (black) to 255 (green). The default value is 0.''

''BlueValue: The blue component of the color. Measured from 0 (black) to 255 (blue). The default value is 0.''

*Options for Subject
''0: Does not show the lower needle.''

''1 or BC or ブレーキシリンダ: Indicates the pressure of the brake cylinder.''

''2 or BP or ブレーキ管 or 制動管: Indicates the pressure of the brake pipe.''

''3 or ER or 釣り合い空気溜め or 釣り合い空気ダメ or つりあい空気溜め or ツリアイ空気ダメ: Indicates the pressure of the equalizing reservoir.''

''4 or MR or 元空気溜め or 元空気ダメ: Indicates the pressure of the main reservoir.''

''5 or SAP or 直通管: Indicates the pressure of the straight air pipe.''

Creates the lower needle for a gauge-type pressure indicator, or defines the color of the lower shape for an LED-type indicator.

*''The following spelling variations can be used:
LowerNeedle, LowerHand, 下針''

===UpperNeedle===

<pre><nowiki>
UpperNeedle = Subject, RedValue, GreenValue, BlueValue
</nowiki></pre>

''Subject: The kind of pressure to indicate.''

''RedValue: The red component of the color. Measured from 0 (black) to 255 (red). The default value is 0.''

''GreenValue: The green component of the color. Measured from 0 (black) to 255 (green). The default value is 0.''

''BlueValue: The blue component of the color. Measured from 0 (black) to 255 (blue). The default value is 0.''

*Options for Subject
''0: Does not show the upper needle.''

''1 or BC or ブレーキシリンダ: Indicates the pressure of the brake cylinder.''

''2 or BP or ブレーキ管 or 制動管: Indicates the pressure of the brake pipe.''

''3 or ER or 釣り合い空気溜め or 釣り合い空気ダメ or つりあい空気溜め or ツリアイ空気ダメ: Indicates the pressure of the equalizing reservoir.''

''4 or MR or 元空気溜め or 元空気ダメ: Indicates the pressure of the main reservoir.''

''5 or SAP or 直通管: Indicates the pressure of the straight air pipe.''

Creates the upper needle for a gauge-type pressure indicator, or defines the color of the lower shape for an LED-type indicator.

*''The following spelling variations can be used: UpperNeedle, UpperHand, 上針''

===Center===
<pre><nowiki>
Center = X, Y
</nowiki></pre>

''X: The X-coordinate in the panel image at which the center of the pressure indicator is placed in pixels. The default value is 0.''

''Y: The Y-coordinate in the panel image at which the center of the pressure indicator is placed in pixels. The default value is 0.''

*''The following spelling variations can be used: Center, 中心''

===Radius===
<pre><nowiki>
Radius = ValueInPixels
</nowiki></pre>

''ValueInPixels: The radius of the pressure indicator in pixels. The default value is 16.''

For gauge-type indicators, defines the radius of the pressure gauge needle in pixels. For LED-type indicators, defines half the edge length of the LED-square in pixels. The radius is measured in pixels of the panel image.

*''The following spelling variations can be used: Radius, 半径''

===Background===
<pre><nowiki>
Background = Filename
</nowiki></pre>

''FileName: The background image to use, relative to the train folder.''

Creates a background for the pressure indicator. The background is shown below the needles or the LED-square. Pure blue in the image (red=0, green=0, blue=255) represents transparent pixels.

*''The following spelling variations can be used: Background, 背景''

===Cover===

<pre><nowiki>
Cover = Filename
</nowiki></pre>

''FileName: The cover image to use, relative to the train folder.''

Creates a cover for the pressure indicator. The cover is shown on top of the needles or the LED-square. Pure blue in the image (red=0, green=0, blue=255) represents transparent pixels.

*''The following spelling variations can be used:
Cover, ふた''

===Unit===

<pre><nowiki>
Unit = Value
</nowiki></pre>

''Value: The type of unit to use for the Minimum and Maximum settings. The default value is 0.''

*Options for Value:
''0 or kpa: The unit is kilo-pascal (1000 Pa).''

''1 or kgf/cm2 or kgf/cm^2 or kg/cm2 or kg/cm^2: The unit is kilogram-force per centimeter squared (98066.5 Pa).''

*''The following spelling variations can be used:
Unit, 単位''

===Minimum===

<pre><nowiki>
Minimum = PressureValue
</nowiki></pre>

''PressureValue: The minimum pressure corresponding to Angle. The unit is defined via Unit.''

Defines the minimum pressure corresponding to the Angle measured clockwise from the 6 o'clock position. The default value is 0.

*''The following spelling variations can be used: Minimum, 最小''

===Maximum===

<pre><nowiki>
Maximum = Pressurevalue
</nowiki></pre>

''PressureValue: The maximum pressure corresponding to Angle. The unit is defined via Unit.''

Defines the maximum pressure corresponding to the Angle measured counter-clockwise from the 6 o'clock position. The default value is 1000.

*''The following spelling variations can be used: Maximum, 最大''

===Angle===

<pre><nowiki>
Angle = ValueInDegrees
</nowiki></pre>

''ValueInDegrees: The angle corresponding to the Minimum and Maximum pressures in degrees.''

Defines the angle, measured clockwise from the 6 o'clock position, corresponding to the Minimum pressure, and also the angle, measured counter-clockwise from the 6 o'clock position, corresponding to the Maximum pressure. The default value is 45.

*''The following spelling variations can be used: Angle, 角度''

==To Be Finished Later==
This article will be finished later.

Panel2.cfg

2015-02-07T00:25:41Z

Kevin: Created page with " The '''panel2.cfg''' file format {| style="border: 0px currentColor; margin-right: 1..."

The '''panel2.cfg''' file format 

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| 
|}

 

{|
|- style="height: 4px"
|
|}

■ 1. Overview

----

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| 
|}

The panel2.cfg file allows to create 2D panels by defining which elements to use, like lamps, needles, etc., what they are intended to display and where they are to be placed. The panel2.cfg file is a plain text file encoded in any arbitrary [http://trainsimframework.org/develop/information_encodings.html encoding], however, UTF-8 with a byte order mark is the preferred choice. The [http://trainsimframework.org/develop/information_numberformats.html parsing model] for numbers is '''Loose''', however, you are encouraged to produce ''Strict'' output nonetheless. The file is required to be located inside the train folder and is expected to be named '''panel2.cfg'''. The file is interpreted on a per-line basis, from top to bottom. 

{|
|- style="height: 4px"
|
|}

{| style="border: 1px dashed currentColor; margin-right: 20pt; margin-left: 20pt"
| style="border: 2px ridge currentColor" bgcolor="#ffe080" | '''ⓘ''' Layers
|-
| bgcolor="#ffffff" | All elements in the panel are associated layers. The layer is described as an integer, where small values represent the background and high numbers the foreground. When placing elements, you should make sure that no overlapping elements share the same layer number. The background image of the panel is always associated layer number 0, so elements on top of it should start with layer number 1 or higher. If you want to place elements behind the panel background image, you can likewise use negative numbers to represent these layers.
|}

{|
|- style="height: 4px"
|
|}

 

{|
|- style="height: 4px"
|
|}

{| style="border: 1px dashed currentColor; margin-right: 20pt; margin-left: 20pt"
| style="border: 2px ridge currentColor" bgcolor="#ffe080" | '''ⓘ''' Daytime and nighttime images
|-
| bgcolor="#ffffff" | For all elements that take a texture, you can specify distinct daytime and nighttime textures. Depending on the lighting conditions and additional route instructions, openBVE will display any intermediate blend between the daytime and nighttime textures. If no nighttime textures are used, the daytime images will be darkened to simulate corresponding nighttime images.
|}

{|
|- style="height: 4px"
|
|}

 ➟ [http://trainsimframework.org/develop/train_panel2_cfg_quick.html See also the quick reference for the panel2.cfg...] 

{|
|- style="height: 4px"
|
|}

{| style="border: 1px dashed currentColor; margin-right: 20pt; margin-left: 20pt"
| style="border: 2px ridge currentColor" bgcolor="#ffe080" | '''ⓘ''' Overlay and Lighting
|-
| bgcolor="#ffffff" | The cab is rendered as an overlay. This means that the cab will always appear in front of scenery objects. This is intentional, because this way, rain, walls and other obstructing objects cannot be accidentally rendered inside the cab. Furthermore, lighting in the cab is different than in the scenery. While the ambient brightness is reflected in the cab, the ambient color is not, and the cab always appears as if reflecting white light.
|}

{|
|- style="height: 4px"
|
|}

 

{|
|- style="height: 4px"
|
|}

■ 2. Syntax

----

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| 
|}

 Each line in the file can be empty (or solely consist of white spaces) and will be ignored, can mark the beginning of a new section or contain key-value pairs inside a section. All key-value pairs relate to the last section opened. A new section is opened by starting the line with an opening bracket (U+005B) and ending it with a closing bracket (U+005D). The text in-between the brackets indicates the name of the section and is case-insensitive. White spaces at the beginning and the end of the line are ignored, as well as at the beginning and the end of the name of the section. Thus, the beginning of the section has the following form: 

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | [NameOfTheSection]
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| 
|}

 A key-value pair is indicated by giving the key, an equals sign (U+003D) and then the value. The key is case-insensitive. White spaces at the beginning and the end of the line are ignored, as well as in front and after the equals sign. Alternatively, white spaces surrounding the key and the value are ignored. Thus, a key-value pair as the following form: 

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | NameOfTheKey = Value
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| 
|}

 Some values are further split into multiple parts, separated by commas (U+002C). You can use comments anywhere at the end of a line. A comment is started by a semicolon (U+003B). Comments, if present, are stripped away from all lines before these are processed. 

{|
|- style="height: 4px"
|
|}

■ 3. The This section

----

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| 
|}

The This section defines the background image to use for the panel and which resolution the panel has. Only one This section may be used within the file. 

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | [This]
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| 
|}

This starts the section. 

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | Resolution = ''Value''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| '''''Value'''''<nowiki>: A floating-point number representing the width measured on the panel background image that corresponds to the width of the screen for the default camera position, alignment and zoom.</nowiki>
|}

 

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | Left = ''Value''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| '''''Value'''''<nowiki>: A floating-point representing which x-coordinate in the panel background corresponds to the farthest point to which can be scrolled left. The point is not required to lie within the bounds of the background image.</nowiki>
|}

 

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | Right = ''Value''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| '''''Value'''''<nowiki>: A floating-point representing which x-coordinate in the panel background corresponds to the farthest point to which can be scrolled right. The point is not required to lie within the bounds of the background image. </nowiki>
|}

 

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | Top = ''Value''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| '''''Value'''''<nowiki>: A floating-point representing which y-coordinate in the panel background corresponds to the farthest point to which can be scrolled up. The point is not required to lie within the bounds of the background image.</nowiki>
|}

 

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | Bottom = ''Value''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| '''''Value'''''<nowiki>: A floating-point representing which y-coordinate in the panel background corresponds to the farthest point to which can be scrolled down. The point is not required to lie within the bounds of the background image.</nowiki>
|}

 

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | DaytimeImage = ''FileName''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| '''''FileName'''''<nowiki>: The image file to use as the daytime version of the panel background image, relative to the train folder. If not specified, no background image will be shown. </nowiki>
|}

 

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | NighttimeImage = ''FileName''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| '''''FileName'''''<nowiki>: The image file to use as the nighttime version of the panel background image, relative to the train folder. If specified, the daytime version must also be specified. Otherwise, no nighttime version will be available. </nowiki>
|}

 

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | TransparentColor = ''HexColor''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| '''''HexColor'''''<nowiki>: A </nowiki>[http://trainsimframework.org/develop/information_numberformats.html#colors hexcolor] representing the exact color in both the ''DaytimeImage'' and ''NighttimeImage'' files which corresponds to a transparent pixel. The default value is #0000FF.
|}

 

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | Center = ''X'', ''Y''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| '''''X'''''<nowiki>: A floating-point number representing the x-coordinate of the panel background image that corresponds to the center of the screen.</nowiki> '''''Y'''''<nowiki>: A floating-point number representing the y-coordinate of the panel background image that corresponds to the center of the screen. </nowiki>
|}

Defines which pixel in the background image corresponds to the center of the screen for the default camera position. The relation between ''Center'' and ''Origin'' influences the yaw and pitch of the cab alignment. 

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | Origin = ''X'', ''Y''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| '''''X'''''<nowiki>: A floating-point number representing the x-coordinate of the panel background image that corresponds to the vanishing point.</nowiki> '''''Y'''''<nowiki>: A floating-point number representing the y-coordinate of the panel background image that corresponds to the vanishing point.</nowiki>
|}

Defines which pixel in the background image corresponds to the vanishing point for the default camera position. This is the point to which the two rails converge at the horizon on a straight piece of track. The relation between ''Center'' and ''Origin'' influences the yaw and pitch of the cab alignment. [[Image:illustration_center_origin.png]] 

{|
|- style="height: 4px"
|
|}

{| style="border: 1px dashed currentColor; margin-right: 20pt; margin-left: 20pt"
| style="border: 2px ridge currentColor" bgcolor="#ffe080" | '''ⓘ''' When camera restriction affects the default camera setup 
|-
| bgcolor="#ffffff" | Camera restriction is the built-in functionality to limit the camera view inside cabs created by the panel2.cfg to the rectangle as specified via ''Left'', ''Right'', ''Top'' and ''Bottom''. If your setup of ''Center'' and ''Resolution'' would force the camera to show parts that are outside of that specified region even with the default camera settings, the camera position will be altered to guarantee that the view stays inside the cab region. In order to verify that your ''Center'' and ''Origin'' setup is unaffected by this, disable camera restriction by hitting the CAMERA_RESTRICTION key (default: CTRL+R) and then reset the camera by hitting the CAMERA_RESET key (default: num 5). The ''Center'' and ''Origin'' values will now be exactly as scripted, thereby revealing possible problems in the relations of ''Resolution'', ''Left'', ''Right'', ''Top'', ''Bottom'', ''Center'' and ''Origin''.
|}

{|
|- style="height: 4px"
|
|}

 

{|
|- style="height: 4px"
|
|}

■ 4. The PilotLamp section

----

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| 
|}

The PilotLamp section creates an indicator that can be made visible or invisible. You can use as many of these sections as required. The ''DaytimeImage'' is required to be specified if you make use of the PilotLamp section. The ''Subject'' used needs to return 1 if the PilotLamp is to be made visible, otherwise it will be invisible. 

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | [PilotLamp]
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| 
|}

This starts the section. 

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | Subject = ''Subject''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| '''''Subject'''''<nowiki>: One of the </nowiki>[http://trainsimframework.org/develop/train_panel2_cfg.html#subjects available subjects]. The default subject is '''true'''. 
|}

 

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | Location = ''Left'', ''Top''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| '''''Left'''''<nowiki>: A floating-point number representing the x-coordinate at which the left of the image is inserted. The default value is 0.</nowiki> '''''Top'''''<nowiki>: A floating-point number representing the y-coordinate at which the top of the image is inserted. The default value is 0.</nowiki>
|}

 

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | DaytimeImage = ''FileName''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| '''''FileName'''''<nowiki>: The image file to use as the daytime version of the indicator image, relative to the train folder. </nowiki>'''''Is required to be specified.''''' 
|}

 

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | NighttimeImage = ''FileName''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| '''''FileName'''''<nowiki>: The image file to use as the nighttime version of the indicator image, relative to the train folder. If not specified, no nighttime version will be available. </nowiki>
|}

 

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | TransparentColor = ''HexColor''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| '''''HexColor'''''<nowiki>: A </nowiki>[http://trainsimframework.org/develop/information_numberformats.html#colors hexcolor] representing the exact color in both the ''DaytimeImage'' and ''NighttimeImage'' files which corresponds to a transparent pixel. The default value is #0000FF.
|}

 

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | Layer = ''LayerIndex''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| '''''LayerIndex'''''<nowiki>: An integer which uniquely defines this element among overlapping elements. Lower numbers represent the background and higher numbers the foreground. Elements may use the same </nowiki>''LayerIndex'' as long as they do not overlap. The default value is 0.
|}

 

{|
|- style="height: 4px"
|
|}

■ 5. The Needle section

----

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| 
|}

The Needle section creates a rotating element, or needle. You can use as many of these sections as required. The image used for the Needle, defined by ''DaytimeImage'' (required) or ''NighttimeImage'' (optional), will be rotated around a defined ''Origin'' and optionally scaled if ''Radius'' is used. The needle depicted in the image should be pointing up. 

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | [Needle]
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| 
|}

This starts the section. 

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | Subject = ''Subject''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| '''''Subject'''''<nowiki>: One of the </nowiki>[http://trainsimframework.org/develop/train_panel2_cfg.html#subjects available subjects]. The default subject is '''true'''. 
|}

 

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | Location = ''CenterX'', ''CenterY''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| '''''CenterX'''''<nowiki>: A floating-point number representing the x-coordinate of the center of rotation in terms of the background image. The default value is 0.</nowiki> '''''CenterY'''''<nowiki>: A floating-point number representing the y-coordinate of the center of rotation in terms of the background image. The default value is 0. </nowiki>
|}

 

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | Radius = ''ValueInPixels''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| '''''ValueInPixels'''''<nowiki>: A non-zero floating-point number that redefines the radius of the element in pixels relative to the background image. The default value is </nowiki>''Y'' from the ''Origin'' key-value pair.
|}

The ''Y'' value in the ''Origin'' key-value pair defines the vertical point of rotation, but also defines the actual radius of the element in the bitmap's own pixel coordinates. If ''ValueInPixels'' is set to a different value than this actual radius, the image will be scaled by a factor of ''Radius'' / ''Y'', while preserving the ''Origin''-''Center'' relation. If you do not want to scale the image, set ''ValueInPixels'' to the same value as ''Y'' in the ''Origin'' key-value pair, or omit ''Radius'' altogether. 

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | DaytimeImage = ''FileName''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| '''''FileName'''''<nowiki>: The image file to use as the daytime version of the needle image, relative to the train folder. </nowiki>'''''Is required to be specified.'''''
|}

 

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | NighttimeImage = ''FileName''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| '''''FileName'''''<nowiki>: The image file to use as the nighttime version of the needle image, relative to the train folder. If not specified, no nighttime version will be available. </nowiki>
|}

 

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | Color = ''HexColor''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| '''''HexColor'''''<nowiki>: A </nowiki>[http://trainsimframework.org/develop/information_numberformats.html#colors hexcolor] representing the color by which the images are multiplied with. The default value is #FFFFFF.
|}

Multiplies the images by the color specified by ''HexColor''. Setting ''HexColor'' to '''<nowiki>#FFFFFF</nowiki>''' (white) preserves the original color of the images, while setting ''HexColor'' to '''<nowiki>#000000</nowiki>''' (black) produces black images. Pixels defined as being transparent via ''TransparentColor'' are not affected. 

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | TransparentColor = ''HexColor''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| '''''HexColor'''''<nowiki>: A </nowiki>[http://trainsimframework.org/develop/information_numberformats.html#colors hexcolor] representing the exact color in both the ''DaytimeImage'' and ''NighttimeImage'' files which corresponds to a transparent pixel. The default value is #0000FF.
|}

 

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | Origin = ''X'', ''Y''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| '''''X'''''<nowiki>: A floating-point number representing the x-coordinate that corresponds to the image's center of rotation. The default value is half the image width.</nowiki> '''''Y'''''<nowiki>: A floating-point number representing the y-coordinate that corresponds to the image's center of rotation. The default value is half the image height.</nowiki>
|}

 

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | InitialAngle = ''ValueInDegrees''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| '''''ValueInDegrees'''''<nowiki>: A floating-point number representing the angle </nowiki>'''in degrees''' that corresponds to the ''Minimum'' value. The angle is measured clock-wise from the 12 o'clock position. The default value is -120.
|}

 

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | LastAngle = ''ValueInDegrees''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| '''''ValueInDegrees'''''<nowiki>: A floating-point number representing the angle </nowiki>'''in degrees''' that corresponds to the ''Maximum'' value. The angle is measured clock-wise from the 12 o'clock position. The default value is 120.
|}

 

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | Minimum = ''Value''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| '''''Value'''''<nowiki>: A floating-point value corresponding to the value returned by the </nowiki>''Subject'' in use that should be linked to the ''InitialAngle''. The default value is 0. 
|}

 

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | Maximum = ''Value''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| '''''Value'''''<nowiki>: A floating-point value corresponding to the value returned by the </nowiki>''Subject'' in use that should be linked to the ''LastAngle''. The default value is 1000. 
|}

 

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | NaturalFreq = ''Value''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| '''''Value'''''<nowiki>: A non-negative floating-point number representing the natural frequency of an assumed undamped oscillatory system. If not specified, damping will not be performed.</nowiki>
|}

Defines the natural frequency. In an undamped oscillatory system, this is the angular frequency in radians per second. As soon as damping is performed, the frequency will decrease with convergence of the oscillator. A natural frequency of 0 will not allow any rotation to be performed. Higher values roughly correspond to radians per second. If specified, ''DampingRatio'' should also be specified. 

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | DampingRatio = ''Value''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| '''''Value'''''<nowiki>: A non-negative floating-point number representing the damping ratio. If not specified, damping will not be performed.</nowiki>
|}

Defines the damping ratio for the oscillatory system. Values between 0 and 1 represent [http://en.wikipedia.org/wiki/Damping#Under-damping under-damping], 1 represents [http://en.wikipedia.org/wiki/Damping#Critical_damping critical damping] and values above 1 represent [http://en.wikipedia.org/wiki/Damping#Over-damping over-damping]. Compare the following illustration in which the angle of rotation changes from 0 to 1 over time: [[Image:300px-2nd_Order_Damping_Ratios.svg.png]] If specified, ''NaturalFreq'' should also be specified. 

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | Layer = ''LayerIndex''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| '''''LayerIndex'''''<nowiki>: An integer which uniquely defines this element among overlapping elements. Lower numbers represent the background and higher numbers the foreground. Elements may use the same </nowiki>''LayerIndex'' as long as they do not overlap. The default value is 0.
|}

 

{|
|- style="height: 4px"
|
|}

■ 6. The DigitalNumber section

----

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| 
|}

The DigitalNumber section creates an indicator that can switch between multiple states, useful to build up a display of decimal digits. You can use as many of these sections as required. The image used for the DigitalNumber, defined by ''DaytimeImage'' (required) and ''NighttimeImage'' (optional), is comprised of the individual states, which are stacked vertically, anchored at the top of the image. The width of a single state is equal to the width of the image, while the height of a single state is defined by ''Interval'' (required). The ''Subject'' used needs to return an integer from 0 (first element) to ''n''-1 (last element), where ''n'' is the number of elements. If a value outside of that range is returned by ''Subject'', the DigitalNumber will be made invisible. 

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | [DigitalNumber]
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| 
|}

This starts the section. 

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | Subject = ''Subject''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| '''''Subject'''''<nowiki>: One of the </nowiki>[http://trainsimframework.org/develop/train_panel2_cfg.html#subjects available subjects]. The default subject is '''true'''. 
|}

 

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | Location = ''Left'', ''Top''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| '''''Left'''''<nowiki>: A floating-point number representing the x-coordinate at which the left of the image is inserted. The default value is 0.</nowiki> '''''Top'''''<nowiki>: A floating-point number representing the y-coordinate at which the top of the image is inserted. The default value is 0.</nowiki>
|}

 

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | DaytimeImage = ''FileName''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| '''''FileName'''''<nowiki>: The image file to use as the daytime version of the DigitalNumber image, relative to the train folder. </nowiki>'''''Is required to be specified.''''' 
|}

 

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | NighttimeImage = ''FileName''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| '''''FileName'''''<nowiki>: The image file to use as the nighttime version of the DigitalNumber image, relative to the train folder. If not specified, no nighttime version will be available. </nowiki>
|}

 

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | TransparentColor = ''HexColor''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| '''''HexColor'''''<nowiki>: A </nowiki>[http://trainsimframework.org/develop/information_numberformats.html#colors hexcolor] representing the exact color in both the ''DaytimeImage'' and ''NighttimeImage'' files which corresponds to a transparent pixel. The default value is #0000FF.
|}

 

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | Interval = ''Height''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| '''''Height'''''<nowiki>: The height of a single state in the images in pixels. </nowiki>'''''Is required to be specified.'''''
|}

 

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | Layer = ''LayerIndex''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| '''''LayerIndex'''''<nowiki>: An integer which uniquely defines this element among overlapping elements. Lower numbers represent the background and higher numbers the foreground. Elements may use the same </nowiki>''LayerIndex'' as long as they do not overlap. The default value is 0.
|}

 

{|
|- style="height: 4px"
|
|}

■ 7. The DigitalGauge section

----

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| 
|}

The DigitalGauge section creates a solid-color square of which only a radial section is shown at a time. You can use as many of these sections as required. There are three important angles to consider. The ''InitialAngle'' defines which angle corresponds to the ''Minimum'' value, while ''LastAngle'' defines which angle corresponds to the ''Maximum'' value. The current value at a given time corresponds to the current angle. The solid-color square will only show the part that is between the current angle and the ''LastAngle''. If ''InitialAngle'' is less than ''LastAngle'', the solid-color square will wind clockwise. If ''InitialAngle'' is greater than ''LastAngle'', the solid-color square will wind counter-clockwise. The subject needs to return a value that meaningfully works together with the ''Minimum'' and ''Maximum'' settings. [[Image:illustration_digitalgauge_1.png]] [[Image:illustration_digitalgauge_2.png]] 

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | [DigitalGauge]
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| 
|}

This starts the section. 

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | Subject = ''Subject''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| '''''Subject'''''<nowiki>: One of the </nowiki>[http://trainsimframework.org/develop/train_panel2_cfg.html#subjects available subjects]. The default subject is '''true'''. 
|}

 

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | Location = ''CenterX'', ''CenterY''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| '''''CenterX'''''<nowiki>: A floating-point number representing the x-coordinate at which the left of the image is inserted. The default value is 0.</nowiki> '''''CenterY'''''<nowiki>: A floating-point number representing the y-coordinate at which the top of the image is inserted. The default value is 0.</nowiki>
|}

 

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | Radius = ''ValueInPixels''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| '''''ValueInPixels'''''<nowiki>: A non-zero floating-point number representing half the edge length of the solid-color square in pixels. </nowiki>'''''Is required to be specified.''''' 
|}

If ''Radius'' is negative, it is treated as if it was positive, but the entire LED is rotated by 180 degrees. 

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | Color = ''HexColor''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| '''''HexColor'''''<nowiki>: A </nowiki>[http://trainsimframework.org/develop/information_numberformats.html#colors hexcolor] representing the color of the solid-color square. The default value is #FFFFFF.
|}

 

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | InitialAngle = ''ValueInDegrees''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| '''''ValueInDegrees'''''<nowiki>: A floating-point number representing the angle </nowiki>'''in degrees''' that corresponds to the ''Minimum'' value. The angle is measured clock-wise from the 12 o'clock position. The default value is -120.
|}

{|
| ⚠
|
| bgcolor="#e0e0e0" |
| bgcolor="#e0e0e0" | The absolute difference between ''InitialAngle'' and ''LastAngle'' may not exceed 360 degrees.
| bgcolor="#e0e0e0" |
|}

 

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | LastAngle = ''ValueInDegrees''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| '''''ValueInDegrees'''''<nowiki>: A floating-point number representing the angle </nowiki>'''in degrees''' that corresponds to the ''Maximum'' value. The angle is measured clock-wise from the 12 o'clock position. The default value is 120.
|}

{|
| ⚠
|
| bgcolor="#e0e0e0" |
| bgcolor="#e0e0e0" | The absolute difference between ''InitialAngle'' and ''LastAngle'' may not exceed 360 degrees.
| bgcolor="#e0e0e0" |
|}

 

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | Minimum = ''Value''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| '''''Value'''''<nowiki>: A floating-point value corresponding to the value returned by the </nowiki>''Subject'' in use that should be linked to the ''InitialAngle''. The default value is 0. 
|}

 

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | Maximum = ''Value''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| '''''Value'''''<nowiki>: A floating-point value corresponding to the value returned by the </nowiki>''Subject'' in use that should be linked to the ''LastAngle''. The default value is 1000. 
|}

 

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | Step = ''Value''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| '''''Value'''''<nowiki>: A floating-point value representing the step in which values on the solid-color square can increase. The value to be displayed via the solid-color square will be rounded down to the next integer multiple of </nowiki>''Value''. If ''Value'' is negative, values will be rounded up to the absolute value of ''Value'' instead. If ''Value'' is 0, increases will be smooth. The default value is 0.
|}

 

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | Layer = ''LayerIndex''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| '''''LayerIndex'''''<nowiki>: An integer which uniquely defines this element among overlapping elements. Lower numbers represent the background and higher numbers the foreground. Elements may use the same </nowiki>''LayerIndex'' as long as they do not overlap. The default value is 0.
|}

 

{|
|- style="height: 4px"
|
|}

■ 8. The Timetable section

----

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| 
|}

The Timetable section defines where to place custom timetables. The actual images are loaded via the route file. Only one Timetable section may be used within the file. 

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | [Timetable]
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| 
|}

This starts the section. 

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | Location = ''Left'', ''Top''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| '''''Left'''''<nowiki>: A floating-point number representing the x-coordinate at which the left of the image is inserted. The default value is 0.</nowiki> '''''Top'''''<nowiki>: A floating-point number representing the y-coordinate at which the top of the image is inserted. The default value is 0.</nowiki>
|}

 

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | Width = ''ValueInPixels''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| '''''ValueInPixels'''''<nowiki>: A positive floating-point number representing the width of the timetable measured in terms of the background image. </nowiki>'''''Is required to be specified.'''''
|}

 

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | Height = ''ValueInPixels''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| '''''ValueInPixels'''''<nowiki>: A positive floating-point number representing the height of the timetable measured in terms of the background image. </nowiki>'''''Is required to be specified.'''''
|}

 

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | TransparentColor = ''HexColor''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| '''''HexColor'''''<nowiki>: A </nowiki>[http://trainsimframework.org/develop/information_numberformats.html#colors hexcolor] representing the exact color in both the daytime and nighttime versions of the timetable which corresponds to a transparent pixel. The default value is #0000FF.
|}

 

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | Layer = ''LayerIndex''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| '''''LayerIndex'''''<nowiki>: An integer which uniquely defines this element among overlapping elements. Lower numbers represent the background and higher numbers the foreground. Elements may use the same </nowiki>''LayerIndex'' as long as they do not overlap. The default value is 0.
|}

 

{|
|- style="height: 4px"
|
|}

■ 9. Available subjects

----

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| 
|}

A subject is composed of a base subject and an optional subject suffix. The subject controls what information is fed to the element that uses the subject. For example, a ''Needle'' can use the subject ''kmph'' to be fed with the current speed of the train in kilometers per hour, or with the ''mr'' subject to show the main reservoir pressure. 

{|
|- style="height: 4px"
|
|}

● Base subjects

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| 
|}

{|
|- style="height: 2px"
|
|}

{| style="border-collapse: collapse"
! style="padding: 4px; border: 2px ridge currentColor" bgcolor="#d0d0d0" | Base subject
! style="padding: 4px; border: 2px ridge currentColor" bgcolor="#d0d0d0" | Description
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | acc
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | Returns the (signed) acceleration of the train in meters per second squared (m/s²).
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | atc
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | Equivalent to ''ats271''.
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | ats''i''
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | Returns the state of the ''i''th plugin variable, depending on the plugin used. This is the same as pluginState[''i''] in animated objects. For the built-in safety systems ATS and ATC, see below.
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | bc
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | Returns the pressure of the brake cylinder in kPa (1000 Pa).
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | bp
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | Returns the pressure of the brake pipe in kPa (1000 Pa).
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | brake
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | Returns the currently selected brake notch. For trains with automatic air brakes, 0 represents ''RELEASE'', 1 represents ''LAP'', 2 represents ''SERVICE'' and 3 represents the emergency brake. For trains without a hold brake device, 0 represents released brakes, ''i'' represents brake notch ''i'' and ''n''+1 represents the emergency brake, where ''n'' is the number of brake notches the train has. For trains with a hold brake device, 0 represents released brakes, 1 represents the hold brake, ''i''+1 represents brake notch ''i'', and ''n''+2 represents the emergency brakes, where ''n'' is the number of brake notches the train has.
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | csc
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | Returns 1 if the const speed system is currently active and 0 otherwise.
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | door
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | Returns a value between 0 (open doors) and 1 (closed doors).
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | doorl''i''
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | Returns a value between 0 (open) and 1 (closed) for the left doors of car ''i'', or 2 if the car does not exist. Car index 0 represents the first car in the train, and ''n''-1 the last car, where ''n'' is the number of cars in the train.
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | doorr''i''
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | Returns a value between 0 (open) and 1 (closed) for the right doors of car ''i'', or 2 if the car does not exist. Car index 0 represents the first car in the train, and ''n''-1 the last car, where ''n'' is the number of cars in the train.
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | er
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | Returns the pressure of the equalizing reservoir in kPa (1000 Pa).
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | hour
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | Returns the integer part of the current hour.
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | kmph
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | Returns the absolute speed of the train in kilometers per hour (km/h).
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | min
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | Returns the integer part of the current minute.
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | motor
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | Returns the acceleration which the motor of the first motor car currently generates in m/s².
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | mph
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | Returns the absolute speed of the train in international miles per hour (mph).
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | mr
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | Returns the pressure of the main reservoir in kPa (1000 Pa).
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | ms
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | Returns the absolute speed of the train in meters per second (m/s).
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | power
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | Returns the currently selected power notch. This is an integer between 0 and ''n'', where ''n'' is the number of power notches the train has.
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | rev
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | Returns the currently selected reverser position. 0 represents backward, 1 represents neutral and 2 represents forward.
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | sap
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | Returns the pressure of the straight air pipe in kPa (1000 Pa).
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | sec
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | Returns the integer part of the current second.
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | true
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | Always returns 1. This is useful for the ''PilotLamp'' element in order to always show the associated bitmap.
|}

 If ats''i'' is used with the built-in safety systems ATS and ATC, the following mapping for ''i'' applies: 

{| style="border-collapse: collapse"
! style="padding: 4px; border: 2px ridge currentColor" bgcolor="#d0d0d0" | ''i''
! style="padding: 4px; border: 2px ridge currentColor" bgcolor="#d0d0d0" | English
! style="padding: 4px; border: 2px ridge currentColor" bgcolor="#d0d0d0" | 日本語
! style="padding: 4px; border: 2px ridge currentColor" bgcolor="#d0d0d0" | Return values
! style="padding: 4px; border: 2px ridge currentColor" bgcolor="#d0d0d0" |
! style="padding: 4px; border: 2px ridge currentColor" bgcolor="#d0d0d0" | ats271
! style="padding: 4px; border: 2px ridge currentColor" bgcolor="#d0d0d0" | Meaning
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | 256
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | ATS
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | ATS
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | 0 (unlit) or 1 (lit)
! style="padding: 4px; border: 2px ridge currentColor" bgcolor="#d0d0d0" |
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | 0
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | ATC not available
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | 257
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | ATS RUN
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | ATS 作動
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | 0 (unlit), 1 (lit) or 2 (flashing)
! style="padding: 4px; border: 2px ridge currentColor" bgcolor="#d0d0d0" |
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | 1
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | 0 km/h
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | 258
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | ATS RUN
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | ATS 作動
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | 0 (unlit / non-flashing), 1 (lit / flashing)
! style="padding: 4px; border: 2px ridge currentColor" bgcolor="#d0d0d0" |
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | 2
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | 15 km/h
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | 259
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | P POWER
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | P 電源
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | 0 (unlit) or 1 (lit)
! style="padding: 4px; border: 2px ridge currentColor" bgcolor="#d0d0d0" |
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | 3
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | 25 km/h
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | 260
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | PTN APPROACH
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | パターン接近
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | 0 (unlit) or 1 (lit)
! style="padding: 4px; border: 2px ridge currentColor" bgcolor="#d0d0d0" |
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | 4
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | 45 km/h
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | 261
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | BRAKE RELEASE
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | ブレーキ開放
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | 0 (unlit) or 1 (lit)
! style="padding: 4px; border: 2px ridge currentColor" bgcolor="#d0d0d0" |
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | 5
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | 55 km/h
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | 262
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | BRAKE APPLY
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | ブレーキ動作
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | 0 (unlit) or 1 (lit)
! style="padding: 4px; border: 2px ridge currentColor" bgcolor="#d0d0d0" |
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | 6
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | 65 km/h
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | 263
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | ATS P
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | ATS-P
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | 0 (unlit) or 1 (lit)
! style="padding: 4px; border: 2px ridge currentColor" bgcolor="#d0d0d0" |
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | 7
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | 75 km/h
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | 264
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | FAILURE
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | 故障
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | 0 (unlit) or 1 (lit)
! style="padding: 4px; border: 2px ridge currentColor" bgcolor="#d0d0d0" |
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | 8
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | 90 km/h
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | 265
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | ATC
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | ATC
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | 0 (unlit) or 1 (lit)
! style="padding: 4px; border: 2px ridge currentColor" bgcolor="#d0d0d0" |
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | 9
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | 100 km/h
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | 266
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | ATC POWER
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | ATC 電源
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | 0 (unlit) or 1 (lit)
! style="padding: 4px; border: 2px ridge currentColor" bgcolor="#d0d0d0" |
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | 10
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | 110 km/h
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | 267
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | ATC SRV
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | ATC 常用
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | 0 (unlit) or 1 (lit)
! style="padding: 4px; border: 2px ridge currentColor" bgcolor="#d0d0d0" |
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | 11
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | 120 km/h
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | 268
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | ATC EMG
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | ATC 非常
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | 0 (unlit) or 1 (lit)
! style="padding: 4px; border: 2px ridge currentColor" bgcolor="#d0d0d0" |
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | 12
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | ATS is active
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | 269
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | CONST SPEED
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | 定速
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | 0 (unlit) or 1 (lit)
! style="padding: 4px; border: 2px ridge currentColor" bgcolor="#d0d0d0" |
! style="padding: 4px; border: 2px ridge currentColor" bgcolor="#d0d0d0" |
! style="padding: 4px; border: 2px ridge currentColor" bgcolor="#d0d0d0" |
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | 270
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | EB
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | EB
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | 0 (unlit) or 1 (lit)
! style="padding: 4px; border: 2px ridge currentColor" bgcolor="#d0d0d0" |
! style="padding: 4px; border: 2px ridge currentColor" bgcolor="#d0d0d0" |
! style="padding: 4px; border: 2px ridge currentColor" bgcolor="#d0d0d0" |
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | 271
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | ATC speed indicator
! style="padding: 4px; border: 2px ridge currentColor" bgcolor="#d0d0d0" |
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | 0 - 12, see table on the right
! style="padding: 4px; border: 2px ridge currentColor" bgcolor="#d0d0d0" |
! style="padding: 4px; border: 2px ridge currentColor" bgcolor="#d0d0d0" |
! style="padding: 4px; border: 2px ridge currentColor" bgcolor="#d0d0d0" |
|}

 

{|
|- style="height: 4px"
|
|}

● Suffixes

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| 
|}

{|
|- style="height: 2px"
|
|}

{| style="border-collapse: collapse"
! style="padding: 4px; border: 2px ridge currentColor" bgcolor="#d0d0d0" | Subject suffix
! style="padding: 4px; border: 2px ridge currentColor" bgcolor="#d0d0d0" | Description
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | d''i''
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | With d0 for the ones, d1 for the tens, d2 for the hundreds, etc., this suffix returns a value between 0 and 9 corresponding to the respective digit of the underlying subject, but only if the value of the subject is less than 10 for d1, less than 100 for d2, etc., otherwise this suffix returns 10.
|}

 '''Example:''' kmphd1 can be used to feed a ''DigitalNumber'' with the tens of the current speed of the train in kilometers per hour. The image used by the ''DigitalNumber'' will thus need to be composed of images from 0 to 10 in order to show all possible states kmphd1 can return, where images 0 through 9 correspond to the digits, and 10 corresponds to an image shown at the tens when the speed is below 10 km/h (e.g. another 0-digit, or blank space).

Panel.animated

2015-02-07T00:25:24Z

Kevin: Created page with "The panel.animated file format If present in the train folder, this file defines a 3D cab. The file is a normal animated object file. The train body is assumed..."

The panel.animated file format

If present in the train folder, this file defines a 3D cab.

The file is a normal [[.ANIMATED|animated]] object file. The train body is assumed to be centered on the x- and z-axes, while a value of 0 on the y-axis corresponds to the top of the rails, just as with exterior train objects.

==Viewing Point==
The viewing point of the driver's eye is determined via the #CAB or #COCKPIT sections in the [[train.dat]] (which measures the viewing point in millimeters from the front of the train).

You can use Object Viewer to preview any animated object, including the panel.animated file. It might also be a good idea to load both the exterior object and the panel.animated in Object Viewer so you can match them against each other.

==Overlay and Lighting==
The cab is rendered as an overlay. This means that the cab will always appear in front of scenery objects. This is intentional, because this way, rain, walls and other obstructing objects cannot be accidentally rendered inside the cab. Furthermore, lighting in the cab is different than in the scenery. While the ambient brightness is reflected in the cab, the ambient color is not, and the cab always appears as if reflecting white light. This behavior might change in future versions of openBVE.

Train.dat

2015-02-07T00:25:07Z

Kevin: Created page with " The '''train.dat''' file format {| style="border: 0px currentColor; margin-right: 10..."

The '''train.dat''' file format 

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| 
|}

 

{|
|- style="height: 4px"
|
|}

■ 1. Overview

----

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| 
|}

The train.dat file describes the characteristics of trains including acceleration, brake behavior, installed equipment, speed-sound associations, and more. 

{|
|- style="height: 4px"
|
|}

{| style="border: 1px dotted currentColor; margin-right: 20pt; margin-left: 20pt"
| style="border: 2px ridge currentColor" bgcolor="#60a0ff" | '''☀''' Tip: Train Editor
|-
| bgcolor="#ffffff" |
You can use the [http://trainsimframework.org/develop/tool_traineditor.html Train Editor] to more conveniently edit the train.dat. This page should still be used as a reference. However, you can also edit the train.dat manually if so desired.
|}

{|
|- style="height: 4px"
|
|}

 The file is a plain text file encoded in any arbitrary [http://trainsimframework.org/develop/information_encodings.html encoding], however, UTF-8 with a byte order mark is the preferred choice. The [http://trainsimframework.org/develop/information_numberformats.html parsing model] for numbers is '''Loose''', however, you are encouraged to produce ''Strict'' output nonetheless. The file is required to be located inside the [http://trainsimframework.org/develop/information_folderstructure.html train folder] and is expected to be named '''train.dat'''. The file is interpreted on a per-line basis, from top to bottom. 

{|
|- style="height: 4px"
|
|}

■ 2. The file identifier

----

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| 
|}

The first line in the train.dat is expected to be an identifier indicating the version of the file format. Allowed values are: 

{|
| width="16" valign="top" |
| ''Version 1.22 is being used:''
|-
| width="16" valign="top" | ▶
| style="border: 1px dashed currentColor" bgcolor="#d4d8ff" | <tt>BVE1220000</tt>
|}

 

{|
| width="16" valign="top" |
| ''Version 2.0 is being used (choose either one):''
|-
| width="16" valign="top" | ▶
| style="border: 1px dashed currentColor" bgcolor="#d4d8ff" | <tt>BVE2000000 OPENBVE</tt>
|}

 Any other value will be reported as being non-supported and version 2.0 will be assumed. The selected version number affects the parsing of the #ACCELERATION section, which is explained later on. 

{|
|- style="height: 4px"
|
|}

■ 3. Syntax

----

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| 
|}

For each line in the file, [http://trainsimframework.org/develop/information_whitespaces.html white spaces] at the beginning and the end of that line are ignored. Each line in the file after the identifier can mark the beginning of a new section or contain data entries for the last opened section. Empty lines or lines solely consisting of white spaces are '''not''' ignored. A new section is opened by starting the line with a number sign character (U+0023). The text which follows the number sign indicates the name of the section and is case-insensitive. The beginning of a section has thus the following form: 

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | <nowiki>#NameOfTheSection</nowiki>
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| 
|}

 The order in which sections appear within the file is irrelevant. Each line following the opening of a new section is interpreted as a data entry. These data entries are not named, thus their order is important. When a data entry is expected but omitted because a new section was started, a default value will apply. The exact interpretation of each data entry is explained in the following sections, along with default values. You can use comments anywhere at the end of a line. A comment is started by a semicolon (U+003B). Comments, if present, are stripped away from all lines before these are processed. 

{|
|- style="height: 4px"
|
|}

■ 4. The Acceleration section

----

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| 
|}

The Acceleration section defines the acceleration characteristics of the train for each individual power notch. The number of notches available in the train can be set inside the Handle section. For each notch, one data entry is expected, starting with the first notch. 

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | <nowiki>#ACCELERATION</nowiki>
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| This starts the section. 
|}

 

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | ''a0'', ''a1'', ''v1'', ''v2'', ''e''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| '''''a0'''''<nowiki>: A positive floating-point number representing the acceleration at a speed of 0 km/h expressed in km/h/s.</nowiki> '''''a1'''''<nowiki>: A positive floating-point number representing the acceleration at a speed of </nowiki>''v1'' expressed in km/h/s. '''''v1'''''<nowiki>: A positive floating-point number representing a reference speed in km/h corresponding to </nowiki>''a1''. '''''v2'''''<nowiki>: A positive floating-point number representing a reference speed in km/h corresponding to </nowiki>''e''. '''''e'''''<nowiki>: A positive floating-point number representing an exponent. The behavior is different for version 1.22 and version 2.0 file formats.</nowiki>
|}

This data entry consists of five comma-separated values. White spaces surrounding the values are ignored. The acceleration the motor cars can provide for the whole train (accounting for unpowered trailer cars) at a given speed is calculated as follows: If the speed of the train is 0 km/h, ''a0'' indicates the acceleration output. If the speed of the train is between 0 km/h and ''v1'', the acceleration output is determined via the following formula: 

{|
| width="16" valign="top" |
| ''Acceleration between 0 km/h and ''v1'', where ''x'' is the current speed of the train in km/h:''
|-
| width="16" valign="top" | ƒ
| style="border: 1px dotted currentColor" bgcolor="#ffd8c0" | <tt>''a0'' + (''a1'' - ''a0'') * ''x'' / ''v1''</tt>
|}

 If the speed of the train is ''v1'', the acceleration output is indicated by ''a1''. If the speed of the train is between ''v1'' and ''v2'', the acceleration output is determined via the following formula: 

{|
| width="16" valign="top" |
| ''Acceleration between ''v1'' and ''v2'', where ''x'' is the current speed of the train in km/h:''
|-
| width="16" valign="top" | ƒ
| style="border: 1px dotted currentColor" bgcolor="#ffd8c0" | <tt>v1 * a1 / x</tt>
|}

 If the speed of the train is greater than ''v2'', the acceleration output is determined via the following formula (for version 2.0 exponents): 

{|
| width="16" valign="top" |
| '''''For version 2.0:''' Acceleration above ''v2'', where ''x'' is the current speed of the train in km/h:''
|-
| width="16" valign="top" | ƒ
| style="border: 1px dotted currentColor" bgcolor="#ffd8c0" | <tt>v1 * a1 * v2e-1 / xe</tt>
|}

 For a version 1.22 file format, the exponent ''e'' is converted into a version 2.0 exponent according to the following equation (and then, the above formula applies): 

{|
| width="16" valign="top" |
| ''Converting a version 1.22 exponent into a version 2.0 exponent:''
|-
| width="16" valign="top" | ƒ
| style="border: 1px dotted currentColor" bgcolor="#ffd8c0" | <tt>e2.0 = min(1 - v2 * log(e1.22) / log(9/4), 4)</tt>
|}

In the above formula, ''log'' denotes the natural logaritm and ''min'' the minimum function. Please notice that version 1.22 exponents are clamped at 4 after conversion to a 2.0 exponent. Please take into account that the effective acceleration will always be lower than specified due to various resistances, including rolling resistance and air resistance. 

{|
| width="16" valign="top" |
| ''Example of an Acceleration section for 4 power notches:''
|-
| width="16" valign="top" | ▶
| style="border: 1px dashed currentColor" bgcolor="#d4d8ff" | <tt><nowiki>#ACCELERATION</nowiki> 0.77,0.39,7,7,1 1.96,1.96,24,24,3 1.96,1.96,52,52,3.4 1.96,1.96,52,83,2.7</tt>
|}

 

{|
|- style="height: 4px"
|
|}

■ 5. The Performance section

----

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| 
|}

This section defines the brake performance and coefficients which influence the physics. 

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | <nowiki>#PERFORMANCE</nowiki>
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| This starts the section. 
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 20pt" bgcolor="#e0e0e0"
| ☀
| ''The following spelling variations can be used: ''
|-
|
| <nowiki>#PERFORMANCE, DECELERATION</nowiki>
|}

 

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | ''Deceleration''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| 
|}

A non-negative floating-point number corresponding to the deceleration in km/h/s the service brakes can provide. The corresponding brake cylinder pressure can be defined in the #PRESSURE section. The default value is 1. 

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | ''CoefficientOfStaticFriction''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| 
|}

A non-negative floating-point number corresponding to the coefficient of static friction, which plays an important role in wheel slip. The coefficient is dimensionless. Normal values for steel on steel range between 0.25 and 0.35. For rubber on steel, normal values range between 0.50 and 0.60. The default value is 0.35. 

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | ''Reserved''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| 
|}

''This value is not currently used by openBVE. Please set to 0.'' 

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | ''CoefficientOfRollingResistance''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| 
|}

A non-negative floating-point number corresponding to the coefficient of rolling resistance, which plays an important role in the acceleration performance as it is one of the factors providing a resistance to the attempt of the train to accelerate. The coefficient is dimensionless. The default value is 0.0025. 

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | ''AerodynamicDragCoefficient''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| 
|}

A non-negative floating-point number corresponding to the aerodynamic drag coefficient, which plays an important role in the acceleration performance as it is one of the factors providing a resistance to the attempt of the train to accelerate. The coefficient is dimensionless. The default value is 1.1. 

{|
| width="16" valign="top" |
| ''Example of a Performance section:''
|-
| width="16" valign="top" | ▶
| style="border: 1px dashed currentColor" bgcolor="#d4d8ff" | <tt><nowiki>#PERFORMANCE</nowiki> 3.6 0.35 0 0.0025 1.1</tt>
|}

 

{|
|- style="height: 4px"
|
|}

■ 6. The Delay section

----

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| 
|}

This section defines various delays associated with electric power and electric braking. 

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | <nowiki>#DELAY</nowiki>
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| This starts the section. 
|}

 

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | ''DelayPowerUp''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| 
|}

A non-negative floating point number representing the time in '''seconds''' (s) before increasing the power notch takes effect. The default value is 0. 

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | ''DelayPowerDown''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| 
|}

A non-negative floating point number representing the time in '''seconds''' (s) before decreasing the power notch takes effect. The default value is 0. 

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | ''DelayBrakeUp''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| 
|}

A non-negative floating point number representing the time in '''seconds''' (s) before increasing the brake notch takes effect. Applies only to trains that have notched brakes. The default value is 0. 

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | ''DelayBrakeDown''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| 
|}

A non-negative floating point number representing the time in '''seconds''' (s) before decreasing the brake notch takes effect. Applies only to trains that have notched brakes. The default value is 0. 

{|
| width="16" valign="top" |
| ''Example of a Pressure section:''
|-
| width="16" valign="top" | ▶
| style="border: 1px dashed currentColor" bgcolor="#d4d8ff" | <tt><nowiki>#DELAY</nowiki> 0.5 0 0.32 0.32</tt>
|}

 

{|
|- style="height: 4px"
|
|}

■ 7. The Move section

----

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| 
|}

This section defines various jerk values associated with electric power and electric braking, as well as flow rates associated to the physical brake systems. 

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | <nowiki>#MOVE</nowiki>
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| This starts the section. 
|}

 

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | ''JerkPowerUp''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| 
|}

A non-negative floating point number representing the jerk in '''1/100 meters per second cubed''' (1/100 m/s³) when the acceleration produced by the engine is increased. The default value is 1000. 

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | ''JerkPowerDown''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| 
|}

A non-negative floating point number representing the jerk in '''1/100 meters per second cubed''' (1/100 m/s³) when the acceleration produced by the engine is decreased. The default value is 1000. 

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | ''JerkBrakeUp''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| 
|}

A non-negative floating point number representing the jerk in '''1/100 meters per second cubed''' (1/100 m/s³) when the deceleration produced by the electric brake is increased. Applies only to trains that use the electric brake. The default value is 1000. 

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | ''JerkBrakeDown''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| 
|}

A non-negative floating point number representing the jerk in '''1/100 meters per second cubed''' (1/100 m/s³) when the deceleration produced by the electric brake is decreased. Applies only to trains that use the electric brake. The default value is 1000. 

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | ''BrakeCylinderUp''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| 
|}

A non-negative floating point number representing the mean pressure increase rate of the brake cylinder in '''kilopascal per second''' (kPa/s) when the pressure increases due to an emergency brake application. The default value is 300. For a service brake application, a lower value than ''BrakeCylinderUp'' will be used. 

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | ''BrakeCylinderDown''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| 
|}

A non-negative floating point number representing the mean pressure decrease rate of the brake cylinder in '''kilopascal per second''' (kPa/s) when the pressure decreases due to a brake release. The default value is 200. 

{|
| width="16" valign="top" |
| ''Example of a Move section:''
|-
| width="16" valign="top" | ▶
| style="border: 1px dashed currentColor" bgcolor="#d4d8ff" | <tt><nowiki>#MOVE</nowiki> 500 3000 3000 500 200 160</tt>
|}

 

{|
|- style="height: 4px"
|
|}

■ 8. The Brake section

----

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| 
|}

This section defines the brake type and other related settings. 

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | <nowiki>#BRAKE</nowiki>
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| This starts the section. 
|}

 

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | ''BrakeType''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| 
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 40pt"
| ▸ Options for ''BrakeType''<nowiki>:</nowiki>
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 50pt"
| '''0'''<nowiki>: Electromagnetic straight air brake</nowiki> '''1'''<nowiki>: Digital/analog electro-pneumatic air brake without brake pipe (electric command brake)</nowiki> '''2'''<nowiki>: Air brake with partial release feature</nowiki>
|}

This entry defines which brake type to use. If set to '''2''', the automatic air brake is used which uses a brake pipe across the whole train to supply each car with compressed air and to regulate the brake application. The brake pipe pressure needs time to propagate through the train, and thus, brake applications and releases are not synchonized between the cars. The train will always have separated power and brake handles, and thus, the ''HandleType'' entry inside the Handle section will be ignored. If set to '''0''', the electromagnetic straight air brake is used which is an enhancement to the automatic air brake. Contrary to the automatic air brake, the brake command is synchronized on all cars electrically, while the brake pipe is still used to distribute compressed air. If set to '''1''', the electric command brake is used which does not use the classical brake pipe altogether. Each car is an individual unit having its own brake equipment, while the brake command is synchronized electronically. 

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | ''BrakeControlSystem''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| 
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 40pt"
| ▸ Options for ''BrakeControlSystem''<nowiki>:</nowiki>
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 50pt"
| '''0'''<nowiki>: None</nowiki> '''1'''<nowiki>: Closing electromagnetic valve (lock-out valve) (締切電磁弁)</nowiki> '''2'''<nowiki>: Delay-including control (遅れ込め制御)</nowiki>
|}

This entry defines which kind of brake control system to use. This setting only applies for the electromagnetic straight air brake and the electric command brake. With those brake systems, the motor of the train helps in braking a train (dynamic braking). If ''BrakeControlSystem'' is set to '''0''' (none), the motor will always brake in addition to the physical brake, leading to a stronger braking force at all times. With '''1''' (closing electromagnetic valve), the pressure to the brake cylinder is interrupted when the train travels above the brake control speed, and the electric brake is used instead. When below the control speed, the physical brake operates normally, while the electric brake is not used. With '''2''' (delay-including control), the motor is used to brake the train with the deceleration setting as specified in the Performance section, and if the motor cannot provide this deceleration on its own, the physical brake is additionally used. When the train travels below the brake control speed, the physical brakes are used. However, as the physical brakes need time to fill the brake cylinder, the electric brake is still used to compensate for this delay. The deceleration that is provided by the electric brake is calculated via the highest acceleration obtained via any of the acceleration curves in the #ACCELERATION section (let's call it ''MaximumAcceleration'') and the service brake deceleration performance as defined in the #PERFORMANCE section (let's call it ''Deceleration'') in the following way: 

{|
| width="16" valign="top" |
| ''''
|-
| width="16" valign="top" | ƒ
| style="border: 1px dotted currentColor" bgcolor="#ffd8c0" | <tt>0.5 * (''MaximumAcceleration'' + ''Deceleration'')</tt>
|}

 

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | ''BrakeControlSpeed''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| 
|}

A non-negative floating-point number measured in '''kilometers per hour''' (km/h) at which the brake control system changes operation. The setting is ignored if ''BrakeType'' is set to '''2''' or if ''BrakeControlSystem'' is set to '''0'''. See the description for ''BrakeControlSystem'' for more information. 

{|
| width="16" valign="top" |
| ''Example of Brake section:''
|-
| width="16" valign="top" | ▶
| style="border: 1px dashed currentColor" bgcolor="#d4d8ff" | <tt><nowiki>#BRAKE</nowiki> 0 1 10</tt>
|}

 

{|
|- style="height: 4px"
|
|}

■ 9. The Pressure section

----

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| 
|}

This section defines various pressures for the train brake. 

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | <nowiki>#PRESSURE</nowiki>
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| This starts the section. 
|}

 

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | ''BrakeCylinderServiceMaximumPressure''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| 
|}

A positive floating-point number measured in '''kilopascal''' (kPa) indicating the brake cylinder pressure corresponding to a full service brake application. The value is required to be less than or equal to ''BrakeCylinderEmergencyMaximumPressure''. The default value is 480. 

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | ''BrakeCylinderEmergencyMaximumPressure''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| 
|}

A positive floating-point number measured in '''kilopascal''' (kPa) indicating the brake cylinder pressure corresponding to an emergency brake application. The value is required to be greater than or equal to ''BrakeCylinderServiceMaximumPressure''. The default value is 480. 

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | ''MainReservoirMinimumPressure''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| 
|}

A positive floating-point number measured in '''kilopascal''' (kPa) indicating the pressure in the main reservoir at which the air compressor is activated until the maximum pressure is reached. The default value is 690. 

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | ''MainReservoirMaximumPressure''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| 
|}

A positive floating-point number measured in '''kilopascal''' (kPa) indicating the pressure in the main reservoir at which the air compressor is deactivated. As a consequence, no pressure in either of the brake components can exceed this value. The default value is 780. 

{|
|- style="height: 4px"
|
|}

{| style="border: 1px dashed currentColor; margin-right: 20pt; margin-left: 20pt"
| style="border: 2px ridge currentColor" bgcolor="#ffe080" | '''ⓘ''' Brake cylinder and main reservoir
|-
| bgcolor="#ffffff" | Note that for all brake systems, the pressure in the brake cylinder can never exceed the highest pressure that can be produced in the main reservoir. As such, setting ''BrakeCylinderEmergencyMaximumPressure'' to a higher value than ''MainReservoirMaximumPressure'' will result in lower deceleration than set by ''Deceleration'' in the Pressure or Deceleration section. If ''BrakeCylinderEmergencyMaximumPressure'' is greater than ''MainReservoirMinimumPressure'', there might not be enough pressure available in the main reservoir to obtain a full service or emergency brake application, and also, the brake cylinder might not be exhaused immediately with the automatic air brake and the electromagnetic straight air brake.
|}

{|
|- style="height: 4px"
|
|}

 

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | ''BrakePipeNormalPressure''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| 
|}

A positive floating-point number measured in '''kilopascal''' (kPa) indicating the normal pressure in the brake pipe. The default value is chosen to be somewhere between ''BrakeCylinderEmergencyMaximumPressure'' and ''MainReservoirMinimumPressure'', ideally 490, if possible. 

{|
| width="16" valign="top" |
| ''Example of a Pressure section:''
|-
| width="16" valign="top" | ▶
| style="border: 1px dashed currentColor" bgcolor="#d4d8ff" | <tt><nowiki>#PRESSURE</nowiki> 440 440 690 780 490</tt>
|}

 

{|
|- style="height: 4px"
|
|}

■ 10. The Handle section

----

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| 
|}

This section defines the type of the handle and the amount of power and brake notches. 

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | <nowiki>#HANDLE</nowiki>
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| This starts the section. 
|}

 

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | ''HandleType''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| 
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 40pt"
| ▸ Options for ''HandleType''<nowiki>:</nowiki>
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 50pt"
| '''0'''<nowiki>: Separate power and brake handles</nowiki> '''1'''<nowiki>: One combined power and brake handle</nowiki>
|}

This entry defines which kind of handles should be used. If the train uses an automatic air brake (defined in the #BRAKE section), this setting will always be overridden to use two separate handles. 

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | ''PowerNotches''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| 
|}

A non-negative integer indicating how many power notches are available. There should be as many entries in the #ACCELERATION section as indicated by ''PowerNotches''. 

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | ''BrakeNotches''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| 
|}

A non-negative integer indicating how many brake notches are available. The value is ignored for trains using automatic air brakes (defined in the #BRAKE section). 

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | ''PowerNotchReduceSteps''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| 
|}

A non-negative integer indicating how many notches the power handle needs to be reduced before an actual change in the power notch setting internally occurs. 

{|
|- style="height: 4px"
|
|}

{| style="border: 1px dotted currentColor; margin-right: 20pt; margin-left: 20pt"
| style="border: 2px ridge currentColor" bgcolor="#60a0ff" | '''☀''' Frequently used application:
|-
| bgcolor="#ffffff" | If the value is set to ''PowerNotches'', the driver needs to reset the power notch to neutral before the power is actually reduced. If the driver wanted to go from power notch P4 to power notch P3, it would be first required to move down to neutral. When going down from P4 over P3, P2 and P1, the internal power output will still resemble power notch P4 during that time. Only once the neutral position is reached will the power output be actually reduced to zero. The driver could then increase the power to P3 as initially desired.
|}

{|
|- style="height: 4px"
|
|}

 

{|
| width="16" valign="top" |
| ''Example of a Handle section:''
|-
| width="16" valign="top" | ▶
| style="border: 1px dashed currentColor" bgcolor="#d4d8ff" | <tt><nowiki>#HANDLE</nowiki> 0 4 8 0</tt>
|}

 

{|
|- style="height: 4px"
|
|}

■ 11. The Cab section

----

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| 
|}

This section defines the location of the driver's eyes inside the train. [[Image:illustration_cab_coordinates.png]] 

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | <nowiki>#CAB</nowiki>
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| This starts the section. 
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 20pt" bgcolor="#e0e0e0"
| ☀
| ''The following spelling variations can be used: ''
|-
|
| <nowiki>#CAB, #COCKPIT</nowiki>
|}

 

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | ''X''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| 
|}

A floating-point number measured in '''millimeters''' (mm) which gives the X-coordinate of the driver's eye from the center of the driver's car. Negative values indicate a location on the left side of the train, positive ones on the right side. 

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | ''Y''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| 
|}

A floating-point number measured in '''millimeters''' (mm) which gives the Y-coordinate of the driver's eye from the top of the rails. Negative values indicate a location below the top of the rails, positive ones above the top of the rails. 

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | ''Z''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| 
|}

A floating-point number measured in '''millimeters''' (mm) which gives the Z-coordinate of the driver's eye from the front of the driver's car. Negative values indicate a location inside the car, positive ones outside. 

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | ''DriverCar''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| 
|}

A non-negative integer indicating which car the driver is located in. The first car in the train has index 0, the second car index 1, and so on. 

{|
| width="16" valign="top" |
| ''Example of a Cab section:''
|-
| width="16" valign="top" | ▶
| style="border: 1px dashed currentColor" bgcolor="#d4d8ff" | <tt><nowiki>#CAB</nowiki> -900 2750 -1000 0</tt>
|}

 

{|
|- style="height: 4px"
|
|}

■ 12. The Car section

----

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| 
|}

This section defines the number of cars and their masses. 

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | <nowiki>#CAR</nowiki>
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| This starts the section. 
|}

 

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | ''MotorCarMass''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| 
|}

A positive floating-point number measured in '''metric tons''' (1000 kg) indicating the mass of a single motor car. 

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | ''NumberOfMotorCars''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| 
|}

A positive integer indicating how many motor cars are available in the train. Only these cars will provide acceleration. 

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | ''TrailerCarMass''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| 
|}

A positive floating-point number measured in '''metric tons''' (1000 kg) indicating the mass of a single trailer car. If ''NumberOfTrailerCars'' is set to 0, this value will be ignored. 

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | ''NumberOfTrailerCars''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| 
|}

A non-negative integer indicating how many trailer cars are available in the train. These cars are unpowered and thus, they do not contribute to accelerating the train. If ''FrontCarIsAMotorCar'' is set to ''0'', this value is required to be at least 1. 

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | ''LengthOfACar''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| 
|}

A positive floating-point number measured in '''meters''' (m) indicating the length of a car. The number is applied for all the cars in the train, however, this can be overridden by the use of the '''extensions.cfg''' file. 

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | ''FrontCarIsAMotorCar''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| 
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 40pt"
| ▸ Options for ''FrontCarIsAMotorCar''<nowiki>:</nowiki>
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 50pt"
| '''0'''<nowiki>: The front car is not a motor car, but a trailer car. This is the default value.</nowiki> '''1'''<nowiki>: The front car is a motor car.</nowiki>
|}

Basically, you cannot influence which cars are motor cars and which are trailer cars. However, you can decide on whether the front car (where the driver is located) is a motor car or not, which this entry defines. There is a number of simple setups where the assignment of motor and trailer cars is well defined: 

{| style="border-collapse: collapse"
! style="padding: 4px; border: 2px ridge currentColor" bgcolor="#d0d0d0" | NumberOfMotorCars
! style="padding: 4px; border: 2px ridge currentColor" bgcolor="#d0d0d0" | NumberOfTrailerCars
! style="padding: 4px; border: 2px ridge currentColor" bgcolor="#d0d0d0" | FrontCarIsAMotorCar
! style="padding: 4px; border: 2px ridge currentColor" bgcolor="#d0d0d0" | Effect
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | 1
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | 0
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | 1
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | There is only one car, and it's a motor car.
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | 1
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | ''n''
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | 0
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | The rear car is a motor car. All other cars (including the front car) are trailer cars. This corresponds to a locomotive pushing the train from behind.
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | 1
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | ''n''
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | 1
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | The front car is a motor car. All other cars are trailer cars. This corresponds to a locomotive pulling the train from the front.
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | 2
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | 0
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | 1
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | There are two cars and both are motor cars.
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | 2
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | 1
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | 0
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | There are three cars. The front car is a trailer car, and the other two cars are motor cars.
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | 2
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | 1
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | 1
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | There are three cars. The front and rear cars are motor cars, and the car in the middle is a trailer car.
|}

 In all other cases, motor cars will be uniformly distributed along the train, but the exact assignment is implementation-specific. 

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | ''WidthOfACar''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| 
|}

A positive floating-point number measured in '''meters''' (m) indicating the width of a car. The number is applied for all the cars in the train. It is primarily used in the calculation of toppling. The default value is 2.6 

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | ''HeightOfACar''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| 
|}

A positive floating-point number measured in '''meters''' (m) indicating the height of a car. The number is applied for all the cars in the train. The value is not currently used, but will be in the future in the calculation of side winds. The default value is 3.6. 

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | ''CenterOfMassHeight''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| 
|}

A floating-point number measured in '''meters''' (m) indicating height above the rails at which the center of mass is located. The number is applied for all the cars in the train. The value is primarily used in the calculation of derailments. The default value is 1.6. 

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | ''ExposedFrontalArea''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| 
|}

A positive floating-point number measured in '''square meters''' (m²) indicating the frontal area of a car when it is fully exposed to resisting air. This is the case when the car is the front car and the train is driving forward, or the rear car when the train is driving backward. The number is applied to all the cars in the train. The value is primarily used in the calculation of air resistance. Trains usually have a lower frontal area than ''WidthOfACar'' * ''HeightOfACar'' due to the front being rounded. This is especially true for aerodynamically enhanced trains like Shinkansen. The default value is 0.6 * ''WidthOfACar'' * ''HeightOfACar''. 

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | ''UnexposedFrontalArea''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| 
|}

A positive floating-point number measured in '''square meters''' (m²) indicating the frontal area of a car when it is not fully exposed to resisting air. This is the case when the car is in the middle of the train and thus surrounded by other cars. The number is applied to all the cars in the train. The value is primarily used in the calculation of air resistance. The default value is 0.2 * ''WidthOfACar'' * ''HeightOfACar''. 

{|
| width="16" valign="top" |
| ''Example of a Car section:''
|-
| width="16" valign="top" | ▶
| style="border: 1px dashed currentColor" bgcolor="#d4d8ff" | <tt><nowiki>#CAR</nowiki> 42 4 36 2 20 0 2.3 3.4 2.6 7.5 1.8</tt>
|}

 

{|
|- style="height: 4px"
|
|}

■ 13. The Device section

----

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| 
|}

This section defines which devices are present on the train. 

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | <nowiki>#DEVICE</nowiki>
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| This starts the section. 
|}

 

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | ''Ats''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| 
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 40pt"
| ▸ Options for ''Ats''<nowiki>:</nowiki>
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 50pt"
| '''-1'''<nowiki>: Neither ATS-SN, nor ATS-P are available.</nowiki> '''0'''<nowiki>: ATS-SN is available, but ATS-P is not available.</nowiki> '''1'''<nowiki>: ATS-SN and ATS-P are available. </nowiki>
|}

This entry defines which of the default Japanese security systems ATS-SN or ATS-P are available. If the ats.cfg is used, this entry may be without effect depending on the plugin. 

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | ''Atc''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| 
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 40pt"
| ▸ Options for ''Atc''<nowiki>:</nowiki>
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 50pt"
| '''0'''<nowiki>: ATC is not available.</nowiki> '''1'''<nowiki>: ATC is available but requires manual activation.</nowiki> '''2'''<nowiki>: ATC is available and will automatically activate once transmitting. </nowiki>
|}

This entry defines whether the default Japanese security system ATC is available or not. If available, the user needs to manually activate ATC ('''1'''), or the system will automatically activate ('''2''') once the ATC data is transmitting, depending on the setting of ''Atc''. If the ats.cfg is used, this entry may be without effect depending on the plugin. 

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | ''Eb''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| 
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 40pt"
| ▸ Options for ''Eb''<nowiki>:</nowiki>
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 50pt"
| '''0'''<nowiki>: The EB device is not available.</nowiki> '''1'''<nowiki>: The EB device is available.</nowiki>
|}

This entry defines whether the EB device (alerter, or dead-man's vigilance device) is available or not. If available and the driver does not touch any of the control for 60 seconds, an alarm goes off which needs to be canceled within 5 seconds, or otherwise, an emergency brake application will be performed. If the ats.cfg is used, this entry may be without effect depending on the plugin. 

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | ''ConstSpeed''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| 
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 40pt"
| ▸ Options for ''ConstSpeed''<nowiki>:</nowiki>
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 50pt"
| '''0'''<nowiki>: The constant speed device is not available.</nowiki> '''1'''<nowiki>: The constant speed device is available. </nowiki>
|}

This entry defines whether the constant speed device is available or not. If available, the driver can order to hold the current speed at any time. The device will increase power to hold the current speed despite of inclines and resistances which would normally slow down the train if the power handle was set to neutral. However, the constant speed device will not reduce the speed or even brake on downward gradients. 

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | ''HoldBrake''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| 
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 40pt"
| ▸ Options for ''HoldBrake''<nowiki>:</nowiki>
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 50pt"
| '''0'''<nowiki>: The hold brake device is not available.</nowiki> '''1'''<nowiki>: The hold brake device is available. </nowiki>
|}

This entry defines whether the hold brake device is available or not. If available, the driver can activate the hold brake, which applies the brakes to hold the current speed on a downward gradient. 

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | ''ReAdhesionDevice''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| 
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 40pt"
| ▸ Options for ''ReAdhesionDevice''<nowiki>:</nowiki>
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 50pt"
| '''-1'''<nowiki>: A readhesion device is not available.</nowiki> '''0'''<nowiki>: The readhesion device type A is used.</nowiki> '''1'''<nowiki>: The readhesion device type B is used.</nowiki> '''2'''<nowiki>: The readhesion device type C is used.</nowiki> '''3'''<nowiki>: The readhesion device type D is used. </nowiki>
|}

This entry defines the type of readhesion device to be used. The device tests in certain intervals (reduce interval) whether wheel slip occurs. If so, it reduces the motor output by a certain amount (reduce amount) until the wheels regain adhesion. In certain intervals (increase interval), the device increases the motor output back to normal by a certain amount (increase amount) in order to see whether wheel slip would occur again or not. There are four different types available: 

{| style="border-collapse: collapse"
! style="padding: 4px; border: 2px ridge currentColor" bgcolor="#d0d0d0" | Type
! style="padding: 4px; border: 2px ridge currentColor" bgcolor="#d0d0d0" | Reduce interval
! style="padding: 4px; border: 2px ridge currentColor" bgcolor="#d0d0d0" | Reduce amount
! style="padding: 4px; border: 2px ridge currentColor" bgcolor="#d0d0d0" | Increase interval
! style="padding: 4px; border: 2px ridge currentColor" bgcolor="#d0d0d0" | Increase amount
! style="padding: 4px; border: 2px ridge currentColor" bgcolor="#d0d0d0" | Characteristics
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | A
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | high
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | instantly zero
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | medium
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | very high
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | Cuts off power instantly and rebuilds it up fast in steps.
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | B
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | medium
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | small
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | high
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | small
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | Updates not so often and adapts slowly. Wheel slip can persist longer and power is regained slower. The behavior is smoother.
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | C
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | medium
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | medium
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | medium
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | medium
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | The behavior is somewhere in-between type B and type D.
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | D
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | small
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | high
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | small
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | high
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | Updates fast and adapts fast. Wheel slip only occurs briefly and power is regained fast. The behavior is more abrupt.
|}

 

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | ''LoadCompensatingDevice''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| ''This entry is not used by openBVE.'' 
|}

 

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | ''PassAlarm''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| 
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 40pt"
| ▸ Options for ''PassAlarm''<nowiki>:</nowiki>
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 50pt"
| '''0'''<nowiki>: The pass alarm device is not available.</nowiki> '''1'''<nowiki>: The pass alarm device is available and plays a single time.</nowiki> '''2'''<nowiki>: The pass alarm device is available and plays in a loop.</nowiki>
|}

This entry defines whether the pass alarm device is available or not. If available, the '''halt.wav''' located inside the train folder will be played a single time ('''1''') at around 400 m from the beginning of the station, or in a loop ('''2''') until the train opens the doors at the station. 

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | ''DoorOpenMode''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| 
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 40pt"
| ▸ Options for ''DoorOpenMode''<nowiki>:</nowiki>
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 50pt"
| '''0'''<nowiki>: The doors are opened automatically, but can also be prematurely opened manually. This is the default.</nowiki> '''1'''<nowiki>: The doors are opened automatically. Manual override is not possible.</nowiki> '''2'''<nowiki>: The doors can only be opened manually. </nowiki>
|}

 

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | ''DoorCloseMode''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| 
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 40pt"
| ▸ Options for ''DoorCloseMode''<nowiki>:</nowiki>
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 50pt"
| '''0'''<nowiki>: The doors are closed automatically, but can also be prematurely closed manually. This is the default.</nowiki> '''1'''<nowiki>: The doors are closed automatically. Manual override is not possible.</nowiki> '''2'''<nowiki>: The doors can only be closed manually. </nowiki>
|}

 

{|
| width="16" valign="top" |
| ''Example of a Device section:''
|-
| width="16" valign="top" | ▶
| style="border: 1px dashed currentColor" bgcolor="#d4d8ff" | <tt><nowiki>#DEVICE</nowiki> 1 0 1 0 0 2 0 1 2 2</tt>
|}

 

{|
|- style="height: 4px"
|
|}

■ 14. The Motor sections

----

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| 
|}

These sections define which sounds to play at a given speed for the electric motor and eletric brake, along with associated pitch and volume at that speed. There are four sections called #MOTOR_P1, #MOTOR_P2, #MOTOR_B1 and MOTOR_B2 that control the behavior. The #MOTOR_P1 and #MOTOR_P2 sections define two independent sounds that can be played at a given time for the electric motor. The #MOTOR_B1 and #MOTOR_B2 sections define two independent sounds that can be played at a given time for the electric brake. Each section starts with a corresponding #MOTOR_''Xi'' line: 

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | <nowiki>#MOTOR_</nowiki>''Xi''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| 
|}

 The following entries define the sounds that are to be played at multiples of 0.2 km/h. The first entry corresponds to a speed of 0 km/h, the second entry to a speed of 0.2 km/h, the third entry to a speed of 0.4 km/h, and so on. There can be as many entries as desired. For example, with 800 entries, the 800th entry corresponds to a speed of 159.8 km/h. If the train travels at a higher speed than corresponding to the last entry, this last entry also takes effect for all higher speeds. An entry inside any of the #MOTOR_''Xi'' sections has the following form: 

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | ''SoundIndex'', ''Pitch'', ''Volume''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| 
|}

'''''SoundIndex'''''<nowiki>: A non-negative integer corresponding to the Motor</nowiki>''SoundIndex''.wav file that is to be played (default sounds), or the ''SoundIndex''<nowiki>=</nowiki>''FileName'' setting in the [Motor] section of the sound.cfg file. ''SoundIndex'' may also be -1 in order to indicate that no sound should be played. The default value is -1. '''''Pitch'''''<nowiki>: A positive floating-point number representing the pitch of the sound in percent. A value of 100 represents an unaltered sound, a value of 200 represents a sound that is played at double speed, a value of 50 represents a sound that is played at half the original speed, and so on. You should avoid values near zero. The default value is 100.</nowiki> '''''Volume'''''<nowiki>: A non-negative floating-point number representing the volume of the sound. Nominal volume corresponds to a value of 128. The scale of volume is non-linear, and the exact behavior is implementation-specific. The default value is 128.</nowiki> Please note that the final volume is proportional to the acceleration/deceleration provided by the train. This means that if the motor only outputs a fraction of its maximum acceleration, the final volume of the motor sounds will be reduced. Likewise, if the electric brake only outputs a fraction of its maximum deceleration, the final volume of the electric brake sounds will also be reduced. 

{|
| width="16" valign="top" |
| ''Example of a part of a #MOTOR_P1 section:''
|-
| width="16" valign="top" | ▶
| style="border: 1px dashed currentColor" bgcolor="#d4d8ff" | <tt><nowiki>#MOTOR_P1</nowiki> -1,100,36 0,100,36 0,100,35 0,100,35 0,100,34 0,100,34 0,100,33 0,100,33 0,100,32 0,100,32</tt>
|}

Using Oskari's Plugin (OS ATS1.dll)

2015-02-07T00:24:20Z

Kevin: Created page with "This is one of the older OpenBVE plugins, the most common plugin for most trains. It is a Win32 plugin, and it is NOT cross-platform compatible. This allows for the use of an..."

This is one of the older OpenBVE plugins, the most common plugin for most trains. It is a Win32 plugin, and it is NOT cross-platform compatible.

This allows for the use of animated destination signs, rail gaps, the train stop feature, switchable interior lighting, and more.

More documentation will be available soon

==Rail Gap==
===On Route===
You will need to specify this within your "With Structure" list. It is best to use a null object for the basis of the beacon. In this example, we use null.x

<pre><nowiki>
.Beacon(1) MyRoute\null.x ;beacon for power rail gaps and tripcock
</nowiki></pre>

Of course, change the directory of the object to where it is located. For example, we put it in the Rails folder instead

<pre><nowiki>
.Beacon(1) MyRoute\Rails\null.x ;beacon for power rail gaps and tripcock
</nowiki></pre>

Now here is the beacon for the rail gap to place within the route:

<pre><nowiki>
X, .Beacon 20; 1; 0; Y
</nowiki></pre>

X represents the location where you would want to place the beacon. For example if you want to place the beacon on a switch that the train crosses for a different track, and the switch object starts at 256 meters, the location would be stated as this:

<pre><nowiki>
256, .Beacon 20; 1; 0; Y
</nowiki></pre>

Now Y represents the duration of the gap, in meters. For example, the switch is 30 meters long, then you would specify the following:

<pre><nowiki>
256, .Beacon 20; 1; 0; 30
</nowiki></pre>

And there you have it! Your new route or existing route is now equipped with the rail gap!

===On Train===

----

This feature will only work if your exterior/interior objects are associated with an .animated file rather than being a standalone .b3d or .csv object. So first, create an .animated file on notepad, and here is how it works:

<pre><nowiki>
[Object]
States = OFF.b3d, ON.b3d
StateFunction = pluginstate[53]
</nowiki></pre>

OR

<pre><nowiki>
[Object]
States = OFF.csv, ON.csv
StateFunction = pluginstate[53]
</nowiki></pre>

OR

<pre><nowiki>
[Object]
States = OFF.b3d, ON.csv
StateFunction = pluginstate[53]
</nowiki></pre>

OR

<pre><nowiki>
[Object]
States = OFF.csv, ON.b3d
StateFunction = pluginstate[53]
</nowiki></pre>

OFF.csv and OFF.b3d represents the object without the EmissiveColor (.b3d)/SetEmissiveColor (.csv) command being used, while ON.csv and ON.b3d represents the same object, but using the EmissiveColor/SetEmissiveColor command.

Your train's extensions.cfg MUST specify these .animated files. For each car object, a pair of .b3d files (or .csv) needs to be made, as shown above.

<pre><nowiki>
StateFunction = pluginstate[53]
</nowiki></pre>

This is the StateFunction for the rail gap to work. The OFF state must be MENTIONED FIRST before the ON state on the states list! In this example, we are using .csv objects:

<pre><nowiki>
States = OFF.csv, ON.csv
</nowiki></pre>

The same will apply to animated doors as well, if the train includes an interior. Here is an exmaple of applying the rail gap with 2 pairs of animated doors:

<pre><nowiki>
[Object]
Position = -1.28, 1.05, -6.67
States = doorLNP.b3d,doorL.b3d
StateFunction = pluginstate[53]
TranslateZFunction = if[leftdoorstarget==0, min[value+delta*1.8/4.8,0], max[value-delta*0.8/1.5,-0.8]]

[Object]
Position = -1.28, 1.05, -6.03
States = doorL1NP.b3d,doorL1.b3d
StateFunction = pluginstate[53]
TranslateZFunction = if[leftdoorstarget==0, max[value-delta*1.8/4.8,0], min[value+delta*0.8/1.5,0.8]]

[Object]
Position = 1.30, 1.05, -2.50
States = doorRNP.b3d,doorR.b3d
StateFunction = pluginstate[53]
TranslateZFunction = if[rightdoorstarget==0, min[value+delta*1.8/4.8,0], max[value-delta*0.8/1.5,-0.8]]

[Object]
Position = 1.30, 1.05, -1.85
States = doorR1NP.b3d,doorR1.b3d
StateFunction = pluginstate[53]
TranslateZFunction = if[rightdoorstarget==0, max[value-delta*1.8/4.8,0], min[value+delta*0.8/1.5,0.8]]
</nowiki></pre>

And there you have it, your basics of applying the rail gap feature on an exterior/interior train object!

==Tripcock/Train Stop==
===On Route===
You will need to specify this within your "With Structure" list. It is best to associate it with a tripcock object for the basis of the beacon. In this example, we use tripcock.x

<pre><nowiki>
.Beacon(2) YOURSIGNALS\tripcock.x
</nowiki></pre>

Now here is the beacon for the tripcock/train stop to place within the route. It has been tested and successfully trips the train.:

<pre><nowiki>
X, .Beacon 44003;2;0;0,
</nowiki></pre>

===On Train===

This feature will only work if your exterior/interior objects are associated with an .animated file rather than being a standalone .b3d or .csv object. So first, create an .animated file on notepad, and here is how it works:

<pre><nowiki>
[Object]
States = DISENGAGED.b3d, ENGAGED.b3d
StateFunction = pluginstate[51]
</nowiki></pre>

This works best for trains that have pivoting trucks/bogies or detailed trucks/bogies.

==Animated objects==
===Animated Static Destination Signs===

here's how it works:
<pre><nowiki>
[Object]
States = your states here, either .b3d or .csv, separated by a comma per state.
Statefunction = Mod[value+delta*pluginstate[customindicator], numberofobjects]
</nowiki></pre>

THIS SECTION IS STILL INCOMPLETE. WILL BE COMPLETED LATER.

Using ATC

2015-02-07T00:24:01Z

Kevin: Created page with " Tutorial: Using ATC in a CSV route file {| style="border: 0px currentColor; margin-r..."

Tutorial: Using ATC in a CSV route file 

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| 
|}

 This tutorial is intended to guide you on how to properly set up the built-in Japanese safety system ATC in the case you want to make your route ready to use it. This page assumes that you are familiar with what ATC is. If not, please take a look at the following page first: ➟ [http://trainsimframework.org/use/drive.html How to drive - A quick overview on controls, ATS/ATC, signals and signs] 

{|
|- style="height: 4px"
|
|}

■ Setting up a route for ATC

----

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| 
|}

First of all, ATC needs to be enabled on a per-station basis. For every station for which ATC is enabled, the track from the beginning of that station until the end of the next station is ATC-equipped. The end of the ATC-enabled track is known in advance by the system, and then train will thus be braked down in time to prevent over-travel. 

{|
| width="16" valign="top" |
| ''In order to enable ATC:''
|-
| width="16" valign="top" | ▶
| style="border: 1px dashed currentColor" bgcolor="#d4d8ff" | <tt>Track.Sta STATION; ; ; ; ; ; 1</tt>
|}

 

{|
| width="16" valign="top" |
| ''In order to disable ATC:''
|-
| width="16" valign="top" | ▶
| style="border: 1px dashed currentColor" bgcolor="#d4d8ff" | <tt>Track.Sta STATION; ; ; ; ; ; 0</tt>
|}

 In the following example, the track from station B until station C is ATC-equipped: 

{|
| width="16" valign="top" |
| ''''
|-
| width="16" valign="top" | ▶
| style="border: 1px dashed currentColor" bgcolor="#d4d8ff" | <tt>With Track 0000, .Sta A; ; ; ; ; ; 0 0120, .Stop <nowiki>; start of ATC-equipped track at 800</nowiki> 0800, .Sta B; ; ; ; ; ; 1 0920, .Stop 1600, .Sta C; ; ; ; ; ; 0 1720, .Stop <nowiki>; end of ATC-equipped track at 1720</nowiki> 2400, .Sta D; ; ; ; ; ; 0 2520, .Stop</tt>
|}

 

{|
|- style="height: 4px"
|
|}

■ Signalling and ATC

----

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| 
|}

Technically, users may ignore any signals as long as the train operates in ATC. Of course you can demand otherwise on your route. In openBVE, instead of using signals, ATC receives the distance to the next train in blocks of 200m. Depending on the deceleration characteristics of the train, ATC then dictates a particular speed limit, which may be released at any time depending on the change of location of the preceding train. These 200m blocks are placed at track positions 0, 200, 400, 600, and so on. 

{|
|- style="height: 4px"
|
|}

■ Speed limits and ATC

----

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| 
|}

When using the '''Track.Limit''' command, ATC knows the location of the immediately upcoming one in advance and automatically brakes the train before reaching that position. For example: 

{|
| width="16" valign="top" |
| ''''
|-
| width="16" valign="top" | ▶
| style="border: 1px dashed currentColor" bgcolor="#d4d8ff" | <tt>100, .Limit 100 800, .Limit 40 ,; is known in advance from track position 100</tt>
|}

There is a way, however, to prevent this behavior. As ATC only knows the immediately upcoming speed limit in advance, repeating the old speed limit in close proximity to the new speed limit makes ATC only brake as soon as the repeating speed limit is reached. For example: 

{|
| width="16" valign="top" |
| ''''
|-
| width="16" valign="top" | ▶
| style="border: 1px dashed currentColor" bgcolor="#d4d8ff" | <tt>100, .Limit 100 799, .Limit 100 800, .Limit 40 ,; is known in advance only from track position 799</tt>
|}

Using ATS

2015-02-07T00:23:19Z

Kevin: Created page with " Tutorial: Using ATS-SN and ATS-P in a CSV route file {| style="border: 0px currentCo..."

Tutorial: Using ATS-SN and ATS-P in a CSV route file 

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| 
|}

 This tutorial is intended to guide you on how to properly set up the built-in Japanese safety systems ATS-SN and ATS-P in the case you want to make your route ready to use them. This page assumes that you are familiar with what ATS-SN and ATS-P are. If not, please take a look at the following page first: ➟ [http://trainsimframework.org/use/drive.html How to drive - A quick overview on controls, ATS/ATC, signals and signs] 

{|
|- style="height: 4px"
|
|}

■ Setting up a route for ATS-SN

----

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| 
|}

For ATS-S, an S-type transponder is usually placed 600 meters in front of a red signal. The distance can of course vary with the operation speed used on the route, but is a good start for speeds up to 100 km/h. For ATS-SN, the SN-transponder is additionally placed around 20 meters in front of the signal. 

{|
|- style="height: 4px"
|
|}

● When the signal interval is larger than 600 meters

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| 
|}

{|
|- style="height: 2px"
|
|}

[[Image:illustration_transponder_setup_atssn.png]] In the case that your signals are at least 600 meters apart from each other, the setup is quite easy. Place a '''Track.Tr 0''' command around 600 meters in front of any signal, and a '''Track.Tr 1''' command around 20 meters in front of any signal: 

{|
| width="16" valign="top" |
| ''''
|-
| width="16" valign="top" | ▶
| style="border: 1px dashed currentColor" bgcolor="#d4d8ff" | <tt>With Track 0200, .Tr 0 0780, .Tr 1 0800, .Signal 3;;-3;-1</tt>
|}

 

{|
|- style="height: 4px"
|
|}

● When the signal interval is smaller than 600 meters

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| 
|}

{|
|- style="height: 2px"
|
|}

When signals are in placed smaller intervals, it can become necessary that an S-type transponder is placed in front of one signal, while it actually needs to reference the signal following that one. In this case, it is necessary to indicate which upcoming signal a transponder is supposed to reference. Via a '''Track.Tr ''type''<nowiki>; 0</nowiki>''' command, the immediately following signal is referenced, while via '''Track.Tr ''type''<nowiki>; 1</nowiki>''', the signal following that one is referenced. [[Image:illustration_transponder_setup_atssn_overlap.png]] Your code will then need to follow this scheme: 

{|
| width="16" valign="top" |
| ''''
|-
| width="16" valign="top" | ▶
| style="border: 1px dashed currentColor" bgcolor="#d4d8ff" | <tt>With Track 0200, .Tr 0 0700, .Tr 0;1 ,; referencing signal B 0780, .Tr 1 0800, .Signal 3;;-3;-1 ,; signal A 1280, .Tr 1 1300, .Signal 3;;-3;-1 ,; signal B</tt>
|}

 

{|
|- style="height: 4px"
|
|}

■ Setting up a route for ATS-P

----

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| 
|}

For ATS-P, the first pattern renewal transponder is usually placed 600 meters in front of each signal, which can also vary with the operation speed. The pattern renewal transponder is usually repeated a few times so that in the case the aspect of the signal changes, the train can be informed about the change without having to apply the brakes for too long. The pattern renewal transponder is usually placed 600 meters, 280 meters, 180 meters, 85 meters or 50 meters in front of signals, while an immediate stop transponder is usually placed either 25 meters or 30 meters in front of each signal. Which transponders are located where usually depends on the type of the signal. The following is only an example. 

{| style="border-collapse: collapse"
! style="padding: 4px; border: 2px ridge currentColor" bgcolor="#d0d0d0" | Signal
! style="padding: 4px; border: 2px ridge currentColor" bgcolor="#d0d0d0" | 600m
! style="padding: 4px; border: 2px ridge currentColor" bgcolor="#d0d0d0" | 280m
! style="padding: 4px; border: 2px ridge currentColor" bgcolor="#d0d0d0" | 180m
! style="padding: 4px; border: 2px ridge currentColor" bgcolor="#d0d0d0" | 85m
! style="padding: 4px; border: 2px ridge currentColor" bgcolor="#d0d0d0" | 50m
! style="padding: 4px; border: 2px ridge currentColor" bgcolor="#d0d0d0" | 30m
! style="padding: 4px; border: 2px ridge currentColor" bgcolor="#d0d0d0" | 25m
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | Departure signal
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | ✓
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | ✓
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | ✓
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | ✓
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | ✓
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | ✗
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | ✓
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | Block signal
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | ✓
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | ✗
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | ✓
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | ✓
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | ✗
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | ✓
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | ✗
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | Home signal
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | ✓
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | ✓
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | ✓
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | ✓
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | ✓
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | ✓
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | ✗
|}

 Departure signals are those placed at the end of a station, block signals are signals in-between stations, and home signals are those immediately placed before stations. 

{|
|- style="height: 4px"
|
|}

● When the signal interval is larger than 600 meters

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| 
|}

{|
|- style="height: 2px"
|
|}

[[Image:illustration_transponder_setup_atsp.png]] In the case that your signals are at least 600 meters apart from each other, the setup is quite easy. Place '''Track.Tr 3''' commands around 600 meters, 280 meters, 180 meters, 85 meters and 50 meters, depending on the requirements, in front of any signal, and a '''Track.Tr 4''' command around 25 meters in front of any signal: 

{|
| width="16" valign="top" |
| ''''
|-
| width="16" valign="top" | ▶
| style="border: 1px dashed currentColor" bgcolor="#d4d8ff" | <tt>With Track 0200, .Tr 3 ,; 600m 0520, .Tr 3 ,; 280m 0620, .Tr 3 ,; 180m 0715, .Tr 3 ,; 85m 0750, .Tr 3 ,; 50m 0775, .Tr 4 ,; 25m 0800, .Signal 3;;-3;-1</tt>
|}

 

{|
|- style="height: 4px"
|
|}

● When the signal interval is smaller than 600 meters

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| 
|}

{|
|- style="height: 2px"
|
|}

When signals are placed in shorter intervals, you need to be a little more careful on how to place the transponders if they need to reference signals following the immediately upcoming one. Whenever you reference signals beyond the immediately upcoming one with pattern renewal transponders or immediate stop transponders, the first signal until then which is red is referenced. This means that if you use '''Track.Tr ''type''<nowiki>;1</nowiki>''', but the immediately upcoming signal is red, that signal will be referenced. Only otherwise, the signal behind that is referenced. Take a look at the following illustration depicting how to set up ATS-P in the case of overlapping signal ranges: [[Image:illustration_transponder_setup_atsp_overlap.png]] The corresponding code could look something like this: 

{|
| width="16" valign="top" |
| ''''
|-
| width="16" valign="top" | ▶
| style="border: 1px dashed currentColor" bgcolor="#d4d8ff" | <tt>0200, .Tr 3 ,; 600m 0520, .Tr 3 ,; 280m 0620, .Tr 3;1 ,; 180m (signal A); 605m (signal B) 0775, .Tr 4 ,; 25m (signal A); 0777, .Tr 3;1 ,; 23m (signal A); 448m (signal B) 0800, .Signal 3;;-3;-1 ,; signal A 0945, .Tr 3 ,; 280m 1045, .Tr 3 ,; 180m 1140, .Tr 3 ,; 85m 1175, .Tr 3 ,; 50m 1200, .Tr 4 ,; 25m 1225, .Signal 3;;-3;-1, ; signal B</tt>
|}

This code is simplified in that you would likely also want to include transponders for signal A at 85m and 50m, which you can do by using additional '''Track.Tr 3;1''' commands. 

{|
|- style="height: 4px"
|
|}

■ Setting up a route for both ATS-SN and ATS-P

----

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| 
|}

Often, a route equipped with ATS-P additionally employs equipment for ATS-SN, be it for trains not equipped with ATS-P, or as a fallback should ATS-P suffer from a failure. Normally, any of the S-type or SN-type transponders will activate the ATS-SN system, while any of the pattern renewal or immediate stop transponders will activate ATS-P. In order for an ATS-P-equipped train to stay in ATS-P operation all the time, you should set up all ATS-SN-related transponders to not change the current safety system. This can be done via '''Track.Tr ''type''<nowiki>; </nowiki>''signal''<nowiki>; -1</nowiki>'''. [[Image:illustration_transponder_setup_atsp_atssn.png]] You should make sure that no two transponders occupy the same location. Both the S-type and the pattern renewal transponders are usually placed 600 meters in front of each signal. If you place the pattern renewal transponder first, ATS-P can activate if not already active, and the subsequent S-type transponder will have no effect on a train equipped with ATS-P. Your code will thus need to follow this scheme: 

{|
| width="16" valign="top" |
| ''''
|-
| width="16" valign="top" | ▶
| style="border: 1px dashed currentColor" bgcolor="#d4d8ff" | <tt>With Track 0195, .Tr 3 0200, .Tr 0;;-1 0520, .Tr 3 0620, .Tr 3 0715, .Tr 3 0750, .Tr 3 0775, .Tr 4 0780, .Tr 1;;-1 0800, .Signal 3;;-3;-1</tt>
|}

If the signal distance is shorter than 600 meters, you should additionally employ the techniques described in the respective sections for ATS-SN and ATS-P. 

{|
|- style="height: 4px"
|
|}

■ Setting up a route for the use of accidental departure transponders

----

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| 
|}

In stations, the accidental departure transponders are occasionally placed shortly after a station stop point to prevent a train from accidentally starting toward a red signal. The accidental departure transponder will trigger regardless of whether the train currently operates in ATS-SN or in ATS-P. As you can define multiple stop points per station, each being associated to a particular number of cars, any accidental departure transponder will only be active if it is behind the stop point at which the train is supposed to stop at. You can employ the accidental departure transponder in the following way: 

{|
| width="16" valign="top" |
| ''''
|-
| width="16" valign="top" | ▶
| style="border: 1px dashed currentColor" bgcolor="#d4d8ff" | <tt>0100, .Sta 0178, .Stop 1;;;4 0180, .Tr 2 0212, .Stop 1;;;6 0214, .Tr 2 0246, .Stop 1;;;8 0248, .Tr 2 0280, .Stop 1;;;10 0282, .Tr 2 0300, .Signal 3;;-3;-1</tt>
|}

If, in this code example, your train had a length of 8 cars, the transponders at 248 and 282 would bring the train to a hold immediately if the upcoming signal at 300 is red.

CSVRouteQuickRef

2015-02-07T00:23:00Z

Kevin: Created page with " The '''.csv''' route format - Quick reference {| style="border: 0px currentColor; ma..."

The '''.csv''' route format - Quick reference 

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| 
|}

 '''Notes:''' 

{|
| valign="top" | ●
|
| Arguments highlighted in '''green''' are affected by Options.UnitOfLength.
|}

{|
| valign="top" | ●
|
| Arguments highlighted in '''blue''' are affected by Options.UnitOfSpeed.
|}

{|
| valign="top" | ●
|
| Optional suffixes are indicated in gray. Mandatory suffixes are '''bolded'''.
|}

{|
| valign="top" | ●
|
| Syntax variations are not possible with the $-directives.
|}

{|
| valign="top" | ●
|
| The statement separator is the , character.
|}

----

 Track positions ''Number'' ''Number1'' : ''Number2'' : ''...'' : ''Numbern'' Preprocessing directives '''$Include('''''File1''<nowiki>; </nowiki>''Weight1''<nowiki>; </nowiki>''File2''<nowiki>; </nowiki>''Weight2''<nowiki>; ...</nowiki>''')''' '''$Chr('''''AsciiCode''''')''' '''$Rnd('''''Minimum'''''<nowiki>; </nowiki>'''''Maximum''''')''' '''$Sub('''''VariableIndex''''')''' = ''Value'' '''$Sub('''''VariableIndex''''')''' '''$If('''''Condition''''')''' '''$ElseIf'''() '''$EndIf'''() Options namespace '''Options.UnitOfLength''' ''FactorInMeters1''<nowiki>; </nowiki>''FactorInMeters2''<nowiki>; </nowiki>''...''<nowiki>; </nowiki>''FactorInMetersn'' '''Options.UnitOfSpeed''' ''FactorInKmph'' '''Options.BlockLength''' ''Length'' '''Options.ObjectVisibility''' { '''0''' = legacy | '''1''' = track-based } '''Options.SectionBehavior''' { '''0''' = index-based | '''1''' = value-based } '''Options.CantBehavior''' { '''0''' = unsigned | '''1''' = signed } '''Options.FogBehavior''' { '''0''' = block-wise | '''1''' = interpolated } Route namespace '''Route.Comment''' ''Text'' '''Route.Image''' ''FileName'' '''Route.Timetable''' ''Text'' '''Route.Change''' { '''-1''' = service brakes (ATS) | '''0''' = emergency brakes (no ATS) | '''1''' = service brakes (ATS) } '''Route.Gauge''' ''ValueInMillimeters'' '''Route.Signal('''''Aspect''''')'''.Set ''Speed'' '''Route.RunInterval''' ''Interval0''<nowiki>; </nowiki>''Interval1''<nowiki>; ...; </nowiki>''Intervaln-1'' '''Route.AccelerationDueToGravity''' ''Value'' '''Route.Elevation''' ''Height'' '''Route.Temperature''' ''ValueInCelsius'' '''Route.Pressure''' ''ValueInKPa'' '''Route.AmbientLight''' ''RedValue''<nowiki>; </nowiki>''GreenValue''<nowiki>; </nowiki>''BlueValue'' '''Route.DirectionalLight''' ''RedValue''<nowiki>; </nowiki>''GreenValue''<nowiki>; </nowiki>''BlueValue'' '''Route.LightDirection''' ''Theta''<nowiki>; </nowiki>''Phi'' Train namespace '''Train.Folder''' ''FolderName'' '''Train.Run('''''RailTypeIndex''''')'''.Set ''RunSoundIndex'' '''Train.Flange('''''RailTypeIndex''''')'''.Set ''FlangeSoundIndex'' '''Train.Timetable('''''TimetableIndex''''').Day'''.Load ''FileName'' '''Train.Timetable('''''TimetableIndex''''').Night'''.Load ''FileName'' '''Train.Gauge''' ''ValueInMillimeters'' '''Train.Interval''' ''Interval0''<nowiki>; </nowiki>''Interval1''<nowiki>; ...; </nowiki>''Intervaln-1'' '''Train.Velocity''' ''Speed'' Structure namespace '''Structure.Rail('''''RailStructureIndex''''')'''.Load ''FileName'' '''Structure.Beacon('''''BeaconStructureIndex''''')'''.Load ''FileName'' '''Structure.Pole('''''AdditionalRailsCovered'''''<nowiki>; </nowiki>'''''PoleStructureIndex''''')'''.Load ''FileName'' '''Structure.Ground('''''GroundStructureIndex''''')'''.Load ''FileName'' '''Structure.WallL('''''WallStructureIndex''''')'''.Load ''FileName'' '''Structure.WallR('''''WallStructureIndex''''')'''.Load ''FileName'' '''Structure.DikeL('''''DikeStructureIndex''''')'''.Load ''FileName'' '''Structure.DikeR('''''DikeStructureIndex''''')'''.Load ''FileName'' '''Structure.FormL('''''FormStructureIndex''''')'''.Load ''FileName'' '''Structure.FormR('''''FormStructureIndex''''')'''.Load ''FileName'' '''Structure.FormCL('''''FormStructureIndex''''')'''.Load ''FileName'' '''Structure.FormCR('''''FormStructureIndex''''')'''.Load ''FileName'' '''Structure.RoofL('''''RoofStructureIndex''''')'''.Load ''FileName'' '''Structure.RoofR('''''RoofStructureIndex''''')'''.Load ''FileName'' '''Structure.RoofCL('''''RoofStructureIndex''''')'''.Load ''FileName'' '''Structure.RoofCR('''''RoofStructureIndex''''')'''.Load ''FileName'' '''Structure.CrackL('''''CrackStructureIndex''''')'''.Load ''FileName'' '''Structure.CrackR('''''CrackStructureIndex''''')'''.Load ''FileName'' '''Structure.FreeObj('''''FreeObjStructureIndex''''')'''.Load ''FileName'' Texture namespace '''Texture.Background('''''BackgroundTextureIndex''''')'''.Load ''FileName'' '''Texture.Background('''''BackgroundTextureIndex''''').X''' ''RepetitionCount'' '''Texture.Background('''''BackgroundTextureIndex''''').Aspect''' { '''0''' = fixed height | '''1''' = keep aspect ratio } Cycle namespace '''Cycle.Ground('''''GroundStructureIndex''''')'''.Params ''GroundStructureIndex1''<nowiki>; </nowiki>''GroundStructureIndex2''<nowiki>; </nowiki>''...''<nowiki>; </nowiki>''GroundStructureIndexn'' Signal namespace '''Signal('''''SignalIndex''''')'''.Load ''AnimatedObjectFile'' '''Signal('''''SignalIndex''''')'''.Load ''SignalFileWithoutExtension''<nowiki>; </nowiki>''GlowFileWithoutExtension'' Track namespace ''Rails:'' '''Track.RailStart''' ''RailIndex''<nowiki>; </nowiki>''X''<nowiki>; </nowiki>''Y''<nowiki>; </nowiki>''RailStructureIndex'' '''Track.Rail''' ''RailIndex''<nowiki>; </nowiki>''X''<nowiki>; </nowiki>''Y''<nowiki>; </nowiki>''RailStructureIndex'' '''Track.RailType''' ''RailIndex''<nowiki>; </nowiki>''RailStructureIndex'' '''Track.RailEnd''' ''RailIndex''<nowiki>; </nowiki>''X''<nowiki>; </nowiki>''Y'' '''Track.Accuracy''' ''Value'' '''Track.Adhesion''' ''Value'' ''Geometry:'' '''Track.Pitch''' ''ValueInPermille'' '''Track.Curve''' ''Radius''<nowiki>; </nowiki>''CantInMillimeters'' '''Track.Turn''' ''Ratio'' '''Track.Height''' ''Height'' ''Objects:'' '''Track.FreeObj''' ''RailIndex''<nowiki>; </nowiki>''FreeObjStructureIndex''<nowiki>; </nowiki>''X''<nowiki>; </nowiki>''Y''<nowiki>; </nowiki>''Yaw''<nowiki>; </nowiki>''Pitch''<nowiki>; </nowiki>''Roll'' '''Track.Wall''' ''RailIndex''<nowiki>; </nowiki>''Direction''<nowiki>; </nowiki>''WallStructureIndex'' '''Track.WallEnd''' ''RailIndex'' '''Track.Dike''' ''RailIndex''<nowiki>; </nowiki>''Direction''<nowiki>; </nowiki>''DikeStructureIndex'' '''Track.DikeEnd''' ''RailIndex'' '''Track.Pole''' ''RailIndex''<nowiki>; </nowiki>''AdditionalRailsCovered''<nowiki>; </nowiki>''Location''<nowiki>; </nowiki>''Interval''<nowiki>; </nowiki>''PoleStructureIndex'' '''Track.PoleEnd''' ''RailIndex'' '''Track.Crack''' ''RailIndex1''<nowiki>; </nowiki>''RailIndex2''<nowiki>; </nowiki>''CrackStructureIndex'' '''Track.Ground''' ''CycleIndex'' ''Stations:'' '''Track.Sta''' ''Name''<nowiki>; </nowiki>''ArrivalTime''<nowiki>; </nowiki>''DepartureTime''<nowiki>; </nowiki>''PassAlarm''<nowiki>; </nowiki>''Doors''<nowiki>; </nowiki>''ForcedRedSignal''<nowiki>; </nowiki>''System''<nowiki>; </nowiki>''ArrivalSound''<nowiki>; </nowiki>''StopDuration''<nowiki>; </nowiki>''PassengerRatio''<nowiki>; </nowiki>''DepartureSound''<nowiki>; </nowiki>''TimetableIndex'' '''Track.Station''' ''Name''<nowiki>; </nowiki>''ArrivalTime''<nowiki>; </nowiki>''DepartureTime''<nowiki>; </nowiki>''ForcedRedSignal''<nowiki>; </nowiki>''System''<nowiki>; </nowiki>''DepartureSound'' '''Track.Stop''' ''Direction''<nowiki>; </nowiki>''BackwardTolerance''<nowiki>; </nowiki>''ForwardTolerance''<nowiki>; </nowiki>''Cars'' '''Track.Form''' ''RailIndex1''<nowiki>; </nowiki>''RailIndex2''<nowiki>; </nowiki>''RoofStructureIndex''<nowiki>; </nowiki>''FormStructureIndex'' ''Signalling and speed limits:'' '''Track.Limit''' ''Speed''<nowiki>; </nowiki>''Direction''<nowiki>; </nowiki>''Cource'' '''Track.Section''' ''Aspect0''<nowiki>; </nowiki>''Aspect1''<nowiki>; </nowiki>''...''<nowiki>; </nowiki>''Aspectn'' '''Track.SigF''' ''SignalIndex''<nowiki>; </nowiki>''Section''<nowiki>; </nowiki>''X''<nowiki>; </nowiki>''Y''<nowiki>; </nowiki>''Yaw''<nowiki>; </nowiki>''Pitch''<nowiki>; </nowiki>''Roll'' '''Track.Signal''' ''Aspects''<nowiki>; </nowiki>''<strike>Unused</strike>''<nowiki>; </nowiki>''X''<nowiki>; </nowiki>''Y''<nowiki>; </nowiki>''Yaw''<nowiki>; </nowiki>''Pitch''<nowiki>; </nowiki>''Roll'' '''Track.Relay''' ''X''<nowiki>; </nowiki>''Y''<nowiki>; </nowiki>''Yaw''<nowiki>; </nowiki>''Pitch''<nowiki>; </nowiki>''Roll'' ''Safety systems:'' '''Track.Beacon''' ''Type''<nowiki>; </nowiki>''BeaconStructureIndex''<nowiki>; </nowiki>''Section''<nowiki>; </nowiki>''Data''<nowiki>; </nowiki>''X''<nowiki>; </nowiki>''Y''<nowiki>; </nowiki>''Yaw''<nowiki>; </nowiki>''Pitch''<nowiki>; </nowiki>''Roll'' '''Track.Transponder''' ''Type''<nowiki>; </nowiki>''Signals''<nowiki>; </nowiki>''SwitchSystems''<nowiki>; </nowiki>''X''<nowiki>; </nowiki>''Y''<nowiki>; </nowiki>''Yaw''<nowiki>; </nowiki>''Pitch''<nowiki>; </nowiki>''Roll'' '''Track.AtsSn''' '''Track.AtsP''' '''Track.Pattern''' ''Type''<nowiki>; </nowiki>''Speed'' '''Track.PLimit''' ''Speed'' ''Miscellaneous:'' '''Track.Back''' ''BackgroundTextureIndex'' '''Track.Fog''' ''StartingDistance''<nowiki>; </nowiki>''EndingDistance''<nowiki>; </nowiki>''RedValue''<nowiki>; </nowiki>''GreenValue''<nowiki>; </nowiki>''BlueValue'' '''Track.Brightness''' ''Value'' '''Track.Marker''' ''FileName''<nowiki>; </nowiki>''Distance'' '''Track.PointOfInterest''' ''RailIndex''<nowiki>; </nowiki>''X''<nowiki>; </nowiki>''Y''<nowiki>; </nowiki>''Yaw''<nowiki>; </nowiki>''Pitch''<nowiki>; </nowiki>''Roll''<nowiki>; </nowiki>''Text'' '''Track.PreTrain''' ''Time'' '''Track.Announce''' ''FileName''<nowiki>; </nowiki>''Speed'' '''Track.Doppler''' ''FileName''<nowiki>; </nowiki>''X''<nowiki>; </nowiki>''Y'' '''Track.Buffer'''

RWRouteRef

2015-02-07T00:22:03Z

Kevin: Created page with " The '''.rw''' route format - Quick reference {| style="border: 0px currentColor; mar..."

The '''.rw''' route format - Quick reference 

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| 
|}

 '''Notes:''' 

{|
| valign="top" | ●
|
| Arguments highlighted in '''green''' are affected by UnitOfLength in [Options].
|}

{|
| valign="top" | ●
|
| Arguments highlighted in '''blue''' are affected by UnitOfSpeed in [Options].
|}

{|
| valign="top" | ●
|
| Each command takes one line, except for commands starting in an @ sign, which can be chained together on the same line.
|}

----

 Track positions ''Number'' ''Number1'' : ''Number2'' : ''...'' : ''Numbern'' Preprocessing directives '''$Include('''''File1''<nowiki>; </nowiki>''Weight1''<nowiki>; </nowiki>''File2''<nowiki>; </nowiki>''Weight2''<nowiki>; ...</nowiki>''')''' '''$Chr('''''AsciiCode''''')''' '''$Rnd('''''Minimum'''''<nowiki>; </nowiki>'''''Maximum''''')''' '''$Sub('''''VariableIndex''''')''' = ''Value'' '''$Sub('''''VariableIndex''''')''' '''$If('''''Condition''''')''' '''$ElseIf'''() '''$EndIf'''() [Options] '''UnitOfLength''' = ''FactorInMeters1''<nowiki>; </nowiki>''FactorInMeters2''<nowiki>; </nowiki>''...''<nowiki>; </nowiki>''FactorInMetersn'' '''UnitOfSpeed''' = ''FactorInKmph'' '''BlockLength''' = ''Length'' '''ObjectVisibility''' = { '''0''' = legacy | '''1''' = track-based } '''SectionBehavior''' = { '''0''' = index-based | '''1''' = value-based } '''CantBehavior''' = { '''0''' = unsigned | '''1''' = signed } '''FogBehavior''' = { '''0''' = block-wise | '''1''' = interpolated } [Route] '''Comment''' = ''Text'' '''Image''' = ''FileName'' '''Timetable''' = ''Text'' '''Change''' = { '''-1''' = service brakes (ATS) | '''0''' = emergency brakes (no ATS) | '''1''' = service brakes (ATS) } '''Gauge''' = ''ValueInMillimeters'' '''Signal('''''Aspect''''') = ''Speed''''' '''RunInterval''' = ''Interval0''<nowiki>; </nowiki>''Interval1''<nowiki>; ...; </nowiki>''Intervaln-1'' '''AccelerationDueToGravity''' = ''Value'' '''Elevation''' = ''Height'' '''Temperature''' = ''ValueInCelsius'' '''Pressure''' = ''ValueInKPa'' '''AmbientLight''' = ''RedValue''<nowiki>; </nowiki>''GreenValue''<nowiki>; </nowiki>''BlueValue'' '''DirectionalLight''' = ''RedValue''<nowiki>; </nowiki>''GreenValue''<nowiki>; </nowiki>''BlueValue'' '''LightDirection''' = ''Theta''<nowiki>; </nowiki>''Phi'' [Train] '''Folder''' = ''FolderName'' '''Run('''''RailTypeIndex''''')''' = ''RunSoundIndex'' '''Flange('''''RailTypeIndex''''')''' = ''FlangeSoundIndex'' '''Timetable('''''TimetableIndex''''').Day''' = ''FileName'' '''Timetable('''''TimetableIndex''''').Night''' = ''FileName'' '''Gauge''' = ''ValueInMillimeters'' '''Interval''' = ''Interval0''<nowiki>; </nowiki>''Interval1''<nowiki>; ...; </nowiki>''Intervaln-1'' '''Velocity''' = ''Speed'' [Object] '''Rail('''''RailStructureIndex''''')''' = ''FileName'' '''Beacon('''''BeaconStructureIndex''''')''' = ''FileName'' '''Pole('''''AdditionalRailsCovered''''', '''''PoleStructureIndex''''')''' = ''FileName'' '''Ground('''''GroundStructureIndex''''')''' = ''FileName'' '''WallL('''''WallStructureIndex''''')''' = ''FileName'' '''WallR('''''WallStructureIndex''''')''' = ''FileName'' '''DikeL('''''DikeStructureIndex''''')''' = ''FileName'' '''DikeR('''''DikeStructureIndex''''')''' = ''FileName'' '''FormL('''''FormStructureIndex''''')''' = ''FileName'' '''FormR('''''FormStructureIndex''''')''' = ''FileName'' '''FormCL('''''FormStructureIndex''''')''' = ''FileName'' '''FormCR('''''FormStructureIndex''''')''' = ''FileName'' '''RoofL('''''RoofStructureIndex''''')''' = ''FileName'' '''RoofR('''''RoofStructureIndex''''')''' = ''FileName'' '''RoofCL('''''RoofStructureIndex''''')''' = ''FileName'' '''RoofCR('''''RoofStructureIndex''''')''' = ''FileName'' '''CrackL('''''CrackStructureIndex''''')''' = ''FileName'' '''CrackR('''''CrackStructureIndex''''')''' = ''FileName'' '''FreeObj('''''FreeObjStructureIndex''''') = ''FileName''''' '''Back('''''BackgroundTextureIndex''''')''' = ''FileName'' '''Back('''''BackgroundTextureIndex''''').X''' = ''RepetitionCount'' '''Back('''''BackgroundTextureIndex''''').Aspect''' = { '''0''' = fixed height | '''1''' = keep aspect ratio } [Cycle] ''GroundStructureIndex'' = ''GroundStructureIndex1''<nowiki>; </nowiki>''GroundStructureIndex2''<nowiki>; </nowiki>''...''<nowiki>; </nowiki>''GroundStructureIndexn'' [Signal] ''SignalIndex'' = ''AnimatedObjectFile'' ''SignalIndex'' = ''SignalFileWithoutExtension''<nowiki>; </nowiki>''GlowFileWithoutExtension'' [Railway] ''Rails:'' '''@RailStart'''(''RailIndex'', ''X'', ''Y'', ''RailStructureIndex'') '''@Rail'''(''RailIndex'', ''X'', ''Y'', ''RailStructureIndex'') '''@RailType'''(''RailIndex'', ''RailStructureIndex'') '''@RailEnd'''(''RailIndex'', ''X'', ''Y'') '''@Accuracy'''(''Value'') '''@Adhesion'''(''Value'') ''Geometry:'' '''@Pitch'''(''ValueInPermille'') '''@Curve'''(''Radius'', ''CantInMillimeters'') '''@Turn'''(''Ratio'') '''@Height'''(''Height'') ''Objects:'' '''@FreeObj'''(''RailIndex'', ''FreeObjStructureIndex'', ''X'', ''Y'', ''Yaw'', ''Pitch'', ''Roll'') '''@Wall'''(''RailIndex'', ''Direction'', ''WallStructureIndex'') '''@WallEnd'''(''RailIndex'') '''@Dike'''(''RailIndex'', ''Direction'', ''DikeStructureIndex'') '''@DikeEnd'''(''RailIndex'') '''@Pole'''(''RailIndex'', ''AdditionalRailsCovered'', ''Location'', ''Interval'', ''PoleStructureIndex'') '''@PoleEnd'''(''RailIndex'') '''@Crack'''(''RailIndex1'', ''RailIndex2'', ''CrackStructureIndex'') '''@Ground'''(''CycleIndex'') ''Stations:'' '''@Sta'''(''Name'', ''ArrivalTime'', ''DepartureTime'', ''PassAlarm'', ''Doors'', ''ForcedRedSignal'', ''System'', ''ArrivalSound'', ''StopDuration'', ''PassengerRatio'', ''DepartureSound'', ''TimetableIndex'') '''@Station'''(''Name'', ''ArrivalTime'', ''DepartureTime'', ''ForcedRedSignal'', ''System'', ''DepartureSound'') '''@Stop'''(''Direction'', ''BackwardTolerance'', ''ForwardTolerance'', ''Cars'') '''@Form'''(''RailIndex1'', ''RailIndex2'', ''RoofStructureIndex'', ''FormStructureIndex'') ''Signalling and speed limits:'' '''@Limit'''(''Speed'', ''Direction'', ''Cource'') '''@Section'''(''Aspect0'', ''Aspect1'', ''...'', ''Aspectn'') '''@SigF'''(''SignalIndex'', ''Section'', ''X'', ''Y'', ''Yaw'', ''Pitch'', ''Roll'') '''@Signal'''(''Aspects'', ''<strike>Unused</strike>'', ''X'', ''Y'', ''Yaw'', ''Pitch'', ''Roll'') '''@Relay'''(''X'', ''Y'', ''Yaw'', ''Pitch'', ''Roll'') ''Safety systems:'' '''@Beacon'''(''Type'', ''BeaconStructureIndex'', ''Section'', ''Data'', ''X'', ''Y'', ''Yaw'', ''Pitch'', ''Roll'') '''@Transponder'''(''Type'', ''Signals'', ''SwitchSystems'', ''X'', ''Y'', ''Yaw'', ''Pitch'', ''Roll'') '''@AtsSn''' '''@AtsP''' '''@Pattern'''(''Type'', ''Speed'') '''@PLimit'''(''Speed'') ''Miscellaneous:'' '''@Back'''(''BackgroundTextureIndex'') '''@Fog'''(''StartingDistance'', ''EndingDistance'', ''RedValue'', ''GreenValue'', ''BlueValue'') '''@Brightness'''(''Value'') '''@Marker'''(''FileName'', ''Distance'') '''@PointOfInterest'''(''RailIndex'', ''X'', ''Y'', ''Yaw'', ''Pitch'', ''Roll'', ''Text'') '''@PreTrain'''(''Time'') '''@Announce'''(''FileName'', ''Speed'') '''@Doppler'''(''FileName'', ''X'', ''Y'') '''@Buffer'''

RW Routes

2015-02-07T00:21:51Z

Kevin: Created page with " The '''.rw''' route format {| style="border: 0px currentColor; margin-right: 10pt; m..."

The '''.rw''' route format 

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| 
|}

 The RW route format is functionally equivalent to the CSV route format, but differs in syntax, structure and choice of words. Given that the RW route format is not frequently used any longer, it is recommended to use the CSV route format instead. There is no full documentation on RW routes, only the quick reference which illustrates the available commands and syntax: ➟ [[RWRouteRef|Quick reference...]] Please refer to the documentation for CSV routes for the behavior of the various commands, but mind that choice of words and syntax differ in CSV. You can also compare against the [[CSVRouteQuickRef|quick reference for CSV routes]] to work out the differences between the formats. 

----

 '''Behavioral differences between CSV and RW''' In RW, comments starting with a semicolon can only be used at the end of a line inside the [Railway] section. Outside of the [Railway] section, comments must appear on their own line. In RW, every piece of text before the first [Section] is considered part of the route description, which is Route.Comment in CSV. In RW, the default @Height at the beginning of the route is 0.3 meters, while in CSV, the default Track.Height is 0.0 meters. Additionally, every value passed to @Height is added an additional 0.3 meters in RW. In RW, the second argument to @Form can take special values: -9 is the same as L, 9 is the same as R, and 9X references rail 9. In CSV, -9 is invalid and 9 references rail 9.

CSV Routes

2015-02-07T00:21:13Z

Kevin: Created page with " The '''.csv''' route format =Overview= A C..."

The '''.csv''' route format 

=Overview=

A CSV route allows to create a route in a text file. The file is a plain text file encoded in any arbitrary [http://trainsimframework.org/develop/information_encodings.html encoding], however, UTF-8 with a byte order mark is the preferred choice. The [http://trainsimframework.org/develop/information_numberformats.html parsing model] for numbers is '''Loose''' (unless otherwise stated), however, you are encouraged to produce ''Strict'' output nonetheless. The file is required to be located inside any folder whose current or parent folder includes the ''Railway'' and ''Train'' folders. The file name is arbitrary, but must have the extension '''.csv'''. The file is interpreted on a per-line basis, from top to bottom, where each line is split into expressions, which are interpreted from left to right. The route file consists of a series of commands to define the objects which are used throughout the route (Structure namespace). Additional properties for the route, for the default train to be used and for the background images to be used can also be defined. At last, the route file will contain instructions from the Track namespace. Here, track positions (usually in meters) are used to define when the track should curve, when stations are to be placed, when a wall should start and end, and so on. Generally speaking, instructions from the Track namespace should be used after using instructions from any of the other namespaces. The format assumes an implicit rail 0 which cannot be explicitly started or ended. Instead, it is present from the beginning of the route to the end, and it marks the rail the player's train drives on. All other rails in the CSV format are purely visual and have no functional purpose. Geometrically, you can curve and pitch the implicit rail 0, while all other rails are defined relative to rail 0 and follow rail 0 into curves and pitch changes. Unless overridden, the file format is built around a fixed block size of 25 meters length, and it is only possible for certain commands to be used on 25 meter block boundaries. The placement of objects always assumes a non-curved coordinate system which connects blocks linearly. 

➟ [[CSVRouteQuickRef|See also the quick reference for the CSV route...]] 

{| style="border: 2px groove currentColor; margin-right: 20pt; margin-left: 20pt" align="center"
| style="border: 2px ridge currentColor" bgcolor="#c04040" | Check these tutorials out:
|-
| bgcolor="#ffffff" |
*[http://www.bvestation.com/forums/index.php?topic=2772.0 .CSV Route Building Part 1 By ipac]
*[http://www.bvestation.com/forums/index.php?topic=2773.0 .CSV Route Building Part 2 By ipac]
*[http://www.freewebs.com/dennislance/ Dennis Lance's Route Building Tutorials]
*[http://www.freewebs.com/dennislance/modifying%20existing%20routes.htm Modifying Existing .CSV Routes By Dennis Lance]
|}

=Syntax=

For each line in the file, white spaces at the beginning and the end of that line are ignored. Then, lines are split into individual expressions, separated by commas (U+002C). Thus, each line is of the following form: 

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | ''Expression1'', ''Expression2'', ''Expression3'', ..., ''Expressionn''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| 
|}

In turn, each expression can be of any of the following forms: 

{|
|- style="height: 4px"
|
|}

==Comments==

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| 
|}

{|
|- style="height: 2px"
|
|}

A comment is completely ignored by the parser. To form a comment, the expression must begin with a semicolon (U+003B). 

{|
|- style="height: 4px"
|
|}

==Track positions and lengths==

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| 
|}

{|
|- style="height: 2px"
|
|}

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | ''Position''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| 
|}

A non-negative [http://trainsimframework.org/develop/information_numberformats.html strict] floating-point number corresponding to a track position. All subsequent commands from the Track namespace are associated to this track position. 

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | ''Part1''<nowiki>:</nowiki>''Part2''<nowiki>:...:</nowiki>''Partn''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| 
|}

This is a more complex way of specifying track positions for use in conjunction with Options.UnitOfLength. Each of the ''Parti'' is a [http://trainsimframework.org/develop/information_numberformats.html strict] floating-point number. ''Part1'' will be multiplied with ''Factor1'', ''Part2'' with ''Factor2'', and so on, then all products are added together to form the final track position. This track position must be non-negative. The parts are separated by colons (U+003A). Please consult Options.UnitOfLength for further information on how to define the factors. Whereever arguments in commands represent lengths, they can also be entered using the colon notation. These cases are highlighted in green in the following. When ''n'' units are defined via Options.UnitOfLength, but fewer parameters are given using the colon notation, the parameters are right-associative, meaning, the parameters on the left are those which are skipped. Therefore, each of the following lengths are equivalent: ''0:0:2'', ''0:2'', and ''2''. 

{|
|- style="height: 4px"
|
|}

==Commands==

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| 
|}

{|
|- style="height: 2px"
|
|}

Commands without arguments: 

{|
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | ''NameOfTheCommand''
|}

 Commands with arguments: 

{|
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | ''NameOfTheCommand'' ''Argument1''<nowiki>;</nowiki>''Argument2''<nowiki>;</nowiki>''Argument3''<nowiki>;...;</nowiki>''Argumentn'' ''NameOfTheCommand''(''Argument1''<nowiki>;</nowiki>''Argument2''<nowiki>;</nowiki>''Argument3''<nowiki>;...;</nowiki>''Argumentn'')
|}

 Commands with indices and arguments: 

{|
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | ''NameOfTheCommand''(''Index1''<nowiki>;</nowiki>''Index2''<nowiki>;...;</nowiki>''Indexm'') ''Argument1''<nowiki>;</nowiki>''Argument2''<nowiki>;</nowiki>''Argument3''<nowiki>;...;</nowiki>''Argumentn'' ''NameOfTheCommand''(''Index1''<nowiki>;</nowiki>''Index2''<nowiki>;...;</nowiki>''Indexm'').''Suffix'' ''Argument1''<nowiki>;</nowiki>''Argument2''<nowiki>;</nowiki>''Argument3''<nowiki>;...;</nowiki>''Argumentn'' ''NameOfTheCommand''(''Index1''<nowiki>;</nowiki>''Index2''<nowiki>;...;</nowiki>''Indexm'').''Suffix''(''Argument1''<nowiki>;</nowiki>''Argument2''<nowiki>;</nowiki>''Argument3''<nowiki>;...;</nowiki>''Argumentn'')
|}

 Rules: ''NameOfTheCommand'' is case-insensitive. Indices and arguments are separated by semicolons (U+003B). White spaces around ''NameOfTheCommand'' and any of the indices and arguments are ignored. White spaces surrounding any of the parantheses are also ignored. If indices are used, these are enclosed by opening parantheses (U+0028) and closing parantheses (U+0029). At least one argument, or a ''Suffix'' is mandatory when using indices. There are two variations on how to encode arguments. Except for the $-directives ($Chr, $Rnd, $Sub, ...), you can freely choose which variant to use. Variant 1: The first argument is separated from the command, indices or ''Suffix'' by at least one space (U+0020). Variant two: The arguments are enclosed by opening parantheses (U+0028) and closing parantheses (U+0029). In the latter case, ''Suffix'' is mandatory when used in conjunction with indices. White spaces surrounding any of the parantheses are ignored. Please note that in some commands, ''Suffix'' is mandatory regardless of the style you use to encode arguments. In the following, ''Suffix'' will be '''bolded''' when it is mandatory, and grayed when it is optional. 

{|
|- style="height: 4px"
|
|}

==The '''With''' statement==

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| 
|}

{|
|- style="height: 2px"
|
|}

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | With ''Prefix''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| 
|}

All subsequent commands that start with a period (U+002E) are prepended by ''Prefix''. For example: 

{|
| width="16" valign="top" |
| ''''
|-
| width="16" valign="top" | ▶
| style="border: 1px dashed currentColor" bgcolor="#d4d8ff" | <tt>With Route .Gauge 1435 .Timetable 1157_M</tt>
|}

Is equivalent to: 

{|
| width="16" valign="top" |
| ''''
|-
| width="16" valign="top" | ▶
| style="border: 1px dashed currentColor" bgcolor="#d4d8ff" | <tt>Route.Gauge 1435 Route.Timetable 1157_M</tt>
|}

 

{|
|- style="height: 4px"
|
|}

=Preprocessing=

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| 
|}

Before any of the commands in the route file are actually interpreted, the expressions are preprocessed. The first thing done is to replace any occurences of the $-directives within an expression from right to left. The $Chr, $Rnd and $Sub directives may be nested in any way, while $Include, $If, $Else and $EndIf must not appear inside another directive. 

{|
| ⚠
|
| bgcolor="#e0e0e0" |
| bgcolor="#e0e0e0" | The syntax for the $-directives cannot be freely chosen, but must adhere to the forms presented below.
| bgcolor="#e0e0e0" |
|}

==Include==

 

{|
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | $Include(''File'') $Include(''File''<nowiki>:</nowiki>''TrackPositionOffset'') $Include(''File1''<nowiki>; </nowiki>''Weight1''<nowiki>; </nowiki>''File2''<nowiki>; </nowiki>''Weight2''<nowiki>; ...)</nowiki>
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| '''''Filei'''''<nowiki>: A file to include of the same format (CSV/RW) as the main file.</nowiki> '''''Weighti'''''<nowiki>: A positive floating-point number giving a probability weight for the corresponding file. </nowiki>
|}

This directive chooses randomly from the specified files based on their associated probabilities and includes the content from one selected file into the main file. The content is copied into the place of the $Include directive, meaning that you need to take care of track positions and the last used With statement, for example. If the last weight in the argument sequence is omitted, it is treated as 1. The $Include directive is useful for splitting up a large file into smaller files, for sharing common sections of code between multiple routes, and for choosing randomly from a larger block of code. Please note that the included files may themselves include other files, but you need to make sure that there are no circular dependencies, e.g. file A including file B, and file B including file A, etc. You should use a file extension different from .csv for included files so that users cannot accidentally select them in the main menu (except where this is desired). If any of the ''Filei'' is followed by :''TrackPositionOffset'', then all expressions in the included file are offset by the specified track position '''in meters'''. For example, $Include(stations.include:2000) shifts all track positions in the part.include file by 2000 meters before including them. It is important to understand that "track positions" are not actually understood until after the $-directives have been processed, so all expressions in the included file are simply flagged to be offset later should they form track positions then. This means that if the included file contains expressions such as 1$Rnd(2;8)00, these are offset, too, even though at this stage, they do not form track positions yet. 

{|
| ⚠
|
| bgcolor="#e0e0e0" |
| bgcolor="#e0e0e0" | The track position offset feature is only available in the development release 1.2.11 and above.
| bgcolor="#e0e0e0" |
|}

==$Chr(''Ascii'')==

 

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | $Chr(''Ascii'')
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| '''''Ascii'''''<nowiki>: An integer in the range from 20 to 127, or 10 or 13, corresponding to an ASCII character of the same code.</nowiki>
|}

This directive is replaced by the ASCII character represented by ''Ascii''. This is useful if you want to include characters that are part of syntax rules or would be stripped away. A list of relevant characters: 

{| style="border-collapse: collapse"
! style="padding: 4px; border: 2px ridge currentColor" bgcolor="#d0d0d0" | Code
! style="padding: 4px; border: 2px ridge currentColor" bgcolor="#d0d0d0" | Meaning
! style="padding: 4px; border: 2px ridge currentColor" bgcolor="#d0d0d0" | Character
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | 10
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | Newline
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | ''newline''
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | 13
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | Newline
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | ''newline''
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | 20
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | Space
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | ''space''
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | 40
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | Opening parantheses
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | (
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | 41
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | Closing parantheses
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | )
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | 44
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | Comma
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | ,
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | 59
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | Semicolon
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | <nowiki>;</nowiki>
|}

 The sequence $Chr(13)$Chr(10) is handled as a single newline. Inserting $Chr(59) can be interpreted as a comment starter or as an argument separator, depending on where it is used. 

==Start==

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | $Rnd(''Start''<nowiki>; </nowiki>''End'')
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| '''''Start'''''<nowiki>: An integer representing the lower bound.</nowiki> '''''End'''''<nowiki>: An integer representing the upper bound.</nowiki>
|}

This directive is replaced by a random integer in the range from ''Start'' to ''End''. It is useful to add randomness to a route. 

{|
| width="16" valign="top" |
| ''Example for the use of the $Rnd directive:''
|-
| width="16" valign="top" | ▶
| style="border: 1px dashed currentColor" bgcolor="#d4d8ff" | <tt>10$Rnd(3;5)0, Track.FreeObj 0; 1</tt>
|}

{|
| width="16" valign="top" |
| ''Possible outcome from the previous example is exactly '''one''' of these lines:''
|-
| width="16" valign="top" | ▶
| style="border: 1px dashed currentColor" bgcolor="#d4d8ff" | <tt>1030, Track.FreeObj 0; 1 1040, Track.FreeObj 0; 1 1050, Track.FreeObj 0; 1</tt>
|}

==$Sub(''Index'')==

 

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | $Sub(''Index'') = ''Expression''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| '''''Index'''''<nowiki>: A non-negative integer representing the index of a variable.</nowiki> '''''Expression'''''<nowiki>: The expression to store in the variable.</nowiki>
|}

This directive should only appear as a single expression. It is used to assign ''Expression'' to a variable identified by ''Index''. The whole $Sub directive is replaced by an empty string once the assignment is done. It is useful for storing values obtained by the $Rnd directive in order to reuse the same randomly-generated value. See the following definition of the $Sub(''Index'') directive for examples. 

{|
| ⚠
|
| bgcolor="#e0e0e0" |
| bgcolor="#e0e0e0" | '''Implementation note:''' While it is also possible to store non-numeric strings, it is not possible to include commas via $Chr(44) and have them work as a statement separator. However, it is possible to store a semicolon as the first character via $Chr(59) and have it work as a comment. For conditional expressions, you should use $Include or $If, though.
| bgcolor="#e0e0e0" |
|}

==Index==

 

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | $Sub(''Index'')
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| '''''Index'''''<nowiki>: A non-negative integer representing the index of the variable to retrieve. </nowiki>
|}

This directive is replaced by the content of the variable ''Index''. The variable must have been assigned prior to retrieving it. 

{|
| width="16" valign="top" |
| ''Example for the use of the $Sub(''Index'')=''Value'' and $Sub(''Index'') directives:''
|-
| width="16" valign="top" | ▶
| style="border: 1px dashed currentColor" bgcolor="#d4d8ff" | <tt>$Sub(0) = $Rnd(3; 5) 1000, Track.FreeObj $Sub(0); 47 1020, Track.FreeObj $Sub(0); 47 1040, Track.FreeObj $Sub(0); 47</tt>
|}

In the previous example, all three Track.FreeObj commands are guaranteed to use the same randomly-generated value in order to place a free object on the same rail. If you inserted the $Rnd(3;5) directive in each of the three lines individually, the objects could be placed on different rails each time. 

==$If(''Condition'')==

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | $If(''Condition'')
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| '''''Condition'''''<nowiki>: A number that represents </nowiki>'''false''' if zero, and '''true''' otherwise. 
|}

The $If directive allows to only process subsequent expressions if the specified condition evaluates to true (any non-zero number). $If must be followed by $EndIf in any subsequent expression. Optionally, an $Else directive may appear between $If and $EndIf. 

==$Else()==

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | $Else()
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| 
|}

The $Else directive allows to only process subsequent expressions if the condition in the preceding $If evaluated to false (zero). 

==$EndIf()==

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | $EndIf()
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| 
|}

The $EndIf directive marks the end of an $If block that was started previously. 

{|
| width="16" valign="top" |
| ''Example of $If, $Else and $EndIf''
|-
| width="16" valign="top" | ▶
| style="border: 1px dashed currentColor" bgcolor="#d4d8ff" | <tt>$Sub(1) = 0 With Track $If($Sub(1)) 1020, .FreeObj 0; 1 1040, .FreeObj 0; 2 $Else() 1030, .FreeObj 0; 3 $EndIf()</tt>
|}

 

{|
| width="16" valign="top" |
| ''Another example of $If, $Else and $EndIf''
|-
| width="16" valign="top" | ▶
| style="border: 1px dashed currentColor" bgcolor="#d4d8ff" | <tt>With Track 1050 $If($Rnd(0;1)), .FreeObj 0; 4, $Else(), .FreeObj 0; 5, $EndIf()</tt>
|}

 It is possible to nest $If blocks. If you place $If/$Else/$EndIf on separate lines, you may want to employ indentation to improve readability of the block structure (as in the first example). 

==After the $-directives==

'''Finally''', after the $-directives have been processed, all expressions in the route file are sorted according to their associated track positions. 

{|
| width="16" valign="top" |
| ''Example of a partial route file:''
|-
| width="16" valign="top" | ▶
| style="border: 1px dashed currentColor" bgcolor="#d4d8ff" | <tt>1000, Track.FreeObj 0; 23 1050, Track.RailType 0; 1 10$Rnd(3;7)0, Track.Rail 1; 4 Track.FreeObj 1; 42</tt>
|}

{|
| width="16" valign="top" |
| ''Preprocessing the $Rnd directive (assuming 3 is produced):''
|-
| width="16" valign="top" | ▶
| style="border: 1px dashed currentColor" bgcolor="#d4d8ff" | <tt>1000, Track.FreeObj 0; 23 1050, Track.RailType 0; 1 1030, Track.Rail 1; 4 Track.FreeObj 1; 42</tt>
|}

{|
| width="16" valign="top" |
| ''Sorting by associated track positions:''
|-
| width="16" valign="top" | ▶
| style="border: 1px dashed currentColor" bgcolor="#d4d8ff" | <tt>1000, Track.FreeObj 0; 23 1030, Track.Rail 1; 4 Track.FreeObj 1; 42 1050, Track.RailType 0; 1</tt>
|}

 

{|
|- style="height: 4px"
|
|}

=The Options namespace=

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| 
|}

Commands from this namespace provide generic options that affect the way other commands are processed. You should make use of commands from this namespace before making use of commands from other namespaces. 

----

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | '''Options.UnitOfLength''' ''FactorInMeters1''<nowiki>; </nowiki>''FactorInMeters2''<nowiki>; </nowiki>''FactorInMeters3''<nowiki>; ...; </nowiki>''FactorInMetersn''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| '''''FactorInMetersi'''''<nowiki>: A floating-point number representing how many meters the desired unit has. The default value is 1 for </nowiki>''FactorInMeters1'', and 0 for all others.
|}

This command can be used to specify the unit of length to be used in other commands. When entering a generic track position of the form ''Part1''<nowiki>:</nowiki>''Part2''<nowiki>:...:</nowiki>''Partn'', each of the ''Parti'' will be multipled with the corresponding ''FactorInMetersi'', then all of these products are added to form a single track position represented in meters. Ideally, you should set the block length to an integer multiple of any of the units you use via Options.BlockLength. Examples of conversion factors: 

{| style="border-collapse: collapse"
! style="padding: 4px; border: 2px ridge currentColor" bgcolor="#d0d0d0" | Desired unit
! style="padding: 4px; border: 2px ridge currentColor" bgcolor="#d0d0d0" | Conversion factor
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | mile
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | 1609.344
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | chain
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | 20.1168
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | meter
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | 1
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | yard
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | 0.9144
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | foot
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | 0.3048
|}

 In the following, all arguments of all commands are highlighted in green whenever they are affected by Options.UnitOfLength. 

----

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | '''Options.UnitOfSpeed''' ''FactorInKmph''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| '''''FactorInKmph'''''<nowiki>: A floating-point number representing how many kilometes per hour the desired unit has. The default value is 1.</nowiki>
|}

This command can be used to specify the unit of speed to be used in other commands. Examples of conversion factors: 

{| style="border-collapse: collapse"
! style="padding: 4px; border: 2px ridge currentColor" bgcolor="#d0d0d0" | Desired unit
! style="padding: 4px; border: 2px ridge currentColor" bgcolor="#d0d0d0" | Conversion factor
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | meters/second
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | 3.6
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | miles/hour
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | 1.609344
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | kilometers/hour
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | 1
|}

 In the following, all arguments of all commands are highlighted in blue whenever they are affected by Options.UnitOfSpeed. 

----

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | '''Options.BlockLength''' ''Length''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| '''''Length'''''<nowiki>: A positive floating-point number representing the length of a block, </nowiki>'''by default''' measured in '''meters'''. The default is 25 meters. 
|}

This command can be used to specify the length of a block. This is an overall setting and cannot be changed in the middle of the route. ''Length'' is only expressed in the unit specified by Options.UnitOfLength if Options.UnitOfLength is used before Options.BlockLength. 

----

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | '''Options.ObjectVisibility''' ''Mode''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| '''''Mode'''''<nowiki>: The mode determining how objects appear and disappear. The default value is 0. </nowiki>
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 40pt"
| ▸ Available options for ''Mode''<nowiki>:</nowiki>
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 50pt"
| '''0'''<nowiki>: Legacy: An object is made invisible as soon as the end of the block which it resides in has been passed by the camera. This does not work well when turning the camera around. Self-intersecting track (e.g. loops) is not possible.</nowiki> '''1'''<nowiki>: Track-based: An object is made invisible as soon as its end has been passed by the camera. This is measured in track positions. Self-intersecting track (e.g. loops) is not possible. </nowiki>
|}

----

 

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | '''Options.SectionBehavior''' ''Mode''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| '''''Mode'''''<nowiki>: The mode determining how the Track.Section command is processed.</nowiki>
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 40pt"
| ▸ Available options for ''Mode''<nowiki>:</nowiki>
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 50pt"
| '''0'''<nowiki>: Default: In Track.Section </nowiki>''Aspect0''<nowiki>; </nowiki>''Aspect1''<nowiki>; ...; </nowiki>''Aspectn'', any of the ''Aspecti'' refer to the aspect the section should have if ''i'' following sections are clear. '''1'''<nowiki>: Simplified: In Track.Section </nowiki>''Aspect0''<nowiki>; </nowiki>''Aspect1''<nowiki>; ...; </nowiki>''Aspectn'', the section bears the smallest aspect which is higher than that of the following section.
|}

----

 

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | '''Options.CantBehavior''' ''Mode''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| '''''Mode'''''<nowiki>: The mode determining how cant in the Track.Curve command is processed.</nowiki>
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 40pt"
| ▸ Available options for ''Mode''<nowiki>:</nowiki>
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 50pt"
| '''0'''<nowiki>: Unsigned: The </nowiki>''CantInMillimeters'' parameter in Track.Curve is unsigned, i.e. the sign is ignored and the superelevation is always towards the curve center (inward). Cant cannot be applied on straight track. '''1'''<nowiki>: Signed: The </nowiki>''CantInMillimeters'' parameter in Track.Curve is signed, i.e. negative values bank outward and positive ones inward on curved track. Cant can be applied on straight track, where negative values bank toward the left and positive ones toward the right.
|}

----

 

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | '''Options.FogBehavior''' ''Mode''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| '''''Mode'''''<nowiki>: The mode determining how the Track.Fog command is processed. The default value is 0. </nowiki>
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 40pt"
| ▸ Available options for ''Mode''<nowiki>:</nowiki>
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 50pt"
| '''0'''<nowiki>: Block-based: Fog color and ranges are interpolated from the beginning of the block where Track.Fog is used with the old settings to the end of the block with the new settings.</nowiki> '''1'''<nowiki>: Interpolated: Fog color and ranges are interpolated between adjacent Track.Fog commands. This behavior mimicks Track.Brightness. </nowiki>
|}

 

{|
|- style="height: 4px"
|
|}

■ 5. The Route namespace

----

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| 
|}

Commands from this namespace define general properties of the route. 

----

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | '''Route.Comment''' ''Text''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| '''''Text'''''<nowiki>: The route comments which appear in the route selection dialog.</nowiki>
|}

{|
| ⚠
|
| bgcolor="#e0e0e0" |
| bgcolor="#e0e0e0" | You need to use $Chr directives if you want to include newlines, commas and the like in the text.
| bgcolor="#e0e0e0" |
|}

----

 

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | '''Route.Image''' ''File''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| '''''File'''''<nowiki>: The file name of the image which appears in the route selection dialog, relative to the route's folder.</nowiki>
|}

----

 

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | '''Route.Timetable''' ''Text''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| '''''Text'''''<nowiki>: The text which appears at the top of the default timetable.</nowiki>
|}

{|
| ⚠
|
| bgcolor="#e0e0e0" |
| bgcolor="#e0e0e0" | You need to use $Chr directives if you want to include newlines, commas and the like in the text.
| bgcolor="#e0e0e0" |
|}

----

 

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | '''Route.Change''' ''Mode''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| '''''Mode'''''<nowiki>: The mode for the train's safety system to start in. The default value is implementation-specific. </nowiki>
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 40pt"
| ▸ Available options for ''Mode''<nowiki>:</nowiki>
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 50pt"
| '''-1'''<nowiki>: The safety system is </nowiki>'''activated''' and the ''service'' brakes are applied. '''0'''<nowiki>: The safety system is </nowiki>'''activated''' and the '''emergency''' brakes are applied. '''1'''<nowiki>: The safety system is </nowiki>''deactivated'' and the '''emergency''' brakes are applied.
|}

----

 

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | '''Route.Gauge''' ''ValueInMillimeters''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| '''''ValueInMillimeters'''''<nowiki>: A floating-point number representing the rail gauge, measured in </nowiki>'''millimeters''' (0.001 meters). The default value is 1435. 
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 20pt" bgcolor="#e0e0e0"
| ☀
| ''Note: ''
|-
|
| Route.Gauge is the same as Train.Gauge.
|}

----

 

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | '''Route.Signal'''(''AspectIndex'').Set ''Speed''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| '''''AspectIndex'''''<nowiki>: A non-negative integer representing the signal aspect. The aspect 0 corresponds to red.</nowiki> '''''Speed'''''<nowiki>: A non-negative floating-point number representing the allowed speed for this aspect, </nowiki>'''by default''' measured in '''kilometers per hour''' (km/h). 
|}

Use this command to associate speed limits to signal aspects. Aspect 0 represents a red signal, higher values represent more permissive aspects. The default values (for the included Japanese signals) are: 

{| style="border-collapse: collapse"
! style="padding: 4px; border: 2px ridge currentColor" bgcolor="#d0d0d0" | ''Index''
! style="padding: 4px; border: 2px ridge currentColor" bgcolor="#d0d0d0" | Aspect
! style="padding: 4px; border: 2px ridge currentColor" bgcolor="#d0d0d0" | Speed
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | 0
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | ●
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | 0 km/h
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | 1
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | ●●
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | 25 km/h
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | 2
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | ●
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | 55 km/h
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | 3
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | ●●
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | 75 km/h
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | 4
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | ●
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | ''unlimited''
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | 5
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | ●●
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | ''unlimited''
|}

 

----

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | '''Route.RunInterval''' ''Interval0''<nowiki>; </nowiki>''Interval1''<nowiki>; ...; </nowiki>''Intervaln-1''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| '''''Intervali'''''<nowiki>: A floating-point number representing the time interval between the player's train's timetable and that of another train to be created, measured in </nowiki>'''seconds'''. Positive values indicate an earlier train, negative numbers a later train.
|}

This command creates one or more preceding or following trains. These other trains are visible, fully operational, and use the same train as the player has. The other trains follow the same schedule as the player does, but are offset in time by ''Intervali''. Via the Track.Sta command, you can also define stations where only the player or only the other trains should stop. Follow-up trains only appear once the section they are placed in has been cleared by other trains, but the player's train is introduced regardless of the current signalling section's state. Therefore, you should make sure that other trains have cleared the area where the player's train will appear when the scenario begins. 

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 20pt" bgcolor="#e0e0e0"
| ☀
| ''Note: ''
|-
|
| Route.RunInterval is the same as Train.Interval.
|}

----

 

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | '''Route.AccelerationDueToGravity''' ''Value''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| '''''Value'''''<nowiki>: A positive floating-point number representing the acceleration due to gravity in </nowiki>'''meters per second squared''' (m/s²). The default value is 9.80665. 
|}

----

 

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | '''Route.Elevation''' ''Height''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| '''''Height'''''<nowiki>: A floating-point number representing the initial height above sea level, </nowiki>'''by default''' measured in '''meters''' (m). The default value is 0. 
|}

----

 

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | '''Route.Temperature''' ''ValueInCelsius''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| '''''Value'''''<nowiki>: A floating-point number representing the initial temperature in </nowiki>'''Celsius'''. The default value is 20.
|}

----

 

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | '''Route.Pressure''' ''ValueInKPa''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| '''''ValueInKPa'''''<nowiki>: A positive floating-point number representing the initial air pressure in </nowiki>'''kPa''' (1000 Pascal). The default value is 101.325.
|}

----

 

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | '''Route.AmbientLight''' ''RedValue''<nowiki>; </nowiki>''GreenValue''<nowiki>; </nowiki>''BlueValue''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| '''''RedValue'''''<nowiki>: An integer ranging from 0 to 255 representing the red component of the ambient light. The default value is 160.</nowiki> '''''GreenValue'''''<nowiki>: An integer ranging from 0 to 255 representing the green component of the ambient light. The default value is 160.</nowiki> '''''BlueValue'''''<nowiki>: An integer ranging from 0 to 255 representing the blue component of the ambient light. The default value is 160.</nowiki>
|}

This command defines the ambient light color to be used. All polygons in the scene are illuminated by the ambient light regardless of the light direction. 

----

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | '''Route.DirectionalLight''' ''RedValue''<nowiki>; </nowiki>''GreenValue''<nowiki>; </nowiki>''BlueValue''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| '''''RedValue'''''<nowiki>: An integer ranging from 0 to 255 representing the red component of the directional light. The default value is 160.</nowiki> '''''GreenValue'''''<nowiki>: An integer ranging from 0 to 255 representing the green component of the directional light. The default value is 160.</nowiki> '''''BlueValue'''''<nowiki>: An integer ranging from 0 to 255 representing the blue component of the directional light. The default value is 160.</nowiki>
|}

This command defines the directional light to be used. The polygons in the scene are only fully illuminated by the directional light if the light direction points at the front faces. If pointing at back faces, no light is contributed. ''Route.LightDirection'' should be set to specify the light direction. 

----

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | '''Route.LightDirection''' ''Theta''<nowiki>; </nowiki>''Phi''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| '''''Theta'''''<nowiki>: A floating-point number representing the angle in </nowiki>'''degrees''' which controls the pitch of the light direction. The default value is 60. '''''Phi'''''<nowiki>: A floating-point number representing the angle in </nowiki>'''degrees''' which controls the planar rotation of the light direction. The default value is about -26.57.
|}

This command defines the initial light direction for track position 0. This is the direction the light shines at, meaning the opposite direction the sun is located at. First, ''Theta'' determines the pitch. A value of 90 represents a downward direction, while a value of -90 represents an upward direction. With those extremes, the value of ''Phi'' is irrelevant. A value of 0 for ''Theta'' represents a forward direction originating at the horizon behind. Once the pitch is defined by ''Theta'', ''Phi'' determines the rotation in the plane. A value of 0 does not rotate, a value of 90 rotates the direction to the right and a value of -90 rotates to the left. A backward direction can be both obtained by setting ''Theta'' and ''Phi'' to 180 and 0 or to 0 and 180, respectively. Values in-between allow for more precise control of the exact light direction. [[Image:illustration_light_direction.png]] 

{|
| width="16" valign="top" |
| ''Converting a spherical direction (theta,phi) into a cartesian direction (x,y,z):''
|-
| width="16" valign="top" | ƒ
| style="border: 1px dotted currentColor" bgcolor="#ffd8c0" | <tt>x = cos(theta) * sin(phi) y = -sin(theta) z = cos(theta) * cos(phi)</tt>
|}

{|
| width="16" valign="top" |
| ''Converting a cartesian direction (x,y,z) into a spherical direction (theta,phi) for y²≠1:''
|-
| width="16" valign="top" | ƒ
| style="border: 1px dotted currentColor" bgcolor="#ffd8c0" | <tt>theta = -arctan(y/sqrt(x2+z2)) phi = arctan(z,x)</tt>
|}

{|
| width="16" valign="top" |
| ''Converting a cartesian direction (x,y,z) into a spherical direction (theta,phi) for y²=1:''
|-
| width="16" valign="top" | ƒ
| style="border: 1px dotted currentColor" bgcolor="#ffd8c0" | <tt>theta = -y * pi/2 phi = 0</tt>
|}

In the formulas above, [http://functions.wolfram.com/ElementaryFunctions/Cos/02 ''cos(x)''] represents the cosine, [http://functions.wolfram.com/ElementaryFunctions/Sin/02 ''sin(x)''] the sine, [http://functions.wolfram.com/ElementaryFunctions/ArcTan/02 ''arctan(x)''] the inverse tangent, [http://functions.wolfram.com/ElementaryFunctions/ArcTan2/02 ''arctan(x,y)''] the two-argument inverse tangent and [http://functions.wolfram.com/ElementaryFunctions/Sqrt/02 ''sqrt(x)''] the square root. The formulas can be used to convert between spherical and cartesian coordinates if working with either one seems more intuitive than working with the other one. The formulas also serve as the official documentation on how the light direction is mathematically defined (using radians for the trigonometric functions). 

----

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | '''Route.DeveloperID'''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| This command is ignored by openBVE. 
|}

 

{|
|- style="height: 4px"
|
|}

■ 6. The Train namespace

----

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| 
|}

Commands from this namespace define route-train associations. 

----

{|
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | Train.Folder ''FolderName'' Train.File ''FolderName''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| '''''FolderName'''''<nowiki>: The folder name of the default train to use on this route.</nowiki>
|}

----

 

{|
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | '''Train.Run'''(''RailTypeIndex'').Set ''RunSoundIndex'' '''Train.Rail'''(''RailTypeIndex'').Set ''RunSoundIndex''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| '''''RailTypeIndex'''''<nowiki>: A non-negative integer representing the rail type as defined via Structure.Rail and used via Track.RailType.</nowiki> '''''RunSoundIndex'''''<nowiki>: A non-negative integer representing the train's run sound to associate to the rail type. </nowiki>
|}

The train developer provides a repertoire of different run sounds. Use this command to associate these run sounds to the rail types you use in your route. In order for the correct run sounds to be played on any of your rail types, you need to coordinate your efforts with the train developer. Please see the page about [http://trainsimframework.org/develop/information_standards.html standards] for further information. 

----

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | '''Train.Flange'''(''RailTypeIndex'').Set ''FlangeSoundIndex''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| '''''RailTypeIndex'''''<nowiki>: A non-negative integer representing the rail type as defined via Structure.Rail and used via Track.RailType.</nowiki> '''''RunSoundIndex'''''<nowiki>: A non-negative integer representing the train's flange sound to associate to the rail type.</nowiki>
|}

The train developer provides a repertoire of different flange sounds. Use this command to associate these flange sounds to the rail types you use in your route. In order for the correct flange sounds to be played on any of your rail types, you need to coordinate your efforts with the train developer. Please see the page about [http://trainsimframework.org/develop/information_standards.html standards] for further information. 

----

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | '''Train.Timetable'''(''TimetableIndex'')'''.Day'''.Load FileName
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| '''''TimetableIndex'''''<nowiki>: A non-negative integer representing the timetable index.</nowiki> '''''FileName'''''<nowiki>: The file name for the daytime version of the timetable, relative to the train's folder (1</nowiki>st choice), or relative to the '''Object''' folder (2nd choice).
|}

Use this command to load daytime versions of the timetable. Which timetable index to show starting with a particular station can be set in Track.Sta commands. 

----

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | '''Train.Timetable'''(''TimetableIndex'')'''.Night'''.Load FileName
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| '''''TimetableIndex'''''<nowiki>: A non-negative integer representing the timetable index.</nowiki> '''''FileName'''''<nowiki>: The file name for the daytime version of the timetable, relative to the train's folder (1</nowiki>st choice), or relative to the '''Object''' folder (2nd choice).
|}

Use this command to load nighttime versions of the timetable. Which timetable index to show starting with a particular station can be set in Track.Sta commands. 

----

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | '''Train.Gauge''' ''ValueInMillimeters''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| '''''ValueInMillimeters'''''<nowiki>: A floating-point number representing the rail gauge, measured in </nowiki>'''millimeters''' (0.001 meters). The default value is 1435. 
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 20pt" bgcolor="#e0e0e0"
| ☀
| ''Note: ''
|-
|
| Train.Gauge is the same as Route.Gauge.
|}

----

 

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | '''Train.Interval''' ''Interval0''<nowiki>; </nowiki>''Interval1''<nowiki>; ...; </nowiki>''Intervaln-1''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| '''''ValueInSeconds'''''<nowiki>: A floating-point number representing the time interval between the player's train and the preceding train, measured in </nowiki>'''seconds'''. The default value is 0. 
|}

Same as Route.RunInterval. See there for more information. 

----

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | '''Train.Velocity''' ''Speed''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| '''''Speed'''''<nowiki>: A positive floating-point number representing the maximum speed the preceding trains may travel at, </nowiki>'''by default''' measured in '''kilometers per hour''', or 0 for infinite speed. The default value is 0.
|}

This command defines the maximum speed limit the preceding trains may travel at. The actual speed limit may be reduced by Track.Limit commands. The player's train is unaffected by this setting and may travel up to the limits defined by Track.Limit. 

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | '''Train.Acceleration'''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| This command is ignored by openBVE. 
|}

 

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | '''Train.Station'''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| This command is ignored by openBVE. 
|}

 

{|
|- style="height: 4px"
|
|}

■ 7. The Structure namespace

----

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| 
|}

The commands in the Structure namespace define which objects to use in other commands. Generally, commands like Track.Rail, Track.FreeObj and so on create objects referenced by a ''StructureIndex''. This ''StructureIndex'' is specific to that command, so you can define a set of objects specific to Track.Rail, Track.FreeObj and so on. The general syntax for commands in the Structure namespace is: 

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | '''Structure.''Command''(''StructureIndex'')'''.Load ''FileName''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| 
|}

''StructureIndex'' is a non-negative integer. ''FileName'' is the object file to load, relative to the '''Object''' folder. ''Command'' is any of the following commands: 

{| style="border-collapse: collapse"
! style="padding: 4px; border: 2px ridge currentColor" bgcolor="#d0d0d0" | ''Command''<nowiki>:</nowiki>
! style="padding: 4px; border: 2px ridge currentColor" bgcolor="#d0d0d0" | Remarks
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | Ground
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | Defines objects for Cycle.Ground and Track.Ground.
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | Rail
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | Defines objects for Track.Rail, Track.RailStart and Track.RailType.
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | WallL
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | Defines left objects for Track.Wall.
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | WallR
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | Defines right objects for Track.Wall.
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | DikeL
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | Defines left objects for Track.Dike.
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | DikeR
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | Defines right objects for Track.Dike.
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | FormL
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | Defines left platforms edges for Track.Form.
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | FormR
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | Defines right platforms edges for Track.Form.
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | FormCL
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | Defines transformable left platforms for Track.Form. No ANIMATED objects supported.
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | FormCR
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | Defines transformable right platforms for Track.Form. No ANIMATED objects supported.
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | RoofL
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | Defines left roof edges for Track.Form.
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | RoofR
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | Defines right roof edges for Track.Form.
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | RoofCL
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | Defines transformable left roofs for Track.Form. No ANIMATED objects supported.
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | RoofCR
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | Defines transformable rigth roofs for Track.Form. No ANIMATED objects supported.
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | CrackL
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | Defines transformable left objects for Track.Crack. No ANIMATED objects supported.
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | CrackR
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | Defines transformable right objects for Track.Crack. No ANIMATED objects supported.
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | FreeObj
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | Defines objects for Track.FreeObj.
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | Beacon
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | Defines objects for Track.Beacon.
|}

 Generally, supported objects are B3D, CSV, X and ANIMATED. However, the FormCL, FormCR, RoofCL, RoofCR, CrackL and CrackR commands only accept B3D, CSV and X objects. ➟ [http://trainsimframework.org/develop/route_formroofcrack.html More information about forms, roofs and cracks...] Additionally, there is the Structure.Pole command, which has a slightly different syntax: 

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | '''Structure.Pole(''NumberOfAdditionalRails''<nowiki>; </nowiki>''PoleStructureIndex'')'''.Load ''FileName''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| '''''NumberOfAdditionalRails'''''<nowiki>: An non-negative integer representing the number of additional rails covered by the pole. 0 creates a pole for one rail, 1 for two rails, etc.</nowiki> '''''PoleStructureIndex'''''<nowiki>: A non-negative integer representing the pole structure index.</nowiki> '''''FileName'''''<nowiki>: The object file to load, relative to the </nowiki>'''Object''' folder.
|}

 Please note that all objects but the FreeObj are inserted at the beginning of a block and should thus extend from 0 to ''BlockLength'' (by default 25m) on the z-axis. For further information on usage, see the respective commands from the Track namespace. 

{|
|- style="height: 4px"
|
|}

■ 8. The Texture namespace

----

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| 
|}

Commands from this namespace define which background images to use and how they are aligned. [[Image:illustration_background.png]] The background image is displayed as a cylindric wall around the camera whose start (viewed from above) is 60 degrees to the left of the initial forward direction (at the 10 o'clock position). From there, the background image wraps clock-wise around the cylinder with a repetition count specified via Texture.Background(''BackgroundTextureIndex'').X, which by default creats 6 repetitions in a full circle. The upper 3/4 of the image is displayed above the horizon, while the lower 1/4 is displayed below the horizon. Via Texture.Background(''BackgroundTextureIndex'').Aspect, you can choose whether to have a fixed cylinder height or to preserve the aspect ratio of the texture. If the image should have a fixed height, the cylinder has a height of 1/2 its radius, which corresponds to about 20 degree inclination to the top of the image, and about -7 degrees to the bottom of the image. If the aspect ratio of the image is preserved, this takes not only the width and height of the image into account, but also the repetition count. Regardless of the repetition count you chose, you should make sure that the left and right edges of the textures fit seamlessly together. Please also take into account that top and bottom caps are created which sample from the top and bottom 10% of the image. You should avoid mountain peaks and similar extremes in the top 10% of the image in order for such extremes to not leak into the top cap. The image loaded into Texture.Background(0) is displayed at the beginning of the route, unless a Track.Back command at the beginning of the route requests a different image. 

----

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | '''Texture.Background(''BackgroundTextureIndex'')'''.Load ''FileName''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| '''''FileName'''''<nowiki>: The texture file to load, relative to the </nowiki>'''Object''' folder.
|}

This command loads a background image to be later used by Track.Back. 

----

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | '''Texture.Background(''BackgroundTextureIndex'').X''' ''RepetitionCount''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| '''''RepetitionCount'''''<nowiki>: The number of times the background image is repeated in a full circle. The default value is 6.</nowiki>
|}

----

 

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | '''Texture.Background(''BackgroundTextureIndex'').Aspect''' ''Mode''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| '''''Mode'''''<nowiki>: The mode of aspect ratio handling to use. The default value is 0.</nowiki>
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 40pt"
| ▸ Options for ''Mode''<nowiki>:</nowiki>
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 50pt"
| '''0'''<nowiki>: Use a fixed height for the cylinder.</nowiki> '''1'''<nowiki>: Preserve the aspect ratio of the image. </nowiki>
|}

 

{|
|- style="height: 4px"
|
|}

■ 9. The Cycle namespace

----

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| 
|}

 

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | '''Cycle.Ground(''GroundStructureIndex'').Params ''GroundStructureIndex0''<nowiki>; </nowiki>''GroundStructureIndex1''<nowiki>; </nowiki>''GroundStructureIndex2''<nowiki>; ...; </nowiki>''GroundStructureIndexn-1'''''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| '''''GroundStructureIndex'''''<nowiki>: A non-negative integer indicating the ground structure index for which a cycle is to be defined.</nowiki> '''''GroundStructureIndexi'''''<nowiki>: A non-negative integer indicating a ground structure that has been previously loaded via Structure.Ground.</nowiki>
|}

When usually using Track.Ground(''GroundStructureIndex''), the same ground structure object will be repeatedly placed in every block. Via Cycle.Ground, you can override this behavior and automatically cycle through a series of different objects when using Track.Ground(''GroundStructureIndex''). The cycle repeats indefinately, where ''GroundStructureIndex0'' starts at track position 0. Technically, the ''i'' in ''GroundStructureIndexi'' chosen for a particular track position ''p'' is <tt>Mod[''p'' / BlockLength, ''n'']</tt>. Consider the following definition: 

{|
| width="16" valign="top" |
| ''''
|-
| width="16" valign="top" | ▶
| style="border: 1px dashed currentColor" bgcolor="#d4d8ff" | <tt>With Structure .Ground(0) grass.csv .Ground(1) river.csv .Ground(2) asphalt.csv</tt>
|}

 The following two codes will produce the same output: 

{|
| width="16" valign="top" |
| ''''
|-
| width="16" valign="top" | ▶
| style="border: 1px dashed currentColor" bgcolor="#d4d8ff" | <tt>With Track 0, .Ground 0 25, .Ground 1 50, .Ground 2 75, .Ground 0 100, .Ground 1 125, .Ground 2 <nowiki>; and so on...</nowiki></tt>
|}

{|
| width="16" valign="top" |
| ''''
|-
| width="16" valign="top" | ▶
| style="border: 1px dashed currentColor" bgcolor="#d4d8ff" | <tt>With Cycle .Ground(0) 0; 1; 2 With Track 0, .Ground 0</tt>
|}

 

{|
|- style="height: 4px"
|
|}

■ 10. The Signal namespace

----

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| 
|}

Commands from this namespace define custom signals. 

----

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | '''Signal('''''SignalIndex''''')'''.Load ''AnimatedObjectFile''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| '''''SignalIndex'''''<nowiki>: A non-negative integer representing the signal index.</nowiki> '''''AnimatedObjectFile'''''<nowiki>: A reference to an animated object file, relative to the </nowiki>'''Object''' folder.
|}

Use this command to load signals directly from animated objects. The ''SignalIndex'' can be later referenced in Track.SigF commands to place the signal. 

----

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | '''Signal('''''SignalIndex''''')'''.Load ''SignalFileWithoutExtension''<nowiki>; </nowiki>''GlowFileWithoutExtension''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| '''''SignalIndex'''''<nowiki>: A non-negative integer representing the signal index.</nowiki> '''''SignalFileWithoutExtension'''''<nowiki>: A reference to a B3D/CSV/X object file representing the signal, relative to the </nowiki>'''Object''' folder, but without the file extension. '''Is required to be specified.''' '''''GlowFileWithoutExtension'''''<nowiki>: An optional reference to a B3D/CSV/X object file representing the distance glow, relative to the </nowiki>'''Object''' folder, but without the file extension. 
|}

Use this command to load signals from a series of individual textures applied onto a common object. openBVE looks for X, CSV and B3D objects in this exact order. Textures are required to have the same name as the signal or glow, plus a non-negative aspect index, plus a file extension for textures. The ''SignalIndex'' can be later referenced in Track.SigF commands to place the signal. For the ''SignalFileWithoutExtension'', there should be the following files present (example): ''SignalFileWithoutExtension'''''.x''' ''SignalFileWithoutExtension'''''0.bmp''' ''SignalFileWithoutExtension'''''1.bmp''' ''SignalFileWithoutExtension'''''2.bmp''' ''SignalFileWithoutExtension'''''''n''.bmp''' The aspect indices from 0 through ''n'' represent successively more permissive aspects, where 0 is red. The built-in signals, for example, use the indices 0 (●), 1 (●●), 2 (●), 3 (●●), 4 (●) and 5 (●●). You can use as many as required. All faces in the object will be applied the currently active aspect texture. This means that you cannot use any other texture in the object, but still have to assign texture coordinates appropriately. For the glow object, the above rules also apply. The glow object is usually a rectangle placed clearly in front of the signal, although you can also use different shapes. The glow textures deserve special attention. All glow textures are pre-processed in the following way: 

{| style="border-collapse: collapse"
! style="padding: 4px; border: 2px ridge currentColor" bgcolor="#d0d0d0" | A
! style="padding: 4px; border: 2px ridge currentColor" bgcolor="#d0d0d0" | B
! style="padding: 4px; border: 2px ridge currentColor" bgcolor="#d0d0d0" | C
! style="padding: 4px; border: 2px ridge currentColor" bgcolor="#d0d0d0" | D
! style="padding: 4px; border: 2px ridge currentColor" bgcolor="#d0d0d0" | E
! style="padding: 4px; border: 2px ridge currentColor" bgcolor="#d0d0d0" | F
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" |
[[Image:illustration_glow_1.png]]
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" |
[[Image:illustration_glow_2.png]]
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" |
[[Image:illustration_glow_3.png]]
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" |
[[Image:illustration_glow_4.png]]
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" |
[[Image:illustration_glow_5.png]]
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" |
[[Image:illustration_glow_6.png]]
|}

 The texture you start with should have a sharp shape, usually oval. The shape should be fully saturated in the core and blend into pure white at its outer rim. The surroundings of the shape can be either pure black (A) or pure white (B). When openBVE loads the glow texture, it will replace all purely black pixels with purely white pixels, thus arriving at (B). From there, the image is inverted (C), then hue-shifted by 180 degrees (D). Compared to (B), this has the overall effect of inverting the lightness of the image, i.e. fully saturated pixels will be left unchanged (e.g. the core), while bright pixels (such as the outer rim of the shape) will become dark, and vice versa. Then, the image is gamma-corrected to further darken the dark parts (E), and finally, the image is blurred slightly (F). The resulting texture is always additively blended. This means that instead of directly drawing the texture onto the screen, the pixels of the texture are added to the screen pixels. Here, adding black (0) does not change the screen pixels, while adding a fully satured color channel (1) will result in a fully satured color channel, e.g. adding white produces white. Keep in mind that when designing the textures, you will have to follow the inverse rules, e.g. design the image as depicted in (A) or (B), while having in mind how it will be processed afterward. 

{|
|- style="height: 4px"
|
|}

■ 11. The Track namespace

----

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| 
|}

Commands from this namespace define the track layout. Commands from this namespace should appear after commands from any of the other namespaces, and they usually form the largest part of the route file. 

{|
|- style="height: 4px"
|
|}

{| style="border: 1px dashed currentColor; margin-right: 20pt; margin-left: 20pt"
| style="border: 2px ridge currentColor" bgcolor="#ffe080" | '''ⓘ''' Use of track positions
|-
| bgcolor="#ffffff" | All commands from the Track namespace need to be associated to track positions. Once a track position has been defined, all subsequent commands are associated to this track position until a new track position is defined. If you do not explicitly state a track position before the first command of the Track namespace is used, 0 will be assumed. While you do not need to use track positions in ascending order, series of commands which are associated the same track position will be sorted into ascending order once the file is loaded. While track positions can be any non-negative floating-point number, many commands in the Track namespace are only to be applied at the beginning of a block, which is 25m by default. For the default situation, this means that some commands are only to be used at track positions 0, 25, 50, 75, 100, 125 and so on. All commands for which this restriction applies are marked as such.
|}

{|
|- style="height: 4px"
|
|}

 

{|
|- style="height: 4px"
|
|}

● 11.1. Rails

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| 
|}

{|
|- style="height: 2px"
|
|}

----

 

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | '''Track.RailStart''' ''RailIndex''<nowiki>; </nowiki>''X''<nowiki>; </nowiki>''Y''<nowiki>; </nowiki>''RailType''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| '''''RailIndex'''''<nowiki>: A positive integer (</nowiki>'''>=1''') indicating which rail index to use. '''''X'''''<nowiki>: A floating-point number representing the horizontal distance from the player's rail, </nowiki>'''by default''' measured in '''meters'''. Negative values indicate left, positive ones right. '''''Y'''''<nowiki>: A floating-point number representing the vertical distance from the player's rail, </nowiki>'''by default''' measured in '''meters'''. Negative values indicate below, positive ones above. '''''RailType'''''<nowiki>: A non-negative integer referencing the rail type to use as defined by a Structure.Rail command.</nowiki>
|}

This command starts a new rail represented by the index ''RailIndex''. Upon the point where this command is used, a rail of the same ''RailIndex'' must either not have been used so far in the route, or must have been ended via a Track.RailEnd command. If a rail of the same ''RailIndex'' was already used in the route, the default values of ''X'', ''Y'' and ''RailType'' are the values last used by that rail, otherwise 0. If the rail is to be updated, use the Track.Rail command. If it is to be ended, use the Track.RailEnd command. You can end a rail of a given ''RailIndex'' and start a new rail of the same ''RailIndex'' at the same track position provided that the old rail is first ended and the new rail started afterward. For every block, a structure, determined by ''RailType'', is automatically placed. 

{|
| ⚠
|
| bgcolor="#e0e0e0" |
| bgcolor="#e0e0e0" | This command can only be used at the beginning of a block.
| bgcolor="#e0e0e0" |
|}

----

 

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | '''Track.Rail''' ''RailIndex''<nowiki>; </nowiki>''X''<nowiki>; </nowiki>''Y''<nowiki>; </nowiki>''RailType''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| '''''RailIndex'''''<nowiki>: A positive integer (</nowiki>'''>=1''') indicating which rail index to use. '''''X'''''<nowiki>: A floating-point number representing the horizontal distance from the player's rail, </nowiki>'''by default''' measured in '''meters'''. Negative values indicate left, positive ones right. '''''Y'''''<nowiki>: A floating-point number representing the vertical distance from the player's rail, </nowiki>'''by default''' measured in '''meters'''. Negative values indicate below, positive ones above. '''''RailType'''''<nowiki>: A non-negative integer referencing the rail type to use as defined by a Structure.Rail command.</nowiki>
|}

This command starts a new rail or updates an existing rail. The rail is represented by the index ''RailIndex''. If a rail of the same ''RailIndex'' was already used in the route, the default values of ''X'', ''Y'' and ''RailType'' are the values last used by that rail, otherwise 0. If the rail is to be ended, use the Track.RailEnd command. You can end a rail of a given ''RailIndex'' and start a new rail of the same ''RailIndex'' at the same track position provided that the old rail is first ended and the new rail started afterward. In each block, the ''X'' and ''Y'' values are repeated if a Track.Rail command is not used for that block. As a consequence, updating the ''X'' or ''Y'' values affects the layout of the rail from the preceding block only. Changing the ''RailType'' will affect the rail from the point on where this command is used. If this command is used multiple times on the same track position for the same rail, then the first instance of the command takes effect, while subsequent ones are ignored. 

{|
| ⚠
|
| bgcolor="#e0e0e0" |
| bgcolor="#e0e0e0" | This command can only be used at the beginning of a block.
| bgcolor="#e0e0e0" |
|}

 

{|
|- style="height: 4px"
|
|}

{| style="border: 1px dashed currentColor; margin-right: 20pt; margin-left: 20pt"
| style="border: 2px ridge currentColor" bgcolor="#ffe080" | '''ⓘ''' Track.RailStart vs. Track.Rail
|-
| bgcolor="#ffffff" | If you want to start a new rail, you can either use Track.RailStart or Track.Rail. When using Track.RailStart, you provide markup that a new rail is in fact to be started, which is invalid if the rail already exists. Using an explicit Track.RailStart will protect you from using a ''RailIndex'' which is already in use, in which case an error message is generated.
|}

{|
|- style="height: 4px"
|
|}

----

 

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | '''Track.RailType''' ''RailIndex''<nowiki>; </nowiki>''RailType''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| '''''RailIndex'''''<nowiki>: A non-negative integer indicating which rail index to change. The player's rail can be referred to with index </nowiki>'''0'''. The default value is 0. '''''RailType'''''<nowiki>: A non-negative integer referencing the rail type to use as defined by a Structure.Rail command. The default value is 0. </nowiki>
|}

This command changes the rail type for an existing rail, represented by ''RailIndex''. The rail must have been started with a Track.RailStart or Track.Rail command and must not have been ended by a Track.RailEnd command. Changing the ''RailType'' will affect the rail from the point on where this command is used. 

{|
| ⚠
|
| bgcolor="#e0e0e0" |
| bgcolor="#e0e0e0" | This command can only be used at the beginning of a block.
| bgcolor="#e0e0e0" |
|}

----

 

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | '''Track.RailEnd''' ''RailIndex''<nowiki>; </nowiki>''X''<nowiki>; </nowiki>''Y''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| '''''RailIndex'''''<nowiki>: A positive integer (</nowiki>'''>=1''') indicating which rail index to use. '''''X'''''<nowiki>: A floating-point number representing the horizontal distance from the player's rail, </nowiki>'''by default''' measured in '''meters'''. Negative values indicate left, positive ones right. '''''Y'''''<nowiki>: A floating-point number representing the vertical distance from the player's rail, </nowiki>'''by default''' measured in '''meters'''. Negative values indicate below, positive ones above. 
|}

This command ends an existing rail, represented by the index ''RailIndex''. The default values of ''X'' and ''Y'' are the ones last used by the rail. Once this command is used for a specific ''RailIndex'', the corresponding rail is considered to be non-existing afterward. 

{|
| ⚠
|
| bgcolor="#e0e0e0" |
| bgcolor="#e0e0e0" | This command can only be used at the beginning of a block.
| bgcolor="#e0e0e0" |
|}

 

{|
| width="16" valign="top" |
| ''Example of Track.RailStart, Track.Rail, Track.RailType and Track.RailEnd commands''
|-
| width="16" valign="top" | ▶
| style="border: 1px dashed currentColor" bgcolor="#d4d8ff" | <tt>With Track 1000, .RailStart 1; 3.8; 0.0; 0 1025, .RailType 1; 1 1050, .Rail 1; 1.9; 0.0; 0 1075, .RailEnd 1</tt>
|}

In the preceding example, rail 1 starts with an x-value of 3.8 and bears a rail index which corresponds to an object intended to depict a straight rail. The rail keeps the x-value of 3.8 at track position 1025, where the rail type is changed to correspond to an object intended to depict an s-shaped curve. At track position 1050, the rail is redefined to have an x-value of 1.9, after which the rail is straight again until 1075, where it is ended, still having an x-value of 1.9. 

----

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | '''Track.Accuracy''' ''Value''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| '''''Value'''''<nowiki>: A non-negative floating-point number representing the accuracy of the track. The default value is 2.</nowiki>
|}

This command sets the accuracy of the track from this point on. Values should be in the range from 0 to 4, where 0 means perfect accuracy (no inaccuracy at all), 1 means very good accuracy (high speed lines), 2 means good accuracy, 3 means mediocre accuracy, and 4 means poor accuracy. Intermediate values are also possible. Currently, values below 0 are clamped at 0, and values above 4 are clamped at 4. 

----

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | '''Track.Adhesion''' ''Rate''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| '''''Rate'''''<nowiki>: A non-negative floating-point number measured in percent representing the adhesion of the track. The default value is 100.</nowiki>
|}

This command sets the adhesion of the track from this point on. As a reference, the value of 135 represents dry conditions, 85 represents frost and 50 represents snowy conditions. With a value of 0, the train will not be able to move at all. 

{|
|- style="height: 4px"
|
|}

● 11.2. Geometry

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| 
|}

{|
|- style="height: 2px"
|
|}

----

 

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | '''Track.Pitch''' ''Rate''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| '''''Rate'''''<nowiki>: A floating-point number measured in per thousands representing the pitch of the track. The default value is 0.</nowiki>
|}

This command defines the pitch of all rails from this point on. Negative values indicate a downward gradient, positive ones an upward gradient. The value of 0 represents a level track. ''Rate'' can be calculated from a length difference ''X'' and a height difference ''Y'' in the following way: 

{|
| width="16" valign="top" |
| ''''Rate'' expressed through ''X'' and ''Y''<nowiki>:</nowiki>''
|-
| width="16" valign="top" | ƒ
| style="border: 1px dotted currentColor" bgcolor="#ffd8c0" | <tt>''Rate'' = 1000 * ''Y'' / ''X''</tt>
|}

{|
| ⚠
|
| bgcolor="#e0e0e0" |
| bgcolor="#e0e0e0" | This command can only be used at the beginning of a block.
| bgcolor="#e0e0e0" |
|}

----

 

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | '''Track.Curve''' ''Radius''<nowiki>; </nowiki>''CantInMillimeters''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| '''''Radius'''''<nowiki>: A floating-point number representing the radius of the curve, </nowiki>'''by default''' measured in '''meters'''. The default value is 0. '''''CantInMillimeters'''''<nowiki>: A floating-point number which represents the superelevation of a banked curve, </nowiki>'''always''' measured in '''millimeters''' (0.001 meters). The default value is 0. See also Options.CantBehavior.
|}

This command defines the radius of the curve for the player's rail from this point on. Negative values for ''Radius'' indicate a curve to the left, positive ones to the right. The value of 0 represents straight track. The ''CantInMillimeters'' parameter defines the cant (superelevation) in millimeters. If Options.CantBehavior is 0 (default), only the absolute value of ''CantInMillimeters'' is considered, and the superelevation is always towards the curve center (inward). Also, cant cannot be applied on straight track. If Options.CantBehavior is 1, ''CantInMillimeters'' is signed, i.e. negative values bank outward and positive ones inward on curved track. Also, cant can be applied on straight track, where negative values bank toward the left and positive ones toward the right. 

{|
| ⚠
|
| bgcolor="#e0e0e0" |
| bgcolor="#e0e0e0" | This command can only be used at the beginning of a block.
| bgcolor="#e0e0e0" |
|}

----

 

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | '''Track.Turn''' ''Ratio''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| '''''Rate'''''<nowiki>: A floating-point number representing a turn. The default value is 0.</nowiki>
|}

This command creates a point-based turn at the point of insertion. ''Ratio'' indicates the ratio between the length difference ''Z'' and the horizontal offset ''X'' in the following way: 

{|
| width="16" valign="top" |
| ''''
|-
| width="16" valign="top" | ƒ
| style="border: 1px dotted currentColor" bgcolor="#ffd8c0" | <tt>''Ratio'' = ''X'' / ''Z''</tt>
|}

A negative ratio represents a turn to the left, a positive one to the right. The value of 0 represents a straight track. 

{|
| ⚠
|
| bgcolor="#e0e0e0" |
| bgcolor="#e0e0e0" | This command can only be used at the beginning of a block.
| bgcolor="#e0e0e0" |
|}

{|
| ⚠
|
| bgcolor="#e0e0e0" |
| bgcolor="#e0e0e0" | This command is deprecated - use Track.Curve instead.
| bgcolor="#e0e0e0" |
|}

----

 

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | '''Track.Height''' ''Y''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| '''''Y'''''<nowiki>: A floating-point number representing the height of the player's rail, </nowiki>'''by default''' measured in meters.
|}

This command defines the height of the player's rail above the ground at the point of insertion. It influences the placement of the ground objects defined via Structure.Ground and changed via Track.Ground. The height is interpolated between adjacent Track.Height commands. For example, the following two codes produce equivalent results: 

{|
| width="16" valign="top" |
| ''Example of a Track.Height command interpolated at 25m boundaries:''
|-
| width="16" valign="top" | ▶
| style="border: 1px dashed currentColor" bgcolor="#d4d8ff" | <tt>1000, Track.Height 1 1075, Track.Height 4</tt>
|}

{|
| width="16" valign="top" |
| ''Example of Track.Height explicitly set each 25m to produce the same result:''
|-
| width="16" valign="top" | ▶
| style="border: 1px dashed currentColor" bgcolor="#d4d8ff" | <tt>1000, Track.Height 1 1025, Track.Height 2 1050, Track.Height 3 1075, Track.Height 4</tt>
|}

{|
| ⚠
|
| bgcolor="#e0e0e0" |
| bgcolor="#e0e0e0" | This command can only be used at the beginning of a block.
| bgcolor="#e0e0e0" |
|}

 

{|
|- style="height: 4px"
|
|}

● 11.3. Objects

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| 
|}

{|
|- style="height: 2px"
|
|}

----

 

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | '''Track.FreeObj''' ''RailIndex''<nowiki>; </nowiki>''FreeObjStructureIndex''<nowiki>; </nowiki>''X''<nowiki>; </nowiki>''Y''<nowiki>; </nowiki>''Yaw''<nowiki>; </nowiki>''Pitch''<nowiki>; </nowiki>''Roll''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| '''''RailIndex'''''<nowiki>: A non-negative integer representing the rail on which to place the object. The default value is 0.</nowiki> '''''FreeObjStructureIndex'''''<nowiki>: A non-negative integer representing the object to place as defined via Structure.FreeObj. The default value is 0.</nowiki> '''''X'''''<nowiki>: The x-offset from the (straight) rail, </nowiki>'''by default''' measured in '''meters'''. Negative values represent the left, positive ones the right. The default value is 0. '''''Y'''''<nowiki>: The y-offset from the (straight) rail, </nowiki>'''by default''' measured in '''meters'''. Negative values represent below the top of the rails, positive ones above. The default value is 0. '''''Yaw'''''<nowiki>: The angle in degrees by which the object is rotated in the XZ-plane in clock-wise order when viewed from above. The default value is 0.</nowiki> '''''Pitch'''''<nowiki>: The angle in degrees by which the object is rotated in the YZ-plane in clock-wise order when viewed from the left. The default value is 0.</nowiki> '''''Roll'''''<nowiki>: The angle in degrees by which the object is rotated in the XY-plane in clock-wise order when viewed from behind. The default value is 0.</nowiki>
|}

This places a "free" object a single time on a specified rail. The object must have been loaded via Structure.FreeObj(''FreeObjStructureIndex'') prior to using this command. 

----

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | '''Track.Wall''' ''RailIndex''<nowiki>; </nowiki>''Direction''<nowiki>; </nowiki>''WallStructureIndex''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| '''''RailIndex'''''<nowiki>: A non-negative integer representing the rail on which to start or update the wall. The default value is 0.</nowiki> '''''Direction'''''<nowiki>: An integer indicating which wall to use as described below.</nowiki> '''''WallStructureIndex'''''<nowiki>: A non-negative integer representing the object to place as defined via Structure.WallL and Structure.WallR. The default value is 0.</nowiki>
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 40pt"
| ▸ Options for ''Direction''<nowiki>:</nowiki>
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 50pt"
| '''-1'''<nowiki>: The WallL object (left wall) is used.</nowiki> '''0'''<nowiki>: Both the WallL and WallR objects are used.</nowiki> '''1'''<nowiki>: The WallR object (right wall) is used.</nowiki>
|}

This starts or updates a wall on a specified rail. The object must have been loaded via Structure.WallL(''WallObjectIndex'') or Structure.WallR(''WallObjectIndex'') prior to using this command. The walls are placed at the beginning of every block until a corresponding Track.WallEnd ends the wall for this rail. Please note that walls are resurrected if a rail is ended via Track.RailEnd and then started again via Track.RailStart or Track.Rail unless the wall was also ended via Track.WallEnd. 

{|
| ⚠
|
| bgcolor="#e0e0e0" |
| bgcolor="#e0e0e0" | This command can only be used at the beginning of a block.
| bgcolor="#e0e0e0" |
|}

----

 

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | '''Track.WallEnd''' ''RailIndex''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| '''''RailIndex'''''<nowiki>: A non-negative integer representing the rail on which to end an existing wall. </nowiki>
|}

This ends an existing wall that was previously started via Track.Wall on a specified rail. The wall is not placed for the block in which this command is used. 

{|
| ⚠
|
| bgcolor="#e0e0e0" |
| bgcolor="#e0e0e0" | This command can only be used at the beginning of a block.
| bgcolor="#e0e0e0" |
|}

----

 

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | '''Track.Dike''' ''RailIndex''<nowiki>; </nowiki>''Direction''<nowiki>; </nowiki>''DikeStructureIndex''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| '''''RailIndex'''''<nowiki>: A non-negative integer representing the rail on which to start or update the dike. The default value is 0.</nowiki> '''''Direction'''''<nowiki>: An integer indicating which dike to use as described below.</nowiki> '''''DikeStructureIndex'''''<nowiki>: A non-negative integer representing the object to place as defined via Structure.DikeL and Structure.DikeR. The default value is 0.</nowiki>
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 40pt"
| ▸ Options for ''Direction''<nowiki>:</nowiki>
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 50pt"
| '''-1'''<nowiki>: The DikeL object (left dike) is used.</nowiki> '''0'''<nowiki>: Both the DikeL and DikeR objects are used.</nowiki> '''1'''<nowiki>: The DikeR object (right dike) is used.</nowiki>
|}

This starts or updates a dike on a specified rail. The object must have been loaded via Structure.DikeL(''DikeObjectIndex'') or Structure.DikeR(''DikeObjectIndex'') prior to using this command. The dikes are placed at the beginning of every block until a corresponding Track.DikeEnd ends the dike for this rail. Please note that dikes are resurrected if a rail is ended via Track.RailEnd and then started again via Track.RailStart or Track.Rail unless the dike was also ended via Track.DikeEnd. 

{|
| ⚠
|
| bgcolor="#e0e0e0" |
| bgcolor="#e0e0e0" | This command can only be used at the beginning of a block.
| bgcolor="#e0e0e0" |
|}

----

 

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | '''Track.DikeEnd''' ''RailIndex''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| '''''RailIndex'''''<nowiki>: A non-negative integer representing the rail on which to end an existing dike. </nowiki>
|}

This ends an existing dike that was previously started via Track.Dike on a specified rail. The dike is not placed for the block in which this command is used. 

{|
| ⚠
|
| bgcolor="#e0e0e0" |
| bgcolor="#e0e0e0" | This command can only be used at the beginning of a block.
| bgcolor="#e0e0e0" |
|}

----

 

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | '''Track.Pole''' ''RailIndex''<nowiki>; </nowiki>''NumberOfAdditionalRails''<nowiki>; </nowiki>''Location''<nowiki>; </nowiki>''Interval''<nowiki>; </nowiki>''PoleStructureIndex''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| '''''RailIndex'''''<nowiki>: A non-negative integer representing the rail on which to start or update the pole. The default value is 0.</nowiki> '''''NumberOfAdditionalRails'''''<nowiki>: A non-negative integer representing the amount of additional rails covered by this pole (i.e. this rail, plus </nowiki>''NumberOfAdditionalRails'' rails). The default value is 0. '''''Location'''''<nowiki>: If </nowiki>''NumberOfAdditionalRails'' is 0, the side on which the pole is placed (see below), or the x-offset in multiples of 3.8 meters if ''NumberOfAdditionalRails'' is at least 1. The default value is 0. '''''Interval'''''<nowiki>: An integer multiple of the block length specifying the interval in which poles are placed.</nowiki> '''''PoleStructureIndex'''''<nowiki>: A non-negative integer representing the object to place as defined via Structure.Pole. The default value is 0. </nowiki>
|}

This starts or updates a pole on a specified rail. The object must have been loaded via Structure.Pole(''NumberOfAdditionalRails''<nowiki>; </nowiki>''PoleStructureIndex'') prior to using this command. The poles are placed at the beginning of every block whose track positions are an integer multiple of the ''Interval'' (that is not necessarily at the same location this command is placed). If ''NumberOfAdditionalRails'' is 0, ''Location'' indicates the side of the rail on which the pole is placed. If ''Location'' is less than or equal to 0, the pole is placed as-is (corresponding to the left side). If ''Location'' is greater than 0, the object is mirrored on the x-axis and then placed (corresponding to the right side). If ''NumberOfAdditionalRails'' is greater than or equal to 1, ''Location'' specifies the x-offset in multiples of 3.8 meters. Please note that poles are resurrected if a rail is ended via Track.RailEnd and then started again via Track.RailStart or Track.Rail unless the pole was also ended via Track.PoleEnd. 

{|
| ⚠
|
| bgcolor="#e0e0e0" |
| bgcolor="#e0e0e0" | This command can only be used at the beginning of a block.
| bgcolor="#e0e0e0" |
|}

----

 

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | '''Track.PoleEnd''' ''RailIndex''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| '''''RailIndex'''''<nowiki>: A non-negative integer representing the rail on which to end an existing pole. </nowiki>
|}

This ends an existing pole that was previously started via Track.Pole on a specified rail. The pole is not placed for the block in which this command is used. 

{|
| ⚠
|
| bgcolor="#e0e0e0" |
| bgcolor="#e0e0e0" | This command can only be used at the beginning of a block.
| bgcolor="#e0e0e0" |
|}

----

 

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | '''Track.Crack''' ''RailIndex1''<nowiki>; </nowiki>''RailIndex2''<nowiki>; </nowiki>''CrackStructureIndex''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| [[Image:construction_16.png]] Description not available yet.
|}

----

 

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | '''Track.Ground''' ''CycleIndex''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| '''''CycleIndex'''''<nowiki>: A non-negative integer representing the cycle of ground objects to place as defined via Structure.Ground or Cycle.Ground.</nowiki>
|}

This defines which ground objects to place from this point on. Ground objects are always placed at the beginning of a block at a certain height below the player's rail (as defined via Track.Height). If no cycle was defined for ''CycleIndex'', then the object loaded into Structure.Ground(''CycleIndex'') is placed. Otherwise, the cycle of ground objects as defined via Cycle.Ground(''CycleIndex'') is used. 

{|
| ⚠
|
| bgcolor="#e0e0e0" |
| bgcolor="#e0e0e0" | This command can only be used at the beginning of a block.
| bgcolor="#e0e0e0" |
|}

 

{|
|- style="height: 4px"
|
|}

● 11.4. Stations

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| 
|}

{|
|- style="height: 2px"
|
|}

----

 

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | '''Track.Sta''' ''Name''<nowiki>; </nowiki>''ArrivalTime''<nowiki>; </nowiki>''DepartureTime''<nowiki>; </nowiki>''PassAlarm''<nowiki>; </nowiki>''Doors''<nowiki>; </nowiki>''ForcedRedSignal''<nowiki>; </nowiki>''System''<nowiki>; </nowiki>''ArrivalSound''<nowiki>; </nowiki>''StopDuration''<nowiki>; </nowiki>''PassengerRatio''<nowiki>; </nowiki>''DepartureSound''<nowiki>; </nowiki>''TimetableIndex''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| '''''Name'''''<nowiki>: The name of the station. This is displayed in the timetable and in messages, so should not be omitted.</nowiki> '''''ArrivalTime'''''<nowiki>: The </nowiki>[http://trainsimframework.org/develop/information_numberformats.html#times time] the player's train is expected to arrive at this station. Special values may also appear - see below. '''''DepartureTime'''''<nowiki>: The </nowiki>[http://trainsimframework.org/develop/information_numberformats.html#times time] the player's train is expected to depart from this station. Special values may also appear - see below. '''''PassAlarm'''''<nowiki>: Indicates whether the pass alarm device should remind the driver of stopping at this station. The default value is 0.</nowiki> '''''Doors'''''<nowiki>: Indicates which doors should open at this station. The default value is 0.</nowiki> '''''ForcedRedSignal'''''<nowiki>: Indicates whether the signal behind the last station stop should be red on a train approach. The default value is 0.</nowiki> '''''System'''''<nowiki>: Indicates which built-in safety system should apply until the next station. The default value is 0.</nowiki> '''''ArrivalSound'''''<nowiki>: The sound file to be played on arrival, relative to the </nowiki>'''Sound''' folder. '''''StopDuration'''''<nowiki>: A positive floating-point number indicating the minimum stop duration in seconds, including door opening/closing times. The default value is 15.</nowiki> '''''PassengerRatio'''''<nowiki>: A non-negative floating-point number indicating the relative amount of passengers in the train from this station on. As a reference, 100 represents a train with normal amount of passengers, while 250 represents an over-crowded train. Values in-between 0 and 250 should be used. The default value is 100.</nowiki> '''''DepartureSound'''''<nowiki>: The sound file to be played before departure (departure time minus sound duration minus door closing time), relative to the </nowiki>'''Sound''' folder. '''''TimetableIndex'''''<nowiki>: A non-negative integer representing the timetable to be shown from this station on as defined via Train.Timetable(</nowiki>''TimetableIndex''). 
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 40pt"
| ▸ Available options for ''ArrivalTime''<nowiki>:</nowiki>
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 50pt"
| ''time''<nowiki>: The train is expected to arrive at this particular time.</nowiki> ''omitted''<nowiki>: The train may arrive at any time.</nowiki> '''P''' or '''L'''<nowiki>: All trains are expected to pass this station.</nowiki> '''B'''<nowiki>: The player's train is expected to pass this station, while all other trains are expected to stop.</nowiki> '''S'''<nowiki>: The player's train is expected to stop at this station, while all other trains are expected to pass.</nowiki> '''S:'''''time''<nowiki>: The player's train is expected to arrive at this particular time, while all other trains are expected to pass.</nowiki>
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 40pt"
| ▸ Available options for ''DepartureTime''<nowiki>:</nowiki>
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 50pt"
| ''time''<nowiki>: The train is expected to depart at this particular time.</nowiki> ''omitted''<nowiki>: The train may depart at any time.</nowiki> '''T''' or '''<nowiki>=</nowiki>'''<nowiki>: This is the terminal station. If </nowiki>''ForcedRedSignal'' is set to 1, the departure signal will be held at red indefinately. '''T:'''''time''<nowiki>: This is the terminal station. If </nowiki>''ForcedRedSignal'' is set to 1, the departure signal will still switch to green before the specified time as if this was a regular station. '''C'''<nowiki>: This is a station at which to "change ends". See the description below.</nowiki> '''C:'''''time''<nowiki>: This is a station at which to "change ends". Changing ends will take place at the specified time unless </nowiki>''StopDuration'' interferes. See the description below. 
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 40pt"
| ▸ Available options for ''PassAlarm''<nowiki>:</nowiki>
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 50pt"
| '''0'''<nowiki>: The pass alarm device does not remind the driver of stopping at this station.</nowiki> '''1'''<nowiki>: The pass alarm device reminds the driver of stopping at this station.</nowiki>
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 40pt"
| ▸ Available options for ''Doors''<nowiki>:</nowiki>
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 50pt"
| '''L''' or '''-1'''<nowiki>: The left doors are expected to open at this station.</nowiki> '''N''' or '''0'''<nowiki>: No doors are expected to open at this station, i.e. the train should simply come to a hold.</nowiki> '''R''' or '''1'''<nowiki>: The right doors are expected to open at this station.</nowiki> '''B'''<nowiki>: Both the left and right doors are expected to open at this station.</nowiki>
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 40pt"
| ▸ Available options for ''ForcedRedSignal''<nowiki>:</nowiki>
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 50pt"
| '''0'''<nowiki>: Signals are unaffected by this station.</nowiki> '''1'''<nowiki>: The signal immediately following the last station stop is hold at red until the train reaches the stopping area and the departure time.</nowiki>
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 40pt"
| ▸ Available options for ''System''<nowiki>:</nowiki>
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 50pt"
| '''ATS''' or '''0'''<nowiki>: ATS should be used from this station on. The following track is not be equipped with ATC.</nowiki> '''ATC''' or '''1'''<nowiki>: ATC should be used from this station on. The following track is equipped with ATC.</nowiki>
|}

This command initializes a new station. It should be placed at the beginning of the station platform. In order to finalize the creation of a station, use the Track.Stop command to place stop points following this command. All following Track.Stop commands will be associated to this station. At least one Track.Stop command must follow if trains are expected to stop at this station. Stations can be marked as "changing ends" in the departure time. At such stations, when the departure time has been reached, the train will automatically jump to the next station. This feature is intended to fake a reverse of traveling direction without the need to jump to stations manually from the menu. 

{|
| ⚠
|
| bgcolor="#e0e0e0" |
| bgcolor="#e0e0e0" | The "changing ends" feature is only available in the development release 1.2.11 and above.
| bgcolor="#e0e0e0" |
|}

----

 

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | '''Track.Station''' ''Name''<nowiki>; </nowiki>''ArrivalTime''<nowiki>; </nowiki>''DepartureTime''<nowiki>; </nowiki>''ForcedRedSignal''<nowiki>; </nowiki>''System''<nowiki>; </nowiki>''DepartureSound''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| '''''Name'''''<nowiki>: The name of the station. This is displayed in the timetable and in messages, so should not be omitted.</nowiki> '''''ArrivalTime'''''<nowiki>: The </nowiki>[http://trainsimframework.org/develop/information_numberformats.html#times time] the player's train is expected to arrive at this station. Special values may also appear - see below. '''''DepartureTime'''''<nowiki>: The </nowiki>[http://trainsimframework.org/develop/information_numberformats.html#times time] the player's train is expected to depart from this station. Special values may also appear - see below. '''''ForcedRedSignal'''''<nowiki>: Indicates whether the signal behind the last station stop should be red on a train approach. The default value is 0.</nowiki> '''''System'''''<nowiki>: Indicates which built-in safety system should apply until the next station. The default value is 0.</nowiki> '''''DepartureSound'''''<nowiki>: The sound file to be played before departure (departure time minus sound duration minus door closing time), relative to the </nowiki>'''Sound''' folder. 
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 40pt"
| ▸ Available options for ''ArrivalTime''<nowiki>:</nowiki>
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 50pt"
| ''time''<nowiki>: The train is expected to arrive at this particular time.</nowiki> ''omitted''<nowiki>: The train may arrive at any time.</nowiki> '''P''' or '''L'''<nowiki>: All trains are expected to pass this station.</nowiki> '''B'''<nowiki>: The player's train is expected to pass this station, while all other trains are expected to stop.</nowiki> '''S'''<nowiki>: The player's train is expected to stop at this station, while all other trains are expected to pass.</nowiki> '''S:'''''time''<nowiki>: The player's train is expected to arrive at this particular time, while all other trains are expected to pass.</nowiki>
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 40pt"
| ▸ Available options for ''DepartureTime''<nowiki>:</nowiki>
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 50pt"
| ''time''<nowiki>: The train is expected to depart at this particular time.</nowiki> ''omitted''<nowiki>: The train may depart at any time.</nowiki> '''T''' or '''<nowiki>=</nowiki>'''<nowiki>: This is the terminal station. If </nowiki>''ForcedRedSignal'' is set to 1, the departure signal will be held at red indefinately. '''T:'''''time''<nowiki>: This is the terminal station. If </nowiki>''ForcedRedSignal'' is set to 1, the departure signal will still switch to green before the specified time as if this was a regular station. '''C'''<nowiki>: This is a station at which to "change ends". See the description below.</nowiki> '''C:'''''time''<nowiki>: This is a station at which to "change ends". Changing ends will take place at the specified departure unless </nowiki>''StopDuration'' interferes.
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 40pt"
| ▸ Available options for ''ForcedRedSignal''<nowiki>:</nowiki>
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 50pt"
| '''0'''<nowiki>: Signals are unaffected by this station.</nowiki> '''1'''<nowiki>: The signal immediately following the last station stop is hold at red until the train reaches the stopping area and the departure time.</nowiki>
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 40pt"
| ▸ Available options for ''System''<nowiki>:</nowiki>
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 50pt"
| '''ATS''' or '''0'''<nowiki>: ATS should be used from this station on. The following track is not be equipped with ATC.</nowiki> '''ATC''' or '''1'''<nowiki>: ATC should be used from this station on. The following track is equipped with ATC.</nowiki>
|}

This command initializes a new station. Prefer using the Track.Sta command, which includes more options. For the options of Track.Sta which are not offered by Track.Station, the following values apply: 

{| style="border-collapse: collapse"
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | ''PassAlarm''
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | 0 (not used)
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | ''Doors''
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | B (both doors must be opened)
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | ''ArrivalSound''
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | Not played
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | ''StopDuration''
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | 15
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | ''PassengerRatio''
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | 100
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | ''TimetableIndex''
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | Not affected
|}

 The command should be placed at the beginning of the station platform. In order to finalize the creation of a station, use the Track.Stop command to place stop points following this command. All following Track.Stop commands will be associated to this station. At least one Track.Stop command must follow if trains are expected to stop at this station. Stations can be marked as "changing ends" in the departure time. At such stations, when the departure time has been reached, the train will automatically jump to the next station. This feature is intended to fake a reverse of traveling direction without the need to jump to stations manually from the menu. 

{|
| ⚠
|
| bgcolor="#e0e0e0" |
| bgcolor="#e0e0e0" | The "changing ends" feature is only available in the development release 1.2.11 and above.
| bgcolor="#e0e0e0" |
|}

----

 

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | '''Track.Stop''' ''Direction''<nowiki>; </nowiki>''BackwardTolerance''<nowiki>; </nowiki>''ForwardTolerance''<nowiki>; </nowiki>''Cars''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| '''''Direction'''''<nowiki>: On which side to place a default stop post. The default value is 0.</nowiki> '''''BackwardTolerance'''''<nowiki>: A positive floating-point number indicating the allowed tolerance in the backward direction, </nowiki>'''by default''' measured in '''meters'''. The default value is 5. '''''ForwardTolerance'''''<nowiki>: A positive floating-point number indicating the allowed tolerance in the forward direction, </nowiki>'''by default''' measured in '''meters'''. The default value is 5. '''''Cars'''''<nowiki>: A non-negative integer indicating for how many cars this stop point applies, or 0 for all cars. The default value is 0.</nowiki>
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 40pt"
| ▸ Available options for ''Direction''<nowiki>:</nowiki>
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 50pt"
| '''-1'''<nowiki>: A stop post is created on the left side.</nowiki> '''0'''<nowiki>: No stop post is created.</nowiki> '''1'''<nowiki>: A stop post is created on the right side.</nowiki>
|}

This command places a stop point for the last created station. If there is more than one stop defined for a station, a train is expected to stop at the first Track.Stop command for which ''Cars'' is greater than or equal to the number of cars the train has, where a value for ''Cars'' of 0 indicates a stop point regardless of the amount of cars to be used as the last stop point for a station. 

{|
| width="16" valign="top" |
| ''Example of a station with multiple stop points:''
|-
| width="16" valign="top" | ▶
| style="border: 1px dashed currentColor" bgcolor="#d4d8ff" | <tt>With Track 0100, .Sta STATION 0178, .Stop 1;;;4 ,; for 4 or less cars 0212, .Stop 1;;;6 ,; for 5 or 6 cars 0246, .Stop 1;;;8 ,; for 7 or 8 cars 0280, .Stop 1;;;0 ,; for 9 or more cars</tt>
|}

----

 

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | '''Track.Form''' ''RailIndex1''<nowiki>; </nowiki>''RailIndex2''<nowiki>; </nowiki>''RoofStructureIndex''<nowiki>; </nowiki>''FormStructureIndex''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| [[Image:construction_16.png]] Description not available yet.
|}

 

{|
|- style="height: 4px"
|
|}

● 11.5. Signalling and speed limits

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| 
|}

{|
|- style="height: 2px"
|
|}

----

 

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | '''Track.Limit''' ''Speed''<nowiki>; </nowiki>''Post''<nowiki>; </nowiki>''Cource''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| '''''Speed'''''<nowiki>: A positive floating-point number representing the speed, </nowiki>''' by default''' measured in '''km/h''', or 0 to indicate no speed restriction. The default value is 0. '''''Post'''''<nowiki>: The side on which to place a default Japanese-style speed limit post. The default value is 0.</nowiki> '''''Cource'''''<nowiki>: The directional indication. The default value is 0.</nowiki>
|}

[[Image:illustration_limit.png]] 

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 40pt"
| ▸ Options for ''Post''<nowiki>:</nowiki>
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 50pt"
| '''-1'''<nowiki>: The post is placed on the left side of the track.</nowiki> '''0'''<nowiki>: No post will be placed.</nowiki> '''1'''<nowiki>: The post is placed on the right side of the track.</nowiki>
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 40pt"
| ▸ Options for ''Cource''<nowiki>:</nowiki>
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 50pt"
| '''-1'''<nowiki>: The post applies for a left-bound track.</nowiki> '''0'''<nowiki>: The post does not indicate a particular direction.</nowiki> '''1'''<nowiki>: The post applies for a right-bound track. </nowiki>
|}

This command defines the new speed limit from this point on. If the new speed limit is lower than the current speed limit, the new speed limit will take effect immediately. If the speed limit is higher than the current speed limit, the new speed limit will take effect only once the whole train has passed this point. By setting ''Speed'' to <tt>0</tt>, the speed restriction is released. By setting ''Post'' to either <tt>-1</tt> or <tt>1</tt>, a default Japanese-style speed post is placed at the respective side of the track. Setting ''Course'' to either <tt>-1</tt> or <tt>1</tt> includes a directional indication, which is usually used at railroad switches to indicate that the speed limit only applies if the respective direction is being taken. If ''Speed'' is set to <tt>0</tt>, the setting of ''Course'' has no effect. 

----

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | '''Track.Section''' ''a0''<nowiki>; </nowiki>''a1''<nowiki>; </nowiki>''a2''<nowiki>; ...; </nowiki>''an''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| '''a''i'''''<nowiki>: A non-negative number specifying one of the section's aspects.</nowiki>
|}

This command starts a section, the functional part of signalling, to be used in conjunction with Track.SigF, which creates a visual representation of a section (a signal). The ''ai'' parameters specify the aspects the section can bear. An aspect of 0 corresponds to a red section which must not be passed by a train. The ''a0'' term is mandatory. 

{|
|- style="height: 4px"
|
|}

{| style="border: 1px dashed currentColor; margin-right: 20pt; margin-left: 20pt"
| style="border: 2px ridge currentColor" bgcolor="#ffe080" | '''ⓘ''' Default versus simplified section behavior
|-
| bgcolor="#ffffff" | There are two different modes of behavior on how to interpret the ''ai'' parameters. The mode can be set via Options.SectionBehavior. The following are separate descriptions for default and simplified behavior.
|}

{|
|- style="height: 4px"
|
|}

 '''Default behavior:''' The ''ai'' terms specify the aspect the section should bear depending on how many sections ahead are clear until a red one is encountered. The order of the terms is relevant. The same aspect may occur multiple times. 

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 40pt"
| ▸ Meanings of the ''ai'' terms:
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 50pt"
| '''a0'''<nowiki>: The aspect to show when this section is occupied by a train or otherwise hold at red.</nowiki> '''a1'''<nowiki>: The aspect to show when this section is clear, but the immediately following section is red.</nowiki> '''a2'''<nowiki>: The aspect to show when this section and the following section are clear, but the one immediately following the latter one is red.</nowiki> '''a''n'''''<nowiki>: The aspect to show when </nowiki>''n'' sections are clear before a red one is encountered.
|}

In the case more sections ahead are clear than indicated by the ''ai'' terms, the section will bear the aspect of ''an''. '''Simplified behavior:''' The ''ai'' terms specify the repertoire of aspects the section can have. A section will bear the smallest of the ''ai'' which is greater than the current aspect of the upcoming section. If no such ''ai'' exists, the section will bear the aspect of ''an''. The order of the ''ai'' is irrelevant. If the same aspect occurs multiple times, this has no effect. 

{|
| width="16" valign="top" |
| ''Example of a Track.Section command in conjunction with a Track.SigF command:''
|-
| width="16" valign="top" | ▶
| style="border: 1px dashed currentColor" bgcolor="#d4d8ff" | <tt>With Track 1000, .Section 0;2;4, .SigF 3;0;-3;-1</tt>
|}

----

 

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | '''Track.SigF''' ''SignalIndex''<nowiki>; </nowiki>''Section''<nowiki>; </nowiki>''X''<nowiki>; </nowiki>''Y''<nowiki>; </nowiki>''Yaw''<nowiki>; </nowiki>''Pitch''<nowiki>; </nowiki>''Roll''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| '''''SignalIndex'''''<nowiki>: A non-negative integer representing the signal to be placed as defined via Signal(</nowiki>''SignalIndex'').Load. '''''Section'''''<nowiki>: A non-negative integer representing the section this signal is attached to, with 0 being the current section, 1 the upcoming section, 2 the section after that, and so on.</nowiki> '''''X'''''<nowiki>: The X-coordinate to place the signal object, </nowiki>'''by default''' measured in '''meters'''. The default value is 0. '''''Y'''''<nowiki>: The Y-coordinate to place the signal object, </nowiki>'''by default''' measured in '''meters'''. The default value is 0. '''''Yaw'''''<nowiki>: The angle in degrees by which the object is rotated in the XZ-plane in clock-wise order when viewed from above. The default value is 0.</nowiki> '''''Pitch'''''<nowiki>: The angle in degrees by which the object is rotated in the YZ-plane in clock-wise order when viewed from the left. The default value is 0.</nowiki> '''''Roll'''''<nowiki>: The angle in degrees by which the object is rotated in the XY-plane in clock-wise order when viewed from behind. The default value is 0. </nowiki>
|}

This command creates a non-function signal, that is, a visual representation of a section as defined via Track.Section. Setting ''Y'' to a negative number resets the y-coordinate to 4.8 meters and attaches a default signal post. Also see Track.Section. If no object has been defined by Signal(''SignalIndex''), one of the default Japanese signals is used: 

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 40pt"
| ▸ Default signals for ''SignalIndex''<nowiki>:</nowiki>
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 50pt"
| '''3'''<nowiki>: A three-aspect signal having aspects </nowiki>●red, ●yellow and ●green. '''4'''<nowiki>: A four-aspect (type A) signal having aspects </nowiki>●red, ●●yellow-yellow, ●yellow and ●green. '''5'''<nowiki>: A five-aspect (type A) signal having aspects </nowiki>●red, ●●yellow-yellow, ●yellow, ●●yellow-green and ●green. '''6'''<nowiki>: A repeating signal equivalent to that created by Track.Relay.</nowiki>
|}

----

 

{|
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | '''Track.Signal''' ''Aspects''<nowiki>; </nowiki>''Unused''<nowiki>; </nowiki>''X''<nowiki>; </nowiki>''Y''<nowiki>; </nowiki>''Yaw''<nowiki>; </nowiki>''Pitch''<nowiki>; </nowiki>''Roll'' '''Track.Sig''' ''Aspects''<nowiki>; </nowiki>''Unused''<nowiki>; </nowiki>''X''<nowiki>; </nowiki>''Y''<nowiki>; </nowiki>''Yaw''<nowiki>; </nowiki>''Pitch''<nowiki>; </nowiki>''Roll''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| '''''Type'''''<nowiki>: The number of aspects for this signal. The default value is -2.</nowiki> '''''Unused'''''<nowiki>: </nowiki>''This argument is not used by openBVE.'' '''''X'''''<nowiki>: The X-coordinate to place the signal object, </nowiki>'''by default''' measured in '''meters'''. The default value is 0. '''''Y'''''<nowiki>: The Y-coordinate to place the signal object, </nowiki>'''by default''' measured in '''meters'''. The default value is 0. '''''Yaw'''''<nowiki>: The angle in degrees by which the object is rotated in the XZ-plane in clock-wise order when viewed from above. The default value is 0.</nowiki> '''''Pitch'''''<nowiki>: The angle in degrees by which the object is rotated in the YZ-plane in clock-wise order when viewed from the left. The default value is 0.</nowiki> '''''Roll'''''<nowiki>: The angle in degrees by which the object is rotated in the XY-plane in clock-wise order when viewed from behind. The default value is 0. </nowiki>
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 40pt"
| ▸ Options for ''Type''<nowiki>:</nowiki>
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 50pt"
| [http://trainsimframework.org/common/illustration_signals_large.png [[Image:illustration_signals_small.png]]] '''2'''<nowiki>: A two-aspect (type A) signal having aspects </nowiki>●red and ●yellow. '''-2'''<nowiki>: A two-aspect (type B) signal having aspects </nowiki>●red and ●green. '''3'''<nowiki>: A three-aspect signal having aspects </nowiki>●red, ●yellow and ●green. '''4'''<nowiki>: A four-aspect (type A) signal having aspects </nowiki>●red, ●●yellow-yellow, ●yellow and ●green. '''-4'''<nowiki>: A four-aspect (type B) signal having aspects </nowiki>●red, ●yellow, ●●yellow-green and ●green. '''5'''<nowiki>: A five-aspect (type A) signal having aspects </nowiki>●red, ●●yellow-yellow, ●yellow, ●●yellow-green and ●green. '''-5'''<nowiki>: A five-aspect (type B) signal having aspects </nowiki>●red, ●yellow, ●●yellow-green, ●green and ●●green-green. '''6'''<nowiki>: A six-aspect signal having aspects </nowiki>●red, ●●yellow-yellow, ●yellow, ●●yellow-green, ●green and ●●green-green.
|}

This command creates a functional signal. You can choose from the available options for ''Aspect'' to create any of the default Japanese signals. Setting ''X'' to 0 creates a functional but invisible signal similar to Track.Section. Setting ''X'' to a non-zero number and ''Y'' to a negative number resets the y-coordinate to 4.8 meters and attaches a default signal post. 

{|
| width="16" valign="top" |
| ''Example of a four-aspect type B signal without a post at x=-3 and y=5:''
|-
| width="16" valign="top" | ▶
| style="border: 1px dashed currentColor" bgcolor="#d4d8ff" | <tt>1000, Track.Signal -4;;-3;5</tt>
|}

{|
| width="16" valign="top" |
| ''Example of a four-aspect type B signal including a post at x=-3 and y=4.8:''
|-
| width="16" valign="top" | ▶
| style="border: 1px dashed currentColor" bgcolor="#d4d8ff" | <tt>1000, Track.Signal -4;;-3;-1</tt>
|}

Track.Signal is similar to using Track.Section and Track.SigF in one command. 

----

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | '''Track.Relay''' ''X''<nowiki>; </nowiki>''Y''<nowiki>; </nowiki>''Yaw''<nowiki>; </nowiki>''Pitch''<nowiki>; </nowiki>''Roll''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| '''''X'''''<nowiki>: The X-coordinate at which to place the object, </nowiki>'''by default''' measured in '''meters'''. The default value is 0. '''''Y'''''<nowiki>: The Y-coordinate at which to place the object, </nowiki>'''by default''' measured in '''meters'''. The default value is 0. '''''Yaw'''''<nowiki>: The angle in degrees by which the object is rotated in the XZ-plane in clock-wise order when viewed from above. The default value is 0.</nowiki> '''''Pitch'''''<nowiki>: The angle in degrees by which the object is rotated in the YZ-plane in clock-wise order when viewed from the left. The default value is 0.</nowiki> '''''Roll'''''<nowiki>: The angle in degrees by which the object is rotated in the XY-plane in clock-wise order when viewed from behind. The default value is 0. </nowiki>
|}

This commands creates a default Japanese repeating signal. The repeating signal repeats the state of the upcoming signal. Setting ''X'' to zero does not create a repeating signal, but forces the command to be ignored. Setting ''X'' to a non-zero number and ''Y'' to a negative number resets the y-coordinate to 4.8 and attaches a default signal post. 

{|
|- style="height: 4px"
|
|}

● 11.6. Safety systems

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| 
|}

{|
|- style="height: 2px"
|
|}

----

 

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | '''Track.Beacon''' ''Type''<nowiki>; </nowiki>''BeaconStructureIndex''<nowiki>; </nowiki>''Section''<nowiki>; </nowiki>''Data''<nowiki>; </nowiki>''X''<nowiki>; </nowiki>''Y''<nowiki>; </nowiki>''Yaw''<nowiki>; </nowiki>''Pitch''<nowiki>; </nowiki>''Roll''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| '''''Type'''''<nowiki>: A non-negative integer representing the type of the beacon to be transmitted to the train.</nowiki> '''''BeaconStructureIndex'''''<nowiki>: A non-negative integer representing the object to be placed as defined via Structure.Beacon, or -1 to not place any object.</nowiki> '''''Section'''''<nowiki>: An integer representing the section to which the beacon is attached, namely 0 for the current section, 1 for the upcoming section, 2 for the section behind that, etc., or -1 for the next red section.</nowiki> '''''Data'''''<nowiki>: An integer representing arbitrary data specific to the beacon type to be transmitted to the train.</nowiki> '''''X'''''<nowiki>: The X-coordinate at which to place the object, </nowiki>'''by default''' measured in '''meters'''. The default value is 0. '''''Y'''''<nowiki>: The Y-coordinate at which to place the object, </nowiki>'''by default''' measured in '''meters'''. The default value is 0. '''''Yaw'''''<nowiki>: The angle in degrees by which the object is rotated in the XZ-plane in clock-wise order when viewed from above. The default value is 0.</nowiki> '''''Pitch'''''<nowiki>: The angle in degrees by which the object is rotated in the YZ-plane in clock-wise order when viewed from the left. The default value is 0.</nowiki> '''''Roll'''''<nowiki>: The angle in degrees by which the object is rotated in the XY-plane in clock-wise order when viewed from behind. The default value is 0.</nowiki>
|}

This command places a beacon (transponder). The object must have been loaded via Structure.Beacon(''BeaconStructureIndex'') prior to using this command. When the train passes the beacon, the type of beacon and various data will be transmitted to the train, including the state of the referenced section. It should be noted that the built-in safety systems also receive data from these beacons as Track.Beacon(''Type'') is roughly equivalent to Track.Transponder(''Type''). Please see [http://trainsimframework.org/develop/information_standards.html the page about beacon standards] for more information. 

----

{|
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | '''Track.Transponder''' ''Type''<nowiki>; </nowiki>''Signal''<nowiki>; </nowiki>''SwitchSystem''<nowiki>; </nowiki>''X''<nowiki>; </nowiki>''Y''<nowiki>; </nowiki>''Yaw''<nowiki>; </nowiki>''Pitch''<nowiki>; </nowiki>''Roll'' '''Track.Tr''' ''Type''<nowiki>; </nowiki>''Signal''<nowiki>; </nowiki>''SwitchSystem''<nowiki>; </nowiki>''X''<nowiki>; </nowiki>''Y''<nowiki>; </nowiki>''Yaw''<nowiki>; </nowiki>''Pitch''<nowiki>; </nowiki>''Roll''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| '''''Type'''''<nowiki>: The type of the transponder. The default value is 0.</nowiki> '''''Signal'''''<nowiki>: The signal this transponder references. The default value is 0.</nowiki> '''''SwitchSystem'''''<nowiki>: Whether to automatically switch the safety system. The default value is 0.</nowiki> '''''X'''''<nowiki>: The X-coordinate at which to place the object, </nowiki>'''by default''' measured in '''meters'''. The default value is 0. '''''Y'''''<nowiki>: The Y-coordinate at which to place the object, </nowiki>'''by default''' measured in '''meters'''. The default value is 0. '''''Yaw'''''<nowiki>: The angle in degrees by which the object is rotated in the XZ-plane in clock-wise order when viewed from above. The default value is 0.</nowiki> '''''Pitch'''''<nowiki>: The angle in degrees by which the object is rotated in the YZ-plane in clock-wise order when viewed from the left. The default value is 0.</nowiki> '''''Roll'''''<nowiki>: The angle in degrees by which the object is rotated in the XY-plane in clock-wise order when viewed from behind. The default value is 0.</nowiki>
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 40pt"
| ▸ Options for ''Type''<nowiki>:</nowiki>
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 50pt"
| [[Image:illustration_transponders.png]] '''0'''<nowiki>: An S-type transponder used by ATS-S. Usually placed 600m in front of a signal.</nowiki> '''1'''<nowiki>: An SN-type transponder used by ATS-SN. Usually placed 20m in front of a signal.</nowiki> '''2'''<nowiki>: An accidental departure transponder. Usually placed shortly behind a station stop.</nowiki> '''3'''<nowiki>: An ATS-P pattern renewal transponder. Usually placed 600m, 280m, 180m, 130m, 85m or 50m in front of a signal, depending on the circumstances.</nowiki> '''4'''<nowiki>: An ATS-P immediate stop transponder. Usually placed either 25m or 30m in front of a signal, depending on the circumstances.</nowiki>
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 40pt"
| ▸ Options for ''Signal''<nowiki>:</nowiki>
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 50pt"
| '''0'''<nowiki>: The upcoming signal is referenced.</nowiki> '''1'''<nowiki>: The signal immediately behind the upcoming signal is referenced.</nowiki> '''''n'''''<nowiki>: The </nowiki>''n'''th signal behind the upcoming signal is referenced.
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 40pt"
| ▸ Options for ''SwitchSystem''<nowiki>:</nowiki>
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 50pt"
| '''-1'''<nowiki>: The transponder does not switch the train between ATS-SN and ATS-P.</nowiki> '''0'''<nowiki>: The transponder automatically switches the train to ATS-SN for transponder types </nowiki>''0'' and ''1'', and to ATS-P for types ''3'' and ''4''. 
|}

 This command places a transponder, usually for the built-in safety systems ATS-SN or ATS-P. For more information about these systems and their transponders, see [http://trainsimframework.org/use/drive.html#atssn the user's documentation about ATS]. It should be noted that custom safety system plugins also receive data from these transponders as Track.Transponder(''Type'') is roughly equivalent to Track.Beacon(''Type''). Please see [http://trainsimframework.org/develop/information_standards.html the page about beacon standards] for more information. ➟ [http://trainsimframework.org/use/drive.html#atssn Go here to find out more about ATS-SN and ATS-P.] ➟ [http://trainsimframework.org/develop/tutorial_ats.html There is a tutorial available for the proper use of ATS-SN and ATS-P in route files, including all of the five transponders.] 

----

 

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | '''Track.AtsSn'''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| 
|}

This command places an S-type transponder for the built-in safety system ATS-SN, referencing the upcoming signal, and automatically switching to ATS-SN. The command is equivalent to '''Track.Tr 0;0;0'''. See there for more information. 

----

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | '''Track.AtsP'''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| 
|}

This command places a pattern renewal transponder for the built-in safety system ATS-P, referencing the upcoming signal, and automatically switching to ATS-P. The command is equivalent to '''Track.Tr 3;0;0'''. See there for more information. 

----

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | '''Track.Pattern''' ''Type''<nowiki>; </nowiki>''Speed''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| '''''Type'''''<nowiki>: The type of speed restriction.</nowiki> '''''Speed'''''<nowiki>: A non-negative floating-point number representing the speed restriction, </nowiki>'''by default''' measured in '''km/h'''.
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 40pt"
| ▸ Options for ''Type''<nowiki>:</nowiki>
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 50pt"
| '''0'''<nowiki>: A temporary speed restriction.</nowiki> '''1'''<nowiki>: A permanent speed restriction.</nowiki>
|}

This command defines a speed restriction for the built-in safety system ATS-P. A temporary speed restriction (''Type''<nowiki>=0) is to be inserted at the point where the speed restriction should apply. ATS-P will know about this speed restriction in advance and will brake the train so that the train meets the speed restriction at that point. Once the point is passed, the speed restriction no longer applies.</nowiki> A permanent speed restriction (''Type''<nowiki>=1) is to be inserted at the point where the speed restriction should apply, however, ATS-P does not know about this limit in advance and will only brake the train from that point on. For a higher degree of realism, insert permanent speed restrictions at the same point as ATS-P transponders. A permanent speed restriction, as the name suggests, is remembered by ATS-P and is only released by a subsequent permanent speed restriction.</nowiki> 

----

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | '''Track.PLimit''' ''Speed''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| '''''Speed'''''<nowiki>: A positive floating-point number representing the permanent speed restriction for ATS-P, </nowiki>'''by default''' measured in '''km/h'''. 
|}

This command is equivalent to '''Track.Pattern 1;''Speed'''''. See there for more information. 

{|
|- style="height: 4px"
|
|}

● 11.7. Miscellaneous

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| 
|}

{|
|- style="height: 2px"
|
|}

----

 

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | '''Track.Back''' ''BackgroundTextureIndex''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| '''''BackgroundTextureIndex'''''<nowiki>: A non-negative integer representing the background image to be displayed as defined via Texture.Background(</nowiki>''BackgroundTextureIndex''). 
|}

This command defines which background image to show from now on. 

{|
| ⚠
|
| bgcolor="#e0e0e0" |
| bgcolor="#e0e0e0" | This command can only be used at the beginning of a block.
| bgcolor="#e0e0e0" |
|}

----

 

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | '''Track.Fog''' ''StartingDistance''<nowiki>; </nowiki>''EndingDistance''<nowiki>; </nowiki>''RedValue''<nowiki>; </nowiki>''GreenValue''<nowiki>; </nowiki>''BlueValue''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| '''''StartingDistance'''''<nowiki>: A floating-point number indicating the start of fog, </nowiki>'''by default''' measured in '''meters'''. The default value is 0. '''''EndingDistance'''''<nowiki>: A floating-point number indicating the end of fog, </nowiki>'''by default''' measured in '''meters'''. The default value is 0. '''''RedValue'''''<nowiki>: An integer ranging from 0 to 255 representing the red component of the fog. The default value is 128.</nowiki> '''''GreenValue'''''<nowiki>: An integer ranging from 0 to 255 representing the green component of the fog. The default value is 128.</nowiki> '''''BlueValue'''''<nowiki>: An integer ranging from 0 to 255 representing the blue component of the fog. The default value is 128. </nowiki>
|}

This command defines the fog from this point on, or deactivates fog. If fog is to be enabled, ''StartingDistance'' must be less than ''EndingDistance''. If fog is to be disabled, ''StartingDistance'' must be greater than or equal to ''EndingDistance''. Fog affects the coloring of objects. Objects before the starting distance appear as-is, objects after the ending distance appear in the fog color, and objects in-between blend linearly between those. The background image is affected by fog as well. For the fog calculations, the background image is assumed to be at 600 meters distance from the camera, regardless of the actual viewing distance. Depending on Options.FogBehavior, there are two options how this command affects fog from this point on. In block-wise mode, the current fog blends from the beginning of this block to the new settings at the end of this block. The new setting is kept for following blocks. This is the default behavior. In interpolation mode, each Track.Fog command defines a control point for fog, where all of the settings (distances and colors) are interpolated linearly between the control points. 

{|
| ⚠
|
| bgcolor="#e0e0e0" |
| bgcolor="#e0e0e0" | This command can only be used at the beginning of a block.
| bgcolor="#e0e0e0" |
|}

----

 

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | '''Track.Brightness''' ''Value''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| '''''Value'''''<nowiki>: A non-negative integer within the range from 0 to 255. The default value is 255. </nowiki>
|}

This command marks a point which affects the brightness in the cab. ''Value'' is measured from 0 (dark) to 255 (light), and is linearly interpolated between successive Track.Brightness commands for any given point on the track. This command should be used for tunnels, bridges, station roofs, or anything else that would affect the brightness as perceived inside the cab. 

{|
| width="16" valign="top" |
| ''Example:''
|-
| width="16" valign="top" | ▶
| style="border: 1px dashed currentColor" bgcolor="#d4d8ff" | <tt>With Track 1200, .Brightness 255 ,; before the bridge starts 1205, .Brightness 128 ,; directly under the bridge here 1210, .Brightness 255 ,; as soon as the bridge ends</tt>
|}

----

 

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | '''Track.Marker''' ''FileName''<nowiki>; </nowiki>''Distance''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| '''''FileName'''''<nowiki>: The file name for the marker image, relative to the </nowiki>'''Object''' folder. '''''Distance'''''<nowiki>: A non-zero floating-point number indicating the length for which the marker image is displayed, </nowiki>'''by default''' measured in '''meters'''.
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 40pt"
| ▸ Behavior for ''Distance''<nowiki>:</nowiki>
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 50pt"
| ''negative value''<nowiki>: The marker image starts to display at the Track.Marker command, and ends -</nowiki>''Distance'' meters after the Track.Marker command. ''positive value''<nowiki>: The marker image starts to display </nowiki>''Distance'' meters before the Track.Marker command, and ends at the Track.Marker command.
|}

This command shows a so-called marker image, which is displayed in the top-right corner of the screen. You can use these images for advisory or informational purposes. The RGB color of 64,64,64 inside the image is made transparent. 

----

{|
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | '''Track.PointOfInterest''' ''RailIndex''<nowiki>; </nowiki>''X''<nowiki>; </nowiki>''Y''<nowiki>; </nowiki>''Yaw''<nowiki>; </nowiki>''Pitch''<nowiki>; </nowiki>''Roll''<nowiki>; </nowiki>''Text'' '''Track.POI''' ''RailIndex''<nowiki>; </nowiki>''X''<nowiki>; </nowiki>''Y''<nowiki>; </nowiki>''Yaw''<nowiki>; </nowiki>''Pitch''<nowiki>; </nowiki>''Roll''<nowiki>; </nowiki>''Text''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| '''''RailIndex'''''<nowiki>: A non-negative integer representing the rail for the point of interest.</nowiki> '''''X'''''<nowiki>: A floating-point number representing the horizontal offset from the rail, </nowiki>'''by default''' measured in '''meters'''. Negative values indicate left, positive ones right. '''''Y'''''<nowiki>: A floating-point number representing the vertical offset from the rail, </nowiki>'''by default''' measured in '''meters'''. Negative values indicate below, positive ones above. '''''Yaw'''''<nowiki>: The angle in degrees by which the view is rotated in the XZ-plane in clock-wise order when viewed from above. The default value is 0.</nowiki> '''''Pitch'''''<nowiki>: The angle in degrees by which the view is rotated in the YZ-plane in clock-wise order when viewed from the left. The default value is 0.</nowiki> '''''Roll'''''<nowiki>: The angle in degrees by which the view is rotated in the XY-plane in clock-wise order when viewed from behind. The default value is 0.</nowiki> '''''Text'''''<nowiki>: A textual representation of the point of interest.</nowiki>
|}

This command creates a point of interest which the user can jump to by pressing the CAMERA_POI_PREVIOUS (NUM 1) or CAMERA_POI_NEXT (NUM 7) keys. The camera will be placed at the specified location with the specified orientation. If ''Text'' is non-empty, a message will appear briefly showing the text. 

----

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | '''Track.PreTrain''' ''Time''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| '''''Time'''''<nowiki>: The </nowiki>[http://trainsimframework.org/develop/information_numberformats.html#times time] at which the pretrain is at this track position. 
|}

This commands creates a position-time-association for an invisible preceding train in order to influence signalling. Contrary to a real preceding train as created by Route.RunInterval, the invisible preceding train created by Track.PreTrain is a way of scripting where the invisible preceding train is at any given time. The position-time-associations must be in increasing order, that is, at a later track position, the associated time must also be later. Before the first scripted time, the invisible preceding train resides at the first scripted position. In-between the first and last scripted time, the invisible preceding train moves (linearly) between the scripted points. After the last scripted time, the invisible preceding train is removed and thus clears signalling. 

----

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | '''Track.Announce''' ''FileName''<nowiki>; </nowiki>''Speed''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| '''''FileName'''''<nowiki>: The file name for the sound to play, relative to the </nowiki>'''Sound''' folder. '''''Speed'''''<nowiki>: The reference speed in km/h for speed-dependant sounds, or 0 to play the sound speed-independently. The default value is 0.</nowiki>
|}

This command plays an announcement or other kind of sound in the cab once the player's train crosses the point where this command is used. If ''Speed'' is set to 0 (default), the sound is played as-is. If a ''Speed'' is given though, the sound plays at is original pitch at the specified speed, and is pitch-modulated proportionally for other speeds, useful for custom flange sounds, pointwork sounds, etc. 

----

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | '''Track.Doppler''' ''FileName''<nowiki>; </nowiki>''X''<nowiki>; </nowiki>''Y''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| '''''FileName'''''<nowiki>: The file name for the sound to play, relative to the </nowiki>'''Sound''' folder. '''''X'''''<nowiki>: A floating-point number representing the horizontal offset from rail 0, </nowiki>'''by default''' measured in '''meters'''. Negative values indicate left, positive ones right. '''''Y'''''<nowiki>: A floating-point number representing the vertical offset from rail 0, </nowiki>'''by default''' measured in '''meters'''. Negative values indicate below, positive ones above. 
|}

This command places an environmental sound effect at the specified location. The sound will play in a loop for the duration of the simulation and employs the doppler effect. (Note: All sounds in openBVE employ the doppler effect.) 

----

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | '''Track.Buffer'''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| 
|}

This command places a bumper. The train can collide with the bumper in both the forward and backward directions. Place this command at the beginning and the end of the route. An object is not automatically created, so use Track.FreeObj to create a visual representation of the bumper if necessary.

.ANIMATED

2015-02-07T00:13:53Z

Kevin: Created page with " The '''.animated''' object format {| style="border: 0px currentColor; margin-right:..."

The '''.animated''' object format 

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| 
|}

 

{|
|- style="height: 4px"
|
|}

{|
|- style="height: 4px"
|
|}

{| style="border: 2px groove currentColor; margin-right: 20pt; margin-left: 20pt" align="center"
| style="border: 2px ridge currentColor" bgcolor="#c04040" | Check this tutorial out:
|-
| bgcolor="#ffffff" |
*[http://www.bvestation.com/forums/index.php?topic=2958.0 Animated Object Building Tutorial By willischong]
|}

{|
|- style="height: 4px"
|
|}

 

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| 
|}

{|
|- style="height: 4px"
|
|}

=■ 1. Overview=
<div class="toccolours mw-collapsible" style="width:1024px">
----

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| 
|}

The ANIMATED object format is a container format allowing you to reference other objects (B3D/CSV/X) and to apply animation to them. It also allows to just group other objects (including other ANIMATED objects) without animating them. Animated objects can be used in CSV/RW routes (unless explicitly disallowed by some commands), as train exterior objects via the ''extensions.cfg'', and as 3D cabs via the ''panel.animated'' file. 

{|
|- style="height: 4px"
|
|}
</div>
==● Basics==
<div class="toccolours mw-collapsible" style="width:1024px">
{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| 
|}

{|
|- style="height: 2px"
|
|}

Animation is performed via the following primitives: 

{|
| valign="top" | ●
|
| State changes - basically allowing to switch between different objects at any time
|}

{|
| valign="top" | ●
|
| Translation - moving objects in three independent directions
|}

{|
| valign="top" | ●
|
| Rotation - rotating objects around three independent axes
|}

{|
| valign="top" | ●
|
| Texture shifts - allowing to shift the texture coordinates of objects in two independent directions
|}

 

{|
|- style="height: 4px"
|
|}
</div>
==● A little formality==
<div class="toccolours mw-collapsible" style="width:1024px">
{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| 
|}

{|
|- style="height: 2px"
|
|}

The file is a plain text file encoded in any arbitrary [http://trainsimframework.org/develop/information_encodings.html encoding], however, UTF-8 with a byte order mark is the preferred choice. The [http://trainsimframework.org/develop/information_numberformats.html parsing model] for numbers is '''Strict'''. The file name is arbitrary, but must have the extension '''.animated'''. The file is interpreted on a per-line basis, from top to bottom. 

{|
|- style="height: 4px"
|
|}
</div>
=■ 2. Sections=

----

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| 
|}

{|
|- style="height: 4px"
|
|}

==● The [Include] section==
<div class="toccolours mw-collapsible" style="width:1024px">

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| 
|}

{|
|- style="height: 2px"
|
|}

 You can use the [Include] section to just include other objects, but without animating them. This allows you to use the ANIMATED object file as a container to group other objects. There can be any number of [Include] sections within the file. 

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | [Include]
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| 
|}

This starts the section. 

{|
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | ''FileName0'' ''FileName1'' ''FileName2'' ...
|}

Defines a series of B3D/CSV/X/ANIMATED objects that should be included as-is. 

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | '''Position = ''X'', ''Y'', ''Z'''''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| 
|}

This defines the position of the objects, basically allowing you to offset them with respect to the rest of the ANIMATED object file. 
</div>
----

{|
|- style="height: 4px"
|
|}

==● The [Object] section==
<div class="toccolours mw-collapsible" style="width:1024px">
{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| 
|}

{|
|- style="height: 2px"
|
|}

 You can use the [Object] section to create a single animation. This requires to set up at least one state via the ''States'' parameter, and to use any combination of functions you want, which provide control over the animation. There can be any number of [Object] sections within the file. 

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | [Object]
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| 
|}

This starts the section. 

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | '''Position = ''X'', ''Y'', ''Z'''''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| 
|}

Defines the position of the object. This basically corresponds to a final TranslateAll command in the respective CSV/B3D file, but is performed after any of the functions are performed. For example, if you want to use rotation, then keep in mind that rotation is done around the origin (0,0,0). The ''Position'' command allows you to reposition the object after the rotation is performed. 

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | '''States = ''File0'', ''File1'', ..., ''Filen-1'''''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| 
|}

Loads ''n'' objects of CSV/B3D/X extension. Please note that the first file indicated has state index 0. Use multiple files only if you want to use state changes. 

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | '''StateFunction = ''Formula'''''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| 
|}

This defines the function for state changes. The result of the ''Formula'' is rounded toward the nearest integer. If that integer is between 0 and ''n''-1, where ''n'' is the number of states as defined via ''States'', the respective state is shown, otherwise, no object is shown. You can make use of the latter if you want an object to toggle on/off with only one state. 

{|
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | '''TranslateXDirection = ''X'', ''Y'', ''Z''''' '''TranslateYDirection = ''X'', ''Y'', ''Z''''' '''TranslateZDirection = ''X'', ''Y'', ''Z'''''
|}

These define the directions for the ''TranslateXFunction'', ''TranslateYFunction'' and ''TranslateZFunction'', respectively. The default directions are: ''TranslateXDirection = 1, 0, 0'' ''TranslateYDirection = 0, 1, 0'' ''TranslateZDirection = 0, 0, 1'' This means that TranslateXFunction will move right by default, TranslateYFunction up and TranslateZFunction forward, which is also why TranslateXFunction and so on bear their names. If you define other directions, then simply think of the three functions and associated directions as three independent ways to move the object in that direction. 

{|
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | '''TranslateXFunction = ''Formula''''' '''TranslateYFunction = ''Formula''''' '''TranslateZFunction = ''Formula'''''
|}

These define the functions to move the object into the respective direction. The ''Formula'' needs to return the amount of meters to move from the initial position. The ''X'', ''Y'' and ''Z'' parameters in the respective direction are multiplied by the result of ''Formula'', so you could for example either multiple the formula by 2 or the direction by 2 if you want to double the speed of movement. 

{|
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | '''RotateXDirection = ''X'', ''Y'', ''Z''''' '''RotateYDirection = ''X'', ''Y'', ''Z''''' '''RotateZDirection = ''X'', ''Y'', ''Z'''''
|}

These define the directions for the ''RotateXFunction'', ''RotateYFunction'' and ''RotateZFunction'', respectively. The default directions are: ''RotateXDirection = 1, 0, 0'' ''RotateYDirection = 0, 1, 0'' ''RotateZDirection = 0, 0, 1'' This means that RotateXFunction will rotate around the x-axis by default, RotateYFunction around the Y-axis, and RotateZFunction around the z-axis, which is also why RotateXFunction and so on bear their names. If you define other directions, then simply think of the three functions and associated directions as three independent ways to rotate the object. 

{|
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | '''RotateXFunction = ''Formula''''' '''RotateYFunction = ''Formula''''' '''RotateZFunction = ''Formula'''''
|}

These define the functions to rotate along the respective direction in counter-clockwise order. The ''Formula'' needs to return the angle by which to rotate in radians. The order in which the rotations are performed is: RotateXFunction (first), RotateYFunction (then) and RotateZFunction (last). If you use more than one rotation function at a time, bear this order in mind. If necessary, overwrite the default directions for the rotations if you need a different order. 

{|
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | '''RotateXDamping = ''NaturalFrequency'', ''DampingRatio''''' '''RotateYDamping = ''NaturalFrequency'', ''DampingRatio''''' '''RotateZDamping = ''NaturalFrequency'', ''DampingRatio'''''
|}

These define damping for the corresponding functions. If not used, damping will not be performed. ''NaturalFrequency'' is a non-negative value corresponding to the angular frequency of an assumed undamped oscillator in radians per second. ''DampingRatio'' is a non-negative value indicating the type of damping. Values between 0 and 1 represent under-damping, 1 represents critical damping, and values above 1 represent over-damping. 

{|
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | '''TextureShiftXDirection = ''X'', ''Y''''' '''TextureShiftYDirection = ''X'', ''Y'''''
|}

These define the directions for the ''TextureShiftXFunction'' and ''TextureShiftYFunction'', respectively. The default directions are: ''TextureShiftXDirection = 1, 0'' ''TextureShiftYDirection = 0, 1'' This means that TextureShiftXFunction will shift the texture right by default, and TextureShiftYFunction down, which is also why TextureShiftXFunction and so on bear their names. If you define other directions, then simply think of the two functions and associated directions as two independent ways to shift textures on the objects. 

{|
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | '''TextureShiftXFunction = ''Formula''''' '''TextureShiftYFunction = ''Formula'''''
|}

These define the functions to shift the texture in the respective direction. The texture is shifted by the return value of ''Formula'' in texture coordinates. The integer part of the result is ignored, and a fractional part of 0.5 represents moving the texture half way. The SetTextureCoordinate commands in the object file define the coordinates, which are then added the outcome of these formulas. 

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | '''TextureOverride = ''Value'''''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| 
|}

''Value'' = '''Timetable'''<nowiki>: All faces will show the timetable bitmap as set up by CSV/RW routes.</nowiki> ''Value'' = '''None'''<nowiki>: The original textures will be displayed on the faces (default behavior).</nowiki> 

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | '''RefreshRate = ''Seconds'''''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| 
|}

This defines the minimum amount of time that needs to pass before the functions are updated. A value of 0 forces the functions to be updated every frame. Please note that objects outside of the visual range might be updated less frequently regardless of this parameter. Use RefreshRate when you don't need a perfectly smooth animation (in order to optimize performance), or when you deliberately want the object to be only updated in fixed intervals. 

----

{|
| ⚠
|
| bgcolor="#e0e0e0" |
| bgcolor="#e0e0e0" | '''openBVE 2 compatibility note:''' During the development of openBVE (v0.9) and during the development of the animated object format, there were certain commands in existance ending in ''RPN'', such as ''TranslateXFunctionRPN''. These commands never made it into any official release (v1.0) and were thus never meant to be used outside of development environments. While they are still available undocumentedly, they will be removed for openBVE 2. If you are using these commands, please get rid of them as soon as possible.
| bgcolor="#e0e0e0" |
|}
</div>
----

 

{|
|- style="height: 4px"
|
|}

==● About the formulas==
<div class="toccolours mw-collapsible" style="width:1024px">
{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| 
|}

{|
|- style="height: 2px"
|
|}

First of all, infix notation, which is what you can enter for ''Formula'', is converted into functional notation. Thus for every infix notation, there is a corresponding functional notation. Some functions do not have an infix operator and can thus only be entered in functional notation. For operators, precedence plays an important role. You can use parantheses to override the order of precedence just as in any usual mathematical formula. Names of functions are case-insensitive. 

{|
| ⚠
|
| bgcolor="#e0e0e0" |
| bgcolor="#e0e0e0" | Please note that if the result of any mathematical operation or function would be infinity, indeterminate or non-real, 0 is returned. Numeric overflow is not prevented, so you need to take that into account yourself.
| bgcolor="#e0e0e0" |
|}

 

{|
|- style="height: 4px"
|
|}
</div>
=■ 3. List of infix notation operators=
<div class="toccolours mw-collapsible" style="width:1024px">
----

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| 
|}

{|
|- style="height: 4px"
|
|}

===● Basic arithmetics===
<div class="toccolours mw-collapsible" style="width:1024px">
{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| 
|}

{|
|- style="height: 2px"
|
|}

{| style="border-collapse: collapse"
! style="padding: 4px; border: 2px ridge currentColor" bgcolor="#d0d0d0" | Infix
! style="padding: 4px; border: 2px ridge currentColor" bgcolor="#d0d0d0" | Functional
! style="padding: 4px; border: 2px ridge currentColor" bgcolor="#d0d0d0" | Description
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | <tt>''a'' + ''b''</tt>
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | <tt>Plus[''a'',''b'', ...]</tt>
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | Represents addition
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | <tt>''a'' - ''b''</tt>
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | <tt>Subtract[''a'',''b'']</tt>
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | Represents subtraction
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | <tt>-''a''</tt>
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | <tt>Minus[''a'']</tt>
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | Negates the number
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | <tt>''a'' * ''b''</tt>
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | <tt>Times[''a'',''b'',...]</tt>
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | Represents multiplication
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | <tt>''a'' / ''b''</tt>
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | <tt>Divide[''a'',''b'']</tt>
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | Represents division
|}

 
</div>
{|
|- style="height: 4px"
|
|}

===● Comparisons===

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| 
|}

{|
|- style="height: 2px"
|
|}

All comparisons return 1 for true and 0 for false. 

{| style="border-collapse: collapse"
! style="padding: 4px; border: 2px ridge currentColor" bgcolor="#d0d0d0" | Infix
! style="padding: 4px; border: 2px ridge currentColor" bgcolor="#d0d0d0" | Functional
! style="padding: 4px; border: 2px ridge currentColor" bgcolor="#d0d0d0" | Description
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | <tt>''a'' == ''b''</tt>
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | <tt>Equal[''a'',''b'']</tt>
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | True (1) if ''a'' equals ''b''
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | <tt>''a'' != ''b''</tt>
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | <tt>Unequal[''a'',''b'']</tt>
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | True (1) if ''a'' does not equal ''b''
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | <tt>''a'' < ''b''</tt>
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | <tt>Less[''a'',''b'']</tt>
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | True (1) if ''a'' is less than ''b''
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | <tt>''a'' > ''b''</tt>
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | <tt>Greater[''a'',''b'']</tt>
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | True (1) if ''a'' is greater than ''b''
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | <tt>''a'' <= ''b''</tt>
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | <tt>LessEqual[''a'',''b'']</tt>
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | True (1) if ''a'' is less than or equal to ''b''
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | <tt>''a'' >= ''b''</tt>
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | <tt>GreaterEqual[''a'',''b'']</tt>
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | True (1) if ''a'' is greater than or equal to ''b''
|}

 

{|
|- style="height: 4px"
|
|}
</div>

===● Logical operations===
<div class="toccolours mw-collapsible" style="width:1024px">
{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| 
|}

{|
|- style="height: 2px"
|
|}

All operations treat 0 as false and any other value as true, and return 1 for true and 0 for false. 

{| style="border-collapse: collapse"
! style="padding: 4px; border: 2px ridge currentColor" bgcolor="#d0d0d0" | Infix
! style="padding: 4px; border: 2px ridge currentColor" bgcolor="#d0d0d0" | Functional
! style="padding: 4px; border: 2px ridge currentColor" bgcolor="#d0d0d0" | Description
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | <tt><nowiki>!</nowiki>''a''</tt>
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | <tt>Not[''a'']</tt>
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | True (1) if ''a'' is false
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | <tt>''a'' & ''b''</tt>
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | <tt>And[''a'',''b'']</tt>
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | True (1) if both ''a'' and ''b'' are true
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | <tt>''a'' | ''b''</tt>
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | <tt>Or[''a'',''b'']</tt>
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | True (1) if any of ''a'' or ''b'' are true
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | <tt>''a'' ^ ''b''</tt>
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | <tt>Xor[''a'',''b'']</tt>
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | True (1) if either ''a'' or ''b'' is true
|}

 

{|
|- style="height: 4px"
|
|}
</div>
===● Operator precedence===
<div class="toccolours mw-collapsible" style="width:1024px">
{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| 
|}

{|
|- style="height: 2px"
|
|}

From highest precedence to lowest. Operators of same precedence are evaluated left to right in the order in they occur in the formula. 

{| style="border-collapse: collapse"
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | - (Minus)
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | <tt>/</tt>
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | <tt><nowiki>*</nowiki></tt>
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | <tt>+</tt>, <tt>-</tt> (Subtract)
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | <tt><nowiki>==</nowiki></tt>, <tt><nowiki>!=</nowiki></tt>, <tt><</tt>, <tt>></tt>, <tt><=</tt>, <tt>>=</tt>
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | <tt><nowiki>!</nowiki></tt>
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | <tt>&</tt>
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | <tt>^</tt>
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | <tt><nowiki>|</nowiki></tt>
|}

 

{|
| ⚠
|
| bgcolor="#e0e0e0" |
| bgcolor="#e0e0e0" | Please note that some combinations of prefix and infix operators are not recognized. For example <tt>a*-b</tt> is not accepted. Use <tt>a*(-b)</tt> or <tt>-a*b</tt> instead.
| bgcolor="#e0e0e0" |
|}

 

{|
|- style="height: 4px"
|
|}
</div>
=■ 4. List of functions=

----

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| 
|}

{|
|- style="height: 4px"
|
|}

==● Basic arithmetics==
<div class="toccolours mw-collapsible" style="width:1024px">
{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| 
|}

{|
|- style="height: 2px"
|
|}

{| style="border-collapse: collapse"
! style="padding: 4px; border: 2px ridge currentColor" bgcolor="#d0d0d0" | Function
! style="padding: 4px; border: 2px ridge currentColor" bgcolor="#d0d0d0" | Description
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | <tt>Reciprocal[''x'']</tt>
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | Returns the reciprocal, equal to 1/''x''
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | <tt>Power[''a'',''b'',...]</tt>
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | Returns ''a'' raised to the ''b''th power. ''b'' must be a non-negative number. For consistency, Power[0,''b''] always returns 1, even in the degenerate case Power[0,0], and ''a'' being negative always returns 0.
|}

 

{|
|- style="height: 4px"
|
|}
</div>
==● Numeric functions==
<div class="toccolours mw-collapsible" style="width:1024px">
{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| 
|}

{|
|- style="height: 2px"
|
|}

{| style="border-collapse: collapse"
! style="padding: 4px; border: 2px ridge currentColor" bgcolor="#d0d0d0" | Function
! style="padding: 4px; border: 2px ridge currentColor" bgcolor="#d0d0d0" | Description
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | <tt>Quotient[''a'',''b'']</tt>
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | Divides ''a'' by ''b'' and rounds the result down, equal to <tt>Floor[a/b]</tt>.
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | <tt>Mod[''a'',''b'']</tt>
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | Returns the remainder of dividing ''a'' by ''b'', equal to <tt>a-b*Floor[a/b]</tt>.
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | <tt>Min[''a'',''b'',...]</tt>
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | Returns the smallest of the terms.
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | <tt>Max[''a'',''b'',...]</tt>
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | Returns the largest of the terms.
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | <tt>Abs[''x'']</tt>
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | Returns the absolute value.
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | <tt>Sign[''x'']</tt>
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | Returns the sign of ''x'', which is either -1, 0 or 1.
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | <tt>Floor[''x'']</tt>
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | Rounds down to the nearest integer.
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | <tt>Ceiling[''x'']</tt>
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | Rounds up to the nearest integer.
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | <tt>Round[''x'']</tt>
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | Rounds to the nearest integer. Numbers ending in .5 are rounded to the nearest even integer.
|}

 

{|
|- style="height: 4px"
|
|}
</div>
==● Elementary functions==
<div class="toccolours mw-collapsible" style="width:1024px">
{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| 
|}

{|
|- style="height: 2px"
|
|}

{| style="border-collapse: collapse"
! style="padding: 4px; border: 2px ridge currentColor" bgcolor="#d0d0d0" | Function
! style="padding: 4px; border: 2px ridge currentColor" bgcolor="#d0d0d0" | Description
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | <tt>Exp[''x'']</tt>
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | The exponential function, or ''e'' to the ''x''th power.
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | <tt>Log[''x'']</tt>
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | The natural logarithm, to base ''e''.
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | <tt>Sqrt[x]</tt>
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | The square root.
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | <tt>Sin[''x'']</tt>
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | The sine (input in radians).
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | <tt>Cos[''x'']</tt>
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | The cosine (input in radians).
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | <tt>Tan[''x'']</tt>
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | The tangent (input in radians).
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | <tt>ArcTan[''x'']</tt>
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | The inverse tangent (output in radians).
|}

 

{|
|- style="height: 4px"
|
|}
</div>
==● Conditionals==
<div class="toccolours mw-collapsible" style="width:1024px">
{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| 
|}

{|
|- style="height: 2px"
|
|}

{| style="border-collapse: collapse"
! style="padding: 4px; border: 2px ridge currentColor" bgcolor="#d0d0d0" | Function
! style="padding: 4px; border: 2px ridge currentColor" bgcolor="#d0d0d0" | Description
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | <tt>If[''cond'',''truevalue'',''falsevalue'']</tt>
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | If ''cond'' is != 0, returns ''truevalue'', otherwise ''falsevalue''
|}

 

{|
|- style="height: 4px"
|
|}
</div>
==■ 5. List of variables==

----

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| 
|}

{|
|- style="height: 4px"
|
|}

==● Primitives==
<div class="toccolours mw-collapsible" style="width:1024px">
{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| 
|}

{|
|- style="height: 2px"
|
|}

{| style="border-collapse: collapse"
! style="padding: 4px; border: 2px ridge currentColor" bgcolor="#d0d0d0" | Variable
! style="padding: 4px; border: 2px ridge currentColor" bgcolor="#d0d0d0" | Description
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | <tt>value</tt>
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | The value returned by the function in the last evaluation. At the beginning of the simulation, this is 0.
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | <tt>delta</tt>
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | The time difference since the last evaluation of the function in seconds. Please note that there is no guaranteed time that elapses between successive function calls.
|}

 

{|
|- style="height: 4px"
|
|}
</div>
==● Time and camera==
<div class="toccolours mw-collapsible" style="width:1024px">
{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| 
|}

{|
|- style="height: 2px"
|
|}

{| style="border-collapse: collapse"
! style="padding: 4px; border: 2px ridge currentColor" bgcolor="#d0d0d0" | Variable
! style="padding: 4px; border: 2px ridge currentColor" bgcolor="#d0d0d0" | Description
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | <tt>time</tt>
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | The current in-game time measured in seconds since midnight of the first day.
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | <tt>cameraDistance</tt>
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | The non-negative cartesian distance measured from the object to the camera in meters.
|}

 

{|
|- style="height: 4px"
|
|}
</div>
==● Trains==
<div class="toccolours mw-collapsible" style="width:1024px">
{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| 
|}

{|
|- style="height: 2px"
|
|}

Generally, objects attached to a particular train and car return values for that train and car, unless stated otherwise. For scenery objects, the reference is the driver's car of the nearest train (not necessarily the player's train). In some of the following variables, ''carIndex'' has the following meaning: 0 is the 1st car from the front, 1 is the 2nd car from the front, etc., while -1 is the 1st car from the rear, -2 is the 2nd car from the rear, etc. In general, car indices from -''cars'' to ''cars''-1 represent existing cars, where ''cars'' is the number of cars the train has, while values outside of this range represent non-existing cars. As all trains have at least 1 car, indices -1 and 0 are guaranteed to exist for any train. 

{|
|- style="height: 4px"
|
|}
</div>
==● Trains (general)==
<div class="toccolours mw-collapsible" style="width:1024px">
{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| 
|}

{|
|- style="height: 2px"
|
|}

{| style="border-collapse: collapse"
! style="padding: 4px; border: 2px ridge currentColor" bgcolor="#d0d0d0" | Variable
! style="padding: 4px; border: 2px ridge currentColor" bgcolor="#d0d0d0" | Description
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | <tt>cars</tt>
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | The number of cars the train has.
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | <tt>speed</tt>
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | The signed actual speed of the current car in m/s. Is positive when the train travels forward, and negative when the train travels backward.
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | <tt>speed[''carIndex'']</tt>
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | The signed actual speed of the car ''carIndex'' in m/s. Is positive when the train travels forward, and negative when the train travels backward.
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | <tt>speedometer</tt>
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | The signed perceived speed of the current car in m/s as it would appear to a speedometer on wheel slip and wheel lock.
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | <tt>speedometer[''carIndex'']</tt>
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | The signed perceived speed of the car ''carIndex'' in m/s as it would appear to a speedometer on wheel slip and wheel lock.
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | <tt>acceleration</tt>
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | The actual acceleration of the current car in m/s².
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | <tt>acceleration[''carIndex'']</tt>
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | The actual acceleration of the car ''carIndex'' in m/s².
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | <tt>accelerationMotor</tt>
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | The acceleration which the motor of the first motor car currently generates in m/s².
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | <tt>accelerationMotor[''carIndex'']</tt>
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | The acceleration which the motor of the car ''carIndex'' currently generates in m/s².
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | <tt>distance</tt>
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | The non-negative cartesian distance measured from the object to the closest car in meters. Only meaningful for scenery objects.
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | <tt>distance[''carIndex'']</tt>
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | The non-negative cartesian distance measured from the object to the car ''carIndex'' in meters, or 0 if the car does not exist. Only meaningful for scenery objects.
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | <tt>trackDistance</tt>
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | The signed track distance measured from the object to the closest end of the train in meters. Is positive when the train is in front of the object, negative when behind, and zero when the object lies between the ends of the train. Only meaningful for scenery objects. '''Deprecated. The behavior of this variable may change in future versions of openBVE.'''
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | <tt>trackDistance[''carIndex'']</tt>
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | The signed track distance measured from the object to the car ''carIndex'' in meters. Is positive when the center of the car is in front of the object, and negative if behind. Returns 0 if the car does not exist. Only meaningful for scenery objects. '''Deprecated. The behavior of this variable may change in future versions of openBVE.'''
|}

 

{|
|- style="height: 4px"
|
|}
</div>
==● Trains (brake)==
<div class="toccolours mw-collapsible" style="width:1024px">
{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| 
|}

{|
|- style="height: 2px"
|
|}

{| style="border-collapse: collapse"
! style="padding: 4px; border: 2px ridge currentColor" bgcolor="#d0d0d0" | Variable
! style="padding: 4px; border: 2px ridge currentColor" bgcolor="#d0d0d0" | Description
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | <tt>mainReservoir</tt>
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | The current pressure in the main reservoir in this car, measured in Pa.
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | <tt>mainReservoir[''carIndex'']</tt>
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | The current pressure in the main reservoir in car ''carIndex'', measured in Pa.
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | <tt>emergencyReservoir</tt>
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | The current pressure in the emergency reservoir in this car, measured in Pa.
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | <tt>emergencyReservoir[''carIndex'']</tt>
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | The current pressure in the emergency reservoir in car ''carIndex'', measured in Pa.
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | <tt>brakePipe</tt>
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | The current pressure in the brake pipe in this car, measured in Pa.
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | <tt>brakePipe[''carIndex'']</tt>
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | The current pressure in the brake pipe in car ''carIndex'', measured in Pa.
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | <tt>brakeCylinder</tt>
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | The current pressure in the brake cylinder in this car, measured in Pa.
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | <tt>brakeCylinder[''carIndex'']</tt>
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | The current pressure in the brake cylinder in car ''carIndex'', measured in Pa.
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | <tt>straightAirPipe</tt>
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | The current pressure in the straight air pipe in this car, measured in Pa.
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | <tt>straightAirPipe[''carIndex'']</tt>
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | The current pressure in the straight air pipe in car ''carIndex'', measured in Pa.
|}

 

{|
|- style="height: 4px"
|
|}
</div>
==● Trains (doors)==
<div class="toccolours mw-collapsible" style="width:1024px">
{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| 
|}

{|
|- style="height: 2px"
|
|}

{| style="border-collapse: collapse"
! style="padding: 4px; border: 2px ridge currentColor" bgcolor="#d0d0d0" | Variable
! style="padding: 4px; border: 2px ridge currentColor" bgcolor="#d0d0d0" | Description
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | <tt>doors</tt>
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | The state of the doors. Returns 0 if fully closed, 1 if fully opened, or any intermediate value, biasing doors that are in a more open state.
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | <tt>doors[''carIndex'']</tt>
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | The state of the doors of car ''carIndex''. Returns 0 if fully closed, 1 if fully opened, or any intermediate value, biasing doors that are in a more open state.
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | <tt>leftDoors</tt>
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | The state of the left doors. Returns 0 if fully closed, 1 if fully opened, or any intermediate value, biasing doors that are in a more open state.
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | <tt>leftDoors[''carIndex'']</tt>
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | The state of the left doors of car ''carIndex''. Returns a value between 0 and 1, biasing doors that are in a more open state, or -1 if the car does not exist.
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | <tt>rightDoors</tt>
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | The state of the right doors. Returns 0 if fully closed, 1 if fully opened, or any intermediate value, biasing doors that are in a more open state.
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | <tt>rightDoors[''carIndex'']</tt>
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | The state of the right doors of car ''carIndex''. Returns a value between 0 and 1, biasing doors that are in a more open state, or -1 if the car does not exist.
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | <tt>leftDoorsTarget</tt>
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | The anticipated target state of the left doors. Returns either 0 (closed) or 1 (opened).
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | <tt>leftDoorsTarget[''carIndex'']</tt>
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | The anticipated target state of the left doors of car ''carIndex''. Returns either 0 (closed) or 1 (opened).
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | <tt>rightDoorsTarget</tt>
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | The anticipated target state of the right doors. Returns either 0 (closed) or 1 (opened).
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | <tt>rightDoorsTarget[''carIndex'']</tt>
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | The anticipated target state of the right doors of car ''carIndex''. Returns either 0 (closed) or 1 (opened).
|}

 

{|
|- style="height: 4px"
|
|}
</div>
==● Trains (miscellaneous)==
<div class="toccolours mw-collapsible" style="width:1024px">
{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| 
|}

{|
|- style="height: 2px"
|
|}

{| style="border-collapse: collapse"
! style="padding: 4px; border: 2px ridge currentColor" bgcolor="#d0d0d0" | Variable
! style="padding: 4px; border: 2px ridge currentColor" bgcolor="#d0d0d0" | Description
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | <tt>reverserNotch</tt>
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | The state of the reverser, which is either -1 (backward), 0 (neutral), or forward (1).
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | <tt>powerNotch</tt>
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | The current power notch, i.e. 0 for N, 1 for P1, 2 for P2, 3 for P3, etc.
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | <tt>powerNotches</tt>
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | The amount of power notches the train has.
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | <tt>brakeNotch</tt>
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" |
The current brake notch.

{|
| valign="top" | ●
|
| For trains without the automatic air brake: 0 for N, 1 for B1, 2 for B2, 3 for B3, etc.
|}

{|
| valign="top" | ●
|
| For trains with the automatic air brake: 0 for REL, 1 for LAP and 2 for SRV.
|}
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | <tt>brakeNotches</tt>
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | The amount of brake notches the train has. For trains with the automatic air brake, this returns 2.
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | <tt>brakeNotchLinear</tt>
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" |
A combination of brake notch, hold brake and emergency brake. 

{|
| valign="top" | ●
|
| For trains without the automatic air brake and without hold brake: 0 for N, 1 for B1, 2 for B2, 3 for B3, etc., up to ''BrakeNotches''+1 for EMG.
|}

{|
| valign="top" | ●
|
| For trains without the automatic air brake but with hold brake: 0 for N, 1 for HLD, 2 for B1, 3 for B2, 4 for B3, etc., up to ''BrakeNotches''+2 for EMG.
|}

{|
| valign="top" | ●
|
| For trains with the automatic air brake: 0 for REL, 1 for LAP, 2 for SRV or 3 for EMG.
|}
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | <tt>brakeNotchesLinear</tt>
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" |
The highest value returned by ''brakeNotchesLinear''.

{|
| valign="top" | ●
|
| For trains without the automatic air brake and without hold brake, this is ''BrakeNotches''+1.
|}

{|
| valign="top" | ●
|
| For trains without the automatic air brake but with hold brake, this is ''BrakeNotches''+2.
|}

{|
| valign="top" | ●
|
| For trains with the automatic air brake, this returns 3.
|}
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | <tt>emergencyBrake</tt>
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | Whether the emergency brake is currently active (1) or not (0).
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | <tt>hasAirBrake</tt>
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | Whether the train has the automatic air brake (1) or not (0).
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | <tt>holdBrake</tt>
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | Whether the hold brake is currently active (1) or not (0).
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | <tt>hasHoldBrake</tt>
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | Whether the train has a hold brake (1) or not (0).
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | <tt>constSpeed</tt>
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | Whether the const speed system is currently active (1) or not (0).
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | <tt>hasConstSpeed</tt>
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | Whether the train has a const speed system (1) or not (0).
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | <tt>hasPlugin</tt>
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | Whether the train uses a plugin (1) or not (0).
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | <tt>pluginState[''i'']</tt>
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | The state of the ith plugin variable, returning an integer depending on the plugin. Is the same as ats''i'' in the panel2.cfg.
|}

 If ''pluginState[i]'' is used with the built-in safety systems ATS and ATC, the following mappings for ''i'' apply: 

{| style="border-collapse: collapse"
! style="padding: 4px; border: 2px ridge currentColor" bgcolor="#d0d0d0" | ''i''
! style="padding: 4px; border: 2px ridge currentColor" bgcolor="#d0d0d0" | English
! style="padding: 4px; border: 2px ridge currentColor" bgcolor="#d0d0d0" | 日本語
! style="padding: 4px; border: 2px ridge currentColor" bgcolor="#d0d0d0" | Return values
! style="padding: 4px; border: 2px ridge currentColor" bgcolor="#d0d0d0" |
! style="padding: 4px; border: 2px ridge currentColor" bgcolor="#d0d0d0" | pluginState[271]
! style="padding: 4px; border: 2px ridge currentColor" bgcolor="#d0d0d0" | Meaning
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | 256
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | ATS
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | ATS
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | 0 (unlit) or 1 (lit)
! style="padding: 4px; border: 2px ridge currentColor" bgcolor="#d0d0d0" |
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | 0
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | ATC not available
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | 257
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | ATS RUN
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | ATS 作動
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | 0 (unlit), 1 (lit) or 2 (flashing)
! style="padding: 4px; border: 2px ridge currentColor" bgcolor="#d0d0d0" |
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | 1
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | 0 km/h
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | 258
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | ATS RUN
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | ATS 作動
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | 0 (unlit / non-flashing), 1 (lit / flashing)
! style="padding: 4px; border: 2px ridge currentColor" bgcolor="#d0d0d0" |
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | 2
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | 15 km/h
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | 259
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | P POWER
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | P 電源
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | 0 (unlit) or 1 (lit)
! style="padding: 4px; border: 2px ridge currentColor" bgcolor="#d0d0d0" |
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | 3
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | 25 km/h
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | 260
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | PTN APPROACH
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | パターン接近
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | 0 (unlit) or 1 (lit)
! style="padding: 4px; border: 2px ridge currentColor" bgcolor="#d0d0d0" |
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | 4
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | 45 km/h
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | 261
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | BRAKE RELEASE
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | ブレーキ開放
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | 0 (unlit) or 1 (lit)
! style="padding: 4px; border: 2px ridge currentColor" bgcolor="#d0d0d0" |
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | 5
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | 55 km/h
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | 262
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | BRAKE APPLY
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | ブレーキ動作
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | 0 (unlit) or 1 (lit)
! style="padding: 4px; border: 2px ridge currentColor" bgcolor="#d0d0d0" |
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | 6
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | 65 km/h
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | 263
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | ATS P
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | ATS-P
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | 0 (unlit) or 1 (lit)
! style="padding: 4px; border: 2px ridge currentColor" bgcolor="#d0d0d0" |
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | 7
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | 75 km/h
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | 264
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | FAILURE
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | 故障
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | 0 (unlit) or 1 (lit)
! style="padding: 4px; border: 2px ridge currentColor" bgcolor="#d0d0d0" |
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | 8
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | 90 km/h
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | 265
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | ATC
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | ATC
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | 0 (unlit) or 1 (lit)
! style="padding: 4px; border: 2px ridge currentColor" bgcolor="#d0d0d0" |
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | 9
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | 100 km/h
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | 266
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | ATC POWER
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | ATC 電源
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | 0 (unlit) or 1 (lit)
! style="padding: 4px; border: 2px ridge currentColor" bgcolor="#d0d0d0" |
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | 10
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | 110 km/h
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | 267
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | ATC SRV
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | ATC 常用
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | 0 (unlit) or 1 (lit)
! style="padding: 4px; border: 2px ridge currentColor" bgcolor="#d0d0d0" |
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | 11
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | 120 km/h
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | 268
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | ATC EMG
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | ATC 非常
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | 0 (unlit) or 1 (lit)
! style="padding: 4px; border: 2px ridge currentColor" bgcolor="#d0d0d0" |
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | 12
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | ATS is active
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | 269
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | CONST SPEED
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | 定速
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | 0 (unlit) or 1 (lit)
! style="padding: 4px; border: 2px ridge currentColor" bgcolor="#d0d0d0" |
! style="padding: 4px; border: 2px ridge currentColor" bgcolor="#d0d0d0" |
! style="padding: 4px; border: 2px ridge currentColor" bgcolor="#d0d0d0" |
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | 270
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | EB
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | EB
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | 0 (unlit) or 1 (lit)
! style="padding: 4px; border: 2px ridge currentColor" bgcolor="#d0d0d0" |
! style="padding: 4px; border: 2px ridge currentColor" bgcolor="#d0d0d0" |
! style="padding: 4px; border: 2px ridge currentColor" bgcolor="#d0d0d0" |
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | 271
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | ATC speed indicator
! style="padding: 4px; border: 2px ridge currentColor" bgcolor="#d0d0d0" |
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | 0 - 12, see table on the right
! style="padding: 4px; border: 2px ridge currentColor" bgcolor="#d0d0d0" |
! style="padding: 4px; border: 2px ridge currentColor" bgcolor="#d0d0d0" |
! style="padding: 4px; border: 2px ridge currentColor" bgcolor="#d0d0d0" |
|}

 

{|
|- style="height: 4px"
|
|}
</div>
==● Sections (signalling)==
<div class="toccolours mw-collapsible" style="width:1024px">
{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| 
|}

{|
|- style="height: 2px"
|
|}

The section context is defined when the object is placed using Track.SigF. 

{| style="border-collapse: collapse"
! style="padding: 4px; border: 2px ridge currentColor" bgcolor="#d0d0d0" | Variable
! style="padding: 4px; border: 2px ridge currentColor" bgcolor="#d0d0d0" | Description
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | <tt>section</tt>
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | The value of the section aspect currently shown. ''If this variable is used outside of a Track.SigF context, the behavior is currently undefined and subject to change.''
|}

 

{|
|- style="height: 4px"
|
|}
</div>
=■ 6. Performance=

----
<div class="toccolours mw-collapsible" style="width:1024px">
{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| 
|}

There are certain kinds of animation which are less expensive, and others which are more. Also, the underlying object plays a significant role. If you want to design your animated objects with as best performance as possible '''for future releases of openBVE''', take a look at the following performance table: 

{| style="border-collapse: collapse"
! style="padding: 4px; border: 2px ridge currentColor" bgcolor="#d0d0d0" | Animation
! style="padding: 4px; border: 2px ridge currentColor" bgcolor="#d0d0d0" | Object
! style="padding: 4px; border: 2px ridge currentColor" bgcolor="#d0d0d0" | Performance
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | State changes
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | Has only opaque faces
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | Good
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | State changes
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | Has partially transparent faces
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | Moderate
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | Translation
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | Has only opaque faces
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | Good
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | Translation
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | Has partially transparent faces
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | Moderate
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | Rotation
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | Has only opaque faces
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | Good
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | Rotation
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | Has partially transparent faces
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | Bad
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | Texture shifts
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | Has only opaque faces
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | Bad
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | Texture shifts
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | Has partially transparent faces
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | Bad
|}

 Performance is generally better if the result of a function only infrequently changes. So, even if you set the ''RefreshRate'' parameter to zero, performance is generally better if the outcome of your formula is constant over longer periods of time. On the other hand, if it changes every frame, performance is generally worse. Generally, you should avoid using animation with partially transparent faces and stick to opaque faces when possible. Also, try to avoid texture shifts, and consider using state changes or translation where possible. 

{|
|- style="height: 4px"
|
|}
</div>
=■ 7. Tips=
<div class="toccolours mw-collapsible" style="width:1024px">
----

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| 
|}

 

{|
| valign="top" | ●
|
| Generally speaking, try to keep the complexity of functions as low as possible. This is not the most critical aspect, though, as most of the performance impact will result from applying the results of a function, e.g. rotating the object, and not evaluating the function.
|}

 

{|
| valign="top" | ●
|
| Use the RefreshRate parameter when possible to optimize performance. Usually, you can use this parameter when you don't need a smooth animation, or when you deliberately want the functions to only update in intervals.
|}

 

{|
| valign="top" | ●
|
| Don't use functions which always evaluate to the same constant. For example, don't use RotateXFunction = 3.14159, but rotate the underlying CSV/B3D/X object directly.
|}

 

{|
| valign="top" | ●
|
| State changes are very cheap as long as the state doesn't actually change in between two executions of the StateFunction. If a change occurs, this is a relatively expensive operation, though.
|}

 

{|
| valign="top" | ●
|
| Try to optimize out ''if'' conditions. Especially try to avoid nested ''if'' functions. Often, there is an elegant mathematical solution.
|}

 

{|
| valign="top" | ●
|
| Certain functions, e.g. Exp, Sin, Cos, etc., are relatively expensive. Use them only if absolutely necessary for an effect. Don't include unnecessary operations. For example, the result of StateFunction is automatically rounded toward the nearest integer, so don't apply an additional explicit Round.
|}

 

{|
| valign="top" | ●
|
| When working with car objects, bear in mind that some variables have an optional car index. You should use this index if you want to query the state of a particular car (that is, not necessarily the one the object is attached to). If, however, you just want to query the value of the particular car the object is attached to, use the variable without the index. For scenery objects, you should not generally use car indices as you can't be sure how many cars the queried train has.
|}

 

{|
|- style="height: 4px"
|
|}
</div>
=■ 8. Example functions=

----
<div class="toccolours mw-collapsible" style="width:1024px">
{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| 
|}

 

{|
|- style="height: 4px"
|
|}
</div>
==● Blinking light==
<div class="toccolours mw-collapsible" style="width:1024px">
{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| 
|}

{|
|- style="height: 2px"
|
|}

{|
| width="16" valign="top" |
| ''Template for a blinking light:''
|-
| width="16" valign="top" | ▶
| style="border: 1px dashed currentColor" bgcolor="#d4d8ff" | <tt>States = ''OBJECT0'', ''OBJECT1'' StateFunction = value == 0 RefreshRate = ''SECONDS''</tt>
|}

 

{|
|- style="height: 4px"
|
|}
</div>
==● Rotating wheel==
<div class="toccolours mw-collapsible" style="width:1024px">
{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| 
|}

{|
|- style="height: 2px"
|
|}

{|
| width="16" valign="top" |
| ''Template for the code used in an exterior car object:''
|-
| width="16" valign="top" | ▶
| style="border: 1px dashed currentColor" bgcolor="#d4d8ff" | <tt>States = ''OBJECT'' RotateXFunction = value + delta * speedometer / ''RADIUS_OF_THE_WHEEL''</tt>
|}

 

{|
|- style="height: 4px"
|
|}
</div>
==● Cycling through a list of objects==
<div class="toccolours mw-collapsible" style="width:1024px">
{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| 
|}

{|
|- style="height: 2px"
|
|}

{|
| width="16" valign="top" |
| ''Template for objects that are to be cycled through:''
|-
| width="16" valign="top" | ▶
| style="border: 1px dashed currentColor" bgcolor="#d4d8ff" | <tt>States = ''OBJECT0'', ''OBJECT1'', ''OBJECT2'', ... StateFunction = mod[value + 1, ''AMOUNT_OF_OBJECTS''] RefreshRate = ''TIME_PER_OBJECT''</tt>
|}

 

{|
|- style="height: 4px"
|
|}
</div>
==● Signal (3-aspect) for Track.Section(0; 2; 4)==
<div class="toccolours mw-collapsible" style="width:1024px">
{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| 
|}

{|
|- style="height: 2px"
|
|}

{|
| width="16" valign="top" |
| ''''
|-
| width="16" valign="top" | ▶
| style="border: 1px dashed currentColor" bgcolor="#d4d8ff" | <tt>States = ''RED_OBJECT'', ''YELLOW_OBJECT'', ''GREEN_OBJECT'' StateFunction = section / 2</tt>
|}

 

{|
|- style="height: 4px"
|
|}
</div>
==● Employing an approach-controlled delay in signals==
<div class="toccolours mw-collapsible" style="width:1024px">
{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| 
|}

{|
|- style="height: 2px"
|
|}

If you want to create a signal that keeps being red until the train approaches it to some distance, then counts down a timer before it changes aspect to green, please refer to [http://openbve.freeforums.org/delay-in-approach-controlled-signals-t1195.html#p5378 this post] on the forum for a detailed explanation. Once you understand the concepts, you can use this code template: 

{|
| width="16" valign="top" |
| ''Template for an approach-controlled delay in a signal with two aspects:''
|-
| width="16" valign="top" | ▶
| style="border: 1px dashed currentColor" bgcolor="#d4d8ff" | <tt>States = ''RED_OBJECT'', ''GREEN_OBJECT'' StateFunction = if[trackDistance>DISTANCE | section==0, 0, min[value + 0.5*delta/DELAY, 1]]</tt>
|}

{|
| width="16" valign="top" |
| ''Template for an approach-controlled delay in a signal with any number of aspects:''
|-
| width="16" valign="top" | ▶
| style="border: 1px dashed currentColor" bgcolor="#d4d8ff" | <tt>States = ''RED_OBJECT'', ..., ''GREEN_OBJECT'' StateFunction = if[trackDistance>DISTANCE | section==0, 0, if[value<0.5, value + 0.5*value/DELAY, section]]</tt>
|}
</div>

.X

2015-02-07T00:10:50Z

Kevin: Created page with " {| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt" | This page is under co..."

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| This page is under construction. 
|}

 The X object format is a very narrow subset of the DirectX file format. Every X object validates as a DirectX file, but not necessarily the other way round. Generally speaking, you will be unable to use 3D editing applications that export to the DirectX file format because openBVE will be unable to import the format. Documentation of the X object format is not yet available, but the following is an overview of the supported templates, unstructured. 

{|
| valign="top" | ●
|
| Mesh
|}

{|
| valign="top" | ●
|
| Vector
|}

{|
| valign="top" | ●
|
| MeshFace
|}

{|
| valign="top" | ●
|
| MeshMaterialList
|}

{|
| valign="top" | ●
|
| Material
|}

{|
| valign="top" | ●
|
| ColorRGBA
|}

{|
| valign="top" | ●
|
| ColorRGB
|}

{|
| valign="top" | ●
|
| TextureFilename
|}

{|
| valign="top" | ●
|
| MeshTextureCoords
|}

{|
| valign="top" | ●
|
| Coords2d
|}

{|
| valign="top" | ●
|
| MeshNormals
|}

.CSV

2015-02-07T00:10:29Z

Kevin: Created page with " The '''.csv''' object format {| style="border: 0px currentColor; margin-right: 10pt;..."

The '''.csv''' object format 

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| 
|}

 

{|
|- style="height: 4px"
|
|}

=■ 1. Overview=
<div class="toccolours mw-collapsible" style="width:1024px">
----

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| 
|}

A CSV object allows to create a single object by using textual instructions. The object can be used in routes or in trains. The object described by the file can contain any number of individual polygons. The file format allows to group multiple polygons in CreateMeshBuilder sections in which attributes like color or texture information is assigned to all polygons created in each section. This allows for the creation of many polygons in the same CreateMeshBuilder section which share common attributes. A polygon is called a face in this file format. The file is a plain text file encoded in any arbitrary [http://trainsimframework.org/develop/information_encodings.html encoding], however, UTF-8 with a byte order mark is the preferred choice. The [http://trainsimframework.org/develop/information_numberformats.html parsing model] for numbers is '''Loose''', however, you are encouraged to produce ''Strict'' output nonetheless. The file name is arbitrary, but must have the extension '''.csv'''. The file is interpreted on a per-line basis, from top to bottom. ➟ [[CSVQuickRef|See also the quick reference for the CSV format...]] 
</div>
{|
|- style="height: 4px"
|
|}

=■ 2. Syntax=
<div class="toccolours mw-collapsible" style="width:1024px">
----

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| 
|}

 Each line in the file is split into the name of a command and its arguments. The syntax for all commands is the same: 

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | '''NameOfTheCommand''', ''Argument1'', ''Argument2'', ''Argument3'', ..., ''Argumentn''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| 
|}

 ''NameOfTheCommand'' is case-insensitive. If there are arguments, ''NameOfTheCommand'' and ''Argument1'' are separated by a comma (U+002C). Likewise, arguments are also separated by a comma (U+002C). [http://trainsimframework.org/develop/information_whitespaces.html White spaces] around the arguments and around the ''NameOfTheCommand'', and well as at the beginning and the end of the line, are ignored. Empty lines or lines solely consisting of white spaces are also ignored. Arguments may also be omitted by leaving the text at each of the ''Argumenti'' blank. A default value will usually apply in this case, which is specific to the command used. All default values are specified in the section of available commands. You can use comments anywhere at the end of a line. A comment is started by a semicolon (U+003B). Comments, if present, are stripped away from all lines before these are processed. 
</div>
{|
|- style="height: 4px"
|
|}

=■ 3. Available commands=

----

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| 
|}

 
==CreateMeshBuilder==
<div class="toccolours mw-collapsible" style="width:1024px">
{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | '''CreateMeshBuilder'''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| 
|}

This command marks the beginning of a new section of faces. It must precede any of the following commands. There might be as many CreateMeshBuilder sections as desired in the object file. All subsequent commands will then relate to the last CreateMeshBuilder section opened. 
</div>
----

 
==AddVertex==
<div class="toccolours mw-collapsible" style="width:1024px">
{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | '''AddVertex''', ''vX'', ''vY'', ''vZ'', ''nX'', ''nY'', ''nZ''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| '''''vX'''''<nowiki>: The x-coordinate for the vertex in meters. Negative values are left, positive ones right. The default value is 0.</nowiki> '''''vY'''''<nowiki>: The y-coordinate for the vertex in meters. Negative values are down, positive ones up. The default value is 0.</nowiki> '''''vZ'''''<nowiki>: The z-coordinate for the vertex in meters. Negative values are backward, positive ones forward. The default value is 0.</nowiki> '''''nX'''''<nowiki>: The x-coordinate for the normal of this vertex. The default value is 0.</nowiki> '''''nY'''''<nowiki>: The y-coordinate for the normal of this vertex. The default value is 0.</nowiki> '''''nZ'''''<nowiki>: The z-coordinate for the normal of this vertex. The default value is 0. </nowiki>
|}

This command creates a new vertex which can then be used to create faces via the AddFace or AddFace2 commands. There can be as many AddVertex commands as desired within a CreateMeshBuilder section. However, the order of the vertices given is important for other commands. The first vertex given has index 0, and subsequent vertices have indices 1, 2, 3 and so on. The normal is the direction perpendicular to the face at a particular point. If all vertices in a face have the same normal, the face will look flat. If used appropriately, you can give the illusion of a curved face by specifying different normals per vertex, but using the same normal on all vertices that share the same spatial coordinate - across multiple faces. If left all zero, the normal will be calculated automatically. 

</div>
----

 
==AddFace==
<div class="toccolours mw-collapsible" style="width:1024px">

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | '''AddFace''', ''v1'', ''v2'', ''v3'', ..., ''vmax''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| '''''vi'''''<nowiki>: The vertex index to include in this face. Allowed values are 0 through </nowiki>''n''-1, where ''n'' is the number of AddVertex commands used. 
|}

This command creates a face given an arbitrary long list of vertex indices. The index corresponds to the order in which the vertices have been created by the AddVertex command, thus the AddFace command needs to be stated after the corresponding AddVertex commands. The first AddVertex command used creates index 0, and subsequent AddVertex commands create indices 1, 2, 3 and so on. The order in which the vertex indices appear is important. They need to be given in clockwise order when looking at the front of the face. The back of the face will not be visible. However, the AddFace2 command can be used to create a face which is visible from both sides. Only convex polygons are supported. 
</div>
----
==AddFace2==
<div class="toccolours mw-collapsible" style="width:1024px">
 
{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | '''AddFace2''', ''v1'', ''v2'', ''v3'', ..., ''vmax''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| '''''vi'''''<nowiki>: The vertex index to include in this face. Allowed values are 0 through </nowiki>''n''-1, where ''n'' is the number of AddVertex commands used. 
|}

This command creates a face given an arbitrary long list of vertex indices. The index corresponds to the order in which the vertices have been created by the Vertex command, thus the Face command needs to be stated after the corresponding Vertex commands. The first Vertex command used creates index 0, and subsequent Vertex commands create indices 1, 2, 3 and so on. The order in which the vertex indices appear is important. They need to be given in clockwise order when looking at the front of the face. The back of the face will also be visible, however, lighting on the back face might be the same as on the front face. Only convex polygons are supported. 
</div>
----

 
==Cube==
<div class="toccolours mw-collapsible" style="width:1024px">
{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | '''Cube''', ''HalfWidth'', ''HalfHeight'', ''HalfDepth''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| '''''HalfWidth'''''<nowiki>: A floating-point number representing half the width of the cube in </nowiki>'''meters'''. '''''HalfHeight'''''<nowiki>: A floating-point number representing half the height of the cube in </nowiki>'''meters'''. '''''HalfDepth'''''<nowiki>: A floating-point number representing half the depth of the cube in </nowiki>'''meters'''.
|}

This command creates a cube having dimensions as specified by ''HalfWidth'', ''HalfHeight'' and ''HalfDepth''. The cube will be centered on the origin (0,0,0). Thus, on the x-axis, the cube extends from -''HalfWidth'' to ''HalfWidth'', on the y-axis from -''HalfHeight'' to ''HalfHeight'' and on the z-axis from -''HalfDepth'' to ''HalfDepth''. The cube always has 8 vertices and 6 faces. 

{|
|- style="height: 4px"
|
|}

{| style="border: 1px dashed currentColor; margin-right: 20pt; margin-left: 20pt"
| style="border: 2px ridge currentColor" bgcolor="#ffe080" | '''ⓘ''' Cube representation
|-
| bgcolor="#ffffff" |
The Cube command is equivalent to a series of AddVertex and AddFace commands, which you need to account for when using other commands in the same CreateMeshBuilder section. The details on what the Cube command does are available [http://trainsimframework.org/develop/object_cubecylinder.html here].
|}

{|
|- style="height: 4px"
|
|}
</div>
----
==Cylinder==
<div class="toccolours mw-collapsible" style="width:1024px">
 

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | '''Cylinder''', ''n'', ''UpperRadius'', ''LowerRadius'', ''Height''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| '''''n'''''<nowiki>: An integer representing the number of vertices to be used for the base of the frustum.</nowiki> '''''UpperRadius'''''<nowiki>: A floating-point number representing the radius for the upper base of the frustum in </nowiki>'''meters'''. Can be negative to indicate that the top cap is to be omitted. '''''LowerRadius'''''<nowiki>: A floating-point number representing the radius for the lower base of the frustum in </nowiki>'''meters'''. Can be negative to indicate that the bottom cap is to be omitted. '''''Height'''''<nowiki>: A floating-point number representing the height of the prism in </nowiki>'''meters'''. Can be negative, which will flip the frustum vertically and display it inside-out.
|}

This command creates a [http://en.wikipedia.org/wiki/Frustum frustum]. If ''LowerRadius'' and ''UpperRadius'' are equal, the object generated will reduce to a [http://en.wikipedia.org/wiki/Prism_(geometry) prism], which can be used as an approximation to the cylinder. If either ''LowerRadius'' or ''UpperRadius'' are zero, the object generated will reduce to a [http://en.wikipedia.org/wiki/Pyramid_(geometry) pyramid]. The frustum will be centered on the origin (0,0,0). On the x- and z-axes, the frustum extends from -''LowerRadius'' to ''LowerRadius'' for the lower base and from -''UpperRadius'' to ''UpperRadius'' for the upper base. On the y-axis, the frustum extends from -½*''Height'' to ½*''Height''. The number of vertices ''n'' will usually suffice to be 6 or 8 when only small radii are used, for example to create a pole. Regardless of the values of ''UpperRadius'', ''LowerRadius'' and ''n'', the frustum will always have 2*''n'' vertices, and usually ''n''+2 faces unless any of the caps are omitted. If ''UpperRadius'' or ''LowerRadius'' are negative, the absolute value is being taken, but the respective caps are not created. If ''Height'' is negative, the roles of top and bottom are reversed and the faces will be visible from the inside, while otherwise, they will be visible from the outside. 

{|
|- style="height: 4px"
|
|}

{| style="border: 1px dashed currentColor; margin-right: 20pt; margin-left: 20pt"
| style="border: 2px ridge currentColor" bgcolor="#ffe080" | '''ⓘ''' Cylinder representation
|-
| bgcolor="#ffffff" |
The Cylinder command is equivalent to a series of AddVertex and AddFace commands, which you need to account for when using other commands in the same CreateMeshBuilder section. The details on what the Cylinder command does are available [http://trainsimframework.org/develop/object_cubecylinder.html here].
|}

{|
|- style="height: 4px"
|
|}
</div>
----
==GenerateNormals==
<div class="toccolours mw-collapsible" style="width:1024px">
 

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | GenerateNormals
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| ''This command is ignored by openBVE.'' 
|}
</div>
----

 
==Translate/TranslateAll==
<div class="toccolours mw-collapsible" style="width:1024px">
{|
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | '''Translate''', ''X'', ''Y'', ''Z'' '''TranslateAll''', ''X'', ''Y'', ''Z''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| '''''X'''''<nowiki>: A floating-point number representing the translation on the x-coordinate in </nowiki>'''meters'''. Negative values translate to the left, positive ones right. The default value is 0. '''''Y'''''<nowiki>: A floating-point number representing the translation on the y-coordinate in </nowiki>'''meters'''. Negative values translate down, positive ones up. The default value is 0. '''''Z'''''<nowiki>: A floating-point number representing the translation on the z-coordinate in </nowiki>'''meters'''. Negative values translate backward, positive ones forward. The default value is 0.
|}

The '''Translate''' command moves all vertices that have been created so far in the CreateMeshBuilder section via the AddVertex, Cube or Cylinder commands. Subsequent vertices are not affected. You can use as many Translate commands as desired in a CreateMeshBuilder section. The '''TranslateAll''' command not only affects the vertices generated in the current CreateMeshBuilder section, but also those created in previous CreateMeshBuilder sections. This is useful to insert at the end of the file in order to translate the whole object. 
</div>
----

 
==Scale/ScaleAll==
<div class="toccolours mw-collapsible" style="width:1024px">
{|
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | '''Scale''', ''X'', ''Y'', ''Z'' '''ScaleAll''', ''X'', ''Y'', ''Z''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| '''''X'''''<nowiki>: A non-zero floating-point number representing the scale factor on the x-coordinate. The default value is 1.</nowiki> '''''Y'''''<nowiki>: A non-zero floating-point number representing the scale factor on the y-coordinate. The default value is 1.</nowiki> '''''Z'''''<nowiki>: non-zero A floating-point number representing the scale factor on the z-coordinate. The default value is 1. </nowiki>
|}

The '''Scale''' command scales all vertices that have been created so far in the CreateMeshBuilder section via the AddVertex, Cube or Cylinder commands. Subsequent vertices are not affected. You can use as many Scale commands as desired in a CreateMeshBuilder section. The '''ScaleAll''' command not only affects the vertices generated in the current CreateMeshBuilder section, but also those created in previous CreateMeshBuilder sections. This is useful to insert at the end of the file in order to scale the whole object. 
</div>
----

 
==Rotate/Rotateall==
<div class="toccolours mw-collapsible" style="width:1024px">
{|
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | '''Rotate''', ''X'', ''Y'', ''Z'', ''Angle'' '''RotateAll''', ''X'', ''Y'', ''Z'', ''Angle''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| '''''X'''''<nowiki>: The x-direction of the rotational axis. Negative values point to the left, positive ones to the right. The default value is 0.</nowiki> '''''Y'''''<nowiki>: The y-direction of the rotational axis. Negative values point down, positive ones up. The default value is 0.</nowiki> '''''Z'''''<nowiki>: The z-direction of the rotational axis. Negative values point backward, positive ones forward. The default value is 0.</nowiki> '''''Angle'''''<nowiki>: The angle to rotate in degrees. Negative values rotate counter-clockwise, positive ones clock-wise. The default value is 0.</nowiki>
|}

The '''Rotate''' command rotates all vertices that have been created so far in the current CreateMeshBuilder section via the AddVertex, Cube or Cylinder commands. Subsequent vertices are not affected. The axis of rotation is specified via the ''X'', ''Y'' and ''Z'' values. Rotation will occur in the plane perpendicular to that direction. A zero vector for this axis is treated as (1,0,0). All other directions are normalized. You can use as many Rotate commands as desired in a CreateMeshBuilder section. The '''RotateAll''' command not only affects the vertices generated in the current CreateMeshBuilder section, but also those created in previous CreateMeshBuilder sections. This is useful to insert at the end of the file in order to rotate the whole object. 
</div>
----

 
==Shear/ShearAll==
<div class="toccolours mw-collapsible" style="width:1024px">
{|
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | '''Shear''', ''dX'', ''dY'', ''dZ'', ''sX'', ''sY'', ''sZ'', ''r'' '''ShearAll''', ''dX'', ''dY'', ''dZ'', ''sX'', ''sY'', ''sZ'', ''r''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| '''''dX'''''<nowiki>: The x-coordinate of the vector D. The default value is 0.</nowiki> '''''dY'''''<nowiki>: The y-coordinate of the vector D. The default value is 0.</nowiki> '''''dZ'''''<nowiki>: The z-coordinate of the vector D. The default value is 0.</nowiki> '''''sX'''''<nowiki>: The x-coordinate of the vector S. The default value is 0.</nowiki> '''''sY'''''<nowiki>: The y-coordinate of the vector S. The default value is 0.</nowiki> '''''sZ'''''<nowiki>: The z-coordinate of the vector S. The default value is 0.</nowiki> '''''r'''''<nowiki>: The ratio that indicates how much to displace vectors. The default value is 0. </nowiki>
|}

The '''Shear''' command performs a [http://en.wikipedia.org/wiki/Shear_mapping shear mapping] for all vertices that have been created so far in the current CreateMeshBuilder section. The '''ShearAll''' command not only affects the vertices generated in the current CreateMeshBuilder section, but also those created in previous CreateMeshBuilder sections. This is useful to insert at the end of the file in order to shear the whole object. [[Image:illustration_shear.png]] The shear mapping is performed around the origin. Loosely speaking, the object is sliced into planes along the direction D and then displaced along the direction S. Typically, D and S are perpendicular. D and S are always normalized. If ''Ratio'' is 0, no transformation is performed. If D and S are perpendicular, a ''Ratio'' of 1 corresponds to a slope of 45 degrees. 
</div>
----

 
==SetColor==
<div class="toccolours mw-collapsible" style="width:1024px">
{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | '''SetColor''', ''Red'', ''Green'', ''Blue'', ''Alpha''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| '''''Red'''''<nowiki>: The red component of the color. Measured from 0 (black) to 255 (red). The default value is 255.</nowiki> '''''Green'''''<nowiki>: The green component of the color. Measured from 0 (black) to 255 (green). The default value is 255.</nowiki> '''''Blue'''''<nowiki>: The blue component of the color. Measured from 0 (black) to 255 (blue). The default value is 255.</nowiki> '''''Alpha'''''<nowiki>: The alpha component of the color. Measured from 0 (transparent) to 255 (opaque). The default value is 255.</nowiki>
|}

This command sets the color for all faces that were already created in the current CreateMeshBuilder section. If no texture is used, the faces will be colored using the color data as specified by ''Red'', ''Green'' and ''Blue''. If a texture is used, the pixels in the texture will be multiplied by the color, where multiplying with black results in black and multiplying with white does not change the color of the texture pixels. Values in-between make the texture pixels darker. When lighting is used in the route, the actual color can change depending on the lighting conditions, but will usually become darker. 
</div>
----

 
==SetEmissiveColor==
<div class="toccolours mw-collapsible" style="width:1024px">
{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | '''SetEmissiveColor''', ''Red'', ''Green'', ''Blue''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| '''''Red'''''<nowiki>: The red component of the color. Measured from 0 (black) to 255 (red). The default value is 0.</nowiki> '''''Green'''''<nowiki>: The green component of the color. Measured from 0 (black) to 255 (green). The default value is 0.</nowiki> '''''Blue'''''<nowiki>: The blue component of the color. Measured from 0 (black) to 255 (blue). The default value is 0.</nowiki>
|}

This command sets the emissive color for all faces that were already created in the current CreateMeshBuilder section. The difference between the SetColor command and the SetEmissiveColor command is that the SetColor command is affected by lighting, while the SetEmissiveColor command is not. Thus, the SetEmissiveColor command should be used for faces which would emit light themselves, including signals, lamps, windows and the like. The actual color contribution to the faces will be the sum of the light-affected color data and the static emissive color data. 
</div>
----

 
==SetBlendMode==
<div class="toccolours mw-collapsible" style="width:1024px">
{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | '''SetBlendMode''', ''BlendMode'', ''GlowHalfDistance'', ''GlowAttenuationMode''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| '''''BlendMode'''''<nowiki>: The blend mode to use. The default is Normal.</nowiki> '''''GlowHalfDistance'''''<nowiki>: The distance at which the glow is at 50% of its intensity, measured in meters. The value must be an integer in the range from 1 to 4095, or 0 to disable glow attenuation. The default value is 0.</nowiki> '''''GlowAttenuationMode'''''<nowiki>: The glow attenuation mode to use. The default is DivideExponent4.</nowiki>
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 40pt"
| ▸ Available options for ''BlendMode''<nowiki>:</nowiki>
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 50pt"
| '''Normal'''<nowiki>: The faces are rendered normally.</nowiki> '''Additive'''<nowiki>: The faces are rendered additively. </nowiki>
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 40pt"
| ▸ Available options for ''GlowAttenuationMode''<nowiki>:</nowiki>
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 50pt"
| '''DivideExponent2'''<nowiki>: The glow intensity is determined via the function </nowiki>''x''2 / (''x''2 + ''GlowHalfDistance''2), where ''x'' is the distance from the camera to the object in meters. '''DivideExponent4'''<nowiki>: The glow intensity is determined via the function </nowiki>''x''4 / (''x''4 + ''GlowHalfDistance''4), where ''x'' is the distance from the camera to the object in meters.
|}

This command sets the blend mode for all faces in the current CreateMeshBuilder section. The ''Normal'' mode replaces screen pixels with texture pixels. The ''Additive'' mode adds the color of texture pixels to the color of screen pixels, where adding black does not change the screen pixel, while adding white results in white. If ''GlowHalfDistance'' is 0, glow attenuation will be disabled, which is the default. If glow attenuation is to be used, ''GlowHalfDistance'' represents the distance in meters at which the glow is exactly at 50% of its intensity. When the camera approaches the face, the face will gradually fade out (become transparent). The function used to determine the exact intensity for a given distance can be influenced with the setting of ''GlowAttenuationMode''. DivideExponent2 creates a smoother transition, but will converge to the maximum intensity very slowly, while DivideExponent4 creates a sharper transition which converges more quickly. 

{|
| ⚠
|
| bgcolor="#e0e0e0" |
| bgcolor="#e0e0e0" | '''openBVE 2 compatibility note:''' In openBVE 2, only additive glow will be supported and the ''GlowAttenuationMode'' parameter is likely going to be dropped. Please avoid using normal blending in conjunction with using glow.
| bgcolor="#e0e0e0" |
|}
</div>
----

 
==LoadTexture==
<div class="toccolours mw-collapsible" style="width:1024px">
{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | '''LoadTexture''', ''DaytimeTexture'', ''NighttimeTexture''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| '''''DaytimeTexture'''''<nowiki>: The file name of the daytime version of the texture to load, relative to the directory the object file is stored in.</nowiki> '''''NighttimeTexture'''''<nowiki>: The file name of the nighttime version of the texture to load, relative to the directory the object file is stored in.</nowiki>
|}

This command loads a texture and uses it for all faces in the current CreateMeshBuilder section. The file name is relative to the directory the object file is stored in. You can use PNG, which supports full alpha channels, but use the alpha channel only if absolutely required as it reduces performance. Prefer using a texture without an alpha channel in conjunction with the SetDecalTransparentColor command in order to use color-key transparency. If ''NighttimeTexture'' is used, it specifies the texture to be used on nighttime lighting conditions, while ''DaytimeTexture'' then specifies the texture to be used on daytime lighting conditions. The textures might blend into each other and should be designed accordingly. If ''NighttimeTexture'' is used, ''DaytimeTexture'' must also be specified. If ''NighttimeTexture'' is not used, low lighting conditions will make the daytime version darker. Nighttime textures are meant for use with train interior/exterior objects. 
</div>
----

 
==SetDecalTransparentColor==
<div class="toccolours mw-collapsible" style="width:1024px">

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | '''SetDecalTransparentColor''', ''Red'', ''Green'', ''Blue''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| '''''Red'''''<nowiki>: The red component of the color. Measured from 0 (black) to 255 (red). The default value is 0.</nowiki> '''''Green'''''<nowiki>: The green component of the color. Measured from 0 (black) to 255 (green). The default value is 0.</nowiki> '''''Blue'''''<nowiki>: The blue component of the color. Measured from 0 (black) to 255 (blue). The default value is 0.</nowiki>
|}

This command sets the color used for screendoor transparency for all faces that were already created. The texture loaded via the Load command will become transparent for all pixels which match exactly with the color specified via the ''Red'', ''Green'' and ''Blue'' parameters. The use of screendoor transparency is much more efficient than using a full alpha channel, so prefer using a texture without an alpha channel and use this command instead to make parts of the texture transparent. You need to specify texture coordinates via the Coordinate command in order for the texture to correctly appear on the faces. 
</div>
----

 
==SetTextureCoordinates==
<div class="toccolours mw-collapsible" style="width:1024px">
{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | '''SetTextureCoordinates''', ''VertexIndex'', ''X'', ''Y''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| '''''VertexIndex'''''<nowiki>: The vertex index the coordinate is referring to. Allowed values are 0 through </nowiki>''n''-1, where ''n'' is the number of AddVertex commands used. '''''X'''''<nowiki>: The x-coordinate of the texture. Integer values correspond to the left/right edge of the texture. If only values between 0 and 1 are to be considered, 0 corresponds to the left and 1 to the right.</nowiki> '''''Y'''''<nowiki>: The y-coordinate of the texture. Integer values correspond to the top/bottom edge of the texture. If only values between 0 and 1 are to be considered, 0 corresponds to the top and 1 to the bottom.</nowiki>
|}

This command associates a coordinate in the texture to the vertex specified by ''VertexIndex''. The index corresponds to the order in which the vertices have been created by the AddVertex command, thus the Coordinates command needs to be stated after the corresponding AddVertex command. The ''X'' and ''Y'' values do not necessarily need to be in the range between 0 (left or top) to 1 (right or bottom), but can have any other value. It is assumed in this case that the texture is repeated on an infinite grid where integer values for ''X'' and ''Y'' correspond to the corners of the texture.
</div>

.B3d

2015-02-07T00:10:09Z

Kevin: Created page with " The '''.b3d''' object format =Overview=..."

The '''.b3d''' object format 

=Overview=

<div class="toccolours mw-collapsible" style="width:1024px">
A B3D object allows to create a single object by using textual instructions. The object can be used in routes or in trains. The object described by the file can contain any number of individual polygons. The file format allows to group multiple polygons in [MeshBuilder] sections in which attributes like color or texture information is assigned to all polygons created in each section. This allows for the creation of many polygons in the same [MeshBuilder] section which share common attributes. A polygon is called a face in this file format. The file is a plain text file encoded in any arbitrary [http://trainsimframework.org/develop/information_encodings.html encoding], however, UTF-8 with a byte order mark is the preferred choice. The [http://trainsimframework.org/develop/information_numberformats.html parsing model] for numbers is '''Loose''', however, you are encouraged to produce ''Strict'' output nonetheless. The file name is arbitrary, but must have the extension '''.b3d'''. The file is interpreted on a per-line basis, from top to bottom. ➟ See also the [[B3DQuickRef|
quick reference for the B3D format...]] 

{| style="border: 2px groove currentColor; margin-right: 20pt; margin-left: 20pt" align="center"
| style="border: 2px ridge currentColor" bgcolor="#c04040" | Check these tutorials out:
|-
| bgcolor="#ffffff" |
*[http://www.bvestation.com/forums/index.php?topic=1496.0 Basic 2D Object Building By ipac]
*[http://www.bvestation.com/forums/index.php?topic=3790.0 Transparent Objects By error46146]
|}
</div>
=Syntax=
<div class="toccolours mw-collapsible" style="width:1024px">
{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| 
|}

 Each line in the file is split into the name of a command and its arguments. The syntax for all commands is the same: 

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | '''NameOfTheCommand''' ''Argument1'', ''Argument2'', ''Argument3'', ..., ''Argumentn''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| 
|}

 ''NameOfTheCommand'' is case-insensitive. If there are arguments, ''NameOfTheCommand'' and ''Argument1'' are separated by at least one space space (U+0020). Arguments are separated by a comma (U+002C). [http://trainsimframework.org/develop/information_whitespaces.html White spaces] around the arguments, and well as at the beginning and the end of the line, are ignored. Empty lines or lines solely consisting of white spaces are also ignored. Arguments may also be omitted by leaving the text at each of the ''Argumenti'' blank. A default value will usually apply in this case, which is specific to the command used. All default values are specified in the section of available commands. Note however that the first argument may not be omitted if other arguments are provided. You can use comments anywhere at the end of a line. A comment is started by a semicolon (U+003B). Comments, if present, are stripped away from all lines before these are processed. 
</div>

=Available commands=

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| 
|}

 

==MeshBuilder==
<div class="toccolours mw-collapsible" style="width:1024px">
{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | '''[MeshBuilder]'''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| 
|}

This command marks the beginning of a new section of faces. It must precede any of the following commands. There might be as many [MeshBuilder] sections as desired in the object file. All subsequent commands will then relate to the last [MeshBuilder] section opened. 
</div>
==Vertex==
<div class="toccolours mw-collapsible" style="width:1024px">
 

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | '''Vertex''' ''vX'', ''vY'', ''vZ'', ''nX'', ''nY'', ''nZ''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| '''''vX'''''<nowiki>: The x-coordinate for the vertex in meters. Negative values are left, positive ones right. The default value is 0.</nowiki> '''''vY'''''<nowiki>: The y-coordinate for the vertex in meters. Negative values are down, positive ones up. The default value is 0.</nowiki> '''''vZ'''''<nowiki>: The z-coordinate for the vertex in meters. Negative values are backward, positive ones forward. The default value is 0.</nowiki> '''''nX'''''<nowiki>: The x-coordinate for the normal of this vertex. The default value is 0.</nowiki> '''''nY'''''<nowiki>: The y-coordinate for the normal of this vertex. The default value is 0.</nowiki> '''''nZ'''''<nowiki>: The z-coordinate for the normal of this vertex. The default value is 0. </nowiki>
|}

This command creates a new vertex which can then be used to create faces via the Face or Face2 commands. There can be as many Vertex commands as desired within a [MeshBuilder] section. However, the order of the vertices given is important for other commands. The first vertex given has index 0, and subsequent vertices have indices 1, 2, 3 and so on. The normal is the direction perpendicular to the face at a particular point. If all vertices in a face have the same normal, the face will look flat. If used appropriately, you can give the illusion of a curved face by specifying different normals per vertex, but using the same normal on all vertices that share the same spatial coordinate - across multiple faces. If left all zero, the normal will be calculated automatically. 
</div>

==Face==
<div class="toccolours mw-collapsible" style="width:1024px">
 

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | '''Face''' ''v1'', ''v2'', ''v3'', ..., ''vmax''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| '''''vi'''''<nowiki>: The vertex index to include in this face. Allowed values are 0 through </nowiki>''n''-1, where ''n'' is the number of Vertex commands used. 
|}

This command creates a face given an arbitrary long list of vertex indices. The index corresponds to the order in which the vertices have been created by the Vertex command, thus the Face command needs to be stated after the corresponding Vertex commands. The first Vertex command used creates index 0, and subsequent Vertex commands create indices 1, 2, 3 and so on. The order in which the vertex indices appear is important. They need to be given in clockwise order when looking at the front of the face. The back of the face will not be visible. However, the Face2 command can be used to create a face which is visible from both sides. Only convex polygons are supported. 
</div>
==Face2==
<div class="toccolours mw-collapsible" style="width:1024px">
 

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | '''Face2''' ''v1'', ''v2'', ''v3'', ..., ''vmax''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| '''''vi'''''<nowiki>: The vertex index to include in this face. Allowed values are 0 through </nowiki>''n''-1, where ''n'' is the number of Vertex commands used. 
|}

This command creates a face given an arbitrary long list of vertex indices. The index corresponds to the order in which the vertices have been created by the Vertex command, thus the Face command needs to be stated after the corresponding Vertex commands. The first Vertex command used creates index 0, and subsequent Vertex commands create indices 1, 2, 3 and so on. The order in which the vertex indices appear is important. They need to be given in clockwise order when looking at the front of the face. The back of the face will also be visible, however, lighting on the back face might be the same as on the front face. Only convex polygons are supported. 
</div>
==Cube==
<div class="toccolours mw-collapsible" style="width:1024px">
 

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | '''Cube''' ''HalfWidth'', ''HalfHeight'', ''HalfDepth''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| '''''HalfWidth'''''<nowiki>: A floating-point number representing half the width of the cube in </nowiki>'''meters'''. '''''HalfHeight'''''<nowiki>: A floating-point number representing half the height of the cube in </nowiki>'''meters'''. '''''HalfDepth'''''<nowiki>: A floating-point number representing half the depth of the cube in </nowiki>'''meters'''.
|}

This command creates a cube having dimensions as specified by ''HalfWidth'', ''HalfHeight'' and ''HalfDepth''. The cube will be centered on the origin (0,0,0). Thus, on the x-axis, the cube extends from -''HalfWidth'' to ''HalfWidth'', on the y-axis from -''HalfHeight'' to ''HalfHeight'' and on the z-axis from -''HalfDepth'' to ''HalfDepth''. The cube always has 8 vertices and 6 faces. 

{|
|- style="height: 4px"
|
|}

{| style="border: 1px dashed currentColor; margin-right: 20pt; margin-left: 20pt"
| style="border: 2px ridge currentColor" bgcolor="#ffe080" | '''ⓘ''' Cube representation
|-
| bgcolor="#ffffff" |
The Cube command is equivalent to a series of Vertex and Face commands, which you need to account for when using other commands in the same [MeshBuilder] section. The details on what the Cube command does are available [http://trainsimframework.org/develop/object_cubecylinder.html here].
|}

{|
|- style="height: 4px"
|
|}
</div>
==Cylinder==
<div class="toccolours mw-collapsible" style="width:1024px">
 

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | '''Cylinder''' ''n'', ''UpperRadius'', ''LowerRadius'', ''Height''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| '''''n'''''<nowiki>: An integer representing the number of vertices to be used for the base of the frustum.</nowiki> '''''UpperRadius'''''<nowiki>: A floating-point number representing the radius for the upper base of the frustum in </nowiki>'''meters'''. Can be negative to indicate that the top cap is to be omitted. '''''LowerRadius'''''<nowiki>: A floating-point number representing the radius for the lower base of the frustum in </nowiki>'''meters'''. Can be negative to indicate that the bottom cap is to be omitted. '''''Height'''''<nowiki>: A floating-point number representing the height of the prism in </nowiki>'''meters'''. Can be negative, which will flip the frustum vertically and display it inside-out.
|}

This command creates a [http://en.wikipedia.org/wiki/Frustum frustum]. If ''LowerRadius'' and ''UpperRadius'' are equal, the object generated will reduce to a [http://en.wikipedia.org/wiki/Prism_(geometry) prism], which can be used as an approximation to the cylinder. If either ''LowerRadius'' or ''UpperRadius'' are zero, the object generated will reduce to a [http://en.wikipedia.org/wiki/Pyramid_(geometry) pyramid]. The frustum will be centered on the origin (0,0,0). On the x- and z-axes, the frustum extends from -''LowerRadius'' to ''LowerRadius'' for the lower base and from -''UpperRadius'' to ''UpperRadius'' for the upper base. On the y-axis, the frustum extends from -½*''Height'' to ½*''Height''. The number of vertices ''n'' will usually suffice to be 6 or 8 when only small radii are used, for example to create a pole. Regardless of the values of ''UpperRadius'', ''LowerRadius'' and ''n'', the frustum will always have 2*''n'' vertices, and usually ''n''+2 faces unless any of the caps are omitted. If ''UpperRadius'' or ''LowerRadius'' are negative, the absolute value is being taken, but the respective caps are not created. If ''Height'' is negative, the roles of top and bottom are reversed and the faces will be visible from the inside, while otherwise, they will be visible from the outside. 

{|
|- style="height: 4px"
|
|}

{| style="border: 1px dashed currentColor; margin-right: 20pt; margin-left: 20pt"
| style="border: 2px ridge currentColor" bgcolor="#ffe080" | '''ⓘ''' Cylinder representation
|-
| bgcolor="#ffffff" |
The Cylinder command is equivalent to a series of Vertex and Face commands, which you need to account for when using other commands in the same [MeshBuilder] section. The details on what the Cylinder command does are available [http://trainsimframework.org/develop/object_cubecylinder.html here].
|}

{|
|- style="height: 4px"
|
|}
</div>
==Texture==
<div class="toccolours mw-collapsible" style="width:1024px">
 

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | [Texture]
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| ''This command is ignored by openBVE.'' 
|}
</div>
==Translate/TranslateAll==
<div class="toccolours mw-collapsible" style="width:1024px">
 

{|
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | '''Translate''' ''X'', ''Y'', ''Z'' '''TranslateAll''' ''X'', ''Y'', ''Z''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| '''''X'''''<nowiki>: A floating-point number representing the translation on the x-coordinate in </nowiki>'''meters'''. Negative values translate to the left, positive ones right. The default value is 0. '''''Y'''''<nowiki>: A floating-point number representing the translation on the y-coordinate in </nowiki>'''meters'''. Negative values translate down, positive ones up. The default value is 0. '''''Z'''''<nowiki>: A floating-point number representing the translation on the z-coordinate in </nowiki>'''meters'''. Negative values translate backward, positive ones forward. The default value is 0.
|}

The '''Translate''' command moves all vertices that have been created so far in the [MeshBuilder] section via the Vertex, Cube or Cylinder commands. Subsequent vertices are not affected. You can use as many Translate commands as desired in a [MeshBuilder] section. The '''TranslateAll''' command not only affects the vertices generated in the current [MeshBuilder] section, but also those created in previous [MeshBuilder] sections. This is useful to insert at the end of the file in order to translate the whole object. 
</div>
==Scale/ScaleAll==
<div class="toccolours mw-collapsible" style="width:1024px">
 

{|
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | '''Scale''' ''X'', ''Y'', ''Z'' '''ScaleAll''' ''X'', ''Y'', ''Z''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| '''''X'''''<nowiki>: A non-zero floating-point number representing the scale factor on the x-coordinate. The default value is 1.</nowiki> '''''Y'''''<nowiki>: A non-zero floating-point number representing the scale factor on the y-coordinate. The default value is 1.</nowiki> '''''Z'''''<nowiki>: non-zero A floating-point number representing the scale factor on the z-coordinate. The default value is 1. </nowiki>
|}

The '''Scale''' command scales all vertices that have been created so far in the [MeshBuilder] section via the Vertex, Cube or Cylinder commands. Subsequent vertices are not affected. You can use as many Scale commands as desired in a [MeshBuilder] section. The '''ScaleAll''' command not only affects the vertices generated in the current [MeshBuilder] section, but also those created in previous [MeshBuilder] sections. This is useful to insert at the end of the file in order to scale the whole object. 
</div>
==Rotate/RotateAll==
<div class="toccolours mw-collapsible" style="width:1024px">
 

{|
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | '''Rotate''' ''X'', ''Y'', ''Z'', ''Angle'' '''RotateAll''' ''X'', ''Y'', ''Z'', ''Angle''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| '''''X'''''<nowiki>: The x-direction of the rotational axis. Negative values point to the left, positive ones to the right. The default value is 0.</nowiki> '''''Y'''''<nowiki>: The y-direction of the rotational axis. Negative values point down, positive ones up. The default value is 0.</nowiki> '''''Z'''''<nowiki>: The z-direction of the rotational axis. Negative values point backward, positive ones forward. The default value is 0.</nowiki> '''''Angle'''''<nowiki>: The angle to rotate in degrees. Negative values rotate counter-clockwise, positive ones clock-wise. The default value is 0.</nowiki>
|}

The '''Rotate''' command rotates all vertices that have been created so far in the current [MeshBuilder] section via the Vertex, Cube or Cylinder commands. Subsequent vertices are not affected. The axis of rotation is specified via the ''X'', ''Y'' and ''Z'' values. Rotation will occur in the plane perpendicular to that direction. A zero vector for this axis is treated as (1,0,0). All other directions are normalized. You can use as many Rotate commands as desired in a [MeshBuilder] section. The '''RotateAll''' command not only affects the vertices generated in the current [MeshBuilder] section, but also those created in previous [MeshBuilder] sections. This is useful to insert at the end of the file in order to rotate the whole object. 
</div>
==Shear/ShearAll==
<div class="toccolours mw-collapsible" style="width:1024px">
 

{|
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | '''Shear''' ''dX'', ''dY'', ''dZ'', ''sX'', ''sY'', ''sZ'', ''Ratio'' '''ShearAll''' ''dX'', ''dY'', ''dZ'', ''sX'', ''sY'', ''sZ'', ''Ratio''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| '''''dX'''''<nowiki>: The x-coordinate of the vector D. The default value is 0.</nowiki> '''''dY'''''<nowiki>: The y-coordinate of the vector D. The default value is 0.</nowiki> '''''dZ'''''<nowiki>: The z-coordinate of the vector D. The default value is 0.</nowiki> '''''sX'''''<nowiki>: The x-coordinate of the vector S. The default value is 0.</nowiki> '''''sY'''''<nowiki>: The y-coordinate of the vector S. The default value is 0.</nowiki> '''''sZ'''''<nowiki>: The z-coordinate of the vector S. The default value is 0.</nowiki> '''''r'''''<nowiki>: The ratio that indicates how much to displace vectors. The default value is 0. </nowiki>
|}

The '''Shear''' command performs a [http://en.wikipedia.org/wiki/Shear_mapping shear mapping] for all vertices that have been created so far in the current CreateMeshBuilder section. The '''ShearAll''' command not only affects the vertices generated in the current CreateMeshBuilder section, but also those created in previous CreateMeshBuilder sections. This is useful to insert at the end of the file in order to shear the whole object. [[Image:illustration_shear.png]] The shear mapping is performed around the origin. Loosely speaking, the object is sliced into planes along the direction D and then displaced along the direction S. Typically, D and S are perpendicular. D and S are always normalized. If ''Ratio'' is 0, no transformation is performed. If D and S are perpendicular, a ''Ratio'' of 1 corresponds to a slope of 45 degrees. 
</div>
==Color==
<div class="toccolours mw-collapsible" style="width:1024px">
 

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | '''Color''' ''Red'', ''Green'', ''Blue'', ''Alpha''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| '''''Red'''''<nowiki>: The red component of the color. Measured from 0 (black) to 255 (red). The default value is 255.</nowiki> '''''Green'''''<nowiki>: The green component of the color. Measured from 0 (black) to 255 (green). The default value is 255.</nowiki> '''''Blue'''''<nowiki>: The blue component of the color. Measured from 0 (black) to 255 (blue). The default value is 255.</nowiki> '''''Alpha'''''<nowiki>: The alpha component of the color. Measured from 0 (transparent) to 255 (opaque). The default value is 255.</nowiki>
|}

This command sets the color for all faces that were already created in the current [MeshBuilder] section. If no texture is used, the faces will be colored using the color data as specified by ''Red'', ''Green'' and ''Blue''. If a texture is used, the pixels in the texture will be multiplied by the color, where multiplying with black results in black and multiplying with white does not change the color of the texture pixels. Values in-between make the texture pixels darker. When lighting is used in the route, the actual color can change depending on the lighting conditions, but will usually become darker. 
</div>
==EmissiveColor==
<div class="toccolours mw-collapsible" style="width:1024px">
 

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | '''EmissiveColor''' ''Red'', ''Green'', ''Blue''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| '''''Red'''''<nowiki>: The red component of the color. Measured from 0 (black) to 255 (red). The default value is 0.</nowiki> '''''Green'''''<nowiki>: The green component of the color. Measured from 0 (black) to 255 (green). The default value is 0.</nowiki> '''''Blue'''''<nowiki>: The blue component of the color. Measured from 0 (black) to 255 (blue). The default value is 0.</nowiki>
|}

This command sets the emissive color for all faces that were already created in the current [MeshBuilder] section. The difference between the Color command and the EmissiveColor command is that the Color command is affected by lighting, while the EmissiveColor command is not. Thus, the EmissiveColor command should be used for faces which would emit light themselves, including signals, lamps, windows and the like. The actual color contribution to the faces will be the sum of the light-affected color data and the static emissive color data. 
</div>
==BlendMode==
<div class="toccolours mw-collapsible" style="width:1024px">
 

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | '''BlendMode''' ''BlendMode'', ''GlowHalfDistance'', ''GlowAttenuationMode''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| '''''BlendMode'''''<nowiki>: The blend mode to use. The default is Normal.</nowiki> '''''GlowHalfDistance'''''<nowiki>: The distance at which the glow is at 50% of its intensity, measured in meters. The value must be an integer in the range from 1 to 4095, or 0 to disable glow attenuation. The default value is 0.</nowiki> '''''GlowAttenuationMode'''''<nowiki>: The glow attenuation mode to use. The default is DivideExponent4.</nowiki>
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 40pt"
| ▸ Available options for ''BlendMode''<nowiki>:</nowiki>
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 50pt"
| '''Normal'''<nowiki>: The faces are rendered normally.</nowiki> '''Additive'''<nowiki>: The faces are rendered additively. </nowiki>
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 40pt"
| ▸ Available options for ''GlowAttenuationMode''<nowiki>:</nowiki>
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 50pt"
| '''DivideExponent2'''<nowiki>: The glow intensity is determined via the function </nowiki>''x''2 / (''x''2 + ''GlowHalfDistance''2), where ''x'' is the distance from the camera to the object in meters. '''DivideExponent4'''<nowiki>: The glow intensity is determined via the function </nowiki>''x''4 / (''x''4 + ''GlowHalfDistance''4), where ''x'' is the distance from the camera to the object in meters.
|}

This command sets the blend mode for all faces in the current [MeshBuilder] section. The ''Normal'' mode replaces screen pixels with texture pixels. The ''Additive'' mode adds the color of texture pixels to the color of screen pixels, where adding black does not change the screen pixel, while adding white results in white. If ''GlowHalfDistance'' is 0, glow attenuation will be disabled, which is the default. If glow attenuation is to be used, ''GlowHalfDistance'' represents the distance in meters at which the glow is exactly at 50% of its intensity. When the camera approaches the face, the face will gradually fade out (become transparent). The function used to determine the exact intensity for a given distance can be influenced with the setting of ''GlowAttenuationMode''. DivideExponent2 creates a smoother transition, but will converge to the maximum intensity very slowly, while DivideExponent4 creates a sharper transition which converges more quickly. 

{|
| ⚠
|
| bgcolor="#e0e0e0" |
| bgcolor="#e0e0e0" | '''openBVE 2 compatibility note:''' In openBVE 2, only additive glow will be supported and the ''GlowAttenuationMode'' parameter is likely going to be dropped. Please avoid using normal blending in conjunction with using glow.
| bgcolor="#e0e0e0" |
|}
</div>
==Load==
<div class="toccolours mw-collapsible" style="width:1024px">
 

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | '''Load''' ''DaytimeTexture'', ''NighttimeTexture''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| '''''DaytimeTexture'''''<nowiki>: The file name of the daytime version of the texture to load, relative to the directory the object file is stored in.</nowiki> '''''NighttimeTexture'''''<nowiki>: The file name of the daytime version of the texture to load, relative to the directory the object file is stored in.</nowiki>
|}

This command loads a texture and uses it for all faces in the current CreateMeshBuilder section. The file name is relative to the directory the object file is stored in. You can use PNG, which supports full alpha channels, but use the alpha channel only if absolutely required as it reduces performance. Prefer using a texture without an alpha channel in conjunction with the SetDecalTransparentColor command in order to use color-key transparency. If ''NighttimeTexture'' is used, it specifies the texture to be used on nighttime lighting conditions, while ''DaytimeTexture'' then specifies the texture to be used on daytime lighting conditions. The textures might blend into each other and should be designed accordingly. If ''NighttimeTexture'' is used, ''DaytimeTexture'' must also be specified. If ''NighttimeTexture'' is not used, low lighting conditions will make the daytime version darker. Nighttime textures are meant for use with train interior/exterior objects. 
</div>
==Transparent==
<div class="toccolours mw-collapsible" style="width:1024px">
 

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | '''Transparent''' ''Red'', ''Green'', ''Blue''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| '''''Red'''''<nowiki>: The red component of the color. Measured from 0 (black) to 255 (red). The default value is 0.</nowiki> '''''Green'''''<nowiki>: The green component of the color. Measured from 0 (black) to 255 (green). The default value is 0.</nowiki> '''''Blue'''''<nowiki>: The blue component of the color. Measured from 0 (black) to 255 (blue). The default value is 0.</nowiki>
|}

This command sets the color used for screendoor transparency for all faces that were already created. The texture loaded via the Load command will become transparent for all pixels which match exactly with the color specified via the ''Red'', ''Green'' and ''Blue'' parameters. The use of screendoor transparency is much more efficient than using a full alpha channel, so prefer using a texture without an alpha channel and use this command instead to make parts of the texture transparent. You need to specify texture coordinates via the Coordinate command in order for the texture to correctly appear on the faces. 
</div>
==Coordinates==
<div class="toccolours mw-collapsible" style="width:1024px">
 

{|
|
|-
| style="border: 1px dotted currentColor" bgcolor="#f0f0f0" | '''Coordinates''' ''VertexIndex'', ''X'', ''Y''
|}

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| '''''VertexIndex'''''<nowiki>: The vertex index the coordinate is referring to. Allowed values are 0 through </nowiki>''n''-1, where ''n'' is the number of Vertex commands used. '''''X'''''<nowiki>: The x-coordinate of the texture. Integer values correspond to the left/right edge of the texture. If only values between 0 and 1 are to be considered, 0 corresponds to the left and 1 to the right.</nowiki> '''''Y'''''<nowiki>: The y-coordinate of the texture. Integer values correspond to the top/bottom edge of the texture. If only values between 0 and 1 are to be considered, 0 corresponds to the top and 1 to the bottom.</nowiki>
|}

This command associates a coordinate in the texture to the vertex specified by ''VertexIndex''. The index corresponds to the order in which the vertices have been created by the Vertex command, thus the Coordinates command needs to be stated after the corresponding Vertex command. The ''X'' and ''Y'' values do not necessarily need to be in the range between 0 (left or top) to 1 (right or bottom), but can have any other value. It is assumed in this case that the texture is repeated on an infinite grid where integer values for ''X'' and ''Y'' correspond to the corners of the texture.


</div>

Win32 DLLs

2015-02-07T00:08:14Z

Kevin: Created page with " Win32 train plugins {| style="border: 0px currentColor; margin-right: 10pt; margin-l..."

Win32 train plugins 

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| 
|}

 

----

Win32 train plugins are not available on operating systems other than Microsoft Windows. Therefore, these plugins are officially deprecated. Please use [http://trainsimframework.org/develop/plugin_overview.html .NET assemblies] from now on.

----

 The header and code files for the C/C++ programming languages are available to download here:

{| style="border-collapse: collapse"
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" |
[[plugin_h.txt|plugin.h]]
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" |
[[plugin_cpp.txt|plugin.cpp]]
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" |
[[plugin_def.txt|plugin.def]]
|}

 '''Data types:'''

{| style="border-collapse: collapse"
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | int
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | 32-bit signed integer ranging from -2147483648 to 2147483647
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | float
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | 32-bit floating point number according to the IEEE 754 binary32 standard
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | double
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | 64-bit floating point number according to the IEEE 754 binary64 standard
|}

 

{|
|- style="height: 4px"
|
|}

■ Overview

----

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| 
|}

 The following functions are called in this order when the plugin is loaded: 

{|
| valign="top" | ●
|
| Load
|}

{|
| valign="top" | ●
|
| GetPluginVersion
|}

{|
| valign="top" | ●
|
| SetVehicleSpec
|}

{|
| valign="top" | ●
|
| Initialize
|}

{|
| valign="top" | ●
|
| SetPower
|}

{|
| valign="top" | ●
|
| SetBrake
|}

{|
| valign="top" | ●
|
| SetReverser
|}

{|
| valign="top" | ●
|
| SetSignal
|}

 The following functions are called whenever their respective events occur: 

{|
| valign="top" | ●
|
| SetPower
|}

{|
| valign="top" | ●
|
| SetBrake
|}

{|
| valign="top" | ●
|
| SetReverser
|}

{|
| valign="top" | ●
|
| KeyDown
|}

{|
| valign="top" | ●
|
| KeyUp
|}

{|
| valign="top" | ●
|
| HornBlow
|}

{|
| valign="top" | ●
|
| DoorOpen
|}

{|
| valign="top" | ●
|
| DoorClose
|}

{|
| valign="top" | ●
|
| SetSignal
|}

{|
| valign="top" | ●
|
| SetBeaconData
|}

 The following function is called when the plugin is unloaded: 

{|
| valign="top" | ●
|
| Dispose
|}

 

{|
|- style="height: 4px"
|
|}

■ Descriptions

----

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| 
|}

 '''ATS_API void WINAPI Load()''' This function is the first to be called after the plugin has been loaded. When this function triggers inside the plugin, a matching Dispose() call will be made when the plugin is unloaded. 

----

 '''ATS_API void WINAPI Dispose()''' This function is the last to be called before the plugin is unloaded. 

----

 '''ATS_API int WINAPI GetPluginVersion()''' This function is called after Load() in order to query the version of the API to use for the plugin. Currently, there is only one version available. If the version returned does not match the expected value, Dispose() will be called and the plugin is unloaded. ''Return value:''

{| style="border-collapse: collapse"
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | ATS_VERSION
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | 0x20000 (131072)
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | Valid plugin version
|}

 

----

 '''ATS_API void WINAPI SetVehicleSpec (ATS_VEHICLESPEC vehicleSpec)''' This function is called after GetPluginVersion() is called and informs the plugin about the specifications of the train. ''struct ATS_VEHICLESPEC''<nowiki>: </nowiki>

{| style="border-collapse: collapse"
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | int BrakeNotches
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | The amount of brake notches the train has. This does not include the emergency brake, but it does include the hold brake if the train has one. For trains with automatic air brakes, 2 is returned.
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | int PowerNotches
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | The amount of power notches the train has.
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | int AtsNotch
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | The brake notch index corresponding to the first real brake notch. For trains with automatic air brakes, this returns 1. For other trains, this returns 2 if the train has a hold brake, and 1 otherwise.
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | int B67Notch
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | The brake notch index corresponding to 70% of the brake notches, i.e. round(0.7 * BrakeNotches).
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | int Cars
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | The number of cars the train has.
|}

 

----

 '''ATS_API void WINAPI Initialize(int brake)''' This function is called after SetVehicleSpec() is called and informs the plugin about the mode the safety system should start in. If the safety system in your plugin can be activated or deactivated, you should initialize the state of the plugin accordingly. When the user selects a ''Jump to station'' target, this function is also called prior to moving the train to its new location. ''brake''<nowiki>: </nowiki>

{| style="border-collapse: collapse"
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | ATS_INIT_ON_SRV
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | -1
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | The plugin should start in an '''active''' state. The ''service'' brakes are applied on startup.
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | ATS_INIT_ON_EMG
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | 0
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | The plugin should start in an '''active''' state. The '''emergency''' brakes are applied on startup.
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | ATS_INIT_OFF_EMG
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | 1
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | The plugin should start in an ''inactive'' state. The '''emergency''' brakes are applied on startup.
|}

 

----

 '''ATS_API ATS_HANDLES WINAPI Elapse(ATS_VEHICLESTATE vehicleState, int[] panel, int[] sound)''' This function is called every frame, informs the plugin about the current state of the train, and expects the handles as overwritten by the safety system in return. The state of plugin-specific panel elements can also be set, as well as instructions to play plugin-specific sounds. ''struct ATS_VEHICLESTATE''<nowiki>: </nowiki>

{| style="border-collapse: collapse"
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | double Location
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | The current track position of the front of the train in meters.
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | float Speed
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | The current signed speed of the train in km/h. Negative values represent a backward movement, positive ones a forward movement.
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | int Time
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | The current time in milliseconds since midnight of day one. Please note that the time wraps round after 24 days, thus values are between 0 and 2073599999.
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | float BcPressure
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | The current pressure in the brake cylinder in pascal.
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | float MrPressure
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | The current pressure in the main reservoir in pascal.
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | float ErPressure
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | The current pressure in the equalizing reservoir in pascal.
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | float BpPressure
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | The current pressure in the brake pipe in pascal.
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | float SapPressure
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | The current pressure in the straight air brake in pascal.
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | float Current
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | This value always returns 0 and should be ignored.
|}

 ''int[] panel''<nowiki>:</nowiki> An array with 256 elements (0 through 255) which can be set to any value. The values in the array are preserved between successive Elapse() calls. At the beginning of the simulation, all elements are initialized to 0. Panel developers can query values of this array via the ats''i'' subject, while developers of animated objects can query values via the pluginstate[''i''] variable. You should coordinate your efforts with panel/object developers and release a specification that tells which element in the array has what purpose. ''int[] sound''<nowiki>:</nowiki> An array with 256 elements (0 through 255) which can be set to any sound instruction. The values in the array are preserved between successive Elapse() calls. At the beginning of the simulation, all elements are initialized to ATS_SOUND_PLAYLOOPING (0). Train developers can reference sounds in the sound.cfg file. You should coordinate your efforts with train developers and release a specification that tells which sound index plays what kind of sound. The sound instructions that can be used are:

{| style="border-collapse: collapse"
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | ATS_SOUND_STOP
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | -10000
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | Stops the sound.
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" |
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | -9999 through -1
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | Plays the sound in a loop with a given volume. -9999 corresponds to 0.01% volume and -1 corresponds to 99.99% volume. If the sound is already playing (looping or not), only the volume is changed.
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | ATS_SOUND_PLAYLOOPING
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | 0
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | Plays the sound in a loop with 100% volume. If the sound is already playing (looping or not), only the volume is changed.
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | ATS_SOUND_PLAY
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | 1
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | Plays the sound once. If the sound is already playing, a new instance of the sound starts playing. Subsequently, stopping or changing volume only affects the new sound. The host application will set the sound instruction to ATS_SOUND_CONTINUE after having processed it.
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | ATS_SOUND_CONTINUE
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | 2
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | Does not execute any command. You should set to this value if you don't want to change anything.
|}

 ''Return value struct ATS_HANDLES''<nowiki>: </nowiki>

{| style="border-collapse: collapse"
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | int Brake
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | The brake notch to apply. See SetBrake() below for more information.
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | int Power
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | The power notch to apply. Must be within the range from 0 to ''PowerNotches''.
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | int Reverser
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | The reverser to apply. -1 is backward, 0 is neutral and 1 is forward.
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | int ConstantSpeed
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | The operation mode of the constant speed system. ATS_CONSTANTSPEED_CONTINUE (0) uses the driver's setting, ATS_CONSTANTSPEED_ENABLE (1) forces the system on and ATS_CONSTANTSPEED_DISABLE (2) forces the system off.
|}

 

{|
| ⚠
|
| bgcolor="#e0e0e0" |
| bgcolor="#e0e0e0" | Please note that if you want the driver's settings to take effect, you need to respond to the SetPower(), SetBrake() and SetReverse() calls, save the values that are passed in this those calls, and reapply them here.
| bgcolor="#e0e0e0" |
|}

----

 '''ATS_API void WINAPI SetPower(int notch)''' This function is called when the driver changes the power notch. The value passed can range from 0 to ''PowerNotches''. 

----

 '''ATS_API void WINAPI SetBrake(int notch)''' This function is called when the driver changes the brake notch. For trains with automatic air brake, 0 is RELEASE, 1 is LAP, 2 is SERVICE and 3 is EMERGENCY. For other trains that do not have a hold brake, 0 is released brakes, 1 is brake notch 1, 2 is brake notch 2, etc., ''BrakeNotches'' is the maximum brake notch, and ''BrakeNotches''+1 is the emergency brake. For other trains that have a hold brake, 0 is released brakes, 1 is the hold brake, 2 is brake notch 1, 3 is brake notch 2, etc., ''BrakeNotches'' is the maximum brake notch, and ''BrakeNotches''+1 is the emergency brake. Generally, for trains without the automatic air brake, ''AtsNotch'' is the first brake notch and ''BrakeNotches'' is the maximum brake notch. For all types of trains, ''BrakeNotches''+1 is the emergency brake. 

----

 '''ATS_API void WINAPI SetReverser(int pos)''' This function is called when the driver changes the reverser position. The value of -1 corresponds to backward, 0 to neutral and 1 to forward. 

----

 '''ATS_API void WINAPI KeyDown(int atsKeyCode)''' This function is called when a plugin-specific key is pressed down. The passed value ''atsKeyCode'' corresponds to any value between ATS_KEY_S (0) and ATS_KEY_L (15). When you make use of plugin-specific keys, release a specification that gives the official name of the key (e.g. SECURITY_S, SECURITY_A1, SECURITY_B2, etc.) or their shorthands (S, A1, B2, etc.) along with the meaning. 

----

 '''ATS_API void WINAPI KeyUp(int atsKeyCode)''' This function is called when a plugin-specific key is released. The passed value ''atsKeyCode'' corresponds to any value between ATS_KEY_S (0) and ATS_KEY_L (15). When you make use of plugin-specific keys, release a specification that gives the official name of the key (e.g. SECURITY_S, SECURITY_A1, SECURITY_B2, etc.) or their shorthands (S, A1, B2, etc.) along with the meaning. 

----

 '''ATS_API void WINAPI HornBlow(int hornType)''' This function is called when any of the horn starts or stops playing. ''hornType''<nowiki>: </nowiki>

{| style="border-collapse: collapse"
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | ATS_HORN_PRIMARY
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | 0
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | The function is called only when the horn starts playing.
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | ATS_HORN_SECONDARY
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | 1
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | The function is called only when the horn starts playing.
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | ATS_HORN_MUSIC
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | 2
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | The function is called both when the horn starts playing and when it stops playing.
|}

 

----

 '''ATS_API void WINAPI DoorOpen()''' This function is called when the doors start opening. 

----

 '''ATS_API void WINAPI DoorClose()''' This function is called when the doors have finished closing. 

----

 '''ATS_API void WINAPI SetSignal(int signal)''' This function is called whenever the current signalling section would change its aspect assuming the player's train is not inside. This can occur when passing section boundaries, but only if the newly entered section has a different aspect than the previous one. It can also occur when a preceding train clears any upcoming block and the current section would change its aspect as a consequence of that. Thus, the SetSignal call can occur at any time. The passed value ''signal'' represents the section value (the aspect number). 

{|
| ⚠
|
| bgcolor="#e0e0e0" |
| bgcolor="#e0e0e0" | Please note that the SetSignal call assumes that the player's train is not inside the section for which the SetSignal call is raised. Otherwise, the reported aspect would always be red, which would not be very meaningful to work with.
| bgcolor="#e0e0e0" |
|}

----

 '''ATS_API void WINAPI SetBeaconData(ATS_BEACONDATA beaconData)''' This function is called when a beacon is passed. ''struct ATS_BEACONDATA''<nowiki>: </nowiki>

{| style="border-collapse: collapse"
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | int Type
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | The type of the beacon. In CSV routes, this corresponds to ''Type'' in Track.Beacon(''Type''<nowiki>; </nowiki>''BeaconStructureIndex''<nowiki>; </nowiki>''Section''<nowiki>; </nowiki>''Data'').
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | int Signal
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | The aspect number currently shown on the associated section. In CSV routes, this corresponds to any of the values in Track.Section(''Aspect0'', ''Aspect1'', ..., ''Aspectn'')
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | float Distance
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | The distance from the front of the train to the signal in meters. This can be negative if the associated section is behind the front of the train.
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | int Data
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | The data of the beacon. In CSV routes, this corresponds to ''Data'' in Track.Beacon(''Type''<nowiki>; </nowiki>''BeaconStructureIndex''<nowiki>; </nowiki>''Section''<nowiki>; </nowiki>''Data'').
|}

 ''Type'' can be in the range from 0 to 2147483647, while ''Data'' can be in the range from -2147483648 to 2147483647. Please see the page about [http://trainsimframework.org/develop/information_standards.html standards] to learn more about assigning beacon types.

Train Plugin API (IRuntime)

2015-02-07T00:07:47Z

Kevin: Created page with " Train plugin API (IRuntime) {| style="border: 0px currentColor; margin-right: 10pt;..."

Train plugin API (IRuntime) 

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| 
|}

 This is the documentation for train plugins. In order to create a train plugin, implement the IRuntime interface from the OpenBveApi.Runtime namespace. In the following, you will find a description of how this interface works. 

{|
|- style="height: 4px"
|
|}

{|
|- style="height: 4px"
|
|}

■ Overview

----

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| 
|}

 The following functions are called in this order when the plugin is loaded: 

{|
| valign="top" | ●
|
| Load
|}

{|
| valign="top" | ●
|
| SetVehicleSpecs
|}

{|
| valign="top" | ●
|
| Initialize
|}

{|
| valign="top" | ●
|
| SetPower
|}

{|
| valign="top" | ●
|
| SetBrake
|}

{|
| valign="top" | ●
|
| SetReverser
|}

{|
| valign="top" | ●
|
| SetSignal
|}

 The following functions can be called at any time: 

{|
| valign="top" | ●
|
| SetPower
|}

{|
| valign="top" | ●
|
| SetBrake
|}

{|
| valign="top" | ●
|
| SetReverser
|}

{|
| valign="top" | ●
|
| KeyDown
|}

{|
| valign="top" | ●
|
| KeyUp
|}

{|
| valign="top" | ●
|
| HornBlow
|}

{|
| valign="top" | ●
|
| DoorChange
|}

{|
| valign="top" | ●
|
| SetSignal
|}

{|
| valign="top" | ●
|
| SetBeacon
|}

{|
| valign="top" | ●
|
| PerformAI
|}

 The following function is called when the plugin is unloaded: 

{|
| valign="top" | ●
|
| Unload
|}

 

{|
|- style="height: 4px"
|
|}

● Function calls

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| 
|}

{|
|- style="height: 2px"
|
|}

 The following is a list of all function calls along with explanations on their behavior. 

----

 '''bool Load(LoadProperties properties)''' This function is the first to be called after the plugin has been loaded. When this function triggers inside the plugin, a matching call to ''Unload'' will be made when the plugin is unloaded. Arguments:

{| style="border-collapse: collapse"
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | LoadProperties
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | properties
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | The properties supplied to the plugin on loading.
|}

 LoadProperties (class):

{| style="border-collapse: collapse"
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | string
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | PluginFolder
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | Gets the absolute path to the plugin folder.
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | string
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | TrainFolder
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | Gets the absolute path to the train folder.
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | int[]
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | Panel
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | Gets or sets the array of panel variables.
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | PlaySoundDelegate
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | PlaySound
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | Gets the callback function for playing sounds.
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | AISupport
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | AISupport
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | The extent to which the plugin supports the AI.
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | string
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | FailureReason
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | Gets or sets the reason why the plugin failed loading.
|}

 PlaySound (function): See the section on [http://trainsimframework.org/develop/plugin_iruntime.html#sound playing sounds]. AISupport (enumeration):

{| style="border-collapse: collapse"
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | AISupport.None
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | 0
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | The plugin does not support the AI. Calls to PerformAI will not be made. Non-player trains will not use the plugin.
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | AISupport.Basic
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | 1
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | The plugin complements the built-in AI by performing only functions specific to the plugin.
|}

 Return value:

{| style="border-collapse: collapse"
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | bool
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | Whether the plugin was loaded successfully.
|}

 If your plugin uses external configuration files, open files relative to the ''properties.PluginFolder'' or ''properties.TrainFolder''. The difference between the two can be best visualized when the plugin is in a shared folder: Files relative to the plugin folder are common for all trains that use the plugin, while files relative to the train folder are specific to each train. The plugin folder is simply the folder in which the plugin is stored. Initialize the ''properties.Panel'' array to any size and with any startup values you need. The array is processed after every call to ''Elapse'' by the host application in order to update custom panel indicators. Developers of the panel2.cfg file can query these values with the ''ats''i variable, while developers of the panel.animated file can query these values with the ''pluginState[''i'']'' variable. The ''properties.PlaySound'' function can be used at any time to play sounds. This callback function returns a handle that you can use to track if the sound is still playing, to change its volume and pitch, or to stop it. Please also see the section on [http://trainsimframework.org/develop/plugin_iruntime.html#sound playing sounds]. Set ''properties.AISupport'' to a value other than ''AISupport.None'' if you want your plugin to support the AI. Please also see the section on [http://trainsimframework.org/develop/plugin_iruntime.html#ai supporting the AI]. You should return '''true''' as the return value when loading succeeded. If, on the other hand, you want to abort loading the plugin, for example because an external configuration file could not be found, return '''false''' and set ''properties.FailureReason'' to a human-readible string that explains why loading failed. 

----

 '''void Unload()''' This function is the last to be called before the plugin is unloaded. 

----

 '''void SetVehicleSpecs(VehicleSpecs specs)''' This function is called after ''Load'' to inform the plugin about the specifications of the train. Arguments:

{| style="border-collapse: collapse"
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | VehicleSpecs
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | specs
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | The specifications of the train.
|}

 VehicleSpecs (class):

{| style="border-collapse: collapse"
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | int
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | PowerNotches
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | Gets the number of power notches the train has.
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | BrakeTypes
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | BrakeType
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | Gets the type of brake the train uses.
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | int
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | BrakeNotches
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | Gets the number of brake notches the train has, including the hold brake, but excluding the emergency brake.
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | bool
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | HasHoldBrake
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | Gets whether the train has a hold brake.
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | int
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | AtsNotch
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | Gets the index of the brake notch that corresponds to B1 or LAP.
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | int
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | B67Notch
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | Gets the index of the brake notch that corresponds to 70% of the available brake notches.
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | int
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | Cars
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | Gets the number of cars the train has.
|}

 BrakeTypes (enumeration):

{| style="border-collapse: collapse"
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | BrakeTypes.ElectromagneticStraightAirBrake
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | 0
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | The train uses the electromagnetic straight air brake.
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | BrakeTypes.ElectricCommandBrake
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | 1
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | The train uses the analog/digital electro-pneumatic air brake without a brake pipe (electric command brake).
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | BrakeTypes.AutomaticAirBrake
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | 2
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | The train uses the automatic air brake with partial release.
|}

 For more information about the meanings of the notches, see the sections on SetReverser, SetPower and SetBrake. 

----

 '''void Initialize(InitializationModes mode)''' This function is called after ''SetVehicleSpecs'' and informs the plugin about the mode the safety system should start in. If the safety system in your plugin can be activated or deactivated, you should initialize the state of the plugin accordingly. When the user selects a ''Jump to station'' target, this function is also called prior to moving the train to its new location. Arguments:

{| style="border-collapse: collapse"
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | InitializationModes
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | mode
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | The mode of initialization.
|}

 InitializationModes (enumeration):

{| style="border-collapse: collapse"
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | InitializationModes.OnService
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | -1
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | The safety system should be enabled. The train has its service brakes applied.
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | InitializationModes.OnEmergency
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | 0
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | The safety system should be enabled. The train has its emergency brakes applied.
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | InitializationModes.OffEmergency
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | 1
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | The safety system should be disabled. The train has its emergency brakes applied.
|}

 The initialization mode is set in CSV/RW routes via the Route.Change command. Please note that any value between -2147483648 and 2147483647 can be conveyed to the plugin - the enumeration members are simply meant to standardize the meanings of the initialization modes. 

----

 '''void Elapse(ElapseData data)''' This function is called every frame. It informs the plugin about the current state of the train and allows to set the virtual handles. Arguments:

{| style="border-collapse: collapse"
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | ElapseData
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | data
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | The data passed to the plugin.
|}

 ElapseData (class):

{| style="border-collapse: collapse"
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | VehicleState
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | Vehicle
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | Gets the state of the train.
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | PrecedingVehicleState
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | PrecedingVehicle
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | Gets the state of the preceding train, or a null reference if there is no preceding train.
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | Handles
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | Handles
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | Gets or sets the virtual handles.
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | Time
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | TotalTime
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | Gets the absolute in-game time.
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | Time
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | ElapsedTime
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | Gets the time that elapsed since the last call to Elapse.
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | string
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | DebugMessage
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | Gets or sets the debug message the plugin wants the host application to display.
|}

 VehicleState (class):

{| style="border-collapse: collapse"
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | double
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | Location
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | Gets the location of the front of the train, in meters.
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | Speed
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | Speed
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | Gets the speed of the train.
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | double
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | BcPressure
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | Gets the pressure in the brake cylinder, in pascal.
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | double
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | MrPressure
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | Gets the pressure in the main reservoir, in pascal.
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | double
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | ErPressure
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | Gets the pressure in the equilizing reservoir, in pascal.
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | double
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | BpPressure
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | Gets the pressure in the brake pipe, in pascal.
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | double
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | SapPressure
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | Gets the pressure in the straight air pipe, in pascal.
|}

 PrecedingVehicleState (class):

{| style="border-collapse: collapse"
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | double
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | Location
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | Gets the location of the back of the preceding train, in meters.
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | double
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | Distance
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | Gets the distance from the front of the current train to the back of the preceding train, in meters.
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | Speed
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | Speed
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | Gets the speed of the preceding train.
|}

 Speed (structure):

{| style="border-collapse: collapse"
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | double
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | MetersPerSecond
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | Gets the speed in meters per second.
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | double
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | KilometersPerHour
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | Gets the speed in kilometers per hour.
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | double
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | MilesPerHour
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | Gets the speed in miles per hour.
|}

 Time (structure):

{| style="border-collapse: collapse"
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | double
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | Seconds
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | Gets the time in seconds.
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | double
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | Milliseconds
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | Gets the time in milliseconds.
|}

 Handles (class):

{| style="border-collapse: collapse"
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | int
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | Reverser
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | Gets or sets the reverser position.
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | int
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | PowerNotch
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | Gets or sets the power notch.
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | int
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | BrakeNotch
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | Gets or sets the brake notch.
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | bool
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | ConstSpeed
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | Gets or sets whether the const speed system is enabled.
|}

 The meanings of the notches are explained in the sections on SetReverser, SetPower and SetBrake. 

----

 '''void SetReverser(int reverser)''' This function is called when the driver changes the reverser position. Arguments:

{| style="border-collapse: collapse"
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | int
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | reverser
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | The new reverser position.
|}

 For ''reverser'', the value of -1 corresponds to backward, 0 to neutral and 1 to forward. 

----

 '''void SetPower(int powerNotch)''' This function is called when the driver changes the power notch. Arguments:

{| style="border-collapse: collapse"
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | int
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | powerNotch
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | The new power notch.
|}

 For ''powerNotch'', the value passed can range from 0 to ''specs.PowerNotches''. 

----

 '''void SetBrake(int brakeNotch)''' This function is called when the driver changes the brake notch. Arguments:

{| style="border-collapse: collapse"
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | int
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | brakeNotch
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | The new brake notch.
|}

 For trains with the '''automatic air brake''', 0 is RELEASE, 1 is LAP, 2 is SERVICE and 3 is EMERGENCY. For all other trains '''without a hold brake''', 0 is released brakes, 1 is brake notch B1, 2 is brake notch B2, etc., ''specs.BrakeNotches'' is the maximum brake notch, and ''specs.BrakeNotches''+1 is the emergency brake. For all other trains '''with a hold brake''', 0 is released brakes, 1 is the hold brake, 2 is brake notch B1, 3 is brake notch B2, etc., ''specs.BrakeNotches'' is the maximum brake notch, and ''specs.BrakeNotches''+1 is the emergency brake. Generally speaking, for trains without the automatic air brake, ''specs.AtsNotch'' is brake notch B1 and ''specs.BrakeNotches'' is the maximum service brake notch. For all types of trains, ''specs.BrakeNotches''+1 is the emergency brake. 

----

 '''void KeyDown(VirtualKeys key)''' This function is called when a plugin-specific key is pressed. Arguments:

{| style="border-collapse: collapse"
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | VirtualKeys
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | key
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | The virtual key that was pressed.
|}

 VirtualKeys (enumeration):

{| style="border-collapse: collapse"
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | VirtualKeys.S
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | 0
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | The virtual S key. The default assignment is Space.
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | VirtualKeys.A1
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | 1
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | The virtual A1 key. The default assignment is Insert.
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | VirtualKeys.A2
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | 2
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | The virtual A2 key. The default assignment is Delete.
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | VirtualKeys.B1
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | 3
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | The virtual B1 key. The default assignment is Home.
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | VirtualKeys.B2
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | 4
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | The virtual B2 key. The default assignment is End.
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | VirtualKeys.C1
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | 5
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | The virtual C1 key. The default assignment is Page Up.
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | VirtualKeys.C2
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | 6
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | The virtual C2 key. The default assignment is Page Down.
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | VirtualKeys.D
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | 7
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | The virtual D key. The default assignment is 2.
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | VirtualKeys.E
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | 8
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | The virtual E key. The default assignment is 3.
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | VirtualKeys.F
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | 9
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | The virtual F key. The default assignment is 4.
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | VirtualKeys.G
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | 10
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | The virtual G key. The default assignment is 5.
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | VirtualKeys.H
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | 11
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | The virtual H key. The default assignment is 6.
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | VirtualKeys.I
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | 12
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | The virtual I key. The default assignment is 7.
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | VirtualKeys.J
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | 13
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | The virtual J key. The default assignment is 8.
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | VirtualKeys.K
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | 14
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | The virtual K key. The default assignment is 9.
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | VirtualKeys.L
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | 15
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | The virtual L key. The default assignment is 0.
|}

 When making use of plugin-specific keys in your plugin, be sure to release a documentation that includes the virtual names of the keys along with their plugin-specific meanings. 

----

 '''void KeyUp(VirtualKeys key)''' This function is called when a plugin-specific key is released. Arguments:

{| style="border-collapse: collapse"
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | VirtualKeys
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | key
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | The virtual key that was released.
|}

 VirtualKeys (enumeration):

{| style="border-collapse: collapse"
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | VirtualKeys.S
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | 0
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | The virtual S key. The default assignment is Space.
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | VirtualKeys.A1
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | 1
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | The virtual A1 key. The default assignment is Insert.
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | VirtualKeys.A2
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | 2
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | The virtual A2 key. The default assignment is Delete.
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | VirtualKeys.B1
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | 3
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | The virtual B1 key. The default assignment is Home.
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | VirtualKeys.B2
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | 4
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | The virtual B2 key. The default assignment is End.
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | VirtualKeys.C1
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | 5
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | The virtual C1 key. The default assignment is Page Up.
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | VirtualKeys.C2
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | 6
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | The virtual C2 key. The default assignment is Page Down.
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | VirtualKeys.D
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | 7
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | The virtual D key. The default assignment is 2.
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | VirtualKeys.E
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | 8
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | The virtual E key. The default assignment is 3.
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | VirtualKeys.F
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | 9
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | The virtual F key. The default assignment is 4.
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | VirtualKeys.G
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | 10
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | The virtual G key. The default assignment is 5.
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | VirtualKeys.H
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | 11
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | The virtual H key. The default assignment is 6.
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | VirtualKeys.I
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | 12
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | The virtual I key. The default assignment is 7.
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | VirtualKeys.J
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | 13
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | The virtual J key. The default assignment is 8.
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | VirtualKeys.K
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | 14
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | The virtual K key. The default assignment is 9.
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | VirtualKeys.L
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | 15
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | The virtual L key. The default assignment is 0.
|}

 When making use of plugin-specific keys in your plugin, be sure to release a documentation that includes the virtual names of the keys along with their plugin-specific meanings. 

----

 '''void HornBlow(HornTypes type)''' This function is called when a horn starts playing. In case of the musical horn, this function is also called when the horn stops playing. Arguments:

{| style="border-collapse: collapse"
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | HornTypes
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | type
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | The type of horn.
|}

 HornTypes (enumeration):

{| style="border-collapse: collapse"
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | HornTypes.Primary
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | 0
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | The primary horn.
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | HornTypes.Secondary
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | 1
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | The secondary horn.
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | HornTypes.Music
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | 2
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | The musical horn.
|}

 

----

 '''void DoorChange(DoorStates oldState, DoorStates newState)''' This function is called when the state of the doors change. Arguments:

{| style="border-collapse: collapse"
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | DoorStates
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | oldState
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | The old state of the doors.
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | DoorStates
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | newState
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | The new state of the doors.
|}

 DoorStates (enumeration):

{| style="border-collapse: collapse"
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | DoorStates.None
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | 0
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | No door is open.
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | DoorStates.Left
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | 1
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | The left doors are open.
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | DoorStates.Right
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | 2
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | The right doors are open.
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | DoorStates.Both
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | 3
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | All doors are open.
|}

 

----

 '''void SetSignal(SignalData[] data)''' This function is called when the aspect in the current or in any of the upcoming section changes, or when passing section boundaries. For the current section, it is assumed that no train is currently inside. Only sections until the first red section are reported. Arguments:

{| style="border-collapse: collapse"
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | SignalData[]
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | data
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | The signal data per section.
|}

 SignalData (class):

{| style="border-collapse: collapse"
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | int
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | Aspect
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | Gets the aspect of the section.
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | double
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | Distance
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | Gets the distance to the section.
|}

 The ''data'' array contains one entry per section, where ''data[0]'' is the current section, ''data[1]'' the upcoming section, and so on. You can inspect the aspect and the distance to each section reported. Please note that the length of the ''data'' array is dynamic. Only sections until the first red section are reported. This means that you need to check the size of the array before querying a particular section. Please also note that the last section in the ''data'' array does not have to be red necessarily. For example at the end of the track, the last section might be green. In CSV/RW routes, the Track.Section (CSV) or @Section (RW) command is used to create signalling sections. The ''data.Aspect'' member corresponds to any of the aspects defined by this command. 

----

 '''void SetBeacon(BeaconData data)''' This function is called when a beacon is passed by the front of the train. Arguments:

{| style="border-collapse: collapse"
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | BeaconData
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | data
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | The beacon data.
|}

 BeaconData (class):

{| style="border-collapse: collapse"
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | int
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | Type
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | Gets the type of beacon.
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | int
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | Optional
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | Gets optional data the beacon transmits.
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | SignalData
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | Signal
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | Gets the section the beacon is attached to.
|}

 SignalData (class):

{| style="border-collapse: collapse"
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | int
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | Aspect
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | Gets the aspect of the section.
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | double
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | Distance
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | Gets the distance to the section.
|}

 In CSV/RW routes, the Track.Beacon (CSV) or @Beacon (RW) command is used to install beacons on the route. Both the beacon type and the optional data set by this command is transmitted to the train plugin along with the distance to the attached section. Please note that plugins may receive beacon types less than 0. These beacon types are reserved for future use and must be ignored by current plugins. 

----

 '''void PerformAI(AIData data)''' This function is called when the AI is performed. Arguments:

{| style="border-collapse: collapse"
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | AIData
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | data
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | The AI data.
|}

 AIData (class):

{| style="border-collapse: collapse"
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | Handles
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | Handles
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | Gets or sets the driver handles.
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | AIResponse
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | Response
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | Gets or sets the AI response.
|}

 Whenever you let the AI perform something, set ''data.Response'' to a value other than ''AIResponse.None''. Please also see the section on [http://trainsimframework.org/develop/plugin_iruntime.html#ai supporting the AI]. 

{|
|- style="height: 4px"
|
|}

■ Playing sounds

----

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| 
|}

 You can play custom sounds from within your plugin. Custom sounds need to be configured inside the ''sound.cfg'' file before they can be used by the plugin. In order to play such sounds, keep a reference to the ''PlaySound'' function that is passed in the Load call. You can then start playing sounds at any time by calling this function: '''SoundHandle PlaySound(int index, double volume, double pitch, bool looped)''' Arguments:

{| style="border-collapse: collapse"
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | int
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | index
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | The index to the sound to be played.
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | double
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | volume
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | The initial volume of the sound. A value of 1.0 represents nominal volume.
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | double
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | pitch
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | The initial pitch of the sound. A value of 1.0 represents nominal pitch.
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | bool
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | looped
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | Whether the sound should be played in an indefinate loop.
|}

 Return value:

{| style="border-collapse: collapse"
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | SoundHandle
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | The handle to the sound, or a null reference if the sound could not be played.
|}

 When you call the PlaySound function, a handle will be returned that you can use to later check if the sound is still playing, in order to change the volume or pitch, or to stop playing the sound. If you play a sound in a loop, you '''must''' keep the handle in order to subsequently stop the sound - otherwise it would play indefinately. The handle returned by PlaySound is of the following form: SoundHandle (class):

{| style="border-collapse: collapse"
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | bool
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | Playing
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | Gets whether the sound is still playing. Once this returns false, the sound handle is invalid.
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | bool
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | Stopped
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | Gets whether the sound has stopped. Once this returns true, the sound handle is invalid.
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | double
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | Volume
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | Gets or sets the volume. A value of 1.0 represents nominal volume.
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | double
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | Pitch
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | Gets or sets the pitch. A value of 1.0 represents nominal pitch.
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | void
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | Stop()
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | Stops the sound and invalidates the handle.
|}

 Please note that depending on the implementation by the host application, sounds that are not in audible range may not be played at all. Please also note that the handle returned might be a null reference in the case the host application could not play the sound, for example because the file could not be found. 

{|
|- style="height: 4px"
|
|}

■ Supporting the AI

----

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| 
|}

 Usually, the host application performs the AI. However, your plugin might require special operation precedures which the built-in AI cannot know of. For this reason, you can complement the built-in AI by performing operation procedures specific to your plugin. Before considering to support the AI, however, you should understand what the AI is intended to represent: a human being standing or sitting in the cab, operating levers and pressing buttons, just like the player. This means that the AI must not operate 6 levers and 12 buttons simultaneously, but only do one thing at a time. If you want to support the AI, first set ''data.AISupport'' inside the Load call to ''AISupport.Basic''. Whenever the host application performs an AI round, a call to PerformAI will then be made inside the plugin. The plugin can then decide to let the AI perform an action, or to pass and let the host application perform an action. Different kinds of actions can take different amounts of time, so whenever the plugin lets the AI perform an action, it will also set the time it takes before the next action can be performed. It is important to understand that unless your plugin also simulates a full ATO with automatic stopping at stations, you must let the host application perform the AI for most of the time and only intervene if absolutely necessary, for example in order to start the engine, to acknowledge a vigilance device, etc. Whenever this is the case, react to the PerformAI call appropriately: '''void PerformAI(AIData data)''' Arguments:

{| style="border-collapse: collapse"
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | AIData
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | data
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | The AI data.
|}

 AIData (class):

{| style="border-collapse: collapse"
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | Handles
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | Handles
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | Gets or sets the driver handles.
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | AIResponse
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | Response
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | Gets or sets the AI response.
|}

 Handles (class):

{| style="border-collapse: collapse"
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | int
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | Reverser
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | Gets or sets the reverser position.
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | int
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | PowerNotch
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | Gets or sets the power notch.
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | int
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | BrakeNotch
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | Gets or sets the brake notch.
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | bool
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | ConstSpeed
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | Gets or sets whether the const speed system is enabled.
|}

 The meanings of the notches are explained in the sections on SetReverser, SetPower and SetBrake. AIResponse (enumeration):

{| style="border-collapse: collapse"
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | AIResponse.None
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | No action was performed by the plugin.
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | AIResponse.Short
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | The action performed took a short time.
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | AIResponse.Medium
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | The action performed took an average amount of time.
|-
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | AIResponse.Long
| style="padding: 4px; border: 2px ridge currentColor" bgcolor="#ffffff" | The action performed took a long time.
|}

 You can directly control the driver handles with the ''data.Handles'' member, for example if you want to cut power or apply a certain brake notch. For plugin-specific actions, you should only simulate key presses, for example by calling KeyDown or KeyUp. This will prevent you from letting the AI cheat in any way. If you let the AI operate the handles, you should only change by one notch at a time with a short response time. If you decide to let the AI do something, you must set the ''data.Response'' member to a meaningful value. For operating the handles, best use a short response time, while for other actions like turning a switch not directly accessible, use a long response time. Note that the actual timings are at the whim of the host application. Example: 

{|
| width="16" valign="top" |
| ''''
|-
| width="16" valign="top" | ▶
| style="border: 1px dashed currentColor" bgcolor="#d4d8ff" | <tt>if (AtsAlarm) { /* The driver needs to cut power and apply the brakes, * then press the virtual S key.*/ if (data.Handles.PowerNotch > 0) { /* We change only by one notch at a time. */ data.Handles.PowerNotch -= 1; data.Response = AIResponse.Short; } else if (data.Handles.BrakeNotch < 2) { /* We change only by one notch at a time. */ data.Handles.BrakeNotch += 1; data.Response = AIResponse.Short; } else { /* We simulate a key press here. */ KeyDown(VirtualKeys.S); data.Response = AIResponse.Medium; } } else if (AtoActive) { /* Our ATO does not require driver interaction, so * let's prevent the built-in AI from doing anything. */ data.Response = AIResponse.Long; } else { /* Let the host application perform a default action * such as braking for signals or stations. */ data.Response = AIResponse.None; }</tt>
|}

Trains

2015-02-07T00:07:16Z

Kevin: Created page with "Overview Trains consist of a series of individual configuration files accompanied by bitmaps and sounds. The following is an overview on which files are required and what the..."

Overview

Trains consist of a series of individual configuration files accompanied by bitmaps and sounds. The following is an overview on which files are required and what they represent.

==Information and tips for train creation==

This page presents information developers need to be aware of and general tips for object creation.

===Characteristics===
{| style="color: black; background-color: #ffffcc;" width="100%" class="wikitable"
|-
| style="width: 25%; background-color: white;"|'''[[train.dat]]'''
| style="width: 75%; background-color: white;"|'''This is the core configuration file for the train's characteristics, and is mandatory.'''
|}

===Panels===

{| style="color: black; background-color: #ffffcc;" width="100%" class="wikitable"
|-
| style="width: 25%; background-color: white;"|'''[[panel.animated]]'''
| style="width: 75%; background-color: white;"|'''This file allows to create a fully 3D cab. If present in the train folder, this file has precedence over the panel2.cfg and panel.cfg files.'''
|-
| style="width: 25%; background-color: white;"|'''[[panel2.cfg]]'''
| style="width: 75%; background-color: white;"|'''This file allows to create a limited 2D cab. If present in the train folder, this file has precedence over the panel.cfg. The panel2.cfg has fully superseded the panel.cfg as it offers greater functionality.'''
|-
| style="width: 25%; background-color: white;"|'''[[panel.cfg]]'''
| style="width: 75%; background-color: white;"|'''This file is outdated, and allows to create a limited 2D cab. It has been fully superseded by the panel2.cfg file, which should be used instead..'''
|}

===Sounds===

{| style="color: black; background-color: #ffffcc;" width="100%" class="wikitable"
|-
| style="width: 25%; background-color: white;"|'''[[Default sounds]]'''
| style="width: 75%; background-color: white;"|'''If no sound.cfg is present, these are the default sound files that are being looked for in the train folder.'''
|-
| style="width: 25%; background-color: white;"|'''[[sound.cfg]]'''
| style="width: 75%; background-color: white;"|'''This defines the names of the sound files to use. The file is required if plugin-specific sounds are to be made available.'''
|}

===Safety Systems===

{| style="color: black; background-color: #ffffcc;" width="100%" class="wikitable"
| colspan="4" |
'''ⓘ Built-in systems:
The built-in safety systems ATS-SN, ATS-P and ATC are only used if no ats.cfg file is present, and if the train.dat is configured to define which of these systems should be available.'''
|-
| style="width: 25%; background-color: white;"|'''[[ats.cfg]]'''
| style="width: 75%; background-color: white;"|'''This file defines which external train plugin to use. For information on how to create plugins, see here.'''
|}

===Miscellaneous===

{| style="color: black; background-color: #ffffcc;" width="100%" class="wikitable"
|-
| style="width: 25%; background-color: white;"|'''[[extensions.cfg]]'''
| style="width: 75%; background-color: white;"|'''This defines additional characteristics that are not covered by the other files.'''
|}

===Exterior Objects===
*Exterior objects need to follow the same rules as any other object.
**[[Objects|See Information and tips on object creation]].

===panel.cfg / panel2.cfg===

●You are free to use textures with full alpha channels without worrying about performance or transparency artifacts. Depth sorting will always perform correctly with these panel formats, so make good use of dirty or wet windscreens via alpha channels, for example.

●In the panel2.cfg, you are responsible for ensuring that overlapping elements are placed in unique layers. Otherwise, the rendering order might be erratic or could lead to z-fighting.

●Single textures should be of power-of-two size, e.g. sides should have a length of 1, 2, 4, 8, 16, 32, etc. However, with textures containing smaller images to be extracted later, e.g. DigitalIndicator in panel.cfg or DigitalNumber in panel2.cfg, the individual contained images should be of power-of-two size where possible, while the size of the container texture is irrelevant.

===Plugins===
{| style="color: black; background-color: #ffffcc;" width="100%" class="wikitable"
| colspan="4" |
'''ⓘ Some people have used plugin commands for their trains. The most frequently used plugins are the Oskari plugin and the UK Train System plugin
'''
|-
| style="width: 50%; background-color: white;"|'''[[Using Oskari's Plugin (OS_ATS1.dll)]]'''
| style="width: 50%; background-color: white;"|'''[[Using UK Train System Plugin]]'''
|}

Plugins

2015-02-07T00:06:27Z

Kevin: Created page with " Train plugins {| style="border: 0px currentColor; margin-right: 10pt; margin-left: 1..."

Train plugins 

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| 
|}

 Train plugins allow to change the runtime behavior of trains to some degree. Things you can do include displaying custom indicators in the panels, playing custom sounds and overriding the handles the driver originally set. Plugins can be used to simulate safety equipment such as ATS or ATC, among other things. 

{|
|- style="height: 4px"
|
|}

■ Available forms of plugins

----

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| 
|}

 [[Train Plugin API (IRuntime)|'''.NET assemblies:''']] This is the only officially endorsed form of plugin. The plugins are .NET assemblies and should be designed to be cross-platform-compatible without recompilation. You can choose from a variety of programming languages, including C# and Visual Basic .NET, among many others that target the .NET Framework. [[Win32 DLLs| '''Win32 DLLs:''']] This form of plugin is retained for backward compatibility with BVE Trainsim, but is no longer officially endorsed because these plugins can only run on Microsoft Windows. They are usually developed in C/C++. Given the cross-platform alternative, please develop .NET assemblies from now on. 

{|
|- style="height: 4px"
|
|}

■ Setting up a train to using a plugin

----

{| style="border: 0px currentColor; margin-right: 10pt; margin-left: 10pt"
| 
|}

You will need to ship the plugin somewhere in your train folder and configure the path to your plugin inside the [[ats.cfg]] file. Please note that for .NET assembly train plugins, you should '''not''' ship OpenBveApi.dll along with your plugin.

Routes

2015-02-02T06:21:59Z

Bombardier01800: Created page with " {| style="color: black; background-color: #ffffcc;" width="100%" class="wikitable" | colspan="2" | '''ⓘ Many routes, for OpenBVE and BVE alike, are commonly coded in two fo..."

{| style="color: black; background-color: #ffffcc;" width="100%" class="wikitable"
| colspan="2" |
'''ⓘ Many routes, for OpenBVE and BVE alike, are commonly coded in two formats. That is:'''
|-
| style="width: 25%; background-color: white;"|'''[[CSV Routes| The .CSV Route]]'''
| style="width: 25%; background-color: white;"|'''[[RW Routes| The .RW Route]]'''

|}
 
{| style="color: black; background-color: #ffffcc;" width="100%" class="wikitable"
| colspan="2" |
'''ⓘ Additionally, you can also learn to use the built-in plugins:'''
|-
| style="width: 25%; background-color: white;"|'''[[Using ATS]]'''
| style="width: 25%; background-color: white;"|'''[[Using ATC]]'''

|}
 
Some people have also created routes using Routebuilder. If you want to try the unsupported graphical (WYSIWYG) route editor, you can do so. We have very limited support for Routebuilder, so if you do plan to use this and have questions, you may or may not recieve answers due to the extremely low amount of developers on BVEStation using it.

*[http://www.bvestation.com/forums/index.php?topic=3024.0 Creating Routes with RouteViewer]
 

{| style="color: black; background-color: #ffffcc;" width="100%" class="wikitable"
| colspan="2" |
'''ⓘ Some people have used plugin commands for their routes. The most frequently used plugins are these:'''
|-
| style="width: 25%; background-color: white;"|'''[[Using Oskari's Plugin (OS_ATS1.dll)|Oskari's Plugin (OS_ATS1.dll)]]'''
| style="width: 25%; background-color: white;"|'''[[Using UK Train System Plugin|UK Train System Plugin]]'''

|}

Objects

2015-02-02T06:21:29Z

Bombardier01800: Created page with " {| style="color: black; background-color: #ffffcc;" width="100%" class="wikitable" | colspan="4" | '''ⓘ Objects are essential to the creation of OpenBVE routes and trains...."

{| style="color: black; background-color: #ffffcc;" width="100%" class="wikitable"
| colspan="4" |
'''ⓘ Objects are essential to the creation of OpenBVE routes and trains. Here are the most frequently used formats:'''
|-
| style="width: 25%; background-color: white;"|'''[[.B3d| The .B3D Object]]'''
| style="width: 25%; background-color: white;"|'''[[.CSV| The .CSV Object]]'''
| style="width: 25%; background-color: white;"|'''[[.X| The .X Object]]'''
| style="width: 25%; background-color: white;"|'''[[.ANIMATED| The .ANIMATED Object]]'''
|}

==Information and Tips==

===Commands===

*In Face (B3D) or AddFace (CSV) commands, vertices need to be given in order of adjacency. Complex polygons, meaning self-intersecting polygons, will lead to erratic results.

*The current implementation of openBVE produces incorrect illumination on the back face of faces created by Face2 (B3D) or AddFace2 (CSV). This behavior might change in future versions of openBVE so that both sides are correctly illuminated.

===Geometry===

*Avoid overly complex geometry where the end results are hardly noticable. Avoid using Cube and Cylinder commands (B3D/CSV) if parts of the cube/cylinder will not be visible. Do not create cylinder caps unless they are likely to be visible.

*To get smoothly curved objects, use custom normals with fewer faces instead of no custom normals with many faces.

===Textures===

*Try to create textures that wrap around objects by using texture coordinates appropriately. This will reduce or eliminate the need to change the texture when rendering, which is expensive.

*Use only textures which are of power-of-two size, e.g. whose sides are of length 1, 2, 4, 8, 16, 32, etc. Textures do not need to be square, though.

===Transparency===

*For best visual quality, every transparency has its overhead. Avoid using transparency at all if there are alternatives of similar implementational and geometric complexity.

*Use color-key transparency whenever possible. Avoid using alpha channels in textures or using Color (B3D) or SetColor (CSV) commands with an alpha setting at all costs.

*When it is necessary to use alpha, bear in mind that depth sorting will be used to determine the rendering order. There is no perfect real-time depth sorting algorithm, thus artifacts cannot be completely avoided.

*When using alpha, keep polygons parallel to each other, which will always render correctly. The worst case scenario is perpendicular faces. When such faces overlap on-screen, the rendering order might be erratic. Use perpendicular alpha faces only if they are unlikely to overlap on-screen.