.csv 路線格式

快速進行瀏覽…

目錄

■ 1. 縂概

一個CSV格式嘅路線可以由文本檔案建立成路線。

呢個檔案係純文本,並且可以用任意[字符編碼](/zh_hk/information/encodings.html),但係,我哋推薦作者用UTF-8編碼格式。解析數字數據時,使用[解析方法](/zh_hk/information/numberformats.html)係非常寬鬆嘅(特別指出嘅地方除外),我哋推薦呢個文件一般嚟講可以放喺 LegacyContent 文件夾(或一個內部包含* Railway *同* Train *目錄嘅文件夾)下嘅任何地方。文件名可以隨意,但擴展名(file extension)一定要係**.csv **。路線文件被從頭到尾逐行解析,每行被分割並被從左到右解析。

路線文件包括一系列指令, 用黎導入線路中用到的模型(Structure)結構命名空間 * 有 D 唔嚴謹地說, 在 csv 路線中同 “章節” “部分” 差不多。 ), 線路的屬性信息 (說明線路使用默認既列車同背景等信息), 文件的其餘部分係 track (軌道) 命名空間 (唔係好嚴謹咁講, 意思和段落差不多) 係一部分中, 主軌道位置 (一般以米為單位) 被用來描述軌道喺邊度轉彎, 車站嘅位置喺邊, 牆壁應當喺邊度開始、邊收檔, 以此類推。 講得明少少, track (軌道) 命名空間的指令是要放在最後嘅。

呢個格式默認咗一條遊戲默認的主軌道 (0号軌道), 唔可以指定它開始的位置, 都唔可以完佢。 遊戲中其他軌道同唔同嘅係, 佢由線路嘅開始一直延續到線路的終點, 代表住玩家駕駛嘅列車行駛的軌道。 除此之外, 遊戲中定義的其他軌道都係只供裝飾, 不能行駛嘅。 不過可以使用 [軌道循跡對象]/zh_hk/routes/xml/trackfollowingobject.html 嚟俾 AI 列車喺其它軌道上行駛。

可以幾何意義上咁曲同抬升默認的主軌道, 而其他軌道都系相對于主軌道定義的, 並隨主軌道曲起伏。 除非特別修改定義, 線路中每25米劃分為一個區間蚊, 特定的命令只有在區間蚊嘅邊界位置 (成25米位置) 才能發揮作用。 物體嘅放置 (尤其是在彎道上) 成日基於一個坐標係, 它的軸並不隨軌道彎曲, 而是掂掂地指向鄰近嘅下一個區間蚊。

➟ [仲可以查閱呢份 csv 格式嘅快速參考手冊。] (/zh_hk/routes/csv_quick.html)

■ 2. 句法

對於線路文件中每一行, 係開頭同結尾嘅 [空格] (/zh_hk/information/whitespaces.html) 會被統統忽略。 然後, 每行指令都會㩒逗號 (U+002C, 英文半角) 分割。 于是, 每行都會被看作這樣一個格式:

表達式內容1,* 表達式內容2*,* 表達式內容3*, …, *表達式內容n*

表達式內容主要有以下類別:

● 註釋

遊戲會忽略註釋。以分號(U+003B,英文半角)開頭嘅表達式都會被視為註釋。

● 軌道位置同長度
位置

一個非負的 嚴格格式 浮點數,代表一個主軌道位置。隨後嘅指令都將以此位置作為基準點。

部分1:部分2:…:部分n

係一個配合 options.unitoflength 的更加複雜嘅距離指定格式, 可用于非公制計量單位。 每一個 * 部分i* 都係 [嚴格格式] (/zh_hk/information/numberformats.html) 的浮點數。 * 部分1* 會比搭返 * 係數 1 *, * 部分2* 搭返 * 係數 2 *, 以此類推, 以此類推, 真正嘅主軌道位置係所有積的和。 呢個結果一定是非負嘅。 各部分被冒號 (U+003A, 英文半角嗰個) 分隔。 如果想了解如何設定系數, 請參見 Options.UnitOflength 節。

喺任何參數中使用距離的命令中,呢個冒號表示法就可以被使用,到時我哋會用綠色標出呢種情況。

n 個單位系數被使用 Options.UnitOflength 定義, 但係使用冒號表示法時輸入的部分卻少咗, 咁呢啲系數將會被嚮右匹配, 在左邊的會被忽略。 因此, 幾種表示方法係等傚嘅: 0:0:2,0:2, 同 2.

● 指令

冇參數嘅指令:

指令嘅名稱

含有參數嘅指令:

指令名稱 參數1;參數2;參數3;…;參數n 指令名稱(參數1;參數2;參數3;…;參數n)

有參數仲有後綴同編號的指令:

指令名稱(編號1;編號2;…;編號m) 參數1;參數2;參數3;…;參數n 指令名稱(編號1;編號2;…;編號m).後綴 參數1;參數2;參數3;…;*參數n * 指令名稱(編號1;編號2;…;編號m).後綴(參數1;參數2;參數3;…;參數n)

規則:

指令名稱 係大小寫都可以嘅。 編號和參數被分號 (U+003B, 英文半角) 隔開。 指令名稱、編號和參數都喺周圍嘅空格都係被忽略嘅, 括號周圍嘅空格都係被忽略的。

如果要使用編碼, 它必須被成對括號 (U+0028, 英文半角, 鍵盤9上面嗰個) 和 (u+0029, 英文半角, 鍵盤0上面嗰個) 括起來。 在使用編碼時至少要提供一個參數和一個 后缀

有兩個使用參數嘅方法變種, 除了 $ 開頭嘅預處理指令 ($chr, $rnd, $sub,…) 之外, 可以按照個人喜好二選一。 第 1 種方法: 參數被至少一個空格 (U+0020, 平時用嗰個) 和編碼、指令嘅大名與及 * 后缀 * 分開。 第 2 種方法: 參數被成對括號 (U+0028, 英文半角喺鍵盤9上面嗰個) 和 (U+0029, 英文半角喺鍵盤0上面嗰個) 括起來。 系第二種方法中, 當使用編碼時就必須使用 * 后缀 *。 在參數周圍嘅空格都會被忽略。

請注意在有些指令中, 不管係用邊種表示方法, 后缀 都係必需嘅。 在接下來的文檔中, 必需嘅 后缀 將被 加粗, 對於第一種方法加唔加均可嘅后缀將被使用灰色表示。

With 語法
With 字首

All subsequent commands that start with a period (U+002E) are prepended by Prefix. For example:

With Route
.Gauge 1435
.Timetable 1157_M

相當於

Route.Gauge 1435
Route.Timetable 1157_M

■ 3. Preprocessing

喺遊戲開始解析線路文件之前, 預處理指令將會被處理定替換。 預処理器會按照正常柯打分析呢啲以 $ 開頭嘅預処理命令。 $chr、$rnd 和 $sub 指令可以由嵌套, $if、$else 和 $endif 不能出現在另一個指令嘅括號入面。

預處理指令的語法不可以隨意使用, 必須以下面畀出嘅形式出現。


$Include(文件) $Include(文件:主軌道位置偏移量) $Include(文件1; 權值1; 文件2; 權值2; …)
文件 i: 要被導入本線路嘅另一個文件(CSV/RW)。 權值 i: 一個正浮點數, 表示對應嘅呢個文件被使用的可能性大小。 數越大, 呢個文件就越可能被隨機選中。

該指令按照權值隨機選出一個線路文件, 再將其內容導入本線路中。 因為該文件內容會比唔加修改直接在該指令的位置插入, 可能需要照顧吓 with 指令等, 唔好畀佢哋出現衝突。 如果參數中最後一個文件冇畀出權值, 它會被按1處理。

$include 指令喺幾個線路有大量重複內容時好有用, 可以單獨存入另一個文件只重複內容, 然後在主文檔中導入它, 以方便編碼。 呢個指令都可以被用來隨機選取線路代碼。 請注意導入的文件中都可以包含 $include 指令來引用更多嘅文件, 但係應該避免循環引用, 例如 A 導入 B 而 B 又導入 A。 要導入嗰個文件不應該使用. csv 作為格式擴展名 (或者用. include 係個方便區分好主意), 不然玩家可能會一不小心從主餐牌揀咗呢個 “唔完全嘅線路文件” 然後發現冇辦法加载 (除非嗰個文件本身就係一個單獨的線路, 跟住本來就想讓玩家加载它)。

如果任何一個 * 文件i* 被一個: * 主軌道位置偏移量 * 后缀, 嗰個文件中所有主軌道位置表達式都會被按照呢個量 ** 以米做單位 ** 偏移。 例如, $include (stations.include:2000) 會將 stations.include 文件中嘅所有內容系插入前都向前偏移2000米。 需要注意這些主軌道位置表達式係喺所有嘅預処理命令都被執行完先會畀做偏移處理。 意味着似 “1$rnd (2;8) 00” 這樣的主軌道位置表達式即管喺預処理前都唔係一個主軌道距離表達式, 但是它的隨機結果照樣會被進行偏移處理。

只有OpenBVE1.2.11版以上支持“主軌道位置偏移量”。


$Chr(Ascii編號)
***ASCII 編碼 ***: 一個在10~13 或20~127 範圍內的數, 代表一個擁有對應 ASCII 碼的字符。

這個指令會喺原位插入一個對應 ascii 碼 的字符。 如果想喺某個地方放置一個字符卻又唔想破壞指令語法結構 (比如企名入面開頭帶空格、帶括號逗號分號等, 如果唔咁加入就會被遊戲誤讀), 可以使用這個指令。 有關的字符有:

編號 意思 字符
10 新一行 newline
13 新一行 newline
20 空格 space
40 開括號 (
41 閂括號 )
44 逗號 ,
59 分號 ;

“$Chr(13)$Chr(10)“代表一次換行。插入$Chr(59)可能基於佢嘅位置被解釋為註釋開始或指令參數分隔符。


$Rnd(Start; End)
***最小值 ***: 一個整數, 代表隨機數可以取的最小值。 ***最大值 ***: 一個整數, 代表隨機數可以改嘅最大值。

這個指令會喺原位插入一個位於 最小值最大值 之間嘅隨機整數。 可以用呢個嚟畀線路添加一些隨機性。

Example for the use of the $Rnd directive:
10$Rnd(3;5)0, Track.FreeObj 0; 1
Possible outcome from the previous example is exactly one of these lines:
1030, Track.FreeObj 0; 1
1040, Track.FreeObj 0; 1
1050, Track.FreeObj 0; 1

$Sub(編號) = 表達式
編號: 一個非負整數, 代表要儲埋嘅變量編號。 表達式: 要存進這個變量的數字的值。

呢個指令只應該單獨出現, 它將會把 * 表達式 * 嘅值賦給編號為 * 編號 * 嘅呢個變量。 佢不在原位插入任何內容。 可以將一個隨機數存起來然後之後多次使用。 下面關於 $sub (編號) 的介紹處有幾個使用實例。

程序實現備註

雖然變量中都可以儲埋非數字的內容, 還是不能把逗號通過 $chr (44) 存返入去然後希望它在使用時會起分隔符嘅作用。 但是, 可以透過 $chr 啲分號 (59) 存返入去然後將調用時放佢喺開頭令一行成為註釋。 不過因為可以使用 $include 和 $if 嚟進行條件判斷, 所以並無必要噉做。


$Sub(編號)
編號:一個非負整數,代表要讀出的變量編號。

這個指令會喺原位插入編號為 * 編號 * 的變量的內容。 在讀取前呢個變量必須先被賦值。

Example for the use of the $Sub(Index)=Value and $Sub(Index) directives:
$Sub(0) = $Rnd(3; 5)
1000, Track.FreeObj $Sub(0); 47
1020, Track.FreeObj $Sub(0); 47
1040, Track.FreeObj $Sub(0); 47

在這個例子中, 三個 track.freeobj 指令都使用同樣嘅隨機數值, 所以三個物體會被擺喺同一條隨機嘅軌道邊。 如果使用三個 $rnd (3;5) 而唔係 $sub, 三個物體可能被單獨放在不同的軌道邊


$If(條件)
條件: 一個數值。 如果佢等於 0, 則代表 唔成立 嘅情況。 如果佢唔等於 0, 則代表 成立 嘅情況。

$if (如果…… 那麼) 指令讓遊戲只喺呢個條件成立, 即為非零值時才解析下面嘅線路指令。 $if 嘅後面必須有一個 $endif。 在 $if 和 $endif 之間都可以加個 $else 嚟表示條件係唔成立既時候要解析的指令。


$Else()

$Else (否則) 指令只喺前面嘅 $If 嘅條件係唔成立既時候先解析下面嘅線路指令。


$EndIf()

$EndIf 指令標識前面的 $If 指令的影響範圍到此結束。

Example of $If, $Else and $EndIf
$Sub(1) = 0
With Track
$If($Sub(1))
    1020, .FreeObj 0; 1
    1040, .FreeObj 0; 2
$Else()
    1030, .FreeObj 0; 3
$EndIf()
Another example of $If, $Else and $EndIf
With Track
1050
$If($Rnd(0;1)), .FreeObj 0; 4, $Else(), .FreeObj 0; 5, $EndIf()

可以嵌套 $If 指令。 如果將 $If/$Else/$EndIf 擺喺唔同嘅幾行度, 可以更清晰地表示張結構並令它更易讀 (例如第一個例子)。


最後, 當預處理結束, 線路中嘅所有指令都會被按照軌道位置重新排序。

Example of a partial route file:
1000, Track.FreeObj 0; 23
1050, Track.RailType 0; 1
10$Rnd(3;7)0, Track.Rail 1; 4
Track.FreeObj 1; 42
Preprocessing the $Rnd directive (assuming 3 is produced):
1000, Track.FreeObj 0; 23
1050, Track.RailType 0; 1
1030, Track.Rail 1; 4
Track.FreeObj 1; 42
Sorting by associated track positions:
1000, Track.FreeObj 0; 23
1030, Track.Rail 1; 4
Track.FreeObj 1; 42
1050, Track.RailType 0; 1

■ 4. Options 命名空間

這個命名空間入面嘅指令設置一些基本設置, 並影響其他指令既實際處理效果。 所以應當在開始編寫寫其他指令之前使用這些指令都較只設置先掂。


Options.UnitOfLength FactorInMeters1; FactorInMeters2; FactorInMeters3; …; FactorInMetersn
同米嘅換算系數 i: 一個浮點數, 表示一個單位等於幾多米。 * 同米嘅換算系數 1 * 的默認值係 1, 其他的默認值都係0。

這個指令可以被用來改變其他指令使用的長度單位。 當同形如 * 部分1*:* 部分2*:…:* 部分n* 的主軌道位置一起使用時, * 部分i* 會比搭返 * 系數 i*, 以此類推, 真正嘅主軌道位置係所有積的和。 更改了長度單位時, 你都應同時使用 Options.BlockLength 將區間蚊長度也設為相應單位。

換算系數的幾個示例:

所需單位 轉換係數
英里 1609.344
20.1168
1
市丈 0.9144
英尺 0.3048

在下面的示例中, 會被 Options.UnitOfLength 影響嘅指令參數會被用綠色表示。


Options.UnitOfSpeed 與千米每時的換算係數
FactorInKmph同千米每时嘅換算系數: 一個浮點數, 表示一個單位等於幾多千米每时。 默認值是1。

這個指令可以被用來改變其他指令使用嘅速度單位。 換算系數的幾個示例:

單位 換算係數
米每秒 3.6
英里每小時 1.609344
千米每小時 1

在下面的示例中, 會被 Options.UnitOfSpeed 影響嘅指令參數會被用藍色表示。


Options.BlockLength 長度
長度: 一個正浮點數, 表示區間蚊嘅長度, 默認 嘅單位係 。 默認值係25米。

此指令可以設置隔蚊嘅長度。 係一個全局設置, 一旦設置, 唔可以來回更改。 如果在此指令之前調用了選項. 單位長度, 長度 將使用選項. 單位長度作為單位。


Options.ObjectVisibility 模式
模式: 遊戲判斷一個物體是否可視採用的算法。 默認值係 0 (原版)。

模式 嘅選項:

0: 原版: 當該物體所在的區間舊已經被玩家通過, 遊戲就認為呢個物體不再可見, 都唔再加载顯示呢個物體。 遊戲不會顯示任何玩家後方嘅物體。 在朝前睇時唔會有任何問題, 但當向後看時所有物體都會消失, 且沒有任何途徑可解決。 自相交的軌道 (例如環綫) 唔會畀正確顯示。 該設置會造成唔正確且無法解決的視覺效果, 保留且默認採取該設置只係為咗兼容一些老線路。 請唔好喺新線路中採用這個設置。 1: 基於軌道: 遊戲仍然會加载列車後方可視範圍內嘅物體。 係按照軌道位置計算嘅。 可惜自相交的軌道 (例如環綫) 都係唔會俾正確顯示。 推薦添加這個設置。

Options.SectionBehavior 模式
模式:track.section 指令應當被如何理解。 默認值係 0 (默認)。

模式 嘅選項:

0: 默認: track.section * 緊狀態 0*; * 狀態 1*; …; * 狀態n* 中, 任何一個 * 狀態i* 都代表當一個閉塞區間的前方有 *i* 個閉塞區間清空時要傳達畀信號機嘅信號狀態。 **1**: 簡化: track.section * 緊狀態 0*; * 狀態 1*; …; * 狀態n* 中, 每個閉塞區間的信號狀態都係比佢前面一個閉塞區間嘅狀態值要高嘅最小值。

Options.CantBehavior 模式
模式:Track.Curve 指令應當被如何理解。 默認值係 0 (忽略符號)

模式 嘅選項:

0: 忽略符號: Track.Curve 中 cantinmillimeters 參數係冇符號嘅, 符號會被忽略, 軌道總是會向彎道中心傾斜嚟提供彎道嚮心力。 軌道唔會喺直路段斜。 1: 保留符號: Track.Curve 中 cantinmillimeters 參數是有符號嘅, 正值會使軌道向彎道中心傾斜, 負值會使軌道向彎道外側傾斜。 軌道會喺直路段斜, 正值使軌道右傾, 負值使軌道左傾。

Options.FogBehavior Mode
Mode: The mode determining how the Track.Fog command is processed. The default value is 0 (Block-based).

▸ Available options for Mode:

0: 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.
1: Interpolated: Fog color and ranges are interpolated between adjacent Track.Fog commands. This behavior mimicks Track.Brightness.

Options.CompatibleTransparencyMode Mode
Mode: The mode determining how transparencies are processed in BVE2/ BVE4 objects which use a restricted color pallet. This may be used on a per-route basis to override the value set in ‘Options’.

▸ Available options for Mode:

0: Off: Colors are matched specifically. If the specified transparent color does not exist within the color pallet, no transparency will be added.
1: On: Fuzzy matching. If the texture uses a restricted color pallet, the transparent color will be clamped to the nearest available color in the pallet.

Options.EnableBveTsHacks Mode
Mode: The mode determining whether various hacks are applied in order to fix BVE2 / BVE4 content. This may be used on a per-route basis to override the value set in ‘Options’.

▸ Available options for Mode:

0: Off: Hacks are disabled.
1: On: Hacks are enabled.

■ 5. The Route namespace

Commands from this namespace define general properties of the route.


Route.Comment Text
Text: The route comments which appear in the route selection dialog.

如果需要插入換行、逗號之類的字符,必須使用$Chr。


Route.Image File
File: The file name of the image which appears in the route selection dialog, relative to the route’s folder.

Route.Timetable Text
Text: The text which appears at the top of the default timetable.

如果需要插入換行、逗號之類的字符,必須使用$Chr。


Route.Change Mode
Mode: The mode for the train’s safety system to start in. The default value is implementation-specific.

▸ Available options for Mode:

-1: The safety system is activated and the service brakes are applied.
0: The safety system is activated and the emergency brakes are applied.
1: The safety system is deactivated and the emergency brakes are applied.

Route.Gauge ValueInMillimeters
ValueInMillimeters: A floating-point number representing the rail gauge, measured in millimeters (0.001 meters). The default value is 1435.
Note

Train.Gauge 係同 Route.Gauge 一樣


Route.Signal(AspectIndex).Set Speed
AspectIndex: A non-negative integer representing the signal aspect. The aspect 0 corresponds to red.
Speed: A non-negative floating-point number representing the allowed speed for this aspect, 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:

Index Aspect Speed
0 0 km/h
1 ●● 25 km/h
2 55 km/h
3 75 km/h
4 無限
5 ●● 無限

Route.RunInterval Interval0; Interval1; …; Intervaln-1
Intervali: 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 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.

Note

Route.RunInterval 係同 Train.Interval 一樣


Route.AccelerationDueToGravity Value
Value: A positive floating-point number representing the acceleration due to gravity in meters per second squared (m/s²). The default value is 9.80665.

Route.Elevation Height
Height: A floating-point number representing the initial height above sea level, by default measured in meters (m). The default value is 0.

Route.Temperature ValueInCelsius
Value: A floating-point number representing the initial temperature in Celsius. The default value is 20.

Route.Pressure ValueInKPa
ValueInKPa: A positive floating-point number representing the initial air pressure in kPa (1000 Pascal). The default value is 101.325.

Route.DisplaySpeed Unit; ConversionFactor
Unit: The textual units in which speed-related messages are to be displayed. ConversionFactor: The conversion factor between km/h and your custom unit of speed. For mph, this is 0.621371.

This command allows speed related messages (overspeed etc.) to be displayed in a custom unit, for example mph.


Route.LoadingScreen Image
Image: A path to a supported image file.

This command allows a custom image to be set as the loading screen background.


Route.StartTime Time
Time: The time at which the simulation is to start.

This command allows the start time of the simulation to be set.

Note

If this is not set or is invalid, the simulation will start at the arrival time set at the first station.


Route.DynamicLight Dynamic.XML
Dynamic.XML: A path to a Dynamic Lighting definition XML file.

This command may be used as an alternative to the Route.AmbientLight , Route.DirectionalLight and Route.LightDirection commands.

It allows the lighting to be varied using a time-based model, and is described fully on the following page:

Dynamic Lighting


Route.AmbientLight RedValue; GreenValue; BlueValue
RedValue: An integer ranging from 0 to 255 representing the red component of the ambient light. The default value is 160.
GreenValue: An integer ranging from 0 to 255 representing the green component of the ambient light. The default value is 160.
BlueValue: An integer ranging from 0 to 255 representing the blue component of the ambient light. The default value is 160.

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.


Route.DirectionalLight RedValue; GreenValue; BlueValue
RedValue: An integer ranging from 0 to 255 representing the red component of the directional light. The default value is 160.
GreenValue: An integer ranging from 0 to 255 representing the green component of the directional light. The default value is 160.
BlueValue: An integer ranging from 0 to 255 representing the blue component of the directional light. The default value is 160.

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.


Route.LightDirection Theta; Phi
Theta: A floating-point number representing the angle in degrees which controls the pitch of the light direction. The default value is 60.
Phi: A floating-point number representing the angle in 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.

illustration_light_direction

Converting a spherical direction (theta,phi) into a cartesian direction (x,y,z):
ƒ x = cos(theta) * sin(phi)
y = -sin(theta)
z = cos(theta) * cos(phi)
Converting a cartesian direction (x,y,z) into a spherical direction (theta,phi) for y²≠1:
ƒ theta = -arctan(y/sqrt(x2+z2))
phi = arctan(z,x)
Converting a cartesian direction (x,y,z) into a spherical direction (theta,phi) for y²=1:
ƒ theta = -y * pi/2
phi = 0

In the formulas above, cos(x) represents the cosine, sin(x) the sine, arctan(x) the inverse tangent, arctan(x,y) the two-argument inverse tangent and 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).


Route.InitialViewpoint Value
Value: An integer defining the initial camera viewpoint mode. The following values are valid:
0 : The camera will be placed in the cab. (Default)
1 : The camera will be placed in ‘Track Camera’ mode.
2 : The camera will be placed in ‘Flyby Camera’ mode.
3 : The camera will be placed in ‘Flyby Zooming Camera’ mode.

This command allows the route developer to place the initial camera in one of the alternate camera modes.


Route.DeveloperID

呢個命令係會比OpenBVE忽略

■ 6. The Train namespace

Commands from this namespace define route-train associations.


Train.Folder FolderName
Train.File FolderName
FolderName: The folder name of the default train to use on this route.

Train.Run(RailTypeIndex).Set RunSoundIndex
Train.Rail(RailTypeIndex).Set RunSoundIndex
RailTypeIndex: A non-negative integer representing the rail type as defined via Structure.Rail and used via Track.RailType.
RunSoundIndex: A non-negative integer representing the train’s run sound to associate to the rail type.

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 standards for further information.


Train.Flange(RailTypeIndex).Set FlangeSoundIndex
RailTypeIndex: A non-negative integer representing the rail type as defined via Structure.Rail and used via Track.RailType.
RunSoundIndex: A non-negative integer representing the train’s flange sound to associate to the rail type.

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 standards for further information.


Train.Timetable(TimetableIndex).Day.Load FileName
TimetableIndex: A non-negative integer representing the timetable index.
FileName: The file name for the daytime version of the timetable, relative to the train’s folder (1st 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.


Train.Timetable(TimetableIndex).Night.Load FileName
TimetableIndex: A non-negative integer representing the timetable index.
FileName: The file name for the daytime version of the timetable, relative to the train’s folder (1st 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.


Train.Gauge ValueInMillimeters
ValueInMillimeters: A floating-point number representing the rail gauge, measured in millimeters (0.001 meters). The default value is 1435.
Note

Train.Gauge 係同 Route.Gauge 一樣


Train.Interval Interval0; Interval1; …; Intervaln-1
ValueInSeconds: A floating-point number representing the time interval between the player’s train and the preceding train, measured in seconds. The default value is 0.
Note

Train.ValueInSeconds 係同 Route.RunInterval 一樣


Train.Velocity Speed
Speed: A positive floating-point number representing the maximum speed the preceding trains may travel at, 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.


Train.Acceleration

呢個命令係會比OpenBVE忽略


Train.Station

呢個命令係會比OpenBVE忽略

■ 7. The Structure namespace

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:

Structure.Command(StructureIndex).Load FileName

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:

Command: Remarks
Ground Defines objects for Cycle.Ground and Track.Ground.
Rail Defines objects for Track.Rail, Track.RailStart and Track.RailType.
WallL Defines left objects for Track.Wall.
WallR Defines right objects for Track.Wall.
DikeL Defines left objects for Track.Dike.
DikeR Defines right objects for Track.Dike.
FormL Defines left platforms edges for Track.Form.
FormR Defines right platforms edges for Track.Form.
FormCL Defines transformable left platforms for Track.Form. No ANIMATED objects supported.
FormCR Defines transformable right platforms for Track.Form. No ANIMATED objects supported.
RoofL Defines left roof edges for Track.Form.
RoofR Defines right roof edges for Track.Form.
RoofCL Defines transformable left roofs for Track.Form. No ANIMATED objects supported.
RoofCR Defines transformable right roofs for Track.Form. No ANIMATED objects supported.
CrackL Defines transformable left objects for Track.Crack. No ANIMATED objects supported.
CrackR Defines transformable right objects for Track.Crack. No ANIMATED objects supported.
FreeObj Defines objects for Track.FreeObj.
Beacon 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.

More information about forms, roofs and cracks…

Additionally, there is the Structure.Pole command, which has a slightly different syntax:

Structure.Pole(NumberOfAdditionalRails; PoleStructureIndex).Load FileName
NumberOfAdditionalRails: 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.
PoleStructureIndex: A non-negative integer representing the pole structure index.
FileName: The object file to load, relative to the 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.

■ 8. The Texture namespace

Commands from this namespace define which background images to use and how they are aligned.

illustration_background

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 creates 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.

As an alternative Dynamic or Object based backgrounds may be used. The implementation of these is described upon this page:

Dynamic & Object Based Backgrounds


Texture.Background(BackgroundTextureIndex).Load FileName
FileName: The texture file to load, relative to the Object folder.

This command loads a background image to be later used by Track.Back.

Note

If a dynamic or object based background is to be used, this must instead point to the appropriate XML file.


Texture.Background(BackgroundTextureIndex).X RepetitionCount
RepetitionCount: The number of times the background image is repeated in a full circle. The default value is 6.
Note

Ignored if using a dynamic or object based background.


Texture.Background(BackgroundTextureIndex).Aspect Mode
Mode: The mode of aspect ratio handling to use. The default value is 0 (fixed).

▸ Options for Mode:

0: Fixed: Use a fixed height for the cylinder.
1: Aspect: Preserve the aspect ratio of the image.
Note

Ignored if using a dynamic or object based background.

■ 9. The Cycle namespace

Cycle.Ground(GroundStructureIndex).Params GroundStructureIndex0; GroundStructureIndex1; GroundStructureIndex2; …; GroundStructureIndexn-1
GroundStructureIndex: A non-negative integer indicating the ground structure index for which a cycle is to be defined.
GroundStructureIndexi: A non-negative integer indicating a ground structure that has been previously loaded via Structure.Ground.

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 indefinitely, where GroundStructureIndex0 starts at track position 0. Technically, the i in GroundStructureIndexi chosen for a particular track position p is Mod[p / BlockLength, n].

Cycle.Rail(RailStructureIndex).Params RailStructureIndex0; RailStructureIndex1; RailStructureIndex2; …; RailStructureIndexn-1
RailStructureIndex: A non-negative integer indicating the rail structure index for which a cycle is to be defined.
RailStructureIndexi: A non-negative integer indicating a rail structure that has been previously loaded via Structure.Rail.

Consider the following definition:

With Structure
.Ground(0) grass.csv
.Ground(1) river.csv
.Ground(2) asphalt.csv

The following two codes will produce the same output:

With Track
0, .Ground 0
25, .Ground 1
50, .Ground 2
75, .Ground 0
100, .Ground 1
125, .Ground 2
; and so on…
With Cycle
.Ground(0) 0; 1; 2
With Track
0, .Ground 0

■ 10. The Signal namespace

Commands from this namespace define custom signals.


Signal(SignalIndex__)__.Load AnimatedObjectFile
SignalIndex: A non-negative integer representing the signal index.
AnimatedObjectFile: A reference to an animated object file, relative to the 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.


Signal(SignalIndex__)__.Load SignalFileWithoutExtension; GlowFileWithoutExtension
SignalIndex: A non-negative integer representing the signal index.
SignalFileWithoutExtension: A reference to a B3D/CSV/X object file representing the signal, relative to the Object folder, but without the file extension. Is required to be specified.
GlowFileWithoutExtension: An optional reference to a B3D/CSV/X object file representing the distance glow, relative to the 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
SignalFileWithoutExtension0.bmp
SignalFileWithoutExtension1.bmp
SignalFileWithoutExtension2.bmp
SignalFileWithoutExtensionn.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:

A B C D E F
illustration_glow_1 illustration_glow_2 illustration_glow_3 illustration_glow_4 illustration_glow_5 illustration_glow_6

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.

■ 11. The Track namespace

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.

Use of track positions

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.

● 11.1. Rails

Track.RailStart RailIndex; X; Y; RailType
RailIndex: A positive integer (>=1) indicating which rail index to use.
X: A floating-point number representing the horizontal distance from the player’s rail, by default measured in meters. Negative values indicate left, positive ones right.
Y: A floating-point number representing the vertical distance from the player’s rail, by default measured in meters. Negative values indicate below, positive ones above.
RailType: A non-negative integer referencing the rail type to use as defined by either a Structure.Rail or a Structure.Cycle command.

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.

This command can only be used at the beginning of a block.


Track.Rail RailIndex; X; Y; RailType
RailIndex: A positive integer (>=1) indicating which rail index to use.
X: A floating-point number representing the horizontal distance from the player’s rail, by default measured in meters. Negative values indicate left, positive ones right.
Y: A floating-point number representing the vertical distance from the player’s rail, by default measured in meters. Negative values indicate below, positive ones above.
RailType: A non-negative integer referencing the rail type to use as defined by either a Structure.Rail or a Structure.Cycle command.

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.

This command can only be used at the beginning of a block.

Using a RailIndex value of 0 is not valid for this command: Errata Note

Track.RailStart vs. Track.Rail

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.


Track.RailType RailIndex; RailType
RailIndex: A non-negative integer indicating which rail index to change. The player’s rail can be referred to with index 0. The default value is 0.
RailType: A non-negative integer referencing the rail type to use as defined by either a Structure.Rail or a Structure.Cycle command. The default value is 0.

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.

This command can only be used at the beginning of a block.


Track.RailEnd RailIndex; X; Y
RailIndex: A positive integer (>=1) indicating which rail index to use.
X: A floating-point number representing the horizontal distance from the player’s rail, by default measured in meters. Negative values indicate left, positive ones right.
Y: A floating-point number representing the vertical distance from the player’s rail, 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.

This command can only be used at the beginning of a block.

Using a RailIndex value of 0 is not valid for this command: Errata Note

Example of Track.RailStart, Track.Rail, Track.RailType and Track.RailEnd commands
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

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.


Track.Accuracy Value
Value: A non-negative floating-point number representing the accuracy of the track. The default value is 2.

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.


Track.Adhesion Rate
Rate: A non-negative floating-point number measured in percent representing the adhesion of the track. The default value is 100.

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.

● 11.2. Geometry

Track.Pitch Rate
Rate: A floating-point number measured in per thousands representing the pitch of the track. The default value is 0.

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:

Rate expressed through X and Y:
ƒ Rate = 1000 * Y / X

This command can only be used at the beginning of a block.


Track.Curve Radius; CantInMillimeters
Radius: A floating-point number representing the radius of the curve, by default measured in meters. The default value is 0.
CantInMillimeters: A floating-point number which represents the superelevation of a banked curve, 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.

This command can only be used at the beginning of a block.


Track.Turn Ratio
Rate: A floating-point number representing a turn. The default value is 0.

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:

ƒ Ratio = X / Z

A negative ratio represents a turn to the left, a positive one to the right. The value of 0 represents a straight track.

This command can only be used at the beginning of a block.

This command is deprecated - use Track.Curve instead.


Track.Height Y
Y: A floating-point number representing the height of the player’s rail, 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:

Example of a Track.Height command interpolated at 25m boundaries:
1000, Track.Height 1
1075, Track.Height 4
Example of Track.Height explicitly set each 25m to produce the same result:
1000, Track.Height 1
1025, Track.Height 2
1050, Track.Height 3
1075, Track.Height 4

This command can only be used at the beginning of a block.

● 11.3. Objects

Track.FreeObj RailIndex; FreeObjStructureIndex; X; Y; Yaw; Pitch; Roll
RailIndex: A non-negative integer representing the rail on which to place the object. The default value is 0.
FreeObjStructureIndex: A non-negative integer representing the object to place as defined via Structure.FreeObj. The default value is 0.
X: The x-offset from the (straight) rail, by default measured in meters. Negative values represent the left, positive ones the right. The default value is 0.
Y: The y-offset from the (straight) rail, by default measured in meters. Negative values represent below the top of the rails, positive ones above. The default value is 0.
Yaw: 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.
Pitch: 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.
Roll: 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.

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.


Track.Wall RailIndex; Direction; WallStructureIndex
RailIndex: A non-negative integer representing the rail on which to start or update the wall. The default value is 0.
Direction: An integer indicating which wall to use as described below.
WallStructureIndex: A non-negative integer representing the object to place as defined via Structure.WallL and Structure.WallR. The default value is 0.

▸ Options for Direction:

-1: The WallL object (left wall) is used.
0: Both the WallL and WallR objects are used.
1: The WallR object (right wall) is used.

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.

This command can only be used at the beginning of a block.


Track.WallEnd RailIndex
RailIndex: A non-negative integer representing the rail on which to end an existing wall.

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.

This command can only be used at the beginning of a block.


Track.Dike RailIndex; Direction; DikeStructureIndex
RailIndex: A non-negative integer representing the rail on which to start or update the dike. The default value is 0.
Direction: An integer indicating which dike to use as described below.
DikeStructureIndex: A non-negative integer representing the object to place as defined via Structure.DikeL and Structure.DikeR. The default value is 0.

▸ Options for Direction:

-1: The DikeL object (left dike) is used.
0: Both the DikeL and DikeR objects are used.
1: The DikeR object (right dike) is used.

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.

This command can only be used at the beginning of a block.


Track.DikeEnd RailIndex
RailIndex: A non-negative integer representing the rail on which to end an existing dike.

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.

This command can only be used at the beginning of a block.


Track.Pole RailIndex; NumberOfAdditionalRails; Location; Interval; PoleStructureIndex
RailIndex: A non-negative integer representing the rail on which to start or update the pole. The default value is 0.
NumberOfAdditionalRails: A non-negative integer representing the amount of additional rails covered by this pole (i.e. this rail, plus NumberOfAdditionalRails rails). The default value is 0.
Location: If 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: An integer multiple of the block length specifying the interval in which poles are placed.
PoleStructureIndex: A non-negative integer representing the object to place as defined via Structure.Pole. The default value is 0.

This starts or updates a pole on a specified rail. The object must have been loaded via Structure.Pole(NumberOfAdditionalRails; 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, Locationindicates 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.

This command can only be used at the beginning of a block.


Track.PoleEnd RailIndex
RailIndex: A non-negative integer representing the rail on which to end an existing pole.

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.

This command can only be used at the beginning of a block.


Track.Crack RailIndex1; RailIndex2; CrackStructureIndex

This deforms a specified object to fill the space between two Rails.

RailIndex1: A non-negative integer representing the first RailIndex.
RailIndex2: A non-negative integer representing the second RailIndex.
CrackStructureIndex: A non-negative integer representing the object defined in Structure.Crack

Note: If RailIndex1 is to the left of RailIndex2 (e.g. it’s X-cordinate is smaller), then the object defined in Structure.CrackL will be used.
Otherwise, the objects defined in Structure.CrackR will be used.


Track.Ground CycleIndex
CycleIndex: A non-negative integer representing the cycle of ground objects to place as defined via Structure.Ground or Cycle.Ground.

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.

This command can only be used at the beginning of a block.

● 11.4. Stations

Track.Sta Name; ArrivalTime; DepartureTime; PassAlarm; Doors; ForcedRedSignal; System; ArrivalSound; StopDuration; PassengerRatio; DepartureSound; TimetableIndex
Name: The name of the station. This is displayed in the timetable and in messages, so should not be omitted.
ArrivalTime: The time the player’s train is expected to arrive at this station. Special values may also appear - see below.
DepartureTime: The time the player’s train is expected to depart from this station. Special values may also appear - see below.
PassAlarm: Indicates whether the pass alarm device should remind the driver of stopping at this station. The default value is 0.
Doors: Indicates which doors should open at this station. The default value is 0.
ForcedRedSignal: Indicates whether the signal behind the last station stop should be red on a train approach. The default value is 0.
System: Indicates which built-in safety system should apply until the next station. The default value is 0.
ArrivalSound: The sound file to be played on arrival, relative to the Sound folder.
StopDuration: A positive floating-point number indicating the minimum stop duration in seconds, including door opening/closing times. The default value is 15.
PassengerRatio: 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.
DepartureSound: The sound file to be played before departure (departure time minus sound duration minus door closing time), relative to the Sound folder.
TimetableIndex: A non-negative integer representing the timetable to be shown from this station on as defined via Train.Timetable(TimetableIndex).

▸ Available options for ArrivalTime:

time: The train is expected to arrive at this particular time.
omitted: The train may arrive at any time.
P or L: All trains are expected to pass this station.
B: The player’s train is expected to pass this station, while all other trains are expected to stop.
S: The player’s train is expected to stop at this station, while all other trains are expected to pass.
S:time: The player’s train is expected to arrive at this particular time, while all other trains are expected to pass.

▸ Available options for DepartureTime:

time: The train is expected to depart at this particular time.
omitted: The train may depart at any time.
T or =: This is the terminal station. If ForcedRedSignal is set to 1, the departure signal will be held at red indefinately.
T:time: This is the terminal station. If 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: This is a station at which to “change ends”. See the description below.
C:time: This is a station at which to “change ends”. Changing ends will take place at the specified time unless StopDuration interferes. See the description below.
J:index: This is a station at which the train is “jumped” to the station specified by index. See the description below.
J:index:Time: This is a station at which the train is “jumped” to the specified by index. Jumping will take place at the specified time unless StopDuration interfers. See the description below.

▸ Available options for PassAlarm:

0: The pass alarm device does not remind the driver of stopping at this station.
1: The pass alarm device reminds the driver of stopping at this station.

▸ Available options for Doors:

L or -1: The left doors are expected to open at this station.
N or 0: No doors are expected to open at this station, i.e. the train should simply come to a hold.
R or 1: The right doors are expected to open at this station.
B: Both the left and right doors are expected to open at this station.

▸ Available options for ForcedRedSignal:

0: Signals are unaffected by this station.
1: The signal immediately following the last station stop is hold at red until the train reaches the stopping area and the departure time.

▸ Available options for System:

ATS or 0: ATS should be used from this station on. The following track is not be equipped with ATC.
ATC or 1: ATC should be used from this station on. The following track is equipped with ATC.

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.

Special Features:

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.

Similarly, stations can be marked as a “jump point” in the departure time. At such stations, when the departure time has been reached, the train will automatically jump to the specified station index.

The first occuring station in a route may not be of the Terminal type.


Track.Station Name; ArrivalTime; DepartureTime; ForcedRedSignal; System; DepartureSound
Name: The name of the station. This is displayed in the timetable and in messages, so should not be omitted.
ArrivalTime: The time the player’s train is expected to arrive at this station. Special values may also appear - see below.
DepartureTime: The time the player’s train is expected to depart from this station. Special values may also appear - see below.
ForcedRedSignal: Indicates whether the signal behind the last station stop should be red on a train approach. The default value is 0.
System: Indicates which built-in safety system should apply until the next station. The default value is 0.
DepartureSound: The sound file to be played before departure (departure time minus sound duration minus door closing time), relative to the Sound folder.

▸ Available options for ArrivalTime:

time: The train is expected to arrive at this particular time.
omitted: The train may arrive at any time.
P or L: All trains are expected to pass this station.
B: The player’s train is expected to pass this station, while all other trains are expected to stop.
S: The player’s train is expected to stop at this station, while all other trains are expected to pass.
S:time: The player’s train is expected to arrive at this particular time, while all other trains are expected to pass.

▸ Available options for DepartureTime:

time: The train is expected to depart at this particular time.
omitted: The train may depart at any time.
T or =: This is the terminal station. If ForcedRedSignal is set to 1, the departure signal will be held at red indefinately.
T:time: This is the terminal station. If 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: This is a station at which to “change ends”. See the description below.
C:time: This is a station at which to “change ends”. Changing ends will take place at the specified time unless StopDuration interferes. See the description below.

▸ Available options for ForcedRedSignal:

0: Signals are unaffected by this station.
1: The signal immediately following the last station stop is hold at red until the train reaches the stopping area and the departure time.

▸ Available options for System:

ATS or 0: ATS should be used from this station on. The following track is not be equipped with ATC.
ATC or 1: ATC should be used from this station on. The following track is equipped with ATC.

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:

PassAlarm 0 (not used)
Doors B (both doors must be opened)
ArrivalSound Not played
StopDuration 15
PassengerRatio 100
TimetableIndex 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.

The first occuring station in a route may not be of the Terminal type.


Track.Stop Direction; BackwardTolerance; ForwardTolerance; Cars
Direction: On which side to place a default stop post. The default value is 0.
BackwardTolerance: A positive floating-point number indicating the allowed tolerance in the backward direction, by default measured in meters. The default value is 5.
ForwardTolerance: A positive floating-point number indicating the allowed tolerance in the forward direction, by default measured in meters. The default value is 5.
Cars: A non-negative integer indicating for how many cars this stop point applies, or 0 for all cars. The default value is 0.

▸ Available options for Direction:

-1: A stop post is created on the left side.
0: No stop post is created.
1: A stop post is created on the right side.

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.

Example of a station with multiple stop points:
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

Track.Form RailIndex1; RailIndex2; RoofStructureIndex; FormStructureIndex
RailIndex1: The RailIndex to which the platform is bound.
RailIndex2: The secondary RailIndex to which the platform will deform. Special values may also appear- see below.
RoofStructureIndex: A non-negative integer representing the object to be placed as defined via Structure.Roof
FormStructureIndex: A non-negative integer representing the object to be placed as defined via Structure.Form and Structure.FormC

▸ Available options for RailIndex2:

Any current RailIndex: The form is deformed to meet the specified RailIndex.
L: The specified FormL, FormCL and RoofL objects are placed without deformation.
R: The specified FormR, FormCR and RoofR objects are placed without deformation.

Note: If RailIndex1 is to the left of RailIndex2 (e.g. it’s X-cordinate is smaller), then the objects defined in Structure.FormL, Structure.FormCL and Structure.RoofL will be used.
Otherwise, the objects defined in Structure.FormR, Structure.FormCL and Structure.RoofR will be used.

● 11.5. Signalling and speed limits

Track.Limit Speed; Post; Cource
Speed: A positive floating-point number representing the speed, by default measured in km/h, or 0 to indicate no speed restriction. The default value is 0.
Post: The side on which to place a default Japanese-style speed limit post. The default value is 0.
Cource: The directional indication. The default value is 0.

illustration_limit

▸ Options for Post:

-1: The post is placed on the left side of the track.
0: No post will be placed.
1: The post is placed on the right side of the track.

▸ Options for Cource:

-1: The post applies for a left-bound track.
0: The post does not indicate a particular direction.
1: The post applies for a right-bound track.

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 0, the speed restriction is released. By setting Post to either -1 or 1, a default Japanese-style speed post is placed at the respective side of the track. Setting Course to either -1 or 1 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 0, the setting of Course has no effect.


Track.Section a0; a1; a2; …; an
ai: A non-negative number specifying one of the section’s aspects.

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.

Default versus simplified section behavior

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.

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.

▸ Meanings of the ai terms:

a0: The aspect to show when this section is occupied by a train or otherwise hold at red.
a1: The aspect to show when this section is clear, but the immediately following section is red.
a2: The aspect to show when this section and the following section are clear, but the one immediately following the latter one is red.
an: The aspect to show when 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.

Example of a Track.Section command in conjunction with a Track.SigF command:
With Track
1000, .Section 0;2;4, .SigF 3;0;-3;-1

Track.SigF SignalIndex; Section; X; Y; Yaw; Pitch; Roll
SignalIndex: A non-negative integer representing the signal to be placed as defined via Signal(SignalIndex).Load.
Section: 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.
X: The X-coordinate to place the signal object, by default measured in meters. The default value is 0.
Y: The Y-coordinate to place the signal object, by default measured in meters. The default value is 0.
Yaw: 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.
Pitch: 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.
Roll: 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.

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:

▸ Default signals for SignalIndex:

3: A three-aspect signal having aspects red, yellow and green.
4: A four-aspect (type A) signal having aspects red, ●●yellow-yellow, yellow and green.
5: A five-aspect (type A) signal having aspects red, ●●yellow-yellow, yellow, yellow-green and green.
6: A repeating signal equivalent to that created by Track.Relay.

Track.Signal Aspects; Unused; X; Y; Yaw; Pitch; Roll
Track.Sig Aspects; Unused; X; Y; Yaw; Pitch; Roll
Type: The number of aspects for this signal. The default value is -2.
Unused: This argument is not used by openBVE.
X: The X-coordinate to place the signal object, by default measured in meters. The default value is 0.
Y: The Y-coordinate to place the signal object, by default measured in meters. The default value is 0.
Yaw: 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.
Pitch: 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.
Roll: 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.

▸ Options for Type:

illustration_signals_small
2: A two-aspect (type A) signal having aspects red and yellow.
-2: A two-aspect (type B) signal having aspects red and green.
3: A three-aspect signal having aspects red, yellow and green.
4: A four-aspect (type A) signal having aspects red, ●●yellow-yellow, yellow and green.
-4: A four-aspect (type B) signal having aspects red, yellow, ●●yellow-green and green.
5: A five-aspect (type A) signal having aspects red, ●●yellow-yellow, yellow, yellow-green and green.
-5: A five-aspect (type B) signal having aspects red, yellow, yellow-green, green and ●●green-green.
6: A six-aspect signal having aspects 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.

Example of a four-aspect type B signal without a post at x=-3 and y=5:
1000, Track.Signal -4;;-3;5
Example of a four-aspect type B signal including a post at x=-3 and y=4.8:
1000, Track.Signal -4;;-3;-1

Track.Signal is similar to using Track.Section and Track.SigF in one command.


Track.Relay X; Y; Yaw; Pitch; Roll
X: The X-coordinate at which to place the object, by default measured in meters. The default value is 0.
Y: The Y-coordinate at which to place the object, by default measured in meters. The default value is 0.
Yaw: 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.
Pitch: 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.
Roll: 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.

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.

● 11.6. Safety systems

Track.Beacon Type; BeaconStructureIndex; Section; Data; X; Y; Yaw; Pitch; Roll
Type: A non-negative integer representing the type of the beacon to be transmitted to the train.
BeaconStructureIndex: A non-negative integer representing the object to be placed as defined via Structure.Beacon, or -1 to not place any object.
Section: 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.
Data: An integer representing arbitrary data specific to the beacon type to be transmitted to the train.
X: The X-coordinate at which to place the object, by default measured in meters. The default value is 0.
Y: The Y-coordinate at which to place the object, by default measured in meters. The default value is 0.
Yaw: 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.
Pitch: 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.
Roll: 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.

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 the page about beacon standards for more information.


Track.Transponder Type; Signal; SwitchSystem; X; Y; Yaw; Pitch; Roll
Track.Tr Type; Signal; SwitchSystem; X; Y; Yaw; Pitch; Roll
Type: The type of the transponder. The default value is 0.
Signal: The signal this transponder references. The default value is 0.
SwitchSystem: Whether to automatically switch the safety system. The default value is 0.
X: The X-coordinate at which to place the object, by default measured in meters. The default value is 0.
Y: The Y-coordinate at which to place the object, by default measured in meters. The default value is 0.
Yaw: 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.
Pitch: 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.
Roll: 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.

▸ Options for Type:

illustration_transponders
0: An S-type transponder used by ATS-S. Usually placed 600m in front of a signal.
1: An SN-type transponder used by ATS-SN. Usually placed 20m in front of a signal.
2: An accidental departure transponder. Usually placed shortly behind a station stop.
3: An ATS-P pattern renewal transponder. Usually placed 600m, 280m, 180m, 130m, 85m or 50m in front of a signal, depending on the circumstances.
4: An ATS-P immediate stop transponder. Usually placed either 25m or 30m in front of a signal, depending on the circumstances.

▸ Options for Signal:

0: The upcoming signal is referenced.
1: The signal immediately behind the upcoming signal is referenced.
n: The n‘th signal behind the upcoming signal is referenced.

▸ Options for SwitchSystem:

-1: The transponder does not switch the train between ATS-SN and ATS-P.
0: The transponder automatically switches the train to ATS-SN for transponder types 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 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 the page about beacon standards for more information.

Go here to find out more about ATS-SN and ATS-P.

There is a tutorial available for the proper use of ATS-SN and ATS-P in route files, including all of the five transponders.


Track.AtsSn

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.


Track.AtsP

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.


Track.Pattern Type; Speed
Type: The type of speed restriction.
Speed: A non-negative floating-point number representing the speed restriction, by default measured in km/h.

▸ Options for Type:

0: A temporary speed restriction.
1: A permanent speed restriction.

This command defines a speed restriction for the built-in safety system ATS-P.

A temporary speed restriction (Type=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.

A permanent speed restriction (Type=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.


Track.PLimit Speed
Speed: A positive floating-point number representing the permanent speed restriction for ATS-P, by default measured in km/h.

This command is equivalent to Track.Pattern 1;Speed. See there for more information.

● 11.7. Miscellaneous

Track.Back BackgroundTextureIndex
BackgroundTextureIndex: A non-negative integer representing the background image to be displayed as defined via Texture.Background(BackgroundTextureIndex).

This command defines which background image to show from now on.

This command can only be used at the beginning of a block.


Track.Fog StartingDistance; EndingDistance; RedValue; GreenValue; BlueValue
StartingDistance: A floating-point number indicating the start of fog, by default measured in meters. The default value is 0.
EndingDistance: A floating-point number indicating the end of fog, by default measured in meters. The default value is 0.
RedValue: An integer ranging from 0 to 255 representing the red component of the fog. The default value is 128.
GreenValue: An integer ranging from 0 to 255 representing the green component of the fog. The default value is 128.
BlueValue: An integer ranging from 0 to 255 representing the blue component of the fog. The default value is 128.

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.

This command can only be used at the beginning of a block.


Track.Brightness Value
Value: A non-negative integer within the range from 0 to 255. The default value is 255.

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.

Example:
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

Track.Marker FileName; Distance
FileName: The file name for the marker image, relative to the Object folder.
Distance: A non-zero floating-point number indicating the length for which the marker image is displayed, by default measured in meters.

▸ Behavior for Distance:

negative value: The marker image starts to display at the Track.Marker command, and ends -Distance meters after the Track.Marker command.
positive value: The marker image starts to display 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.


Track.Marker FileName.xml

A Track.Marker command, linking to a single XML file is also supported. These allow more control over markers than is available in the routefile commands.

These are fully described on the the XML Markers page…


Track.TextMarker Text; Distance; FontColor
Text: The marker text to display. (No special characters supported).
Distance: A non-zero floating-point number indicating the length for which the text is displayed, by default measured in meters.
FontColor: The font color for this marker text

▸ Behavior for Distance:

negative value: The marker image starts to display at the Track.Marker command, and ends -Distance meters after the Track.Marker command.
positive value: The marker image starts to display Distance meters before the Track.Marker command, and ends at the Track.Marker command.

▸ Available options for FontColor:

1: Black.
2: Gray.
3: White.
4: Red.
5: Orange.
6: Green.
7: Blue.
8: Magenta.

This command creates a simple textual marker, which is added to the list of messages in the upper left-hand corner of the screen.


Track.PointOfInterest RailIndex; X; Y; Yaw; Pitch; Roll; Text
Track.POI RailIndex; X; Y; Yaw; Pitch; Roll; Text
RailIndex: A non-negative integer representing the rail for the point of interest.
X: A floating-point number representing the horizontal offset from the rail, by default measured in meters. Negative values indicate left, positive ones right.
Y: A floating-point number representing the vertical offset from the rail, by default measured in meters. Negative values indicate below, positive ones above.
Yaw: 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.
Pitch: 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.
Roll: 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.
Text: A textual representation of the point of interest.

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.


Track.PreTrain Time
Time: The 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.


Track.Announce FileName; Speed
FileName: The file name for the sound to play, relative to the Sound folder.
Speed: The reference speed in km/h for speed-dependant sounds, or 0 to play the sound speed-independently. The default value is 0.

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.


Track.Doppler FileName; X; Y
FileName: The file name for the sound to play, relative to the Sound folder.
X: A floating-point number representing the horizontal offset from rail 0, by default measured in meters. Negative values indicate left, positive ones right.
Y: A floating-point number representing the vertical offset from rail 0, 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.)


Track.Buffer

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.


Track.Destination Type; BeaconStructureIndex; NextDestination; PreviousDestination; TriggerOnce; X; Y; Yaw; Pitch; Roll
Type: Defines the types of trains for which this destination setter applies: -1 for AI trains only, 0 for all trains and 1 for the player train only.
BeaconStructureIndex: A non-negative integer representing the object to be placed as defined via Structure.Beacon, or -1 to not place any object.
NextDestination: An integer representing the destination value set when passing over this beacon in a forwards direction, or -1 to disable.
PreviousDestination: An integer representing the destination value set when passing over this beacon in a reverse direction, or -1 to disable.
TriggerOnce: If set to 0, this beacon will be triggered by all valid trains which pass over it. If set to 1, it will be triggered by the first valid train only.
X: The X-coordinate at which to place the object, by default measured in meters. The default value is 0.
Y: The Y-coordinate at which to place the object, by default measured in meters. The default value is 0.
Yaw: 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.
Pitch: 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.
Roll: 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.

This command places a special beacon, which sets the destination variable, available for use by plugins and animated objects. The object must have been loaded via Structure.Beacon(BeaconStructureIndex) prior to using this command.