View source for How to Create a Region Asset

The information in this Wiki Page applies to '''TANE''', '''TRS19''' and '''Trainz Plus'''.

__TOC__
<table>						<!-- BEGIN Nav Buttons Table -->
<tr valign="top">
<td width=729><span id="stepWhat"></span>&nbsp;</td>
<td width=46>[[file:BackToTop.png|link=#top|alt=Top|Top]]</td>
<td width=75>&nbsp;</td>
<td width=75>[[file:NextDown.png|link=#stepCreate|alt=Next Down|Next Down]]</td>
<td width=75>[[file:BackToBottom.png|link=#bottom|alt=Bottom|Bottom]]</td>
</tr>
</table>								<!-- END Nav Buttons Table -->

='''What is a Region?'''=

<table cellpadding="4" bgcolor=#c1e7e7>
<tr valign="top">
<td>[[image:DotPoint.JPG|link=]]</td>
<td>A '''Region''' defines some of the characteristics of a geographic location (e.g. a country or a province) that is represented in a route<td>
</tr>
<tr valign="top">
<td>[[image:DotPoint.JPG|link=]]</td>
<td>A '''Region Asset''' is a '''config.txt''' file that contains the region data<td>
</tr>
</table><br>

<table bgcolor="black" width=604>
<tr valign="top">
<td>
<table cellpadding="4" bgcolor=#ffffb0 width=600>
<tr valign="top">
<td>[[image:NotePad.PNG|link=]]</td>
<td><span style="font-size: 17px; font-weight: 700;">Region Data:'''</span><br>
----
When a '''Region''' has been assigned to a route, it will set:-
*the default switch lever to be used in the route
*the colour of the water (lakes, streams, ponds, ocean)
*the side of the road, left or right, used by all moving road vehicles
*the latitude of a point in the route
*the longitude of a point in the route
*the altitude of a point in the route
*the number and types of moving road vehicles
</td>
</tr>
</table>
</td>
</tr>
</table>

<table>						<!-- BEGIN Nav Buttons Table -->
<tr valign="top">
<td width=729><span id="stepCreate"></span>&nbsp;</td>
<td width=46>[[file:BackToTop.png|link=#top|alt=Top|Top]]</td>
<td width=75>[[file:NextUp.png|link=#stepWhat|alt=Next Up|Top]]</td>
<td width=75>[[file:NextDown.png|link=#stepConfig|alt=Next Down|Next Down]]</td>
<td width=75>[[file:BackToBottom.png|link=#bottom|alt=Bottom|Bottom]]</td>
</tr>
</table>								<!-- END Nav Buttons Table -->

='''How to Create a Region Asset'''=

<table cellpadding="4" bgcolor=#ffffff> 								<!-- BEGIN Step table -->
<tr valign="top">
<td>[[image:Steps.PNG|link=]]<br><br>
<span style="font-size: 17px; font-weight: 700;">Steps</span></td>
<td>[[image:DotPoint1.JPG|link=]]&nbsp;<span style="font-size: 17px; font-weight: 700;">Create the Asset:</span><br>
<table> 																<!-- BEGIN Step 1 table -->
<tr valign="top">
<td>[[image:NewAsset.PNG|link=]]<br><br>
[[image:NewAssetCreated.PNG|link=]]</td>
<td>From the '''Trainz''' Launcher
#select <span style="color: white; background-color: black; font-weight: 700; font-size: 15px;">&nbsp;Manage Content&nbsp;</span>
#in '''Content Manager''' open the '''Developer''' menu
#select '''New Content'''
This will create a new asset and open it for editing.
<br><br>
A message window will appear that will (hopefully) report on the successful creation of a new asset.
*Close the message window
</td>
</tr>
</table> 																<!-- END Step 1 table -->
</td>
</tr>
<tr>
<td colspan="2">
----</td>
</tr>
<tr valign="top">
<td>&nbsp;</td>
<td>[[image:DotPoint2.JPG|link=]]&nbsp;<span style="font-size: 17px; font-weight: 700;">Find the New Asset:</span><br>
<table> 																<!-- BEGIN Step 2 table -->
<tr valign="top">
<td>[[image:NewAssetSelectOpen.PNG|link=]]</td>
<td>
*Set the CM Search Filter to '''Open for Editing'''
This will display only those assets that have been opened for editing (hopefully only your new and as yet unnamed asset will be shown)
</td>
</tr>
</table> 																<!-- END Step 2 table -->
</td>
</tr>
<tr>
<td colspan="2">
----</td>
</tr>
<tr valign="top">
<td>&nbsp;</td>
<td>[[image:DotPoint3.JPG|link=]]&nbsp;<span style="font-size: 17px; font-weight: 700;">Open the Asset in Windows File Explorer:</span><br>
<table> 																<!-- BEGIN Step 3 table -->
<tr valign="top">
<td>[[image:NewAssetShowExplorer.PNG|link=]]</td>
<td>
#Right mouse click on the entry '''New Asset'''
#Select '''Open'''
#Select '''Show in Explorer'''
</td>
</tr>
</table> 																<!-- END Step 3 table -->
</td>
</tr>
<tr>
<td colspan="2">
----</td>
</tr>
<tr valign="top">
<td>&nbsp;</td>
<td>[[image:DotPoint4.JPG|link=]]&nbsp;<span style="font-size: 17px; font-weight: 700;">Open Config.txt File in Notepad:</span><br>
<table> 																<!-- BEGIN Step 4 table -->
<tr valign="top">
<td>[[image:NewAssetOpenExplorer.PNG|link=]]</td>
<td>There will only be a single item in the asset, its config.txt file
*Double click on the file to open it in Notepad</td>
</tr>
</table> 																<!-- END Step 4 table -->
</td>
</tr>
<tr>
<td colspan="2">
----</td>
</tr>
<tr valign="top">
<td>&nbsp;</td>
<td>[[image:DotPoint5.JPG|link=]]&nbsp;<span style="font-size: 17px; font-weight: 700;">Edit the Config.txt File:</span><br>
<table> 																<!-- BEGIN Step 5 table -->
<tr valign="top">
<td>[[image:NewAssetOpenNotepad.PNG|link=]]</td>
<td>You will need to edit the contents of this file. 
*The next section, [[image:PageLink.PNG|link=]] '''[[#The Config.txt File|The Config.txt File]]''', identifies the changes you will need to make. 
*The new name you give to the asset will not take effect until after it has been committed. 
*After editing, save the changes and exit Notepad.</td>
</tr>
</table> 																<!-- END Step 5 table -->
<br>
<table cellpadding="4" bgcolor=#fcbcbc> 								<!-- BEGIN Step 5 warning table -->
<tr valign="top"> <!-- warning -->
<td colspan=2><span style="font-size: 17px;"><b>Warning:</b></span></td>
</tr>
<tr valign="top">
<td>[[image:Stop.PNG|link=]]</td>
<td>Unless you know '''exactly''' what you are doing'''*''',&nbsp;<span style="color: white; background-color: red; font-weight: 700; font-size: 17px;">&nbsp;DO NOT ALTER THE KUID NUMBER&nbsp;</span>&nbsp;that has been added to the file<br>
'''*''' but even if you do, think <span style="font-weight: 700; text-decoration: underline">twice</span> before you change it !</td>
</tr>
</table> 																<!-- END Step 5 warning table -->
</td>
</tr>
<tr>
<td colspan="2">
----</td>
</tr>
<tr valign="top">
<td>&nbsp;</td>
<td>[[image:DotPoint6.JPG|link=]]&nbsp;<span style="font-size: 17px; font-weight: 700;">Add a Thumbnail:</span><br>
<table> 																<!-- BEGIN Step 6 table -->
<tr valign="top">
<td colspan=2>
You will need to add a thumbnail image as described in the section [[image:PageLink.PNG|link=]] '''[[#The Thumbnail Image|The Thumbnail Image]]'''. The thumbnail and the config.txt files are the only two items required in this asset.
<br>
[[image:HTMLFolderView4.JPG|link=|alt=Asset contents]]
The thumbnail does not have to be added immediately but must it be present before the new asset can be used. You can reopen the asset for editing later to add the thumbnail before it is committed.</td>
</tr>
</table> 																<!-- END Step 6 table -->
</td>
</tr>
<tr>
<td colspan="2">
----</td>
</tr>
<tr valign="top">
<td>&nbsp;</td>
<td>[[image:DotPoint7.JPG|link=]]&nbsp;<span style="font-size: 17px; font-weight: 700;">Finish Up:</span>
<table> 																<!-- BEGIN Step 7 table -->
<tr valign="top">
<td>[[image:NewAssetSubmit.PNG|link=]]</td>
<td>
*Close the Asset window
*Commit the asset in Content manager
**Right mouse click on the asset
**Select '''Submit Edits'''
Hopefully there will be no errors.<br><br>

<table bgcolor="black" width=604>								<!-- BEGIN Step 7 Notes table -->
<tr valign="top">
<td>
<table bgcolor=#ffffb0 width=600>
<tr valign="top">
<td>[[image:NotePad.PNG|link=]]</td>
<td>Because you still have the Filter '''Open for Editing''' in operation, the now closed and committed asset will vanish from the '''Content Manager''' display. To check that your asset has been correctly created and renamed, set the Search Filter to '''Today'''.</td>
</tr>
</table>
</td>
</tr>
</table> 																<!-- END Step 7 Notes table -->
<br>
<table cellpadding="4" bgcolor=#ff0000> 								<!-- BEGIN Step 7 errors table -->
<tr valign="top">
<td>
<table cellpading="4" bgcolor=#ffffff> 									<!-- BEGIN Step 7 errors-bugs table -->
<tr valign="top">
<td>[[image:Bug.png|link=]]</td>
<td>Some of the most common errors that can occur when creating and committing a new asset are:-
*no '''''thumbnail image''''' in the asset
*typing errors in the config.txt file
*poorly formatted tags in the config.txt file
*incorrect file types added to the asset folder
*files missing from the asset folder
*incorrect '''kuid''' value (despite the warning you changed it in '''Step 5''')</td>
</tr>
</table> 																<!-- END Step 7 errors-bugs table -->
</td>
</tr>
</table> 																<!-- END Step 7 errors table -->
</td>
</tr>
</table> 																<!-- END Step 7 table -->
</td>
</tr>
</table> 																<!-- END Steps table -->

<table width="100%"> 													<!-- BEGIN Back-to-top table -->
<tr valign="top">
<td align="right">[[image:BackToTop.png|link=#top|alt=Top|Top]]</td>
</tr>
</table> 																<!-- END Back-to-top table -->
<table>						<!-- BEGIN Nav Buttons Table -->
<tr valign="top">
<td width=729><span id="stepConfig"></span>&nbsp;</td>
<td width=46>[[file:BackToTop.png|link=#top|alt=Top|Top]]</td>
<td width=75>[[file:NextUp.png|link=#stepCreate|alt=Next Up|Top]]</td>
<td width=75>[[file:NextDown.png|link=#stepTags|alt=Next Down|Next Down]]</td>
<td width=75>[[file:BackToBottom.png|link=#bottom|alt=Bottom|Bottom]]</td>
</tr>
</table>								<!-- END Nav Buttons Table -->
='''The Config.txt File'''=

This file should follow the same (or a similar) format as the example below.<br>
*entries in&nbsp;<span style="background-color: red; color: white; font-weight: 700;">&nbsp;red&nbsp;</span>&nbsp;must not be changed
*the indenting of the lines and the spacing ("tabbing") between the "tags" on the left and their contents on the right are purely to make it easier for humans to read
*the use of the '''{ }''' braces is to group tags into common "containers". These containers must not be broken up and the number of '''{''' characters must match the number of '''}''' characters
*the order of the "tags" is '''not''' important

 '''kuid'''                              <span style="background-color: red; color: white; font-weight: 700;"><kuid:this is an auto-generated number></span>
 '''kind'''                              "<span style="background-color: red; color: white; font-weight: 700;">region</span>"
 '''username                          "Region data for Tasmania 1950 to 1969"'''
 '''category-class'''                    "<span style="background-color: red; color: white; font-weight: 700;">YX</span>"
 '''category-era                      "1950s;1960s"'''
 '''category-region                   "AU"'''
 '''ontheright                        0'''
 '''water-color                       75,128,255'''
 '''defaultjunction                   <kuid:61119:24120>'''
 '''default-texture                   <kuid:-25:1180>'''
 '''trainz-build                      4.8'''
 '''longitude                         147.0,26.0,1.0'''
 '''latitude                          41.0,50.0,-1.0'''
 '''altitude                          212'''
 '''car0                              <kuid:329364:1568>'''
 '''thumbnails'''
 {
   '''Default'''
   {
     '''width'''                         <span style="background-color: red; color: white; font-weight: 700;">240</span>
     '''height'''                        <span style="background-color: red; color: white; font-weight: 700;">180</span>
     '''image                         "Tasmania-Region'''<span style="background-color: red; color: white; font-weight: 700;">.jpg</span>"
   }
 }
 '''description                       "Vehicle, road, water and geographic data for Tasmania (Australia) in the 1950s and 1960s"'''
 '''kuid-table'''
 {
   '''0                               <kuid:61119:24120>'''
   '''1                               <kuid:329364:1568>'''
   '''2                               <kuid:-25:1180>'''
 }
 
<table cellpadding="4" bgcolor=#eeeeee>
<tr>
<td colspan="2">
----</td>
</tr>
<tr valign="top">
<td>[[image:Gears.PNG|link=]]</td>
<td><span style="font-size: 17px;">'''Settings:'''</span><br>
'''For the above example:'''<br>
*The&nbsp;<span style="background-color: black; color: white; font-weight: 700;"> kuid </span>&nbsp;is unique to every asset so it is&nbsp;<span style="background-color: red; color: white; font-weight: 700;">&nbsp;not a good idea to choose your own&nbsp;</span>. This will be automatically generated by the '''Content Manager''' program when a new asset is created
*The&nbsp;<span style="background-color: black; color: white; font-weight: 700;"> kind </span>&nbsp;identifies the ''type'' of asset and the types of files that '''Trainz''' will expect to find in the asset. It also tells '''Trainz''' how to render and error check the asset. For '''region''' assets, the '''kind''' is "<span style="background-color: red; color: white; font-weight: 700;">region</span>". A list of asset kinds can be found at [[image:WikiLink.PNG|link=]] '''[[KIND_TrainzBaseSpec#KIND_Hierarchy|KIND Hierarchy]]'''
*The&nbsp;<span style="background-color: black; color: white; font-weight: 700;"> username </span>&nbsp;is your name for the asset and the name that other users will see. It is a good idea to make it short and meaningful.
*The&nbsp;<span style="background-color: black; color: white; font-weight: 700;"> category-class </span>&nbsp;identifies the ''intent'' of the asset and is important in classifying it for filtering and searching. For '''region''' assets, the category class is "<span style="background-color: red; color: white; font-weight: 700;">YX</span>". A list of category classes can be found at [[image:WikiLink.PNG|link=]] '''[[Category-class]]'''
*The&nbsp;<span style="background-color: black; color: white; font-weight: 700;"> category-era </span>&nbsp;identifies the decade or decades in which the region is based (e.g. "1950s"). See the section [[image:PageLink.PNG|link=]] '''[[#Category Era Tag|Category Era Tag]]''' below for more details.
*The&nbsp;<span style="background-color: black; color: white; font-weight: 700;"> category-region </span>&nbsp;identifies the country or countries in which layout is based. See the section [[image:PageLink.PNG|link=]] '''[[#Category Region Tag|Category Region Tag]]''' below for more details.
*The&nbsp;<span style="background-color: black; color: white; font-weight: 700;"> ontheright </span>&nbsp;identifies which side of the road is used by road traffic. See the section [[image:PageLink.PNG|link=]] '''[[#On the Right Tag|On the Right Tag]]''' below for more details.
*The&nbsp;<span style="background-color: black; color: white; font-weight: 700;"> water-color </span>&nbsp;identifies the the colour used by water surfaces in this region. See the section [[image:PageLink.PNG|link=]] '''[[#Water Color Tag|Water Color Tag]]''' below for more details.
*The&nbsp;<span style="background-color: black; color: white; font-weight: 700;"> defaultjunction </span>&nbsp;identifies the junction lever or switch that Trainz will use as its default lever asset whenever a lever is added to a track junction in this region. See the section [[image:PageLink.PNG|link=]] '''[[#Default Junction Tag|Default Junction Tag]]''' below for more details.
*The&nbsp;<span style="background-color: black; color: white; font-weight: 700;"> default-texture </span>&nbsp;identifies the texture that will be applied to every new baseboard that is added to a Route. See the section [[image:PageLink.PNG|link=]] '''[[#Default Texture Tag|Default Texture Tag]]''' below for more details.
*The&nbsp;<span style="background-color: black; color: white; font-weight: 700;"> trainz-build </span>&nbsp;identifies the ''minimum'' Trainz version needed for this asset. A list of asset trainz-build numbers and their corresponding Trainz versions can be found at [[image:WikiLink.PNG|link=]] '''[["Trainz-build"_number|Trainz build numbers]]'''
*The&nbsp;<span style="background-color: black; color: white; font-weight: 700;"> longitude </span>&nbsp;identifies the geographic longitude of a point in the region. See the section [[image:PageLink.PNG|link=]] '''[[#Longitude Tag|Longitude Tag]]''' below for more details.
*The&nbsp;<span style="background-color: black; color: white; font-weight: 700;"> latitude </span>&nbsp;identifies the geographic latitude of a point in the region. See the section [[image:PageLink.PNG|link=]] '''[[#Latitude Tag|Latitude Tag]]''' below for more details.
*The&nbsp;<span style="background-color: black; color: white; font-weight: 700;"> altitude </span>&nbsp;identifies the altitude or '''base height''' of the starting baseboard in the route. See the section [[image:PageLink.PNG|link=]] '''[[#Altitude Tag|Altitude Tag]]''' below for more details.
*The&nbsp;<span style="background-color: black; color: white; font-weight: 700;"> car0 </span>&nbsp;identifies the first moving car that will appear on roads in the region. Upto 15 different cars can be specified. See the section [[image:PageLink.PNG|link=]] '''[[#Car Tags|Car Tags]]''' below for more details.
*The&nbsp;<span style="background-color: black; color: white; font-weight: 700;"> thumbnails </span>&nbsp;container holds the ''preview'' images of the asset shown by the '''Content Manager''' program, the Web version of the ''DLS'' and, for '''some assets''', the Surveyor main menu image(s). See the section [[image:PageLink.PNG|link=]] '''[[#Thumbnails|Thumbnails]]''' below for more details. Complete information on thumbnails can be found at [[image:WikiLink.PNG|link=]] '''[[Thumbnails]]'''
**The label&nbsp;<span style="background-color: black; color: white; font-weight: 700;">&nbsp;Default&nbsp;</span>&nbsp;is the '''container ID''' or '''placeholder''' for the thumbnail used by CM and the Web based DLS. While its ''exact label'' (or number - eg. "Default", "00", "01", etc) is not important, it must be different from any other labels that might be present in the thumbnail. '''Default''' and '''0''' are commonly used placeholder labels for the 240 x 180 thumbnail image
***The '''image''' is the name of the thumbnail image. It does not have to be called '''thumbnail.jpg''' but it '''must''' be a <span style="background-color: red; color: white; font-weight: 700;">JPG</span> format image
***The '''width''' of the image in pixels must be <span style="background-color: red; color: white; font-weight: 700;">240</span>
***The '''height''' of the image in pixels must be <span style="background-color: red; color: white; font-weight: 700;">180</span>
*The&nbsp;<span style="background-color: black; color: white; font-weight: 700;"> description </span>&nbsp;provides more details for users than the '''username'''
*The&nbsp;<span style="background-color: black; color: white; font-weight: 700;"> kuid-table </span>&nbsp;contains the kuid values of the '''defaultjunction''' asset and all the '''carN''' assets. See the section [[image:PageLink.PNG|link=]] '''[[#Kuid Table Tag|Kuid Table Tag]]''' below for more details.
</td>
</tr>
<tr>
<td colspan="2">
----</td>
</tr>
</table>

<table cellpadding="4" bgcolor=#ffffb0>
<tr valign="top">
<td>[[image:PencilTips.PNG|link=]]</td>
<td><span style="font-weight: 700; font-size: 17px;">Language Options:</span><br>
----
</td>
</tr>
<tr valign="top">
<td></td>
<td>All Trainz assets have a language facility built into their config.txt files that allows other language translations to be added for certain tags, such as the '''username''' and '''description''' tags. A full description of the process can be found on the Trainz Wiki at [[image:WikiLink.PNG|link=]]&nbsp;'''[[HowTo/Localize_an_Asset|Localize an Asset]]''' and a list of all the supported languages with their two character codes at [[image:WikiLink.PNG|link=]]&nbsp;'''[[Localization_code|Localization (country) Codes]]'''.<br>

At the very basic level any creator can easily provide other language translations for the '''username''' and '''description''' tags in the assets they create. Examples are shown below for this sample asset.</td>
</tr>
<tr valign="top">
<td colspan=2>
 username                    "Region data for Tasmania 1950 to 1969"
 username-c2                 "塔斯马尼亚州1950年至1969年的区域数据"
 username-es                 "Datos de la región para Tasmania 1950 a 1969"
 username-fr                 "Données régionales pour la Tasmanie de 1950 à 1969"
 username-gr                 "Regionsdaten für Tasmanien 1950 bis 1969"
 username-nl                 "Regiogegevens voor Tasmanië 1950 tot 1969"
 username-ru                 "Данные по регионам за Тасманию с 1950 по 1969 год"
</td>
</tr>
<tr valign="top">
<td></td>
<td>Translations to Chinese (simplified), Spanish, French, German, Dutch and Russian, perfect or not, were provided by Google Translate.
</td>
</tr>
</table>

<table width="100%">
<tr valign="top">
<td align="right">[[image:BackToTop.png|link=#top|alt=Top|Top]]</td>
</tr>
</table>
<table>						<!-- BEGIN Nav Buttons Table -->
<tr valign="top">
<td width=729><span id="stepTags"></span>&nbsp;</td>
<td width=46>[[file:BackToTop.png|link=#top|alt=Top|Top]]</td>
<td width=75>[[file:NextUp.png|link=#stepConfig|alt=Next Up|Top]]</td>
<td width=75>[[file:NextDown.png|link=#stepThumb|alt=Next Down|Next Down]]</td>
<td width=75>[[file:BackToBottom.png|link=#bottom|alt=Bottom|Bottom]]</td>
</tr>
</table>								<!-- END Nav Buttons Table -->

='''Region Tags'''=
=='''Category Era Tag'''==

<table cellpadding="4" bgcolor=#c1e7e7>
<tr valign="top">
<td>[[image:DotPoint.JPG|link=]]</td>
<td>This tag is&nbsp;<span style="background-color: blue; color: white; font-weight: 700;">&nbsp;NOT compulsory&nbsp;</span>&nbsp;in a Region asset</td>
</tr>
</table>

'''category-era'''<br>

This identifies the decade or decades in which the region is based. The tag data contains text surrounded by quote (") characters. Each decade name ends with an "s" (e.g. "1950s") and multiple consecutive decades can be specified by using a semi-colon (;) as a separator (e.g. "1950s;1960s"). A list of category-eras can be found at [[image:WikiLink.PNG|link=]] '''[["Category-era"_tag|Category-era tag]]'''.

=='''Category Region Tag'''==

<table cellpadding="4" bgcolor=#c1e7e7>
<tr valign="top">
<td>[[image:DotPoint.JPG|link=]]</td>
<td>This tag is&nbsp;<span style="background-color: blue; color: white; font-weight: 700;">&nbsp;NOT compulsory&nbsp;</span>&nbsp;in a Region asset</td>
</tr>
</table>

'''category-region'''<br>

This identifies the country or countries in which the region is based. The tag data contains text surrounded by quote (") characters. Each country has a two letter code (e.g. "AU" for Australia) and multiple countries can be specified by using a semi-colon (;) as a separator (e.g. "AU;UK;US"). If no country is to be specified then the two character code "00" (double zero) is used. A list of countries (category regions) can be found at [[image:WikiLink.PNG|link=]] '''[["Category-region"_tag|Category-region tag]]'''.

=='''On the Right Tag'''==

<table cellpadding="4" bgcolor=#c1e7e7>
<tr valign="top">
<td>[[image:DotPoint.JPG|link=]]</td>
<td>This tag is&nbsp;<span style="background-color: red; color: white; font-weight: 700;">&nbsp;compulsory&nbsp;</span>&nbsp;in a Region asset</td>
</tr>
</table>

'''ontheright'''<br>

This identifies which side of the road is used by road traffic in this region. The tag data contains a binary value ('''0''' or '''1'''). 0 = left side, 1 = right side.

=='''Water Color Tag'''==

<table cellpadding="4" bgcolor=#fcbcbc>
<tr valign="top">
<td colspan=2><span style="font-size: 17px; font-weight: 700;">Warning:</span></td>
</tr>
<tr valign="top">
<td>[[image:Stop.PNG|link=]]</td>
<td>The '''water-color tag''' in a '''Region''' asset has been superseded by the '''Water Color Lighting Setting''' which is set in the [[image:WikiLink.PNG|link=]]&nbsp;'''[[How_to_Use_Environment_Tools|Environment Tools]]'''</td>
</tr>
</table>
<br>
<table cellpadding="4" bgcolor=#c1e7e7>
<tr valign="top">
<td>[[image:DotPoint.JPG|link=]]</td>
<td>This tag is&nbsp;<span style="background-color: red; color: white; font-weight: 700;">&nbsp;compulsory&nbsp;</span>&nbsp;in a Region asset with an asset build number of '''3.4''' and higher</td>
</tr>
</table>

'''water-color'''<br>

This identifies the colour used by water surfaces added by the Surveyor '''Terrain Tool''' in this region. The tag contains three integers separated by commas (e.g. 75,128,255). The integers specify the RGB ('''R'''ed, '''G'''reen, '''B'''lue) colour values to be used and each value is from '''0''' to '''255'''.

=='''Default Junction Tag'''==

<table cellpadding="4" bgcolor=#c1e7e7>
<tr valign="top">
<td>[[image:DotPoint.JPG|link=]]</td>
<td>This tag is&nbsp;<span style="background-color: red; color: white; font-weight: 700;">&nbsp;compulsory&nbsp;</span>&nbsp;in a Region asset with an asset build number of '''3.4''' and higher</td>
</tr>
</table>

'''defaultjunction''' (no hyphen between the two words)<br>

This identifies the junction lever or switch that Trainz will use as its default lever asset whenever a lever is added to a track junction in this region. The tag data contains a single valid kuid (e.g. <kuid:61119:24120>).<br>

The kuid value of the switch lever must also be added to the '''kuid-table''' container of the config.txt file.

=='''Default Texture Tag'''==

<table cellpadding="4" bgcolor=#c1e7e7>
<tr valign="top">
<td>[[image:DotPoint.JPG|link=]]</td>
<td>This tag is <span style="color: white; background-color: black; font-weight:700;">&nbsp;only valid&nbsp;</span> in a Region asset with a build number of '''4.8''' and higher</td>
</tr>
</table>

'''default-texture'''<br>

This identifies the default texture that will be applied to every new baseboard that is added. If it is not present then a system default texture will be used on new baseboards in '''Trainz TRS19''' and later. If present then the '''Trainz Build Tag''' must also be present and set to a minimum value of '''4.8'''.<br>

The kuid value shown in the sample '''config.txt''' above, '''&lt;kuid:-25:1180&gt;''', is for the standard '''TRS19''' grid pattern.<br>

The kuid value of the texture must also be added to the '''kuid-table''' container of the config.txt file.

=='''Trainz Build Tag'''==

<table cellpadding="4" bgcolor=#c1e7e7>
<tr valign="top">
<td>[[image:DotPoint.JPG|link=]]</td>
<td>This tag is&nbsp;<span style="background-color: blue; color: white; font-weight: 700;">&nbsp;NOT compulsory&nbsp;</span>&nbsp;in a Region asset unless the '''Default Texture Tag''' is present</td>
</tr>
</table>
<br>
The identifies the minimum version of '''Trainz''' that wlll be needed to use this region asset. A list of asset '''trainz-build''' numbers and their corresponding '''Trainz''' versions can be found at [[image:WikiLink.PNG|link=]] '''[["Trainz-build"_number|Trainz build numbers]]'''

=='''Longitude Tag'''== 

<table cellpadding="4" bgcolor=#c1e7e7>
<tr valign="top">
<td>[[image:DotPoint.JPG|link=]]</td>
<td>This tag is&nbsp;<span style="background-color: red; color: white; font-weight: 700;">&nbsp;compulsory&nbsp;</span>&nbsp;in a Region asset with an asset build number of '''3.4''' and higher</td>
</tr>
</table>
<br>
<table cellpadding="4" bgcolor=#fcbcbc>
<tr valign="top">
<td colspan=2><span style="font-size: 17px; font-weight: 700;">Warning:</span></td>
</tr>
<tr valign="top">
<td>[[image:Stop.PNG|link=]]</td>
<td>The '''Longitude tag''' in a '''Region''' asset has been superseded by the '''Longitude Setting''' in the [[image:WikiLink.PNG|link=]]&nbsp;'''[[How_to_Use_Environment_Tools|Environment Tools]]'''</td>
</tr>
</table>
<br>
<table bgcolor="black" width=904>
<tr valign="top">
<td>
<table cellpadding="4" bgcolor=#ffffb0 width=900>
<tr valign="top">
<td>[[image:NotePad.PNG|link=]]</td>
<td><span style="font-size: 17px; font-weight: 700;">Notes:'''</span><br>
----
There is no known feature, function or operation in a Trainz route or session that actually requires a '''Longitude''' value other than the fact that a valid '''Longitude Tag''' is compulsory in a '''Region''' asset with a build number of '''3.4''' and higher.</td>
</tr>
</table>
</td>
</tr>
</table>
<br>

This identifies the geographic longitude of a point in the region. The tag contains three ''floating point'' or ''decimal'' values separated by commas (e.g. 147.0,26.0,1.0). The first value is the longitude '''degrees''', the second value is the longitude '''minutes''' and the third is the '''East/West''' value (1.0 = East, -1.0 = West). For example: 147.0,26.0,1.0 would represent longitude 147 degrees 26 minutes East.<br>

=='''Latitude Tag'''== 

<table cellpadding="4" bgcolor=#c1e7e7>
<tr valign="top">
<td>[[image:DotPoint.JPG|link=]]</td>
<td>This tag is&nbsp;<span style="background-color: red; color: white; font-weight: 700;">&nbsp;compulsory&nbsp;</span>&nbsp;in a Region asset with an asset build number of '''3.4''' and higher</td>
</tr>
</table>
<br>
<table cellpadding="4" bgcolor=#fcbcbc>
<tr valign="top">
<td colspan=2><span style="font-size: 17px; font-weight: 700;">Warning:</span></td>
</tr>
<tr valign="top">
<td>[[image:Stop.PNG|link=]]</td>
<td>The '''Latitude tag''' in a '''Region''' asset has been superseded by the '''Latitude Setting''' in the [[image:WikiLink.PNG|link=]]&nbsp;'''[[How_to_Use_Environment_Tools|Environment Tools]]'''</td>
</tr>
</table>
<br>
<table bgcolor="black" width=904>
<tr valign="top">
<td>
<table cellpadding="4" bgcolor=#ffffb0 width=900>
<tr valign="top">
<td>[[image:NotePad.PNG|link=]]</td>
<td><span style="font-size: 17px; font-weight: 700;">Notes:'''</span><br>
----
The purpose of the '''Latitude''' entry is to:-
*determine the season of the year along with the '''Date''' setting. Many '''SpeedTrees''' assets, for example, use the season to determine which foliage layer should be used. Both the '''Latitude''' and '''Date''' can be set in the [[image:WikiLink.PNG|link=]]&nbsp;'''[[How_to_Use_Environment_Tools|Environment Tools]]'''.
*set the sun angle and its maximum height above the horizon line at noon. The times of sunrise and sunset are fixed at 06:00 and 18:00 and these cannot be changed.
</tr>
</table>
</td>
</tr>
</table>
<br>
This identifies the geographic latitude of a point in the region. The tag contains three ''floating point'' or ''decimal'' values separated by commas (e.g. 41,0,50.0,-1.0). The first value is the latitude '''degrees''', the second value is the latitude '''minutes''' and the third is the '''North/South''' value (1.0 = North, -1.0 = South). For example: 41.0,50.0,-1.0 would represent latitude 41 degrees 50 minutes South.<br>

=='''Altitude Tag'''==

<table cellpadding="4" bgcolor=#c1e7e7>
<tr valign="top">
<td>[[image:DotPoint.JPG|link=]]</td>
<td>This tag is&nbsp;<span style="background-color: red; color: white; font-weight: 700;">&nbsp;compulsory&nbsp;</span>&nbsp;in a Region asset with an asset build number of '''3.4''' and higher</td>
</tr>
</table>
<br>
<table cellpadding="4" bgcolor=#fcbcbc>
<tr valign="top">
<td colspan=2><span style="font-size: 17px; font-weight: 700;">Warning:</span></td>
</tr>
<tr valign="top">
<td>[[image:Stop.PNG|link=]]</td>
<td>The '''Altitude tag''' in a '''Region''' asset has been superseded by the '''World Origin Altitude Setting''' in the [[image:WikiLink.PNG|link=]]&nbsp;'''[[How_to_Use_Environment_Tools|Environment Tools]]'''</td>
</tr>
</table>
<br>
<table cellpadding="4" bgcolor=#c1e7e7>
<tr valign="top">
<td>[[image:DotPoint.JPG|link=]]</td>
<td>The altitude can be set by selecting a '''Region''':- 
*when a new route is created - the route '''base height''' will be set to the altitude shown in the selected region so the first baseboard will have its height set to that altitude instead of the usual starting height of 0 metres
*when an existing route is edited by assigning it a new region - the route will have its '''base height''' set to the altitude shown in the new region and all existing heights (terrain, splines, objects) will be set relative to that value</td>
</tr>
</table>
<br>
This sets the initial altitude (height above sea level) of the route. It is also used in the display of snow but only with those scenery assets that have a snow effect layer.<br>

The tag data contains a single integer that represents the altitude in '''metres'''. All terrain and object heights will be set relative to that altitude. For example: if the first baseboard of a route is manually raised to a height of '''20 metres''' using the '''Terrain Height Tool''' and the route is then assigned to a region with the altitude set to '''100 metres''', then the first baseboard will have a height above sea level of 20 + 100 = '''120 metres'''.<br>

The altitude tag works with the '''Snow Altitude Setting''' which is set in the [[image:WikiLink.PNG|link=]]&nbsp;'''[[How_to_Use_Environment_Tools|Environment Tools]]'''.<br>

<table bgcolor="black" width=904>
<tr valign="top">
<td>
<table cellpadding="4" bgcolor=#ffffb0 width=900>
<tr valign="top">
<td>[[image:PencilTips.PNG|link=]]</td>
<td>The '''Default Region''' has an altitude of 0 metres. If you change the assigned region for an exiting route to the '''Default Region''', then the '''base height''' of that route will be set to 0 metres and all other heights will be adjusted relative to that height. In many cases this will revert the route to its original terrain height when it was created in Surveyor and before it was assigned to a region.</td>
</tr>
</table>
</td>
</tr>
</table>

=='''Car Tags'''==

<table cellpadding="4" bgcolor=#c1e7e7>
<tr valign="top">
<td>[[image:DotPoint.JPG|link=]]</td>
<td>This tag is&nbsp;<span style="background-color: blue; color: white; font-weight: 700;">&nbsp;NOT compulsory&nbsp;</span>&nbsp;in a Region asset. If not present then no moving vehicles will appear</td>
</tr>
</table>
<br>
<table bgcolor="black" width=904>
<tr valign="top">
<td>
<table cellpadding="4" bgcolor=#ffffb0 width=900>
<tr valign="top">
<td>[[image:NotePad.PNG|link=]]</td>
<td><span style="font-size: 17px;">'''Notes:'''</span><br>
----
*There is some confusion over the maximum number of '''different types''' of moving vehicles allowed in a session. Some region assets available on the '''DLS''' claim to produce as many as 100 different types of moving vehicles but whether more than 15 different types can be seen in a '''Driver''' session at any one time is, as yet, unclear.
*The '''carrate''' tag, which is used to control the rate at which moving vehicles are created (i.e. how many per minute), has been declared '''obsolete''' in Route assets. This tag is not used in a '''Region''' asset but has been used in some Route config.txt files. It only applies to road spline assets that support road traffic.
</td>
</tr>
</table>
</td>
</tr>
</table> 																<!-- END Car Tag Notes table -->

The Car Tag identifies the moving vehicles (cars, trucks, etc) that will appear on roads in the region. Each car tag contains just a single kuid value (e.g. <kuid:329364:1568>) that identifies a single vehicle. There are restrictions and requirements:-
*Up to 15 different vehicles, each as a separate tag from '''car0''' to '''car14''' with their '''kuid''' values, can be specified in a region. The car tag numbers must be consecutive with no missing or duplicated entries (see '''Notes''' above)
*'''The vehicles must be specially configured to allow them to be used as moving vehicles''' - static car assets cannot be used. See [[image:WikiLink.PNG|link=]]&nbsp;'''[[HowTo/Build_a_Car_for_Traffic_(stand-alone_version)#Load_Model_into_Trainz|Build a Car for Traffic]]''' for information on how to configure a static vehicle asset for road traffic
*'''Not all roads are configured to carry moving vehicles'''
*The [[image:WikiLink.PNG|link=]]&nbsp;'''[[How_to_Use_Environment_Tools|Environment Tools]]''' has a control that will '''enable''' and '''disable''' ALL road traffic. If this is set to '''disable''' then the car tags will be ignored and no moving vehicles will appear.
*The kuids of the vehicles must be added to the '''kuid-table''' container of the config.txt file
For example, the following entries will specify just 4 different moving vehicles for the region.
 car0                                    <kuid:329364:1568>
 car1                                    <kuid:309161:100599>
 car2                                    <kuid2:329364:1689:1>
 car3                                    <kuid2:329364:1707:1>

<table cellpadding="4" bgcolor=#fcbcbc>
<tr valign="top">
<td colspan=2><span style="font-size: 17px; font-weight: 700;">Warning:</span></td>
</tr>
<tr valign="top">
<td>[[file:Stop.PNG|link=]]</td>
<td>If any of the listed cars are '''faulty''' then the '''Region''' asset will NOT appear for selection in the route '''Region List''' (see '''Using the Asset''' below)</td>
</tr>
</table>

=='''Kuid Table Tag'''==

<table cellpadding="4" bgcolor=#c1e7e7>
<tr valign="top">
<td>[[image:DotPoint.JPG|link=]]</td>
<td>This tag is&nbsp;<span style="background-color: red; color: white; font-weight: 700;">&nbsp;compulsory&nbsp;</span>&nbsp;in a Region asset if the '''defaultjunction''', '''default-texture''' or '''car''' tags are used</td>
</tr>
</table>
<br>
This must contain the kuids of the '''Default Junction Tag''', the '''Default Texture Tag''' and all the cars specified in the '''car''' tags - if any of them are present. The kuid order is not important and the tag numbers ("0", "1", etc) do not have to match those used in the '''car''' tags. Using the examples shown above, the '''kuid-table''' could be as shown below.

 kuid-table
 {
   0                                     <kuid:61119:24120>
   1                                     <kuid:-25:1180>
   2                                     <kuid:329364:1568>
   3                                     <kuid:309161:100599>
   4                                     <kuid2:329364:1689:1>
   5                                     <kuid2:329364:1707:1>
 }

In this example, the first kuid value is for the '''defaultjunction''', the second is for the '''default-texture''' and the remaining kuid values are for the four road vehicles, but the order of the entries is not important.

<table width="100%">
<tr valign="top">
<td align="right">[[image:BackToTop.png|link=#top|alt=Top|Top]]</td>
</tr>
</table>
<table>						<!-- BEGIN Nav Buttons Table -->
<tr valign="top">
<td width=729><span id="stepThumb"></span>&nbsp;</td>
<td width=46>[[file:BackToTop.png|link=#top|alt=Top|Top]]</td>
<td width=75>[[file:NextUp.png|link=#stepTags|alt=Next Up|Top]]</td>
<td width=75>[[file:NextDown.png|link=#bottom|alt=Next Down|Next Down]]</td>
<td width=75>[[file:BackToBottom.png|link=#bottom|alt=Bottom|Bottom]]</td>
</tr>
</table>								<!-- END Nav Buttons Table -->

='''The Thumbnail Image'''=
<table cellpadding="4" bgcolor=#c1e7e7>
<tr valign="top">
<td>[[image:DotPoint.JPG|link=]]</td>
<td>'''A thumbnail image MUST be present in the asset'''</td>
</tr>
</table>
<br>
<table bgcolor="black" width=904>
<tr valign="top">
<td>
<table cellpadding="4" bgcolor=#ffffb0 width=900>
<tr valign="top">
<td>[[image:NotePad.PNG|link=]]</td>
<td><span style="font-size: 17px;">'''Notes:'''</span><br>
----
The thumbnail image:-
*must be in '''JPG''' format.
*must be 240 pixels wide by 180 pixels tall.
*'''does not''' have to be named ''thumbnail.jpg'' as long as the name used is in the '''Thumbnails''' container in the '''config.txt''' file.
</td>
</tr>
</table>
</td>
</tr>
</table>

='''Using the Asset'''=

Once the new asset has been committed it will be available for use as a '''Region'''.

<table cellpadding="4" bgcolor=#fcbcbc>
<tr valign="top">
<td colspan=2><span style="font-size: 17px; font-weight: 700;">Warning:</span></td>
</tr>
<tr valign="top">
<td>[[image:Stop.PNG|link=]]</td>
<td>If the region asset is faulty (for example, if it has an incorrect '''kuid''' code in one of its car tags) then the region '''will not''' appear in the '''Region''' selection list.</td>
</tr>
</table>

The region is specified when a new route is created and it can be altered by selecting '''Edit Route''' from the main menu in '''TANE''' or the edit menu in '''TRS19'''.

[[image:TasmaniaRegion.png|link=|alt=Load a Region]]

<table width="100%">
<tr valign="top">
<td align="right">[[image:BackToTop.png|link=#top|alt=Top|Top]]</td>
</tr>
</table>
<table>						<!-- BEGIN Nav Buttons Table -->
<tr valign="top">
<td width=729><span id="bottom"></span>&nbsp;</td>
<td width=46>[[file:BackToTop.png|link=#top|alt=Top|Top]]</td>
<td width=75>[[file:NextUp.png|link=#stepThumb|alt=Next Up|Top]]</td>
<td width=75>&nbsp;</td>
<td width=75>&nbsp;</td>
</tr>
</table>								<!-- END Nav Buttons Table -->
----
----
='''Trainz Wiki'''=
<table cellpadding="4" bgcolor=#ffffff>
<tr valign="top">
<td>[[image:TrainzWiki.png|link=]]</td>
<td>
<span style="font-size: 17px;">'''More Tutorials and Guides to Using Trainz'''</span><br>
*'''<span class="plainlinks">[http://online.ts2009.com/mediaWiki/index.php/HowTo How to Guides]</span>'''
*'''[[Driver Commands List]]'''
*'''[[Session Rule List with Parameters|Session Rules List (Alphabetical) with Parameters]]'''
*'''[[Session Rules By Categories With Properties|Session Rules List (Categories) With Parameters]]'''
</td>
</tr>
</table>
----
This page was created by Trainz user '''<span class="plainlinks">[http://online.ts2009.com/mediaWiki/index.php/User:Pware pware]</span>''' in April 2020 and was last updated as shown below.
----
[[Category:How-to guides]]