KUID

Taken from CCGTC.

A KUID is a unique number allocated to all content created for Trainz and can be thought of as a bar code.

KUID2 Format

The KUID format in TS2009 follows the standard adopted in TRS2004, and takes the form of three Identification Numbers (ID) each separated by a colon.

The breakdown of the KUID system is as follows: <KUID2:User_ID:Content_ID:Version_ID>

An example of a Kuid number with actual figures:

<KUID2:171456:38001:1>

User ID Number

The number 171456 after the KUID2 is the USER_ID of the content creator.

When you registered Trainz with the Planet Auran website, you would have been issued with your USER_ID. This is the number you should have entered into Trainz as your USER_ID.

Planet Auran may be found by clicking with the left mouse button on the Profile button in the top task bar of the Forum page, or visiting the website: https://www.auran.com/planetauran/login_f.php

Every member of the Trainz community who is a member of Planet Auran has a USER_ID. Now, you may be wondering why you need a USER_ID if you don't intend to make any content for Trainz. If you intend to make a layout (route or map) at some point in time and you'd like to share that layout with your friends or other community members, then you are in fact a content creator.

Content ID Number

The middle number is the CONTENT_ID.

This is a number that the content creator assigns to each creation to uniquely identify it, in previous Trainz builds. In TS2009, the Content Creator Plus module will automatically assign a CONTENT_ID when you create a new asset. It will not repeat a number, and keeps track of all content list or spreadsheet of CONTENT_ID numbers for your model assets.

A CONTENT_ID number is also assigned automatically when you save a layout (map).

The combination of a creator's USER_ID and the CONTENT_ID is unique, and will not conflict with assets created by others.

Note: Previous versions of Trainz used Content ID Ranges for KUID creation. The automatic assignment of CONTENT_ID numbers in TS2009 has obsoleted the need for, or the usefulness of, a specific range of numbers for different kinds of assets.

Version ID Number

The third number is the asset Version_ID number. The default for all assets is 0 e.g. <KUID2:xxx:yyyyy:0>

Should this asset require revisions after release to the Trainz Download Station, the Version ID for each subsequent revision may be updated as follows:

First revision           <KUID2:xxx:yyyyy:1>
Second revision          <KUID2:xxx:yyyyy:2>
Third revision           <KUID2:xxx:yyyyy:3> Etc.

The maximum version number is 127. After the maximum version number is used (rare) a new Content ID needs to be allocated for this asset, and the previous one needs to be added to the obsolete-table.

To make a new version asset, in CMP right click on the asset and select "Create New Version". The version number will be incremented in the new model. Trainz will use the highest version number found for the asset. Obsoleting a KUID2 asset of the same content ID number does not require the use of the obsolete table.

Obsoleting is a process of replacing a previous item with a more recent one, for updating, improving, or replacing a faulty model.

Example 1: A model <KUID2:171456:38001:3> is to be replaced by a newer version. The new number <KUID2:171456:38001:4> is used in the new config.txt file. The previous model will be replaced (obsoleted).

Example 2: A model <KUID:171456:27001> (UTC version) is to be replaced, using the new KUID2 format, and with a new number, <KUID2:171456:27002:1>. Note the new content ID number is different from the original asset.

In this case, the obsolete table container is used to show the old model KUID to be obsoleted. In this way, the new KUID is linked to that of the older asset.

Important Notes:

1: <KUID2:xxx:yyyyy:0> is exactly equal to <KUID:xxx:yyyyy> in the old KUID format. These will be read as duplicates should they be used simultaneously.

2. Similarly, <KUID2:xxx:yyyyy:1> acts as a KUID2 format obsoletion of <KUID:xxx:yyyyy> .

3. Using the zero, "0" as the first version is acceptable, however the display on the Download Station, and the installed file will be in the UTC KUID format, without the KUID2 format display. It is recommended that you start the numbering at one, "1" if this is a problem to you.

4. The Download Station displays a History of obsoleted models. If an obsoleted model has never been placed on the Download Station, do not include it in your obsolete table, it will result in a History error notification when you try to upload the asset.

5. While you may use leading zeros in the KUID system, a version "02" will be the same as "002" or "2", and the zeros will be truncated. It is recommended not to use any leading zeros.

An asset placed in your map will display (show as) the latest installed version. When retrieving an asset from the Download Station, the newest version will be automatically provided, and the Download Station will display a History tag for the model versions.