Loading...
 
Vehicle parameters

Player vehicle parameters

DAT Parameters for Player Vehicleslink

Player Vehicles, or simply vehicles, is the name given for any vehicle that can be bought and used by the players.

The parameters and values are separated by = .

Parameter
Meaning
Value
Format
obj object type vehicle exactly this text
name vehicle name GTK_Truck simple text
copyright creator name Myself simple text
waytype way type road predetermined values
freight cargo type oel simple text
payload loading capacity 100 number
speed max speed 100 number
cost vehicle price 40000 number
runningcost operational cost 80 number
power power in KW 240 number
gear power translation 80 number em percentage
intro_month month of introduction 2 number
intro_year year of introduction 1994 number
retire_month month of retirement 8 number
retire_year year of retirement 2030 number
engine_type propulsion energy hydrogene predetermined values
weight vehicle weight 12 number
length vehicle length 12 number
sound starting sound of the vehicle 2 number or text
smoke smoke emitted when moving steam simple text
from Version 120.0.0
loading_time loading time in milliseconds 1000 number

'obj' Parameterlink

This parameter defines the object type. For a buy-able player vehicle obligatory it's vehicle.

'name' Parameterlink

This parameter is the name of the object. This name should not correspond with the name of an object file *.pak in the in-use pakset folder.

Used to show who made the object, generally the image. Use whatever you want to identify yourself, name or nickname.

'waytype' Parameterlink

This parameter defines the way the vehicle will travel. Its values are predetermined on Simutrans code and they might be:

Value
Way
Vehicles
road road Buses, Trucks
track railroad Trains
tram_track tram track Tram
monorail_track monorail track Monorail
maglev_track maglev track Maglev
narrowgauge_track narrowgauge track Trains
water water (sea, rivers, canals, lakes) Ships
air air Airplanes, Zeppelins

'freight' Parameterlink

The value of this parameter must be a valid object name of a type of goods. Allowable names are usually all good.*.pak files used in the pak directory. The values None, Passagiere and Post can be used in all paksets to transport nothing, passengers and post respectively.

The vehicle will be able to carry all goods with same category the good you have chosen. For example, the good you choose is in boxed goods category, so your vehicle will load all goods in boxed goods category.

For a list of goods that may be used in a specific pakset, consult the pakset documentation or the foruns.

'payload' Parameterlink

Maximum cargo the vehicle can carry. This value have some connection with the metric parameter from good parameter and with the freight parameter. For example, the value is 80 and freight is Oel; this will make the vehicle load 80m³ of petroleum.

'speed' Parameterlink

Determines the vehicle's maximum speed in Km/h. Remember that the vehicle will always respect the track maximum speed. This parameter must not be used for wagons.

'cost' Parameterlink

Determines the depot price. The value include cents so if value 4000000 is used price will be 40.000,00¢.

'runningcost' Parameterlink

Operational cost including cents for every Km. The value include cents so if value 80 is used in game cost will be 0,80¢/Km.

'power' Parameterlink

Vehicle power in kW. Value must be an integer number and will be exact, like 230 will give 230kW power. Must not be used on wagons.

'gear' Parameterlink

This parameter serves to adjust the actual speed of the vehicle, while still allowing its power to reflect actual prototype values. When deciding upon the speed a vehicle may travel at, the power of the vehicle is multiplied by the gear value.

Note, this parameter has very little to do with real life gear, but is simply an internal modifier.

Examples:
gear=80 and power=170, in-game power: 136KW.
gear=140 and power=170, in-game power: 238KW.
gear=100 and power=170, in-game power don't change: 170KW.

'intro_month' Parameterlink

Vehicle production starting month. It's the month the vehicle will be able to be bought on depots. This parameter must be the number corresponding to the month, 1 is January and 12 December.

This parameter only works with intro_year.

'intro_year' Parameterlink

Vehicle production starting year. It's the year the vehicle will be able to be bought on depots. This parameter must be a natural number, integer and positive, corresponding to the year. You can use intro_month together with this parameter.

This parameter is obligatory, without it the vehicle will never start its production and won't show in-game.

'retire_month' Parameterlink

Vehicle production retire month. It's the month the vehicle will become obsolete on depots. This parameter must be the number corresponding to the month, 1 is January and 12 December.

This parameter only works with retire_year.

'retire_year' Parameterlink

Vehicle production retire year. It's the year the vehicle will become obsolete on depots. This parameter must be a natural number, integer and positive, corresponding to the year. You can use retire_month together with this parameter.

This parameter is optional, without it the vehicle will never become obsolete and will be available forever.

'engine_type' Parameterlink

Sets the vehicle's propulsion type. If the vehicle needs another to move, like a train wagon, it must not be used. Values are pre-determined and can only be:

Value
Meaning
Bio Animal
sail Wind
steam Steam
diesel Diesel
electric Electricity
hydrogene Hydrogen
fuel_cell Fuel Cell
battery Battery

Additional: Hydrogen, battery and some electric engines are Fuel Cells, but on Simutrans they have specific categories. Water propelled engines are fuel cells too. More info on Wikipedialink-external.

Simutrans Experimental

'traction_type' Parameterlink

Specifies a list of engine types, as specified in the 'engine_type' parameter for a player vehicle, which may be built in the depot. Defaults to all engine types being available. Example:

traction_type[0]=bio
traction_type[1]=steam

'weight' Parameterlink

Vehicle's weight in tonnes, this will change the vehicle's acceleration depending of its power value. The weight will become bigger as the vehicle load goods. In Simutrans Experimental this parameter also limits usage of bridges and roads. Non integer values can be used with a dot. Ex.: 1.4.

'length' Parameterlink

Determines the vehicle length, the default is 8. Its purpose is enlarge or reduce the length value will be x/16 from tile size.

On first line each blue dot shows 1/4 of vehicle size, each line show the vehicle size with its associated length value
On first line each blue dot shows 1/4 of vehicle size, each line show the vehicle size with its associated length value

'sound' Parameterlink

This parameter specifies what sound will the vehicle make when departing from station.

There are two ways to specify the desired sound - by numerical ID (legacy support) and by file name (preferred).

Wav-files (*.wav) must be placed in folder sound of the pakset with this vehicle. In this folder is also a file sound.tab. Entries in this file map wav file names to numerical IDs.

If the vehicle uses no sound effect, the parameter can be completely omitted or given value -1.

For lists of wav files available in different paksets, see the pakset documentation.

'smoke' Parameterlink

This parameter defines what kind of emissions will emanate from the vehicle when running. Highly used on vehicles with steam and petrol derived engines.

The values of this parameter must match the the object name of the emission, as specified by what is used in the file name between smoke. and .pak .

For a list of available smoke files, see the documentation for each pakset documentation. For more details check smoke parameters.

'loading_time' Parameterlink

Constraint Parameterslink

Constraints are used to define which vehicles can be combined with this current vehicle to form a convoy.

If you omit the parameter the vehicle isn't restricted at all, which means it can not only run alone (as a one-vehicle convoy), but it can also be coupled to any other vehicle (of course also depending on the constraints of this other vehicle).

ConstrainPrevx will set the vehicles to be included before it, the vehicle can only be included if any of the vehicles on ConstrainPrev are included before it. If you set one ConstrainPrev as None the vehicle can be included if there's no vehicle before it. ConstrainNextx works the same, but with vehicles after it, if there's no ConstrainNext as None, you must buy any vehicle set on other ConstrainNext to finish the convoy.

Parameter
Vehicle name
Constraint[Prev][0] trainName_1
Constraint[Next][0] wagonName_2

since Version 121.0
constrait[prev][0]=any require a vehile in front (and same for [next] to require a trailing vehicle)

PNG Image for Vehicleslink

Not only the PNG image must be created but parameters must be included in the DAT file so the game can understand it. More general info about the image creation can be viewed in Creating the PNG image.

Parameter
Map direction
Example value
EmptyImage[S] going south image_name.Y.X
EmptyImage[N] going north image_name.Y.X
EmptyImage[E] going east image_name.Y.X
EmptyImage[W] going west image_name.Y.X
EmptyImage[SW] going southwest image_name.Y.X
EmptyImage[SE] going southeast image_name.Y.X
EmptyImage[NW] going northwest image_name.Y.X
EmptyImage[NE] going northeast image_name.Y.X

Loaded Vehicle Imagelink

You can change the graphics if the vehicle is loaded with any good, you can even included lot of products. For doing so, you need to include the following parameters to define the good with new images:

Parameter
Meaning
Example value
freightimagetype[0] product name sand
freightimagetype[1] product name coal


Then you include the parameter for the images itself just like EmptyImage parameters, the number between brackets must match the same on freightimagetype[X]. If the loaded image will be the same for all goods don't include the above parameter and remove the number brackets. If only some goods will have different images and all other good type will have the same image just add below parameters without the number brackets.

Parameter
Map direction
Example value
freightimage[0][S] going south image_name.Y.X
freightimage[0][N] going north image_name.Y.X
freightimage[0][E] going west image_name.Y.X
freightimage[0][W] going east image_name.Y.X
freightimage[0][SW] going southwest image_name.Y.X
freightimage[0][SE] going southeast image_name.Y.X
freightimage[0][NW] going northwest image_name.Y.X
freightimage[0][NE] going northeast image_name.Y.X

Exampleslink

Examples are modified versions from the pak64 open-source repository.

Clean. Use to edit
obj=vehicle
name=
copyright=
waytype=
freight=
payload=
speed=
cost=
runningcost=
power=
gear=
engine_type=
weight=
length=
intro_year=
intro_month=
retire_year=
retire_month=
EmptyImage[S]=image.Y.2
EmptyImage[N]=image.Y.4
EmptyImage[E]=image.Y.0
EmptyImage[W]=image.Y.6
EmptyImage[SW]=image.Y.7
EmptyImage[SE]=image.Y.1
EmptyImage[NW]=image.Y.5
EmptyImage[NE]=image.Y.3
freightImageType[0]=
freightimage[0][S]=image.Y.X
freightimage[0][N]=image.Y.X
freightimage[0][E]=image.Y.X
freightimage[0][W]=image.Y.X
freightimage[0][SW]=image.Y.X
freightimage[0][SE]=image.Y.X
freightimage[0][NE]=image.Y.X
freightimage[0][NW]=image.Y.X

Example PNG Image

This PNG lets you correctly align the vehicles in pak64. Green color is the car's front.

example PNG for pak64
example PNG for pak64

LKW_ERZ truck pak64
obj=vehicle
name=Heavy_ore_truck
copyright=MHz
waytype=road
freight=Eisenerz
payload=85
speed=43
cost=1050000
weight=15
power=480
gear=60
smoke=Diesel
RunningCost=1820
sound=1
intro_year = 1971
intro_month = 9
retire_year=2031
Constraint[Prev][0]=none
Constraint[Next][0]=none
EmptyImage[S]=LKW_ERZ.0.0
EmptyImage[N]=LKW_ERZ.0.1
EmptyImage[E]=LKW_ERZ.0.2
EmptyImage[W]=LKW_ERZ.0.3
EmptyImage[SE]=LKW_ERZ.0.4
EmptyImage[NW]=LKW_ERZ.0.5
EmptyImage[NE]=LKW_ERZ.0.6
EmptyImage[SW]=LKW_ERZ.0.7
FreightImage[S]=LKW_ERZ.1.0
FreightImage[N]=LKW_ERZ.1.1
FreightImage[E]=LKW_ERZ.1.2
FreightImage[W]=LKW_ERZ.1.3
FreightImage[SE]=LKW_ERZ.1.4
FreightImage[NW]=LKW_ERZ.1.5
FreightImage[NE]=LKW_ERZ.1.6
FreightImage[SW]=LKW_ERZ.1.7

PNG Image LKW_ERZ.png

LKW_ERZ.png modified for wiki
LKW_ERZ.png modified for wiki

BRV36 train pak64
obj=vehicle
name=BRV36
copyright=Saskia
waytype=track
engine_type=diesel
smoke=Diesel
freight=None
length=6
power=265
gear=250
speed=55
intro_year=1937
retire_year=1980
cost=750000
sound=2
RunningCost=316
weight=42
EmptyImage[S]=BRV36.2.0
EmptyImage[E]=BRV36.2.1
EmptyImage[SE]=BRV36.2.2
EmptyImage[SW]=BRV36.2.3
EmptyImage[N]=BRV36.2.4
EmptyImage[W]=BRV36.2.5
EmptyImage[NW]=BRV36.2.6
EmptyImage[NE]=BRV36.2.7

PNG Image BRV36.png

BRV36.png modified for wiki from veh-diesel.png
BRV36.png modified for wiki from veh-diesel.png

EnCo ship pak64
obj=vehicle
name=EnCo_Steel_Ship
copyright=Timothy Baldock
waytype=water
engine_type=diesel
smoke=Diesel
freight=Stahl
payload=320
speed=38
cost=2500000
weight=210
power=600
RunningCost=6800
intro_year=1920
intro_month=6
gear=200
Constraint[Prev][0]=none
Constraint[Next][0]=none
EmptyImage[S]=EnCo_SteelShip.0.0
EmptyImage[E]=EnCo_SteelShip.0.1
EmptyImage[SE]=EnCo_SteelShip.0.2
EmptyImage[SW]=EnCo_SteelShip.0.3
EmptyImage[N]=EnCo_SteelShip.0.4
EmptyImage[W]=EnCo_SteelShip.0.5
EmptyImage[NW]=EnCo_SteelShip.0.6
EmptyImage[NE]=EnCo_SteelShip.0.7
FreightImage[S]=EnCo_SteelShip.1.0
FreightImage[E]=EnCo_SteelShip.1.1
FreightImage[SE]=EnCo_SteelShip.1.2
FreightImage[SW]=EnCo_SteelShip.1.3
FreightImage[N]=EnCo_SteelShip.1.4
FreightImage[W]=EnCo_SteelShip.1.5
FreightImage[NW]=EnCo_SteelShip.1.6
FreightImage[NE]=EnCo_SteelShip.1.7

PNG Image EnCo_SteelShip.png

EnCo_SteelShip.png modified for wiki from TimothyShips.png
EnCo_SteelShip.png modified for wiki from TimothyShips.png

Lockhead_Tristar plane pak64
obj=vehicle
name=Lockhead_Tristar
copyright=MHz
waytype=air
engine_type=diesel
freight=Passagiere
payload=390
speed=894
# 3*213,5kN*880km/h
power=44700
gear=100
weight=165
cost=9000000
runningcost=4330
intro_year=1972
intro_month=1
sound=5
smoke=-1
Constraint[Prev][0]=none
Constraint[Next][0]=none
EmptyImage[S]=Lockhead_Tristar.3.0
EmptyImage[N]=Lockhead_Tristar.3.1
EmptyImage[E]=Lockhead_Tristar.3.3
EmptyImage[W]=Lockhead_Tristar.3.2
EmptyImage[SE]=Lockhead_Tristar.3.4
EmptyImage[NW]=Lockhead_Tristar.3.5
EmptyImage[NE]=Lockhead_Tristar.3.6
EmptyImage[SW]=Lockhead_Tristar.3.7

PNG Image Lockhead_Tristar.png

Lockhead_Tristar.png modified for wiki from planes-mhz.png
Lockhead_Tristar.png modified for wiki from planes-mhz.png

Page discussion

There are no discussions currently on this page Start discussion