Talk:Category List

Latest revision as of 21:21, 23 August 2023

Source: "asset.gs" lines 401ff from Trainz 22 Build 122418

 //=============================================================================
 // Name: AssetCategory
 // Desc: Defines the standard searchable category codes for assets and objects. 
 //       Category codes are used to define 'types' of objects and allow your
 //       scripts to search for very specific or very broard types of objects
 //       within a route. The codes themselves are derived from asset kind/type,
 //       the "category-class" tag, and potentially other config file tags.
 //
 //       This list should be consulted for all named object and asset searches
 //       and the defines referenced directly wherever possible. This ensures 
 //       correct validation of your scripts should a type code be updated,
 //       become obsolete, etc.
 //
 //       Cateogory codes may also be combined to narrow your search by using
 //       the semicolon (;) character. For example you can search for grass/tree
 //       splines by using "Flora;Spline". You can also broaden a search to
 //       include multiple category lists using the vertical bar (|) character.
 //       Each vertical bar acts as an OR operator on the lists. For example you
 //       can search for flora or fauna splines using "Spline;Flora|Spline;Fauna"
 //       (i.e. *NOT* "Spline;Flora|Fauna" which would match all flora splines,
 //       and any fauna tagged object/spline/etc).
 //
 //       Content creators can also add custom category codes to their assets
 //       via the category-class tag. Such codes are prefixed with the '#'
 //       character (e.g. "#CITY"). These may be used freely to allow you to
 //       tag and search for assets which may support a specific 3rd party
 //       library, feature, etc.
 //
 //       Note that there may exist other category codes which are not listed
 //       here, but use of those is considered unsupported and may break without
 //       notice in any future version of Trainz.
 //
 //=============================================================================

 final static class AssetCategory
 {

   // Map Object, Track and Spline category codes
   public define string Bridge               = "BRG";
   public define string Building             = "BD";
   public define string Crossing             = "FIXD;CROS";
   public define string Fauna                = "FA";
   public define string FixedTrack           = "FIXD";
   public define string Flora                = "FL";
   public define string Industry             = "IND";
   public define string InterlockingTower    = "IT";
   public define string Junction             = "TO;?WX";
   public define string Mesh                 = "CMP;MESH";
   public define string People               = "PP";
   public define string Road                 = "RD";
   public define string Scenery              = "SY";
   public define string SceneryWithTrack     = "SWT";
   public define string Signal               = "TO;?WA";
   public define string Spline               = "SPLN";
   public define string Track                = "TK";
   public define string Trackmark            = "?WM";
   public define string TrackBridge          = "TK;BRG";
   public define string TrackTunnel          = "TK;TUN";
   public define string TrackObject          = "TO";
   public define string Trigger              = "?WT";
   public define string Tunnel               = "TUN";
   public define string Turntable            = "FIXD;TURN";
   public define string RoadVehicle          = "VE;LND";

   // Train category codes
   public define string Caboose              = "TR;TV;CAB";
   public define string Consist              = "CN";
   public define string Locomotive           = "TR;TV;LOCO";
   public define string MailTrainCar         = "TR;TV;MAIL";
   public define string MonorailVehicle      = "TR;TV;MNR";
   public define string PassengerTrainCar    = "TR;TV;PAX";
   public define string RollingStock         = "TR;TV;ROLL";
   public define string Tram                 = "TR;TV;TRM";  // incl. trolleys, streetcars and other light rail
   public define string TrainCar             = "TR;TV";
   public define string TrainCarDiesel       = "TR;TV;DIES";
   public define string TrainCarElectric     = "TR;TV;ELEC";
   public define string TrainCarSteam        = "TR;TV;STEM";
   public define string TrainCarTender       = "TR;TV;TEND";
   public define string TrainComponent       = "TR;CMP";
   public define string TrainEngine          = "TR;CMP;ESPC";

   // Route and Session category codes
   public define string Region               = "REGN";
   public define string Route                = "RT";
   public define string SaveGame             = "SG";
   public define string Session              = "SS";
   public define string SessionArcade        = "SS;ARCD";
   public define string SessionTutorial      = "SS;TUT";
   public define string TestTrackTest        = "TC";

   // Script type category codes
   public define string AchievementCategory  = "ACHC";
   public define string AchievementGroup     = "ACHG";
   public define string ControlSet           = "CS";
   public define string GameplayMenu         = "GMNU";
   public define string SessionRule          = "RU";
   public define string SessionRuleTemplate  = "RLTM";
   public define string Script               = "SQ";
   public define string ScriptLibrary        = "SLIB";
   public define string ScriptServlet        = "SVLT";

   // Miscellaneous category codes
   public define string Product              = "PROD";
   public define string ProductCategory      = "PRDC";
   public define string DriverCharacter      = "DR";
   public define string DriverCommand        = "SQ;GEN";
   public define string GroundBrush          = "BRSH";
   public define string GroundTexture        = "TX;ENV;GRND";
   public define string HTML                 = "HT";
   public define string Sound                = "SD";
   public define string Texture              = "TX";
   public define string TextureGroup         = "TX;TXGRP";

 };