Category-class

Revision as of 13:43, 20 August 2013

Category-class Tags

The "category-class" tag of the TrainzBaseSpec is the key searching parameter defining what or how the human content creator meant for the new asset to be used and thought about.

Trainz User Tip: This is a sometimes nebulous and confusing parameter requiring a new user to develop a degree of mental agility, for example, a 'house' asset might be classified (Coded by some asset creator) as scenery, building, industry, or even something as wildly inappropriate as 'fauna'.

The KIND specification defines which other (data type) entries are needed in that particular asset's config.txt file. It is the entry which defines the asset's type, scope, and needs and the very important parameter that tells TRAINZ how to process and render the specific asset item correctly, error check against the standard for the category-class, and render it into 3D graphics models.

Each Trainz asset's category-class tag helps describe the 'intent' of the Asset in the game, as opposed to the internal structure of the Asset. The Content Creators' Guide for Trainz Classics said these classes represent a standardized system for referring to the various types of Locos, Rolling stock, Scenery, Spline and Industry assets. The Category-class classification codes become important to all Trainzers when searching and/or filtering for suitable assets to make into content in a session or route (layout).

Trainz Base Specification

(all config.txt files can contain all these entries)

kind ""
kuid <kuid:code1#:Code2#>
trainz-build ?
script ""
class ""
script-include-table
{
}
username ""
username-XX ""
description ""
description-XX ""
kuid-table
{
}
obsolete-table
{
}
string-table
{
}
string-table-XX
{
}
category-region ""
category-class ""
category-era ""
category-keyword ""
custom-category-list ""
must-have-product-rights ""
must-not-have-product-rights ""
privileges
{
}
thumbnails
{
}
extensions
{
}
license ""
author ""
organisation ""
contact-email ""
contact-website ""
member-of-groups
{
}

Category-class code notes

New users should be aware that these codes listed below are not the direct ContentManager.exe category sort by classifications as a simple comparison of lists will reveal, but they do affect what is displayed within such a sort filter selection.

For example: Set a search filter for 'Location>Local + Category>Flora'.

In the base installed content of TRS2006-SP0 this search will yield diverse assets such as the set of {Flora types: SOME few trees, Betonbridge (1,2,&3 tracks), crop splines, sidewalks, road types}

but the sort will also list a much larger type group, the set of {Scenery: retaining wall splines (Arkaden...), LOADS of trees and Shrubs including Laubbaum with birds (and sound), grasses (textures?), Logs} and so forth.

In that search you will also find electrified railroad centenary parts and the occasional animal. The result of such a search will be no better in new Trainz versions, which means the new Trainzer needs to cultivate a certain mental agility when searching for suitable content. No one has the man-power, deep pockets, nor copyright authority to systematically fix such foibles. You as a user, can clone such items and change the classification to something more sensible to yourself. That however, is not an asset you can upload to the Download Station without a copyright clearance from the original asset creator. The Trainz community is severe in policing copyrights violations!

Trainz User Tip: These codes when applied by the content creator were in many cases cut and pasted into a new similar asset, in others, the way he or she was using the asset in their current project. In short, they are not definitive, but are indicative... even if it is only of the mental state of the creator at the time of donation to the DLS, or as happens in many cases, a case of translation from a native tounge with a different way of thinking than that of English.

The Category Classes are:

Class "A"        Motive Power
Class "B"        Buildings and Structures
Class "C"        Cabeese
Class "D"        Defence
Class "E"        Environment
Class "F"        Foliage
Class "G"        Ground
Class "H"        Mesh
Class "I"        Product
Class "J"        Texture
Class "L"        Light Rail & Monorail
Class "M"        Maintenance Of Way
Class "O"        Organism
Class "P"        Passenger & Mail Cars
Class "R"        Railcars & Multiple Unit Sets
Class "S"        Splines
Class "T"        Track
Class "V"        Vehicles
Class "W"        Wayside
Class "X"        Freight Cars
Class "Y"        Maps and Scenarios
Class "Z"        Train Parts

Figure 02: Base category-class prefixes

Each Category Class may have a number of subcategories as listed below. Please choose the most appropriate Category Class for your item. Select the Class from the Content Creator Plus drop down menu box - only one class may be selected for an asset.

Selecting a correct Category Class is important since Trainz will allow users to use the Category Class as a sort and selection criteria.