TTWiki - User contributions [en-gb]

Variable:driving noise

2011-10-14T00:35:05Z

Maquinista: Add a interesting link

This describes the fields for defining the driving noise of vehicles.

Note: locotool 0.4.3 decodes field_11A[0-63] (= fields 0x11A to 0x159) as chars (8-bit), that is values between 0 and 255. Yet some of these variables are actually short integers (16-Bit: 0-65535). I have written these variables as, for example, field_11A[5&6], where you get the actual value with <tt>field_11A[6]*256+field_11A[5] </tt> (note the order).

Note 2: Adding new sounds can cause some problems in previous games an scenarios. You can find more information about it, and how to solve them [http://www.tt-forums.net/viewtopic.php?f=37&t=38392&start=0&hilit=jet+engine here].

== Variables ==
''startsndtype'' - Defines how the driving sound is played and how field_11A[0-63(?)] works.

=== startsndtype 0 ===
No driving sound. field_11A[0-63] empty.

=== startsndtype 1 ===
Normal driving sound type for carriages, sampling rate changes with speed.

''field_11A[0]'' - Unknown/Unused/Untested 
''field_11A[1&2]'' - Unknown

''field_11A[3&4]'' - Minimum speed for the sound to be played 
''field_11A[5]'' - [[#speed_dependency|Speed dependency]] 
''field_11A[6&7]'' - Base [[#sampling_rate|sampling rate]]

''field_11A[8]'' - Unknown

''field_11A[9]'' - [[#volume|Volume]] at low speed 
''field_11A[10]'' - Volume at high speed; Has to be greater than field_11A[9]

=== startsndtype 2 ===
Normal engine sounds, different sampling rate and volume for three modes of operation.

''field_11A[0]'' - Unknown/Unused/Untested

''field_11A[1&2]'' - [[#sampling_rate|Sampling rate]] for no-load (braking and idle) 
''field_11A[3]'' - [[#volume|Volume]] for no-load

''field_11A[4&5]'' - Sampling rate for load (driving with constant speed) 
''field_11A[6]'' - Volume for load

''field_11A[7&8]'' - Sampling rate for full-load (accelerating) 
''field_11A[9]'' - Volume for full-load

''field_11A[10&11]'' - [[#fade_speed|Fade speed]] from no-load or load to load or full-load sound 
''field_11A[12&13]'' - [[#fade_speed|Fade speed]] from full-load or load to load or no-load sound

''field_11A[14]'' - [[#fade_speed|Fade speed]] on vehicle placement or after breakdown 
''field_11A[15]'' - Unknown (could be another fade speed)

''field_11A[16]'' - [[#speed_dependency|Speed dependency]] for full-load; Other modes have constant sampling rates

=== startsndtype 3 ===
Vehicles with multi-ratio transmission with up to four gears.

''field_11A[0]'' - Unknown/Unused/Untested

''field_11A[ 1& 2]'' - Idle [[#sampling_rate|Sampling rate]] 
''field_11A[3]'' - Idle volume

''field_11A[ 4& 5]'' - Base Sampling rate

''field_11A[ 6& 7]'' - Speed for 2nd gear 
''field_11A[ 8& 9]'' - Sampling rate decrease for 2nd gear

''field_11A[10&11]'' - Speed for 3rd gear 
''field_11A[12&13]'' - Sampling rate decrease from 2nd to 3rd gear

''field_11A[14&15]'' - Speed for 4th gear 
''field_11A[16&17]'' - Sampling rate decrease from 3nd to 4th gear

''field_11A[18]'' - Driving [[#volume|Volume]] 
''field_11A[19]'' - Volume while accelerating

''field_11A[20&21]'' - [[#fade_speed|Fade speed]] for downshift 
''field_11A[22&23]'' - Fade speed for upshift

''field_11A[24]'' - Fade speed on vehicle placement or after breakdown 
''field_11A[25]'' - Unknown (could be another fade speed)

''field_11A[26]'' - [[#speed_dependency|Speed dependency]]

=== startsndtype 4-? ===
Unused/Untested. Locomotion vehicles use only type 0-3, yet there are plenty of unused fields left.

== Definitions ==
Explanations and suggested values for the various variables.

; <div id="volume">volume</div>
: Loudness. Common values range from 150 to 210.

; <div id="sampling_rate">sampling rate</div>
: Locomotion can play sounds with variable sampling rate and thus change pitch and tempo with the vehicles speed or mode of operation. Locomotion sound files are encoded with a sampling rate of 22050 Hz, so this would be a good value to start with. Note that the perceived volume varies with the pitch too.

; <div id="fade_speed">fade speed</div>
: Describes how long Locomotion fades from one sampling rate to another. The higher the value the shorter this fade time. Good values are around 200 for 16-bit values, and between 1 and 4 for 8-bits.

; <div id="speed_dependency">speed dependency</div>
: Describes how much the sampling rate increases with the speed of a vehicle. The lower the value the higher the pitch on full speed. I can't give an exact scale and it may depend on the base sampling rate aswell, however it is quite sensitive. Reasonable values are between 10 and 15, too small values can result in an integer overflow for the sampling rate.

[[Category:Locomotion development]]

Variable:vehicle flags

2011-10-13T00:54:48Z

Maquinista:

Various flags that define the vehicles behaviour.

; Bit_0 : Two coupled vehicles face opposite directions (used by all diesel and electrical engines)
; Bit_1 : Has a driving cab (trains with driving cabs or engines on either side don't turn around at the end of the track, but drive backwards)

; Bit_2 : Front axis can share bogie (field_24[0] defines shared bogie type)
; Bit_3 : Rear axis can share bogie (field_24[1] defines shared bogie type)
When Bit 2 and 3 are set, field_24[0] is for front bogie, field_24[2] for rear and field_24[1] is the actual vehicle.

; Bit_4 : Auto-placing evenly spreads new vehicles along the train, rather than just appending them (used only by TGV and Electra-Star power cars)
; Bit_5 : Is a power car and explicitly requires a driving cab with Bit_1 set.
; Bit_8
: land vehicles: Vehicle can not drive backwards (used by all trucks and busses, buggy for trains)
: planes: Use slope sprites for taxiing (used by old planes)
; Bit_D
: land vehicles: Controls the exhaust for an engine on its limit. If not set, the exhaust is continuous, otherwise it's more random (used by all steam engines).
: planes: Vehicle is a helicopter
; anytrack : Can it run on any type of track? (used by all buses and trucks)
; cancouple
: land vehicles: There can not be more than one of these vehicles on a train (used by all road vehicles)
: planes: Use slope sprites for landing (tilted backwards; used only by Concorde)
; dualhead : If the vehicle requires two locomotives (for example, the TGV)
; noannounce : If the news announcement disabled when this vehicle is invented
; rackrail : Can the vehicle use a rack rail?
; refittable : If the vehicle is refittable(mostly planes and passenger boats) (Refitting allows only mail, food, goods, and grapes. New capacity is passenger capacity divided by 2.5)

[[Category:Locomotion development]]

BridgeBuilding

2011-10-13T00:34:45Z

Maquinista:

== Bridge Graphics ==

Each bridge is made up of up to 124 images, included in their individual DAT file. All images must be present in the file, although images that are not needed can be replaced with a single transparent signal (using the special blue colour) to reduce file size. The following pages discuss further the creation of the graphics.

== Bridge Attributes ==

As with all objects, bridges have a series of attributes that affect how they can be built and what they look like. Below are some explained attributes with the values that they can take.

* [[variable:disabledtrackcfg|disabledtrackcfg]] - Decides what types of corners and slopes the bridge can be used for.

== Adding your bridges to the game ==

You must place your bridges in the game via other xml files, or they will not be selectable. The following tutorial explains how.

* [[AddingBridges|How to add your bridges]]

----

Back to [[Main Page]]

[[Category:Locomotion development]]

Sprite Palette

2011-10-13T00:34:10Z

Maquinista:

== Introduction ==

Locomotion graphics are palette-based. This means that when encoding your PNG files, the actual colours are ignored, only the index in the 256 colour palette matters, so you must ensure that the PNG uses the right palette, and that you're using the right colours of that palette.

== Making PNGs with the right palette ==

(to be written by someone who knows how this works)

== Palette entries ==

[[Image:Locopalette.gif|thumb|Locomotion Palette using/explaining itself.]]

This is a list of palette entries and what they look like in the game:

<table border>
<tr><th>Index<th>Meaning<th>Description</tr>
<tr><td>0<td>regular transparency<td>used for transparent pixels that are part of the object</tr>
<tr><td>1-6<td>(DirectX reserved)<td>These colours are used by some Locomotion sprites, mainly for icons and in game pictures, but should not be used on objects, if they are the results will not be what you expect(In screenshots they come out black because of the pallete change). These are the same colors as index 1-6 on the Windows 256 color pallete, but only INSIDE the game (DirectX).
<tr><td>7-9, 246-254<td>Primary company colour shades<td>These colours will be replaced by the selected primary company colour
<tr><td>202-213<td>Secondary company colour shades<td>These colours will be replaced by the selected secondary company colour
<tr><td>47<td>Glass mask color<td>This color is used when making a glass appearance, but only seem to work on stations so far.
<tr><td>255<td>chunked transparency<td>used for pixels that are not part of the object; only valid if the sprite tag has the "chunked" bit set; this should be your main background colour</table>

[[Category:Locomotion development]]

ObjectFiles:Original

2011-10-13T00:33:52Z

Maquinista: Removing some junk

Original Locomotion object files.

{| border="0" cellpadding="2" cellspacing="0"
|- align="left" style="background:#eeeeee" valign="top"
! ''Class'' || ''Type'' ||align="right"| Nr ||style="padding-left:10px"| Files

|-
| 00 || Interface ||align="right"| 1 ||
{| border="0" cellpadding="2" cellspacing="8"
|- valign="top" style="background:#f4f4f4"
| INTERDEF
|}

|- valign="top"
| 01 || Sounds ||align="right"| 42 || ( SND*.DAT )
{| border="0" cellpadding="2" cellspacing="8"
|- valign="top" style="background:#f4f4f4"
| SndA1 ... SndA3 SndCH1A SndCH1AS SndCH1B SndCH1BS SndCH1C
| SndCH1CS SndCH1D SndCH1DS SndD1 ... SndD12 SndE1 SndH1 ... SndH6
| SndS1 SndTD1 SndTD2 SndTR1 SndW1 ... SndW8
|}

|- valign="top"
| 02 || Currency ||align="right"| 13 || ( CURR*.DAT )
{| border="0" cellpadding="2" cellspacing="8"
|- valign="top" style="background:#f4f4f4"
| CurrDMRK CurrDOLL CurrEURO CurrFREN CurrGUIL
| CurrKRON CurrLIRA CurrNTDL CurrPNDS CurrPSTA
| CurrWON CurrYEN CurrZLOT
|}

|- valign="top"
| 03 || Vehical_Effects ||align="right"| 5 ||
{| border="0" cellpadding="2" cellspacing="8" style="background-color:transparent;margin-top:-10px"
|- valign="top" style="background:#f4f4f4"
| EXH1 || EXH2 || SPARK1 || STEAM || WWAKE1
|}

|- valign="top"
| 04 || Cliffs ||align="right"| 2 ||
{| border="0" cellpadding="2" cellspacing="8" style="background-color:transparent;margin-top:-10px"
|- valign="top" style="background:#f4f4f4"
| LSBROWN || LSROCK
|}

|- valign="top"
| 05 || Water ||align="right"| 1 ||
{| border="0" cellpadding="2" cellspacing="8" style="background-color:transparent;margin-top:-10px"
|- valign="top" style="background:#f4f4f4"
| WATER1
|}

|- valign="top"
| 06 || Ground_Tiles ||align="right"| 5 ||
{| border="0" cellpadding="2" cellspacing="8" style="background-color:transparent;margin-top:-10px"
|- valign="top" style="background:#f4f4f4"
| GRASS1 || GRASSBR || ROCK1 || ROCK2 || SAND1
|}

|- valign="top"
| 07 || Town_Names ||align="right"| 6 || ( ?TOWNNAM.DAT )
{| border="0" cellpadding="2" cellspacing="8"
|- valign="top" style="background:#f4f4f4"
| ATownnam || ETownnam || FTownnam || GTownnam || LTownnam || STownnam
|}

|- valign="top"
| 08 || Resource_Icons ||align="right"| 14 ||
{| border="0" cellpadding="2" cellspacing="8" style="background-color:transparent;margin-top:-10px"
|- valign="top" style="background:#f4f4f4"
| CHEMICAL COAL FOOD GOODS GRAIN
| GRAPES IRONORE LIVESTCK MAIL OIL
| PAPER PASS STEEL TIMBER
|}

|- valign="top"
| 09 || Fences_Walls ||align="right"| 8 ||
{| border="0" cellpadding="2" cellspacing="8" style="background-color:transparent;margin-top:-10px"
|- valign="top" style="background:#f4f4f4"
| BRWNWALG BRWNWALL
| FENCE1 FENCE1G
| SECFENCE SECFENCG
| STONWALG STONWALL
|}

|- valign="top"
| 0A || Train_Signals ||align="right"| 10 || ( SIG*.DAT )
{| border="0" cellpadding="2" cellspacing="8"
|- valign="top" style="background:#f4f4f4"
| SigC3 SigC4 || SigCSW SigCUS || SigS SigSD || SigSDL SigSL || SigSUS SigSW
|}

|- valign="top"
| 0B || Crossing_Signals ||align="right"| 2 ||
{| border="0" cellpadding="2" cellspacing="8" style="background-color:transparent;margin-top:-10px"
|- valign="top" style="background:#f4f4f4"
| LCROSS1 ... LCROSS4
|}

|- valign="top"
| 0C || Street_lights ||align="right"| 1 ||
{| border="0" cellpadding="2" cellspacing="8" style="background-color:transparent;margin-top:-10px"
|- valign="top" style="background:#f4f4f4"
| SLIGHT1
|}

|- valign="top"
| 0D || Tunnels ||align="right"| 2 ||
{| border="0" cellpadding="2" cellspacing="8" style="background-color:transparent;margin-top:-10px"
|- valign="top" style="background:#f4f4f4"
| TUNNEL1 || TUNNEL2
|}

|- valign="top"
| 0E || Bridges ||align="right"| 5 || ( BRDG*.DAT )
{| border="0" cellpadding="2" cellspacing="8"
|- valign="top" style="background:#f4f4f4"
| BrdgBRCK || BrdgGIRD || BrdgSTAR || BrdgSUSP || BrdgWOOD
|}

|- valign="top"
| 0F || Train_Stations ||align="right"| 5 ||
{| border="0" cellpadding="2" cellspacing="8" style="background-color:transparent;margin-top:-10px"
|- valign="top" style="background:#f4f4f4"
| Small Station->Medium Station-->City Station-->Large Station-->XL Station
|}

|- valign="top"
| 10 || Track_Additions ||align="right"| 3 ||
{| border="0" cellpadding="2" cellspacing="8" style="background-color:transparent;margin-top:-10px"
|- valign="top" style="background:#f4f4f4"
| Eletric 3rd Rail || Overhead Electric Wires || Reecue Rail
|}

|- valign="top"
| 11 || Tracks ||align="right"| 2 ||
{| border="0" cellpadding="2" cellspacing="8" style="background-color:transparent;margin-top:-10px"
|- valign="top" style="background:#f4f4f4"
| Railroad || Narrow Gauge Railroad
|}

|- valign="top"
| 12 || Road_Stations ||align="right"| 7 ||
{| border="0" cellpadding="2" cellspacing="8" style="background-color:transparent;margin-top:-10px"
|- valign="top" style="background:#f4f4f4"
| Passagners Stop || Passgner Terminus 1,2,3 || Cargo Loading Bay 1,2,3
|}

|- valign="top"
| 13 || Road_Additions ||align="right"| 1 ||
{| border="0" cellpadding="2" cellspacing="8" style="background-color:transparent;margin-top:-10px"
|- valign="top" style="background:#f4f4f4"
| RDEXCAT1
|}

|- valign="top"
| 14 || Roads ||align="right"| 6 || ( ROAD*.DAT )
{| border="0" cellpadding="2" cellspacing="8"
|- valign="top" style="background:#f4f4f4"
| One-Way Road || Rough Road || Road || Tram Rails || RoadUS1 || RoadUS2
|}

|- valign="top"
| 15 || Airport_Station ||align="right"| 4 ||
{| border="0" cellpadding="2" cellspacing="8" style="background-color:transparent;margin-top:-10px"
|- valign="top" style="background:#f4f4f4"
| Small Airport Medium Airport Large Airport || HPORT1
|}

|- valign="top"
| 16 || Ship_Station ||align="right"| 1 ||
{| border="0" cellpadding="2" cellspacing="8" style="background-color:transparent;margin-top:-10px"
|- valign="top" style="background:#f4f4f4"
| SHIPST1
|}

|-
| 17 || Vehicles ||align="right"| (165) ||


|- valign="top"
| || - Aircrafts - ||align="right"| 19 ||
{| border="0" cellpadding="2" cellspacing="8" style="background-color:transparent;margin-top:-10px"
|- valign="top" style="background:#f8f8f8"
| 707 737 747 777
| A320 A380 A5 AB139 Helicopter
| BAe146 C130 Hercules COMET Concorde
| S55 Helicopter DC3 DH16
| F27 F7 JU52 VISCOUNT
|}

|- valign="top"
| || - Ships - ||align="right"| 10 ||
{| border="0" cellpadding="2" cellspacing="8" style="background-color:transparent;margin-top:-10px"
|- valign="top" style="background:#f8f8f8"
| Cargo Ship Merchant Frigler
| Clipper Bulk Ship
| Steam Ferry Diesel Ferry
| SRN4 Hovercraft Hydrofoil
| Jetfoil Oil Tanker
|}


|- valign="top"
| || - Trains - ||align="right"| 100 ||
{| border="0" cellpadding="2" cellspacing="8" style="background-color:transparent;margin-top:-10px"
|- valign="top" style="background:#f8f8f8"
| 114 142 158
| 2EPB 36R
| 4F 4MT
| 460 508 656
| A3 A4
| AE47 ALCOCENT
| APT1 APT2 APT3
| BALDWIN1 BLACK5 C33 C56
| CATTLE1 CATTLE2 CATTLE3 CATTLEN1
| CE68
|}
|-
| || || ||
{| border="0" cellpadding="2" cellspacing="8" style="background-color:transparent;margin-top:-10px"
|- valign="top" style="background:#f8f8f8"
| CL20 CL37 CL47 CL55 CL58
| CL67 CL71 CL85 CL86 CL90
| COAL1 DASH7 DEH46 E8 EB35 EMU1
| ESTAR1 ESTAR2
| EWIV EWIVDT
| FLATBED1 FLATBED2 FLTBEDN1
| GE442 GE443 GE66
| GOODS1 GOODS2 GOODS3 GOODSN1
|}
|- valign="top"
| || || ||
{| border="0" cellpadding="2" cellspacing="8" style="background-color:transparent;margin-top:-10px"
|- valign="top" style="background:#f8f8f8"
| GRAINHP1 GRAINHP2
| HG23 HGE44 HGE442
| HOPPER HOPPER2
| HST JINTY JUBILEE
| MAILSW1 MAILSW4 MAILUS1 MAILUS2
| MK1 MK2 MK3
| OIL1 OIL2 OILN1
| OPENN1
|}
|-
| || || ||
{| border="0" cellpadding="2" cellspacing="8" style="background-color:transparent;margin-top:-10px"
|- valign="top" style="background:#f8f8f8"
| PCAR1 PCAR2 PCARSW1 PCARUS1 PCARUS2
| PVAN1 PVAN2
| RBE24 RE441 RE442
| SD70MAC SPECIAL ST8FT STANCORR
| SWISS1 SWISS2 SWISS3 SWISS4 SWISS5
| TGV1 TGV2
| USPACIF V2
|}

|- valign="top"
| || - Trams - ||align="right"| 5 ||
{| border="0" cellpadding="2" cellspacing="8" style="background-color:transparent;margin-top:-10px"
|- valign="top" style="background:#f4f4f4"
| Ce 2/2 Tram Be 4/4 Tram Coronation Tram Be 4/6 Tram || Combi Tram
|}

|- valign="top"
| || - Trucks,Bus - ||align="right"| 31 ||
{| border="0" cellpadding="2" cellspacing="8" style="background-color:transparent;margin-top:-10px"
|- valign="top" style="background:#f8f8f8"
| Ailsa Bus GM Classic CTRUCK1 ... CTRUCK4 FTRUCK1 ... FTRUCK4 GTRUCK1 ... GTRUCK4 HTRUCK1 ... HTRUCK4
| Leopard Bus MTRUCK1 ... MTRUCK3 RMT Bus TDH 5301 Bus Model 36R Bus TTRUCK1 ... TTRUCK4
| Vulcan VSD Bus WMC Bus
|}


|- valign="top"
| 18 || Trees ||align="right"| 39 ||
{| border="0" cellpadding="2" cellspacing="8" style="background-color:transparent;margin-top:-10px"
|- valign="top" style="background:#f8f8f8"
| BEECH BIRCH BIRCH2 BSPRUCE CACTUS1 CACTUS2 CACTUS3
| CHESTNUT COPBEACH DREDWOOD ELM FRISIA GFIR HCYPRESS HSTRAW
| ICYPRESS IYEW JAPCRAB JOSHUA KBFIR LCEDAR NASH NMAPLE
| OAK PCYPRESS QPALM RCEDAR RFIR ROBINIA SCPINE SCYPRESS
| SMAPLE SNOWBELL SPALM SVPINE WASH WILLOW YEW YUKKA
|}

|- valign="top"
| 19 || Snow ||align="right"| 1 ||
{| border="0" cellpadding="2" cellspacing="8" style="background-color:transparent;margin-top:-10px"
|- valign="top" style="background:#f4f4f4"
| SNOW
|}

|- valign="top"
| 1A || Climates ||align="right"| 6 ||
{| border="0" cellpadding="2" cellspacing="8" style="background-color:transparent;margin-top:-10px"
|- valign="top" style="background:#f4f4f4"
| CLIM1 ... CLIM6
|}

|- valign="top"
| 1B || Hill_shapes ||align="right"| 1 ||
{| border="0" cellpadding="2" cellspacing="8" style="background-color:transparent;margin-top:-10px"
|- valign="top" style="background:#f4f4f4"
| HS1
|}

|- valign="top"
| 1C || Buildings ||align="right"| 76 ||
{| border="0" cellpadding="2" cellspacing="8" style="background-color:transparent;margin-top:-10px"
|- valign="top" style="background:#f8f8f8"
| BLDALP1 ... BLDALP11 BLDCASTL BLDCRCH1 ... BLDCRCH3 BLDCTY1 ... BLDCTY29 BLDFOUNT
| BLDHALL1 ... BLDHOUS9 BLDHOU10 ... BLDHOU25 BLDLIGHT BLDOFF1 BLDPARK1
| BLDPYLON BLDSHOP1 BLDTRANS HQ1
|}

|- valign="top"
| 1D || Scaffolding ||align="right"| 1 ||
{| border="0" cellpadding="2" cellspacing="8" style="background-color:transparent;margin-top:-10px"
|- valign="top" style="background:#f4f4f4"
| SCAFDEF
|}


|- valign="top"
| 1E || Industrys_Buildings ||align="right"| 22 ||
{| border="0" cellpadding="2" cellspacing="8" style="background-color:transparent;margin-top:-10px"
|- valign="top" style="background:#f8f8f8"
| BREWERY CHEMWORK COALMINE COALPS
| FACTORY FARM FARMUS FOODPROC FOREST
| OILREFIN OILRIG OILWELL OREMINE
| PAPERMIL PRINTWRK
| SAWMILL SKICENT STEELMIL STOCKFRM
| VINEYARD WINDMILL WINERY
|}

|- valign="top"
| 1F || Regions ||align="right"| 3 ||
{| border="0" cellpadding="2" cellspacing="8" style="background-color:transparent;margin-top:-10px"
|- valign="top" style="background:#f4f4f4"
| REGALP || REGUK || REGUS
|}

|- valign="top"
| 20 || Competitors ||align="right"| 38 ||
{| border="0" cellpadding="2" cellspacing="8" style="background-color:transparent;margin-top:-10px"
|- valign="top" style="background:#f4f4f4"
| COMP1 ... COMP38
|}

|- valign="top"
| 21 || Scenario_text ||align="right"| 45 ||
{| border="0" cellpadding="2" cellspacing="8" style="background-color:transparent;margin-top:-10px"
|- valign="top" style="background:#f4f4f4"
| STEX000 ... STEX044
|}

|}
[[Category:Locomotion development]]

Variable:List

2011-10-13T00:33:07Z

Maquinista: /* Class 20 - Companies */

== All Known Variables ==

===Common===

'''auxdata[range]''' - Unknown
 '''basecostfact/buildcostfact''' - The cost of a bridge/track
 '''costfact''' - Purchase cost factor (final cost = basecost[costind]*costfact)
 '''costind''' - Purchase cost index (index into a table of base costs), lower means higher final costs
 '''[[variable:trackpieces|trackpieces]]''' - What trackpieces this track, trackmod, roadmod or train station has
 '''[[variable:description|description]]''' - The description of the object in various languages
 '''designed''' - Year object is designed, 0 if available from the begining
 '''numaux01''' - number of entries in aux_0 and aux_1
 '''numaux02ent''' - number of aux_2 array entries
 '''numaux03ent''' - number of aux_3 array entries
 '''numaux04ent''' - number of aux_4 array entries
 '''numaux05ent''' - number of aux_5 array entries
 '''nummods''' - Number of mods required (vehicles) or buildable (for track)
 '''obsolete''' - Year object becomes obsolete, 65535 if never
 '''[[variable:roadpieces|roadpieces]]''' - Same as [[variable:trackpieces|trackpieces]] but ONLY has smallcurve, tightcurve, normalslope, steelslope and reverse (for tram), and only for roads, and road stations
 '''salecostfact/sellcostfact''' - sale/sell cost factor of bridge/track (final cost = basecost[costind]*salecostfact)
 '''[[variable:sprite|sprite(range)]]''' - Inividual sprites
 '''[[variable:stringtable|stringtable(range)]]''' - A range of strings, mainly used for descriptions of objects
 '''[[variable:trackmod|trackmod(array)]]''' - Array of trackmods required for vehicle to run, or trackmods available in the case of tracks/roads

----

===Class 00 - Interface===

'''field_0[6]''' - Game Object Tooltip - first line: Object name.
 '''field_0[7]''' - Game Object Tooltip - next lines: Object data/Action info.
 '''field_0[8]''' - UI Tooltip (button info)
 '''field_0[9]''' - Action popups, "Can't build/remove ...", "Screenshot saved ...".
 '''field_0[10]''' - Win-Tabs: '''Player Items''' - Build New Vehicles, Vehicles, Stations, Player Status, Messages.
 '''field_0[11]''' - Win-Top - most non-player related windows.
 '''field_0[12]''' - Win-Tab: '''Map Objects''' - Towns, Industries, Scenario Editor - Object Selection.
 '''field_0[13]''' - Win-Tab: '''Player Construction''' - Build- Tracks/Roads, Docks/Airport.
 '''field_0[14]''' - Win-Tab: '''Map Construction''' - Construction -land, Scenario-Generator/Challenge.
 '''field_0[15]''' - Win-Tab - Overview Map.
 '''field_0[16]''' - Win-Tab: '''General''' - Options, About.
 '''field_0[18]''' - main buttons 1: File, Sound.
 '''field_0[19]''' - main buttons 2: Zoom, Rotate, View.
 '''field_0[20]''' - main buttons 3: Construction-Land, Tracks, Roads, Docks/Airport, Build Vehicles.
 '''field_0[21]''' - main buttons 4: Vehicles, Stations, Towns, Industries.
 '''field_0[22]''' - main buttons 5: Player Status, Performance.
 '''field_0[23]''' - main buttons 6: Time, Messages, Map.

Values:
* Palette-numbers 0-30, those are the 31 internal used color gradient sets.
* Other values are excepted but have no real use, and can give strange side effects.
* Value/order of palette sets -> player-status color-picker(LR/UD)

Linked to PlayerColor 1:
* (Win-top) '''Player Items''' & '''Player Construction'''.

Not Editable:
* Scenario Editor: [Back to Previous] & [Forward to Next] navigation buttons.
* Intro screen: Big green buttons.
* Warning message windows: "Are you sure ...", "Vehicle can't ...", etc.
* File windows: Load, Save, New game.
* Two player connection window.

----
===Class 02 - Currencies===

'''shiftnum''' - How many times to multiply pound value by 2
 '''zeroes''' - How many zeros after pound value

----
===Class 05 - Water===

Its as high as the Water-Level set in the map/scenario editor and absolutely flat in the beginning.
 '''field_0[2]''' = "2" (might be default water level)
 '''field_0[4]''' = "102" (might be ingame level changing price)
----
===Class 06 - Ground===

 '''field_3[0]''' - The number of levels stored in the object. I.e. for grass it is the number of levels of "grassiness".
 '''field_A[17]''' - The number rough tiles.

The total number of sprites stored in the file is: 82 * '''field_3[0]''' + '''field_A[17]''' + 7

The sprites are stored in groups of 19. '''field_3[0]''' groups for each zoom-level. The last zoom-level (the closest) also stores 6 plain textures in different shades after each group. Sprite index 16 within each group is often empty, as it is normally not seen.

Sprite 82 * '''field_3[0]''' is a height map color scale. Then comes three buttons or icons. Last is '''field_A[17]''' rough tiles.
----

===Class 08 - Cargo types===

'''decay1days''' - Duration of first decay rate
 '''decay1rate''' - First decay rate
 '''decay2rate''' - Second decay rate
; flags
: '''bit_2''' - Unknown
: '''refitoption''' - Does refitting a vehicle allow it to carry this cargo type?
'''paymentfactor''' - Payment factor
 '''paymentind''' - Payment index
 '''peakdays''' - Days at which payment remains at maximum
 '''unitweight''' - Weight per unit in 1/256 tons

----
===Class 09 - Fences===

'''Field_0[6]''' is always "15"
 '''Field_8''' is "2" or "5" (might set the height in 1/16 units)
 '''Field_9''' is always "8"

----
===Class 0A - Signals===

; field_0[2] - country signal built style + ?
: '''0''' - build signal on left side of track (british style)
: '''1''' - build signal on right side of track (american/european style)
: '''2''' - ?
: '''4''' - ?

'''field_0[5]''' - number of signal frames (4,7,10) -> signal states (2,3,4), frames = (states*3)-2
: input value seems to be fixed, other values where not accepted (locomotion loading lockup)
: signals have 8 directional images per frame group.

----
===Class 0B - Crossings===

'''field_7[1]''' - Number of frames of closing animation. 
'''field_7[2]''' - Number of frames of closed animation. 
'''field_7[5]''' - Introduction year.

This is the order of sprites. If You use animation frames, add 8, 16, 24... to these numbers:

[[File:Crossing.PNG]]

----

===Class 0C - Street Lights===

'''year[array]''' - The year the street lights get build

----
===Class 0D - Tunnel Entrances===

----
===Class 0E - Bridges===

'''[[variable:disabledtrackcfg|disabledtrackcfg]]''' - Decides what types of corners and slopes the bridge can be used for
 '''heightcostfact''' - Cost factor for bridge height
 '''maxheight''' - Maximum height for the bridge, in feet
 '''maxspeed''' - Maximum speed for the bridge, in mph
 '''noroof''' - Does the bridge have a roof? (?)
 '''pillarspacing''' - The space between the bridge pillars
 '''spanlength''' - Length of a bridge element, the BrickBridge has 1, the Steel Arch 2, the Steel Girder 2, the WoodBridge 1, the Suspension 4 parts to have one complete bow.
 '''field_9''' - The space between the bridge columns (153 Steel Arch, 153 Steel Girder, 2550 Brick, 24 Suspension, 255 Wood Bridge )

----
===Class 0F - Train Stations===

'''auxdata[range]''' - positions of cargo icons on stations
 '''field_0[12]''' - Bit 0, use company colored transparency effect (like Passenger Terminus)

auxdata: train stations (TRSTATx) (32 arrays * 57 fields)

* positions of cargo/passenger on train stations, probably same use in road stations (RDSTATx/RDSTATLx)
* the arrays are grouped in sets of 4, every set covers one direction (rail build-direction),
* 1 array per station tile.
* station cargo arrays are linked to the on-screen orientation of the track build-directions. '''aux_0[0,1,2,3]''' = BottomLeft -> TopRight (45') '''aux_0[4,5,6,7]''' = TopLeft -> BottomRight (135') '''aux_0[8,9,10,11]''' = TopRight -> BottomLeft (225') '''aux_0[12,13,14,15]''' = LowerRight -> UpperLeft (315') '''aux_0[16;31]''' = not sure, probably reserved for diagonal(map) stations (trains only)
* every array contains ofset values for one station/tile array fields are grouped in sets of 4 fields, (57-1)/4=14 icons per station '''aux_x[0]''' = general icon height offset for that array (screen +Y ofset) '''aux_x[+1,+2]''' = X + Y offset for cargo(non passenger) icon (ofset is map orientated) '''aux_x[+3,+4]''' = X + Y offset for passenger icon (offset is map orientated)

----
===Class 10 - Track mods===

'''isoverhead''' - 1 for catenary like look, 0 for extra rail-like look

----
===Class 11 - Tracks===

trackst.dat and trackng.dat (the object tree for *.dat object files seems to start here, for a lot of objects being linked to in it and those link to their subobjects...)

'''displayoffset''' - Vertical offset of vehicles in list windows (e.g. train list, new vehicle list, ...)
 '''bridge[array]''' - Array of bridges compatible for the track
 '''curvespeed''' - Speed of vehicles in curves of track (not mph)
 '''numbridges''' - Amount of bridge objects for the track
 '''numsignals''' - Amount of signal objects for the track
 '''numstations''' - Amount of stations objects for track
 '''signal[array]''' - Array of signals available for the track
 '''station[array]''' - Array of station objects for track
 '''[[variable:trackpieces|stationtrackpieces]]''' - What trackpieces supports a station
 '''tunnel''' - Tunnel object for track
 '''tunnelcostfact''' - Tunnel cost factor (final cost = basecost[costind]*tunnelcostfact)
 '''field_3[array]''' - [0] has something to do with disallowing junctions

----

===Class 12 - Road stations===

----
'''Field_B[0]''' - Describes the function of the road station, per below.
## Cargo Where Built Vehicles
-- ----- ----------- ---------
0 All Any straight (B)us, (T)rucks
1 All Any straight B,T
2 Passenger Any straight B,T, Trams**
3 Passenger Any straight B
4 Freight Any straight T
5 Freight Any straight T
6 X*
7 X*
8 All Ends of roads B,T
9 All Ends of roads B,T
10 Passenger Ends of roads B
11 Passenger Ends of roads B
12 Freight Ends of roads T
13 Freight Ends of roads T
14 X*
15 X*

* These values cause non-fatal crashes when loading scenario
** Possibly related to field_29 of trams?

===Class 13 - Road mods===

----
===Class 14 - Roads===
'''Field_B[0&1]''' - Maximum speed (16-Bit)

'''Field_B[2]''' - Unknown; Is "1" in general and not set in ROADRGH or ROADTRAM
 '''Field_B[7]''' - bitmask:
:''Bit_0'' - Is one way road
:''Bit_1'' - Appears in build-tracks menu (rather than build-roads) - used for trams, might trigger other things aswell
:''Bit_2'' - Road-like intersections; Vehicles can turn in any direction
:''Bit_3'' - Vehicle with the anytrack flag set can run on this road. Has other effects aswell, and Locomotion crashes if you change this for a road and load a savegame with it.
:''Bit_4'' - Unknown; Used by all roads
:''Bit_5'' - Unknown; Not used by original roads
:''Bit_6'' - Vehicles can overtake one another. When not set, Terminus stations become impossible. Vehicles still change side after turning if Bit_3 is set.
:''Bit_7'' - Unknown; Used by all roads
'''Field_B[8]''' - bitmask:
:''Bit_0'' - Can have street lights

'''Field_15[7]''' - numstations; Amount of stations objects for road
 '''numstations''' - Unknown/Unused
 '''Field_1E[6]''' - bitmask, sprites related:
:''Bit_0'' - Three tiles are overlaid (tram track - rail, sleepers and ballast)
:''Bit_1'' - Has a direction (ROADUS1); Twice as many sprites.

'''Field_1E[7]''' - [[#Common|nummods]]
 '''Field_29[0]''' - Unknown; Only used by ROADTRAM and set to "2"
 '''Field_29[5]''' - Precedence; Roads with higher numbers take precedence over lower roads, that means cities may upgrade the latter with the former. Cities only build roads with Field_B[7]:Bit_3 set.

----

===Class 15 - Airports===

'''[[allowedplanetypes]]''' - What plane types are allowed to land 
'''numspritesets''' - Number of sprite sets (sets of four sprites not counting the UI icon) included in the file 
'''numtiles''' - Number of tile definitions 
'''2x2tiles''' - Bit mask of tiles that are 2x2 (note, bit numbers are in hex!) 
'''minx''', '''miny''', '''maxx''', '''maxy''' - Extent of airport grid 
'''numnodes''' - Number of nodes (vertices) in aircraft movement pattern 
'''numedges''' - Number of edges connecting nodes in aircraft movement pattern 
'''field_B6''' - Bit mask of edges from entrance node to terminals (see [[Aircraft Movement Graph]])

'''spriteheight''' (auxdata) - defines height of all spritesets
: '''height[array]''' - Height of the spritesets
'''spriteanimframes''' (auxdata) - number of animation frames of the spritesets
: '''frames[array]''' - Number of frames, must be same for all frames of an animation

'''tile[array]''' (auxdata) - tile definitions for airport [[Layout]]
: '''spriteset[array]''' - list of spritesets to use on this tile
'''layout''' (auxdata) - place tiles for airport [[Layout]] 
'''node[array]''' - node definitions for [[Aircraft Movement Graph]] 
'''edge[array]''' - edge definitions for [[Aircraft Movement Graph]]

----

===Class 16 - Docks===

----
===Class 17 - Vehicles===

[[variable:VehicleList|Alphabetical list of all vehicles]] (*.dat file names)

'''colourtype''' - Which colour set to use if e.g. passenger vehicles have different colours
 '''[[variable:cargo|cargo]]''' - The cargo the vehicle can carry
 '''class''' - What does it run on, 0=rail, 1=road, 2=air, 3=water
 '''compatible[array]''' - Array of all compatible objects
 '''field_0[16]''' - The ID of the cargo, used in vehicles
 '''field_10E''' - Position of the Smoke or Steam (value sets height).
 '''field_4''' - Number of carriages on the vehicle
; type - Controls in which tab the vehicle is when you want to buy it
: '''0''' - Trains
: '''1''' - Busses
: '''2''' - Trucks
: '''3''' - Trams
: '''4''' - Planes
: '''5''' - Ships
; field_24
: '''length''' - Distance of the first pivot point from the start of the vehicle. For buses, trucks and trams this is the center of rotation, for trains it's the position of the front bogie. Unknown (0) for ships and planes.
: '''field_1''' - Distance of the rear bogie from the end of the vehicle.
: '''field_2''' - Index of the front bogie (255 for no bogie)
: '''field_3''' - Index of the rear bogie
: '''field_5''' - Effect position (spark, exhaust plume, etc.)
: '''spriteind''' - Index of the sprites (0-3 + [128 if reversed])
'''field_B4[0]''' - Number of animation frames for bogie #0 or the shadow (planes)
 '''field_B4[1]''' - Flags Array for bogie sprite #0 (see [[variable:sprites|sprites(array)]]) or the shadow (planes)
 '''field_B4[18]''' - Number of animation frames for bogie #1
 '''field_B4[19]''' - Flags Array for bogie sprite #1
 '''[[variable:vehicle_flags|flags]]''' - Various flags that define the vehicles behaviour.
 '''numcompat''' - Number of compatible objects, 0 if compatible with all
 '''power''' - Amount of power the vehicle generates, in horsepower (doesn't seem to have any effect on planes or ships)
 '''rackspeed''' - Top speed while on rack rail, or landing/holding pattern speed for planes
 '''reliability''' - Reliability of the vehicle, higher values allow a longer operating lifetime
 '''runcostfact''' - Running cost factor (final cost = basecost[runcostind]*runcostfact)
 '''runcostind''' - Running cost index (index into a table of base costs), lower means higher final costs
 '''speed''' - Top speed, in mph
 '''[[variable:sprites|sprites(array)]]''' - Sprite properties
 '''[[variable:tracktype|tracktype]]''' - Track object required for the vehicle to run
 '''visfxtype''' - How to draw the visual effect 'visualeffect'
 '''visualeffect''' - The object used as visualeffect
 '''wakefxtype''' - How to draw the wake effect 'wakeeffect' (doesn't exist in locotool 0.2)
 '''field_113''' - Distance of the two propeller screws for the wake effect
 '''weight''' - Weight of the vehicle, in tons

'''startsndtype''' - Defines how the driving sound is played and how field_11A[0-63(?)] works.
 '''startsnd''' - The sound the vehicle makes while driving
 '''[[variable:driving_noise|field_11A[0-63(?)]]]''' - Describes the driving noise

'''numsnd''' - Number of start sound effects (the kinds are set in the required object list)
 '''soundeffect[array]''' - Array of start soundeffects of the vehicle

----

===Class 18 - Trees===

'''height''' - Height of the tree in 1/16th height units
 '''field_4[2]''' - Number of tree viewpoint images (rotations) [1,2,4]. '''''n1'''''
 '''field_4[3]''' - Number of tree size images (growth) [1...8]. '''''n1'''''
 '''field_4[4]''' - (Bit-0) Tree has double season set - used for snow graphics (should realistically only go on coniferous trees)
 '''field_4[56]''' – (Bit-flag) Tree states, seasons + dying
: Bit 0 – Autum
: Bit 1 – Winter
: Bit 2 – Spring
: Bit 3 – Summer (default)
: Bit 4 – Dying
: Bit 5/7 - (not used/ignored)

'''''n1)''''' locked/protected/other values disable object.

----
===Class 1A - Climates===

'''firstseason''' - The season that the year starts with, [0,1,2,3]. '''''n1''''' 
'''seasonlength[array]''' - Number of days in the four seasons. 
: seasonlength[0] <- first season, set by firstseason.
: seasonlength[3] -> after this one, its firstseason again until end of year.
'''field_7[0]''' - Low snow level, starts at begin of Winter season. '''''n2''''' 
'''field_7[1]''' - High snow level, starts at begin of Spring season. '''''n2'''''

'''''n1)''''' locked/protected/other values disable object. 
'''''n2)''''' High >= Low, or object will be disabled.

Notes:
* seasons: Autum(0) Winter(1) Spring(2) Summer(3), 3 -> Australia/Southern hemisphere climates.
* snow traveling speed: 4 days per map level.
* field_7 value = (Level - 1) x 4 Where level is counting up from the lowest ground level (lowest ground is 0)
----

===Class 1B - Hill Shapes===

'''field_0[2]''' - number of hill height maps
 '''field_0[3]''' - number of mountain height maps

Notes:
* Last image is UI-icon for object-selection(SE)
* hill shapes will become a selectable option in object-selection(SE), if hill-dat files > 1
* max HF-image size 255x255. (ok, 256x256, but thats with some extra ribble effect)
* field_0[12] - bit 1 ... looks buggy to.

----
===Class 1C - Buildings===

'''cargo[array]''' - The cargo object it produces/accepts
; flags
: '''bit_0 = 1''' Use 2x2 tile size
: '''bit_1 = 1''' Include under "Miscellaneous Buildings"
: '''ishq''' Is company headquarters building
'''clearcostfact''' - Cost factor to clear the building
 '''numproduce[array]''' - Amount of first and second cargo produced. Maximum value of 255 = approx. 12 units/mo. Exceeding 255 is converted to mod[256], so increasing this number beyond 255 does not seem to help. Also, numproduce[0] is the amount added to the city population.
 '''numaccept[array]''' - Units of 1/8 cargo acceptance for the four cargo types
 '''useobject desc="cargo[array]" class="8">''' - First two array elements are types of cargo generated. All four types are accepted.
 
 '''aux_0, num=XX''' XX=Number of .pngs / 4
 '''<unknown name="field_0[0]" size="1">1</unknown>''' not sure what this value means, but seems to increase in order of height?
 
 '''aux_1'''
 '''<unknown name="field_0[X]" size="1">1</unknown>''' same as aux_0, except increments of x are 2x the aux_0 values, and the value is always 1
 
 '''aux_2[X]''' X=Number of different appearences for this building
 '''<unknown name="field_0[1]" size="1">1</unknown>''' value is the number of png tile to use for level 0, as defined in aux_0
 '''<unknown name="field_0[2]" size="1">2</unknown>''' value is the number of png tile to use for level 1, as defined in aux_1
 one entry for every storey of building height
----

===Class 1E - Industries===

'''firstyear''' - First year it can appear
 '''lastyear''' - Last year it can appear
 '''field_0[188]''' - Minimum number of buildings within industry area
 '''costind''' - Index of foundingpricetable
 '''costfactor1''' - How much costs a founding (must be more then 17 or loco.exe will crash)
; flags
: '''bit_8''' - Industry can only be built on water (Oil Rig)
: '''bit_10''' - Industry can be founded by user
: '''needall''' - If it needs all cargo types to produce
: '''canincreaseproduction''' - If it can increase production
: '''candecreaseproduction''' - If it can decrease production
'''produces[array]''' - The cargo object it produces
 '''accepts[array]''' - The cargo object it accepts
 '''fence[array]''' - The fence object to be placed around the industry

 '''numaux4ent''' = number of different building base tiles available
 '''aux4''' = groups of buildings/ 1, 23, 45, 56, etc. ************ Unverified
 '''aux5''' = range is aux4 variables, some sort of selection of aux4 to randomize industry appearence? ****** Unverified

----

===Class 20 - Companies===

'''spritesets''' - Bits 0..8 indicate to use those sprites, two each
 '''intelligence''' - Intelligence
 '''aggressiveness''' - Aggressiveness
 '''competitiveness''' - Competitiveness

[[Category:Locomotion development]]

Creating new Sprites with 3dsMax

2011-10-13T00:32:26Z

Maquinista: /* Creating new Buildings / Industries */

This pages deals with all aspects of creating new Sprites with the application 3d Studio Max 6.

If you are looking for a reference to create the needed *.xml file please refear to this list:

[[all known variables]]

== Basics ==

1. [[Camera Angles]]

2. [[Getting the sprites into the Game]]

----

== Creating new Tracks and Bridges ==

1 [[Basic Knowledge]]

----

== Creating new Vehicles ==

----

== Creating new Buildings / Industries ==

----

(page under developement, feel free to add content)

----
Back to [[Main Page]]

[[Category:Locomotion development]]

Camera Angles

2011-10-13T00:31:58Z

Maquinista:

The camera should be set up in Orthographic Projection. It should be aimed at the origin, from 45 degrees to the left, 45 degrees to the front, and 30 degrees up.

You'll know you have it right because the grid in 3dsm will resemble the isometric terrain layout in Locomotion.

[[Category:Locomotion development]]

Getting the sprites into the Game

2011-10-13T00:31:38Z

Maquinista: Add category

To get you're sprite into the game you need to create an XML see other sections of the wiki for this.

[[Category:Locomotion development]]

Basic Knowledge

2011-10-13T00:30:36Z

Maquinista: /* Track types */

=== General Layout ===

The first thing you have to understand is, that the tracks in the Locomotion engine are as good as flat, so you can't include bridges or whatsoever into your track sprites; these have to be made in the Bridge section (not yet done)

=== Preparations before Modelling ===

Second, before you start modelling in max you should create a dummy Mesh, which represents exactly one Locomotion world unit, which is 5x5x2.5, in which you should build your track model.
(I used a 50x50x25 unit Mesh)

It's important to understand that your model shouldn't be larger than said Mesh.

=== Track types ===

Now that we have the dummy Mesh, which represents 1 World unit; we're going to have a look on how many World units each type of track requiers.

In the following Chart, each black and grey dot represents one World unit, your modeled track peace must not leave these world units, or you are going to end up with a mess.

Straight track

[[image:streight.jpg]]

Diagonal Track
...

Narrow curve

[[image:curve2.jpg]]

Normal curve

[[Image:curve1.jpg]]

Wide Curve
...

S-Bend

[[image:sbend1.jpg]]

Slope
...

Narrow Slope
...

Sloped Normal Curve
...

----

Back to [[Creating new Sprites with 3dsMax]]

[[Category:Locomotion development]]

Creating new Sprites with 3dsMax

2011-10-13T00:30:18Z

Maquinista: /* Creating new Buildings / Industries */ Removing hidden spam

UsingLocoTools

2011-10-13T00:29:33Z

Maquinista: /* Basic Testing */

== Important Notes ==

Before using LocoTools it is recommended you back up your Locomotion .DAT files found in the ObjData folder. You can then restore the original version if you have any problems.

== Downloading & Installing ==

You can download the latest LocoTools version from [http://www.ttdpatch.net/loco/ http://www.ttdpatch.net/loco/]. I then recommend putting the unzipped files in a seperate folder in the ObjData directory. You will create alot of files and it is best to not mix them in with your .DAT files. Remember to keep the .dll with the executable or it won't work.

== Decoding Files ==

To decode your DAT files into an editable format, copy them from ObjData to your LocoTools folder and then simply drag the file onto the LocoTools executable. It will then create an .XML file in that directory and create a new folder for the images. The XML file contains all the variables for that object, such as cost and name, whilst all the graphics used by that object are stored as individual .PNG files in the seperate folder.

== Decoding Files with Parameters ==

By just double clicking on locotool.exe (or reading the readme.txt) you will notice some options/parameters:

 -p 'num' : choose company colours.
 -d : make a *.dat file for the demo version.
 -o 'path' : set base path for png files
 -q do not display error messages
 -s put all sprites in one *.png file (instead of each sprite in one *.png file)
 -u output all unknown entries, even if they are zero

 '''Simple usage of parameters'''
 right click locotool.exe and create a link of/to it.
 right click the link and select "Properties"/"Eigenschaften"
 change "Target"/"Ziel" from something like...
 C:\Windows\Desktop\locotool.exe
 ...to...
 C:\Windows\Desktop\locotool.exe -s -q
 ...by just adding your needed parameters there.
 now instead on locotool.exe drag and drop your *.dat file on locotool.lnk (the link you just created and edited) to use locotool.exe with your parameteters.

== Encoding Files ==

When you are happy with your changes, you can simply drag your updated .XML file onto the LocoTools executable. It will create a backup file of your old .DAT and create a new one for you. Simply drop this file into your ObjData folder and when you next run Locomotion, it will update itself with the new objects.

== Troubleshooting ==

If you are having problems, make note of the error message and use it to fix the problem. To avoid problems, ensure you have all the graphics files properly numbered in relation to the .XML file. Even if the graphic is not used, it needs to be present, but you can shrink it to a single transparent blue pixel to save on file space. If the problems persist, restore an old backup file.

== Basic Testing ==

'''If your custimized object shows up in the scenario editor''' when you click "advanced menu" and the right table, your object basically works.

 '''If it does not show up in the scenario editor''' you might have done something wrong in the first line that looks like:
 object class="0x95" subclass="0x11827C" name="AIRPORT2"><chunk compression="1"
 "AIRPORT2" should be the filename (unique, no duplicates allowed) and exactly 8 letters long (including spaces, not longer not shorter).
 Also check each line for the correct "structure" (accidently broken or partly missing lines).

 '''If it shows up in the scenario editor but not ingame''' you need to change (decompile and compile) your trackst.dat file manually, your kind of object might be listed there, but not the object you just added.
 If so, add a line with your object filename and increase the matching "numobjects" variable by one.
 also scheck if the scenarios year is not too early for your object.

[[Category:Locomotion development]]

Variable:driving noise

2011-10-13T00:29:20Z

Maquinista: /* Definitions */

This describes the fields for defining the driving noise of vehicles.

Note: locotool 0.4.3 decodes field_11A[0-63] (= fields 0x11A to 0x159) as chars (8-bit), that is values between 0 and 255. Yet some of these variables are actually short integers (16-Bit: 0-65535). I have written these variables as, for example, field_11A[5&6], where you get the actual value with <tt>field_11A[6]*256+field_11A[5] </tt> (note the order).

== Variables ==
''startsndtype'' - Defines how the driving sound is played and how field_11A[0-63(?)] works.

=== startsndtype 0 ===
No driving sound. field_11A[0-63] empty.

=== startsndtype 1 ===
Normal driving sound type for carriages, sampling rate changes with speed.

''field_11A[0]'' - Unknown/Unused/Untested 
''field_11A[1&2]'' - Unknown

''field_11A[3&4]'' - Minimum speed for the sound to be played 
''field_11A[5]'' - [[#speed_dependency|Speed dependency]] 
''field_11A[6&7]'' - Base [[#sampling_rate|sampling rate]]

''field_11A[8]'' - Unknown

''field_11A[9]'' - [[#volume|Volume]] at low speed 
''field_11A[10]'' - Volume at high speed; Has to be greater than field_11A[9]

=== startsndtype 2 ===
Normal engine sounds, different sampling rate and volume for three modes of operation.

''field_11A[0]'' - Unknown/Unused/Untested

''field_11A[1&2]'' - [[#sampling_rate|Sampling rate]] for no-load (braking and idle) 
''field_11A[3]'' - [[#volume|Volume]] for no-load

''field_11A[4&5]'' - Sampling rate for load (driving with constant speed) 
''field_11A[6]'' - Volume for load

''field_11A[7&8]'' - Sampling rate for full-load (accelerating) 
''field_11A[9]'' - Volume for full-load

''field_11A[10&11]'' - [[#fade_speed|Fade speed]] from no-load or load to load or full-load sound 
''field_11A[12&13]'' - [[#fade_speed|Fade speed]] from full-load or load to load or no-load sound

''field_11A[14]'' - [[#fade_speed|Fade speed]] on vehicle placement or after breakdown 
''field_11A[15]'' - Unknown (could be another fade speed)

''field_11A[16]'' - [[#speed_dependency|Speed dependency]] for full-load; Other modes have constant sampling rates

=== startsndtype 3 ===
Vehicles with multi-ratio transmission with up to four gears.

''field_11A[0]'' - Unknown/Unused/Untested

''field_11A[ 1& 2]'' - Idle [[#sampling_rate|Sampling rate]] 
''field_11A[3]'' - Idle volume

''field_11A[ 4& 5]'' - Base Sampling rate

''field_11A[ 6& 7]'' - Speed for 2nd gear 
''field_11A[ 8& 9]'' - Sampling rate decrease for 2nd gear

''field_11A[10&11]'' - Speed for 3rd gear 
''field_11A[12&13]'' - Sampling rate decrease from 2nd to 3rd gear

''field_11A[14&15]'' - Speed for 4th gear 
''field_11A[16&17]'' - Sampling rate decrease from 3nd to 4th gear

''field_11A[18]'' - Driving [[#volume|Volume]] 
''field_11A[19]'' - Volume while accelerating

''field_11A[20&21]'' - [[#fade_speed|Fade speed]] for downshift 
''field_11A[22&23]'' - Fade speed for upshift

''field_11A[24]'' - Fade speed on vehicle placement or after breakdown 
''field_11A[25]'' - Unknown (could be another fade speed)

''field_11A[26]'' - [[#speed_dependency|Speed dependency]]

=== startsndtype 4-? ===
Unused/Untested. Locomotion vehicles use only type 0-3, yet there are plenty of unused fields left.

== Definitions ==
Explanations and suggested values for the various variables.

; <div id="volume">volume</div>
: Loudness. Common values range from 150 to 210.

; <div id="sampling_rate">sampling rate</div>
: Locomotion can play sounds with variable sampling rate and thus change pitch and tempo with the vehicles speed or mode of operation. Locomotion sound files are encoded with a sampling rate of 22050 Hz, so this would be a good value to start with. Note that the perceived volume varies with the pitch too.

; <div id="fade_speed">fade speed</div>
: Describes how long Locomotion fades from one sampling rate to another. The higher the value the shorter this fade time. Good values are around 200 for 16-bit values, and between 1 and 4 for 8-bits.

; <div id="speed_dependency">speed dependency</div>
: Describes how much the sampling rate increases with the speed of a vehicle. The lower the value the higher the pitch on full speed. I can't give an exact scale and it may depend on the base sampling rate aswell, however it is quite sensitive. Reasonable values are between 10 and 15, too small values can result in an integer overflow for the sampling rate.

[[Category:Locomotion development]]