TrainzOnline - User contributions [en]

Grade Crossing XING BNSF50 CDE

2023-11-16T22:10:30Z

Christopher824:

Class GameObject

2023-10-10T21:17:28Z

Christopher824: /* GetId */

*[[TrainzScript Library Reference|API Hierarchy]]
**[[Class GSObject|GSObject]]
***GameObject
 

*GameObject is the base class for any object that requires messaging and threading support.
*GameObjects are placed in the game's object table, known as the Router.
*You cannot create a GameObject using ''new()'' from a script, all game objects are created by the game.
*Each game object has a unique ID (see [[#GetId|GetId()]]) and many also have a name.
*GameObject instances are often referred to as a ''node'' because they represent a message node in the Router.

==AddHandler==
{{MethodHeader|public native void AddHandler(GameObject target, string major, string minor, string Handler)}}
;Parameters
*'''target''' = Object to add the message handler to. This is usually ''me'' but can be any ''GameObject''.
*'''major''' = [[List of Standard Messages|Message ''major'']] to listen for.
*'''minor''' = [[List of Standard Messages|Message ''minor'']] to listen for. If this paremeter is null or an empty string then all messages that match the ''major'' parameter will be sent to the handler.
*'''Handler''' Name of the message handler method to call. This must have a prototype in of the form ''void MessageHandler(Message msg)''
;Returned Value
*None
;Syntax
AddHandler(me,"Object","Enter","ObjectHandler");
AddHandler(me,"Object","","ObjectHandler");
;Notes
*Adds a message handler to the current class such that it will be called whenever the target GameObject receives a matching message.
*Message handlers called by this means are not threaded and will be executed immediately.
 

==ClearMessages==
{{MethodHeader|public native void ClearMessages(string major, string minor)}}
;Parameters
*'''major''' = [[List of Standard Messages|Message ''major'']] to listen for.
*'''minor''' = [[List of Standard Messages|Message ''minor'']] to listen for.
;Returned Value
*None
;Syntax
ClearMessages("Object","Enter");
;Notes
*Clears any outstanding messages of the specified major and minor types that have been sent via calls to [[#PostMessage|PostMessage()]] and have not yet been processed.
 

==Exception==
{{MethodHeader|public native void Exception(string reason)}}
;Parameters
*'''reason''' = Explanatory text to add to the message box.
;Returned Value
*None
;Syntax
Exception("Fatal Error");
;Notes
*Raises an Exception on the current thread and prints out the contents of the ''reason'' parameter followed by a stack dump.
 

==GetId==
{{MethodHeader|public native int GetId(void)}}
;Parameters
*None
;Returned Value
*The GameObject ID, an integer value which the Router uses to identify the current object.
;Syntax
int ID = GetId();
;Notes
*The ID is unique to the current session.
'''This method is now obsolete. Replace GetId() with GetGameObjectID()'''
 

==GetName==
{{MethodHeader|public native string GetName(void)'''}}
;Parameters
*None
;Returned Value
*The name of the current object if it has one, an empty string otherwise.
;Syntax
string MyName = GetName();
;Notes
*The name returned is the text string that is shown at the top of the property object browser for the object concerned.
*If the name has been assigned by the game this will be the asset's username followed by a serial number.
*The string returned by this method is not guaranteed to be unique although TRS will issue prompts requesting confirmation in situations where duplication of names is about to occur.
*The name persists from session to session.
 

==PostMessage==
{{MethodHeader|public native void PostMessage(GameObject dest, string major, string minor, float seconds)}}
;Parameters
*'''dest''' = Destination object for the message. If this is null the message will be broadcast.
*'''major''' = [[List of Standard Messages|Message ''major'']] to be sent.
*'''minor''' = [[List of Standard Messages|Message ''minor'']] to be sent.
*'''seconds''' = Delay in seconds before the message is posted. If this is zero the message will be posted immediately.
;Returned Value
*None
;Syntax
PostMessage(me,"Timer","Tick",10.0);
PostMessage(null,"Browser-URL","live://next",0.0);
;Notes
*Messages sent via this method are processed by the Router in the next game update after they become due.
 

==SendMessage==
{{MethodHeader|public native void SendMessage(GameObject dest, string major, string minor)}}
;Parameters
*'''dest''' = Destination object for the message. If this is null the message will be broadcast.
*'''major''' = [[List of Standard Messages|Message ''major'']] to be sent.
*'''minor''' = [[List of Standard Messages|Message ''minor'']] to be sent.
;Returned Value
*None
;Syntax
SendMessage(train,"Object","Enter");
;Notes
*Sends a message to the destination object for immediate processing.
 

==Sleep==
{{MethodHeader|public native void Sleep(float seconds)}}
;Parameters
*'''seconds''' = Time to wait in seconds.
;Returned Value
*None
;Syntax
Sleep(10.0);
;Notes
*Causes the current thread to pause for the specified period of time.
*Warning! Sleep(World.PlaySound(...)) should no longer be used, as PlaySound does not return the file duration anymore!
 

==Sniff==
{{MethodHeader|public native void Sniff(GameObject target, string major, string minor, bool state)}}
;Parameters
*'''target''' = Game Object to which the handler will be attached.
*'''major''' = [[List of Standard Messages|Message ''major'']] to listen for.
*'''minor''' = [[List of Standard Messages|Message ''minor'']] to listen for. If this parameter is null or an empty string then all messages matching the ''major'' parameter will be processed.
*'''state''' = Boolean flag to set whether or not the handler is currently active.
;Returned Value
*None
;Syntax
Sniff(train,"Object","Enter",true);
;Notes
*Attaches a message handler to another object allowing the current script to listen in on the specified messages.
*Messages of the specified type received by the target object will be copied to the current script.
*The current script will usually need a separate handler to process these messages and will normally need to check the identity of the message source.
 

==Code Examples==
Script calls made during the Init() method of an object can never be certain that other objects within the map have already been initialised. In cases where initialisation depends on the existence of other objects [[#PostMessage|PostMessage()]] can be used to delay part or all of the startup. Messages sent in this way are never processed until the next game update and this does not occur until all objects have been initialised.
public void Init(void)
{
inherited();
SetupTasks();
AddHandler(me,"Setup","","SetupHandler");
PostMessage(me,"Setup","",0.0);
}

void SetupHandler(Message msg)
{
if (msg.src == me)
{
MoreSetupTasks();
}
}
 

==Related Methods==
[[Class Router#GetGameObject|Router.GetGameObject()]] 
[[Class Router#PostMessage|Router.PostMessage()]] 
[[TrainzScript Message Reference]] 

==Categories==
[[Category:Script Class]]

Class SceneryWithTrack

2023-10-10T21:13:52Z

Christopher824: /* FindTriggerContainingNode */ GetId is now obsolete

*[[TrainzScript Library Reference|API Hierarchy]]
**[[Class GSObject|GSObject]] *
***[[Class GameObject|GameObject]]
****[[Class TrainzGameObject|TrainzGameObject]]
****[[Class PropertyObject|PropertyObject]] *
*****[[Class MeshObject|MeshObject]]
******[[Class MapObject|MapObject]]
*******SceneryWithTrack
 

*Parent class for scenery objects that have attached track and attached trigger support, such as industries and crossings.
*Where triggers are covered within this document these are attached scenery triggers, as defined in the asset's ''attached-trigger'' table, and should not be confused with Trackside [[Class Trigger|Triggers]].
*Attached scenery triggers and their attributes (name, radius, track) are defined as part of the asset's configuration and cannot be altered or moved in Surveyor.
 

==Related Messages==
*Messages sent to and from SceneryWithTrack objects are listed below:
 
{{TableHeader|width=50%|margin=15px}}
|-
|bgcolor="#EEEEEE"|'''Major'''||bgcolor="#EEEEEE"|'''Minor'''||bgcolor="#EEEEEE"|'''Source'''||bgcolor="#EEEEEE" |'''Destination'''
|-
|[[Object Messages|SceneryTrigger]]||Enter||SceneryWithTrack||Vehicle
|-
|[[Object Messages|SceneryTrigger]]||InnerEnter||SceneryWithTrack||Vehicle
|-
|[[Object Messages|SceneryTrigger]]||Stopped||SceneryWithTrack||Vehicle
|-
|[[Object Messages|SceneryTrigger]]||InnerLeave||SceneryWithTrack||Vehicle
|-
|[[Object Messages|SceneryTrigger]]||Leave||SceneryWithTrack||Vehicle
|-
|[[Object Messages|Object]]||Enter||Vehicle||SceneryWithTrack
|-
|[[Object Messages|Object]]||InnerEnter||Vehicle||SceneryWithTrack
|-
|[[Object Messages|Object]]||Stopped||Vehicle||SceneryWithTrack
|-
|[[Object Messages|Object]]||InnerLeave||Vehicle||SceneryWithTrack
|-
|[[Object Messages|Object]]||Leave||Vehicle||SceneryWithTrack
|}
 
*Embedded [[Class JunctionBase|JunctionBase]] objects issue their own messages in addition to those sent to and from the parent SceneryWithTrack object.
 

==FindTriggerContainingNode==
{{MethodHeader|public native string FindTriggerContainingNode(GameObjectID node, bool onlyInner)}}
;Parameters
*'''node''' = The GameObjectID of a vehicle, usually obtained by a call to [[Class GameObject#GetId|GetId ()]].
*'''onlyInner''' = If true only the inner radius of the trigger will be tested, if false the the trigger name will be returned if the vehicle is within 150 metres of the trigger. which trigger is returned if more than one meets this test?
;Returned Value
*The name of the scenery trigger found, an empty string otherwise.
;Syntax
string trigger = FindTriggerContainingNode(vehicle.GetGameObjectID(),true);
;Notes
*This method returns the name of the attached scenery trigger within which the specified vehicle is currently located.
*int GetID() is now obsolete
 

==GetAttachedJunctions==
{{MethodHeader|public native JunctionBase[ ] GetAttachedJunctions(void)}}
;Parameters
*None
;Returned Value
*An array of any attached [[Class JunctionBase|JunctionBase]] objects included within this object, null if there are no such attachments.
;Syntax
JunctionBase[] nodes = GetAttachedJunctions();
;Notes
*JunctionBase arrays are only returned for objects set up as fixed track junctions.
*The array contains the JunctionBases listed in the ''junction-vertices'' container in ''config.txt''.
*The size of the array and the ordering of the individual components will match the number and sequence of the subcontainers within the ''junction-vertices'' table.
 

==GetAttachedTrack==
{{MethodHeader|public native Track GetAttachedTrack(string trackName)}}
;Parameters
*'''trackName''' = The named track section as defined in the ''attached-track'' table in ''config.txt''.
;Returned Value
*A reference to a [[Class Track|Track]] object if it exists, a script exception will occur otherwise.
Wouldn't null be more polite than an exception?
;Syntax
Track track = GetAttachedTrack("track01");
;Notes
 

==GetTriggerTrack==
{{MethodHeader|public native Track GetTriggerTrack(string triggerName)}}
;Parameters
*'''triggerName''' = A trigger name as defined in the ''attached-trigger'' container in ''config.txt''.
;Returned Value
*A reference to a [[Class Track|Track]] object if it exists, a script exception will occur otherwise.
Wouldn't null be more polite than an exception?
;Syntax
Track track = GetTriggerTrack("trigger01");
;Notes
*The track returned is as sepcified in the ''track'' tag of the ''attached-trigger'' table in ''config.txt''.
 

==InnerReEnter==
{{MethodHeader|public native bool InnerReEnter(int node)}}
;Parameters
*'''node''' = Node Id of a vehicle to be re-entered into inner trigger radius.
;Returned Value
*True if the vehicle is within the inner trigger radius and the message has been sent, false otherwise.
;Syntax
InnerReEnter(vehicle.GetId());
;Notes
*The effect of this method is to cause a new ''Object,InnerEnter'' message to be sent from the vehicle to the SceneryWithTrack object.
 

==InnerReEnterTrain==
{{MethodHeader|public void InnerReEnterTrain(Train train)}}
;Parameters
*'''train''' = A train reference, InnerReEnter will be called on all the vehicles in the train.
;Returned Value
*None
;Syntax
InnerReEnterTrain(train);
;Notes
*Messages are only issued in respect of vehicles actually within the inner trigger at the time of the call?
 

==IsTrainInTriggers==
{{MethodHeader|public native bool IsTrainInTriggers(Train train, bool onlyInner}}
;Parameters
*'''train''' = A reference to the train to look for.
*'''onlyInner''' = If true only the inner radius of the trigger will be tested, if false the the radius tested will be the default 150 metres.
;Returned Value
*True if any part of the specified train is within the trigger radius, false otherwise.
;Syntax
bool trainFound = IsTrainInTriggers(train,true);
;Notes
 

==ReEnter==
{{MethodHeader|public native bool ReEnter(int node)}}
;Parameters
*'''node''' = Node Id of a vehicle to be re-entered into default 150 metre trigger radius.
;Returned Value
*True if the vehicle is within the 150 metre trigger radius and the message has been sent, false otherwise.
;Syntax
ReEnter(vehicle.GetId());
;Notes
*The effect of this method is to cause a new ''Object,Enter'' message to be sent from the vehicle to the SceneryWithTrack object.
 

==Code Examples==
 

==Related Methods==
[[Class Industry#HasTrack|Industry.HasTrack()]]

[[Class JunctionBase#GetMapObject|JunctionBase.GetMapObject()]]

==Categories==
[[Category:Script Class]]

Class GameObject

2023-10-10T21:05:40Z

Christopher824: /* GetId */ Obsolete

*[[TrainzScript Library Reference|API Hierarchy]]
**[[Class GSObject|GSObject]]
***GameObject
 

*GameObject is the base class for any object that requires messaging and threading support.
*GameObjects are placed in the game's object table, known as the Router.
*You cannot create a GameObject using ''new()'' from a script, all game objects are created by the game.
*Each game object has a unique ID (see [[#GetId|GetId()]]) and many also have a name.
*GameObject instances are often referred to as a ''node'' because they represent a message node in the Router.

==AddHandler==
{{MethodHeader|public native void AddHandler(GameObject target, string major, string minor, string Handler)}}
;Parameters
*'''target''' = Object to add the message handler to. This is usually ''me'' but can be any ''GameObject''.
*'''major''' = [[List of Standard Messages|Message ''major'']] to listen for.
*'''minor''' = [[List of Standard Messages|Message ''minor'']] to listen for. If this paremeter is null or an empty string then all messages that match the ''major'' parameter will be sent to the handler.
*'''Handler''' Name of the message handler method to call. This must have a prototype in of the form ''void MessageHandler(Message msg)''
;Returned Value
*None
;Syntax
AddHandler(me,"Object","Enter","ObjectHandler");
AddHandler(me,"Object","","ObjectHandler");
;Notes
*Adds a message handler to the current class such that it will be called whenever the target GameObject receives a matching message.
*Message handlers called by this means are not threaded and will be executed immediately.
 

==ClearMessages==
{{MethodHeader|public native void ClearMessages(string major, string minor)}}
;Parameters
*'''major''' = [[List of Standard Messages|Message ''major'']] to listen for.
*'''minor''' = [[List of Standard Messages|Message ''minor'']] to listen for.
;Returned Value
*None
;Syntax
ClearMessages("Object","Enter");
;Notes
*Clears any outstanding messages of the specified major and minor types that have been sent via calls to [[#PostMessage|PostMessage()]] and have not yet been processed.
 

==Exception==
{{MethodHeader|public native void Exception(string reason)}}
;Parameters
*'''reason''' = Explanatory text to add to the message box.
;Returned Value
*None
;Syntax
Exception("Fatal Error");
;Notes
*Raises an Exception on the current thread and prints out the contents of the ''reason'' parameter followed by a stack dump.
 

==GetId==
{{MethodHeader|public native int GetId(void)}}
;Parameters
*None
;Returned Value
*The GameObject ID, an integer value which the Router uses to identify the current object.
;Syntax
int ID = GetId();
;Notes
*The ID is unique to the current session.
'''This method is now obsolete. Replace GetID() with GetGameObjectID() instead'''
 

==GetName==
{{MethodHeader|public native string GetName(void)'''}}
;Parameters
*None
;Returned Value
*The name of the current object if it has one, an empty string otherwise.
;Syntax
string MyName = GetName();
;Notes
*The name returned is the text string that is shown at the top of the property object browser for the object concerned.
*If the name has been assigned by the game this will be the asset's username followed by a serial number.
*The string returned by this method is not guaranteed to be unique although TRS will issue prompts requesting confirmation in situations where duplication of names is about to occur.
*The name persists from session to session.
 

==PostMessage==
{{MethodHeader|public native void PostMessage(GameObject dest, string major, string minor, float seconds)}}
;Parameters
*'''dest''' = Destination object for the message. If this is null the message will be broadcast.
*'''major''' = [[List of Standard Messages|Message ''major'']] to be sent.
*'''minor''' = [[List of Standard Messages|Message ''minor'']] to be sent.
*'''seconds''' = Delay in seconds before the message is posted. If this is zero the message will be posted immediately.
;Returned Value
*None
;Syntax
PostMessage(me,"Timer","Tick",10.0);
PostMessage(null,"Browser-URL","live://next",0.0);
;Notes
*Messages sent via this method are processed by the Router in the next game update after they become due.
 

==SendMessage==
{{MethodHeader|public native void SendMessage(GameObject dest, string major, string minor)}}
;Parameters
*'''dest''' = Destination object for the message. If this is null the message will be broadcast.
*'''major''' = [[List of Standard Messages|Message ''major'']] to be sent.
*'''minor''' = [[List of Standard Messages|Message ''minor'']] to be sent.
;Returned Value
*None
;Syntax
SendMessage(train,"Object","Enter");
;Notes
*Sends a message to the destination object for immediate processing.
 

==Sleep==
{{MethodHeader|public native void Sleep(float seconds)}}
;Parameters
*'''seconds''' = Time to wait in seconds.
;Returned Value
*None
;Syntax
Sleep(10.0);
;Notes
*Causes the current thread to pause for the specified period of time.
*Warning! Sleep(World.PlaySound(...)) should no longer be used, as PlaySound does not return the file duration anymore!
 

==Sniff==
{{MethodHeader|public native void Sniff(GameObject target, string major, string minor, bool state)}}
;Parameters
*'''target''' = Game Object to which the handler will be attached.
*'''major''' = [[List of Standard Messages|Message ''major'']] to listen for.
*'''minor''' = [[List of Standard Messages|Message ''minor'']] to listen for. If this parameter is null or an empty string then all messages matching the ''major'' parameter will be processed.
*'''state''' = Boolean flag to set whether or not the handler is currently active.
;Returned Value
*None
;Syntax
Sniff(train,"Object","Enter",true);
;Notes
*Attaches a message handler to another object allowing the current script to listen in on the specified messages.
*Messages of the specified type received by the target object will be copied to the current script.
*The current script will usually need a separate handler to process these messages and will normally need to check the identity of the message source.
 

==Code Examples==
Script calls made during the Init() method of an object can never be certain that other objects within the map have already been initialised. In cases where initialisation depends on the existence of other objects [[#PostMessage|PostMessage()]] can be used to delay part or all of the startup. Messages sent in this way are never processed until the next game update and this does not occur until all objects have been initialised.
public void Init(void)
{
inherited();
SetupTasks();
AddHandler(me,"Setup","","SetupHandler");
PostMessage(me,"Setup","",0.0);
}

void SetupHandler(Message msg)
{
if (msg.src == me)
{
MoreSetupTasks();
}
}
 

==Related Methods==
[[Class Router#GetGameObject|Router.GetGameObject()]] 
[[Class Router#PostMessage|Router.PostMessage()]] 
[[TrainzScript Message Reference]] 

==Categories==
[[Category:Script Class]]

Category-class

2023-09-30T13:25:56Z

Christopher824: /* Class Y: MAPS & SCENARIOS */ added YA

{{ORP-top}}
==Category-class Tags==
The '''"category-class" tag''' of the [[KIND_TrainzBaseSpec|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.'' This should not be confused with the [[Category List]], which is a related but distinct topic.
{{UserTip|width=50%|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 ({{wp|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 {{wp|Three-dimensional space|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){{TBS}}
::'''<big><big>Figure: 1 TrainzBaseSpec for quick reference</big></big>'''


==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!
{{TrainzTip|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.}} Rejoice in the positive, they are essentially free and cost you nothing but a bit of puzzlement. Free is good! Having them is better.

==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.

{|
|-valign="top"
|
===Class A: MOTIVE POWER===
*AA Electric Multi-current
*AC AC Electric
*AD DC Electric
*AE Experimental or Special
*AG Gas Turbine
*AH Diesel Hydraulic
*AL Diesel & Diesel Electric
*AM Mammal
*AS Steam Loco & Tender
*AT Steam Tank

===Class B: BUILDINGS & STRUCTURES===
*BB Buildable (Kind Buildable)
*BC Commercial (scenery non-functional)
*BI Industrial (scenery non-functional)
**BIN Industry asset with product processing functionality
*BH Home & Residential (scenery non-functional)
*''Subclass BP: Passenger Station''
**BPF Passenger Station with passenger processing functionality
**BPN Passenger Station (non-functional)
*BR Railway (scenery non-functional)
*BS Special (e.g. military) (scenery non-functional)
*BT Traffic & Streetscape (scenery non-functional)
*BU Utility (incl. Civil buildings) (scenery non-functional)

===Class C: CABEESE / CONSIST / EFFECTS===
*CB Brake van
*CC Caboose
*CLUT Clutter Effect
*CN Consist
*CS ControlSet

===Class D: DEFENCE===
*DA Military motive power
*DE Military experimental & special vehicles
*DP Military equipment - lab & personnel vehicles
*DX Military equipment - freight

===Class E: ENVIRONMENT===
*ES Sky
*EW Water

===Class F: FOLIAGE===
*FC Cactii
*FF Flowers
*FO Orchards & Crops
*FS Shrub
*FT Trees

===Class G: GROUND===
*GA Arid
*GL Lush
*GS Seasonal

===Class H: MESHES===
*HM Mesh

===Class I: PRODUCT===
*IC Container Category
*IP Passenger Category
*IB Bulkload Category
*IL Liquid Category

===Class J: TEXTURES===
*JC Corona
*JI Icon
*JP Particle Effects Texture
*JO Other Texture

===Class L: LIGHT RAIL & MONORAIL===
*LS Articulated train sets
*LT Trolleys, trams & streetcars
*LM Monorail vehicles

===Class M: MAINTENANCE of WAY===
*MA Camp vehicles
*MB Ballast cars
*MC Cranes/lifting
*MD Diagnostic vehicles (e.g. dynamometer)
*ME Instructional vehicles
*MF Fire vehicles
*MI Inspection vehicles
*MT Track vehicles (e.g. tamper)
*MP Snow ploughs
*MS Section cars (e.g. fairmont)
*MX Freight equipment (for MoW traffic)
*MW Weed spray

===Class O: ORGANISM===
*OA Animal Kingdom
*OH Human
**OHD Locomotive Driver

===Class P: PASSENGER & MAIL CARS===
*PA Suburban/short haul (no W.C.)
*PB Baggage cars
*PC Coach/chair cars
*PD Dome cars
*PH Bar/cafeteria cars
*PL Lounge cars
*PM Mail cars
*PO Observation cars
*PP Power cars
*PR Buffet/dining/restaurant cars
*PS Sleeping cars
*PU Special cars (e.g. Gaming Cars)
*PV Private cars
*PX Composite passenger cars

|
===Class R: RAILCARS & MULTIPLE UNIT SETS===
*RA AC electric
*RC DC electric
*RD Diesel & diesel electric
*RH Diesel hydraulic
*RP Petrol
*RS Steam

===Class S: SPLINES===
*SF Fences
*SR Roads
*SP Platforms
*SS Structure
*SV Vegetation

===Class T: TRACK===
*TB Bridge
*TC TestTrack Course
*TR Rails
*TT Tunnel
*TURF Turf Effect
*TF Fixed Track

===Class V: VEHICLES===
*VA Air
*VL Land
*VS Sea

===Class W: WAYSIDE===
*WA Signalling
*WS Trackside signage
*WX Accessories

===Class X: FREIGHT CARS===
*XA Auto transporter
**XAA Open sides
**XAB Auto box car
*XB Box car/covered van
**XBD Dangerous goods
**XBG General service
**XBI Insulated
*XF Flat
**XFA Articulated
**XFC Intermodal
**XFD Depressed center
**XFH Heavy duty
**XFM General service
*XG Gondola/open wagon
**XGB Bottom dumping
**XGC Combination bottom/end/side dumping
**XGE End dumping
**XGR Rotary dumping
**XGS Side dumping
**XGT Covered
*XH Hopper
**XHB Bottom dumping
**XHC Combination bottom/end/side dumping
**XHE End dumping
**XHR Rotary dumping
**XHS Side dumping
**XHT Covered
*XI Foundry
**XIB Bottle/torpedo cars
**XIT Tipper/slag cars
*XL Livestock
**XLA Single deck
**XLC Multiple deck and convertible
**XLH Horse box
*XR Refrigerated
**XRI Ice chilled
**XRM Mechanically chilled
*XS Special
**XSN Novelty
**XSU Unclassified
*XT Tanker
**XTA Domeless
**XTS Single dome
**XTM Multiple dome
*XV Ventilated car/louvred van
**XVG General service
**XVP Produce service

===Class Y: MAPS & SCENARIOS===
*YA Arcade Session
*YD Driver Command
*YH HTML-Asset
*YL Script Library
*YM Map
*YP Profile/Session
*YR Rule
*YS Scenario
*YT Tutorial Session
*YX Region

===Class Z: TRAIN PARTS===
*ZB Bogie/Truck
*ZE Enginespec
*ZH Hornsound
*ZI Interior
*ZP Pantographs
*ZS Enginesound
*ZX Displacement Map (PaintShed-Template Obsolete)
*ZY (Paintshed-Skin Obsolete)
|}
[[Category:Config Tag|category-class tag]]
{{ORP-bot|category-class tag}}

TCCP Content Creation

2023-06-26T21:05:13Z

Christopher824: Added link about Discord

'''[[TCCP]]''' 
This page is a guide for Trainz Content Creation Program or 'TCCP' 
TCCP Beta Testers should look here '''[[TCCP Beta Testing]]'''

'''Under Development''' The contents and the layout of this page is under development.

Trainz Content Creation Program or TCCP allows you to become a Registered Content Creator with N3V Auran. You will be eligible to upload Content which may be made available for download by Trainz users, and, for Approved Content, to receive a share of revenues for sales relating to your Content.

=Getting Started=

==Set Up Account==
Your first step is to get a TCCP account at [https://tccp.auran.com/ '''tccp.auran.com''']
When you create your account use your My Trainz username and password. You will be asked to accept the EULA terms and conditions. This account will be the same for content creation and beta testing, so please do not try to create multiple accounts.

Once you have an account created you can find a lot more detailed instructions under [https://tccp.auran.com/documentation.php '''tccp.auran.com/documentation.php'''].

This video also explains most of what you need to get up and running. It is a long video but is split into sections so you can skip to what you need: [https://www.youtube.com/watch?v=6J9Bhq5vIxk&t=65s '''DETAILED VIDEO''']

==Connect With Other Creators==
More heads are better than one. There are differnt ways to connect with other content creators and you should be involved with this. Trainz is a community based platform, and as such you need to be involed to help gaurantee success. You will find if you are a team player, you will benifit from the team. Here are some avenues to connect;

* [https://forums.auran.com/trainz/forum.php '''Trainz Forums''']
* Trainz Discord channel For this you will need an invite, [https://www.trainzportal.com/blog/view/content-creator-live-chat '''More Information Here''']

=Creating A Package=

==Thumbnails==

Your primary asset(s), Routes, Sessions, Rolling Stock and Locos must have the proper set of thumbnails. To add the thumbnails to your asset, edit the config.txt and make sure it looks like the code below, take note of the dimensions and filenames listed for each thumbnail. If you do not have the correct size thumbnails or filenames, you will need to create or modify them. If the 'default' thumbnail is not named 'thumbnail.jpg', it will not create the auto generated 'new' session thumbnail when a new session is created.

thumbnails
{
0
{
image "0.jpg"
width 1280
height 800
}

1
{
image "1.jpg"
width 1280
height 800
}

2
{
image "2.jpg"
width 1280
height 800
}

default
{
image "thumbnail.jpg"
width 512
height 384
}
}

==TCCP Manager==
Current TCCP projects can be from a TRS19 or TRS22 build. Do not try to create a package using a Beta Build. If you can submit your project in TRS19 SP5, then you can target both TRS19 and TRS22 customers. Open Trainz and look for the Developer Tab. It can be found from the Launcher and the Content Manager.
* Select 'Open TCCP Project List'
* Right Click inside window and select 'Create New Project...'

Once the panel opens, type in a Title. Then type a description in the text box, it can be anything as these will not be the final title or description, so it could just be a note at this point. If you close this dialog without giving it a Title or a Description, you will get an error. If you wish to still quit, close the dialog a second time and it will abandon the project. If you close the dialog with a Title and Description, a TCCP Project ID will be assigned to your project and now can be found on the TCCP website.

In the TCCP Project List, your project will now be listed. You can right click on it and it will give you the option of 'Edit Project...' and 'View Project on TCCP Website...'.

When you choose edit project, the window that pops up it will now have your title on the menu bar. The first list box is where you place the assets you have made and wish to distribute. You will need to open a Content Manager window, and drag your creation(s) into it. The second box is which from the first box you want to encode as payware. You can now drag from the first box to the second box to populate it. If you are a route creator, and wish to have an unlocked base session, you would leave that session out of the second box.

==Using newer asset versions where available==
Checkbox - ''need more info on this setting?'' Default leave unchecked.

==Uploading==

Once you have populated the two list boxes, click the 'Upload Package' button on the bottom right of the dialog.
*.TZARC - Trainz Archive File
The manager will attempt to build your files into a .tzarc file. It will add every dependancy the package needs into the file. If succesful it will upload it to the TCCP build machine.

==Errors==
* '''Payware''' You can not include payware in your project, this includes dependencies.
* '''Packaged and not avialable''' This will happen from time to time. There are different ways to fix this. You could edit your creation and remove the offending asset. You could clone the asset if the license allows or you have permission, then upload it to the DLS, then replace your old one with the new one from the DLS. Or you could open a helpdesk ticket if there is an earlier version on the DLS. If the only version available is the packaged one, then you must remove or clone.
* '''Unfeasable''' You already have a built package on the TCCP website. You will need to go to the website and cancel the package, then delete the .tzarc file. You will now be able to upload your package.
* '''Unknown Errors''' 

=TCCP Package Setup=

==Login==

Once you have uploaded your .tzarc file you will need to login at the TCCP website and navigate to your file or Package. The top level, or the Apps Dashboard, has 3 major sections. Content, Beta Testing and Documentation. Your file will be in the Content section or the Content Creator Dashboard. At the bottom of the page will be a list of your projects. Click on the title of your package in the list to continue to the Content Creator Project.

==Package==

You are required to fill in all the fields before clicking the 'Update Package' button at the bottom of this page. What is entered here can be changed before you submit it to the build machine, so don't be worried if it's not 100% accurate at this point. The Title and Description will overright the Trainz TCCP Manager, so this is important to remember if you need to modify your .tzac file and re-upload it.

==Images==

Upload at least six 1280 (width) x 800 (height) marketing screenshots and one 600 (width) x 262 (height) Trainz Store header image for your product. Accepted upload formats: 'png' or 'jpg'. Please ensure to include a 1280x800 resolution version of the 600x262 header image in the screenshots section as well, as this is required for creating the header images for Steam.

These images will not effect the images in your assets config.txt file.

Optionally you can upload a YouTube video.

==Files==

You can have only one .tzarc file uploaded for a project. If you need to change something, you will have to delete the file from this page. Depending at which stage your project is in, you may need to Cancel Beta and/or Cancel Project

==Beta Testing==

Before you submit for Beta Testing you should add your own questions as part of your Beta so testers have specific details to test with your content. You can add specific testing questions under the Test Plan Tools

==Assets==

==Notifications==

 

=Build Machine=

Near the top of each Content Creator Project page is a status box showing the current build status of the package. Once your package has passed all the requirements, the Submit To Build Queue button will appear.

* Prepare For Submission
* Building Your package is building. It may take up to a couple of hours or more to build the project.
* Failed
* Success Your package passed and can now be submitted for Beta Testing
* Live N3V has approved your package and it is now on the store.

 

=Beta Testing=

==Test Quesions==

==Tickets==

 

=Final Review=

Once you have addressed all tickets opened during the beta test, which could mean that you will have to submit a new beta, again, to confirm the fixes. Your package will pass beta and go into Final Review. This is where it is now scrutinized by the N3V staff.

Per Zec,
"''Something I've been meaning to do for quite a while is post up a bit of a 'guide' on how we generally review DLC packs. This isn't a hard and fast method, but should help you guys to review your content yourselves before submission There is a difference between routes/sessions and traincars, as they involve different aspects of gameplay. For all content, I will verify that the advertised content is included (ie route, sessions, traincars, consists, etc). This is based on what you advertise in the description (ie if you say there are 5 sessions and I only see 4, I'll send it back to you to double check).''"

After verifying the content is installed, and is fully active, and no open tickets.

==Routes / Sessions==

For routes/sessions:
* Each session is loaded into Driver, and then verified that the session loads successfully
* Drive the session for a few minutes, or untill the first navigation mark or task is complete. This is to ensure that the session is starting correctly, and the initial rules are working correctly. It also ensures that the locomotives and rolling stock at the start of the session are working correctly (ie brakes releasing correctly, and so on).
* Take a quick fly over of the route to make sure it all is loading correctly
* If the DLC pack also advertises custom/specific locomotives and rolling stock, then this will also be reviewed using the below.

==Traincar==

For traincar DLC packs:
* Check that the advertised traincars and consists are present
* Place the traincars onto a blank route, that has the track sitting directly on top of water. This allows me to check that the traincar has a water reflection that works properly, looks like the traincar, and isn't badly broken/distorted.
* For passenger coaches, place them onto a test route with a passenger station to check that the doors work as expected with a passenger station.
* For all traincars, place them onto the KSC2 route, and do a check for obvious mesh/LOD issues (ie obvious changes in the look of the loco when moving toward/away from it). This includes distortions to the texture map, or smoothing issues, on lower LODs.
* At this point, also do a check that all controls work. This means that using keyboard and HUD controls work for all main controls (reverser, throttle, dynamic brake^, train brake, independent brake, headlight, ditch lights^, pantographs^, sander, and of course simple controls mode).
^The controls marked with this are 'optional' on traincars, so are only checked where that item has them fitted. The independent brake, although not always fitted in the cab view, should generally be operational on traincars since the HUD control is available. Dynamic brake, OTOH, is generally acceptable if it is not functional (but it absolutely should be
functional on locos fitted with one).
* Quickly try any advertised scripted functions to make sure these work.
* For locos, take the locomotive for a short drive in Driver to make sure that they drive appropriately (note, this isn't necessarily a check for prototypical operation, but more just to make sure that they operate correctly as a locomotive in general). This also allows checking that sounds are working correctly/etc.
* For rolling stock, do the same, but use a builtin locomotive to haul them.

As a final note regarding traincar DLC packs. It is expected that locomotives and rolling stock scripts will not break default functionality.

Examples of this are startup/shutdown scripts that are off by default. For the average user who purchases a loco with this, they will have no way to know how to startup the locomotive, and hence are stuck with a locomotive that to them simply does not work. For startup/shutdown scripts there are two options for this, one is to simply have the loco on by default and allow the player to choose to turn it off in the properties, and then allow them to go through the startup sequence. Another, as seen on the Frecciarossa train DLC, would be to have the train pop up with a message to provide startup options.

Another example would be custom throttle/brake controls that prevent the HUD controls, DCC controls, or keyboard controls from working. Again the average player who purchases this DLC pack will not know what is happening and will see this content as being broken. In this case you must ensure that custom controls correctly respond to the HUD and keyboard.

==Review Results==

If any issues are found during review, these will be reported via the beta testing bug report system in TCCP. If no issues are found we will then process the DLC pack to PreviewPass for 2 weeks, then release publicly after the 2 week PreviewPass. Note that in some cases, very minor issues might be reported but we may still process to previewpass, these issues should be resolved in an update during previewpass or after release, normally we'll note this in the bug report.

==Request Skip Beta==

Depending on the issues noted, we will generally let you know if you can request skip beta on the package after resolving the noted issues, however if we don't you can choose to request this after building the package. However if the issues noted were something that needs testing, we will reject the skip beta so that it can go through another round of beta testing. Otherwise we will review the DLC pack again, double checking that reported bugs are resolved.
 

=Getting Paid=

In order to get paid for your work, you will need a verified PayPal account. Then you will need an Affiliatly account linked to the PayPal account.

==Affiliatly Account==

You will need to setup an [https://www.affiliatly.com/af-102715/affiliate.panel '''Affiliatly Account''']

Start earning royalties and commissions from your Trainz hobby today.

Are you a Trainz Content Creator? Expand your own website sales and earn commissions on all your items sold through the Trainz Store and via other online stores such as Steam and Mac App Store. (Submit your content through [https://tccp.auran.com/ '''this link''']). Commissions are 50% of the sale price for direct purchases. You will also receive commissions on Silver and Gold subscriptions that download your DLC content. The amount of these commissions vary and a detailed chart can be found under the TCCP website Documentation section.

Do you run a Trainz website or Youtube Channel? Use your Affiliatly link to earn commissions on sales through our store. Each time a user clicks on your link then purchases an item in the next week, you earn a 10% commission on that sale. This could result in a total of 60% on a direct sale.

Registration is free. Sign up now to get your Affiliatly ID and begin earning commissions and royalties. The website tracks the royalties earned for referrals and sales through our TrainzPortal store and shows payments to your nominated account. The amount shown may be less than you will actuallly receive as the subscription revenue does not show here, which is calculated on the processing date as it's a shared revenue.

Once you have set up your account you will be given an Affiliatly ID number. Log back into the TCCP website, and in the Content Creator Dashboard choose Options. Enter your ID and Save. WARNING: Double check your Affiliatly ID. Adding the wrong ID could mean the wrong account is paid!

==PayPal Account==

In order to get paid, you must have a PayPal account linked to your Affiliaty account. You will get paid on the 15th or 16th of each month, depending on your time zone and when they process your account. You must have at least $100 US in earnings before you will get paid.

Category-class

2023-05-15T01:20:06Z

Christopher824: /* Class Y: MAPS & SCENARIOS */

{{ORP-top}}
==Category-class Tags==
The '''"category-class" tag''' of the [[KIND_TrainzBaseSpec|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.'' This should not be confused with the [[Category List]], which is a related but distinct topic.
{{UserTip|width=50%|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 ({{wp|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 {{wp|Three-dimensional space|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){{TBS}}
::'''<big><big>Figure: 1 TrainzBaseSpec for quick reference</big></big>'''


==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!
{{TrainzTip|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.}} Rejoice in the positive, they are essentially free and cost you nothing but a bit of puzzlement. Free is good! Having them is better.

==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.

{|
|-valign="top"
|
===Class A: MOTIVE POWER===
*AA Electric Multi-current
*AC AC Electric
*AD DC Electric
*AE Experimental or Special
*AG Gas Turbine
*AH Diesel Hydraulic
*AL Diesel & Diesel Electric
*AM Mammal
*AS Steam Loco & Tender
*AT Steam Tank

===Class B: BUILDINGS & STRUCTURES===
*BB Buildable (Kind Buildable)
*BC Commercial (scenery non-functional)
*BI Industrial (scenery non-functional)
**BIN Industry asset with product processing functionality
*BH Home & Residential (scenery non-functional)
*''Subclass BP: Passenger Station''
**BPF Passenger Station with passenger processing functionality
**BPN Passenger Station (non-functional)
*BR Railway (scenery non-functional)
*BS Special (e.g. military) (scenery non-functional)
*BT Traffic & Streetscape (scenery non-functional)
*BU Utility (incl. Civil buildings) (scenery non-functional)

===Class C: CABEESE / CONSIST / EFFECTS===
*CB Brake van
*CC Caboose
*CLUT Clutter Effect
*CN Consist
*CS ControlSet

===Class D: DEFENCE===
*DA Military motive power
*DE Military experimental & special vehicles
*DP Military equipment - lab & personnel vehicles
*DX Military equipment - freight

===Class E: ENVIRONMENT===
*ES Sky
*EW Water

===Class F: FOLIAGE===
*FC Cactii
*FF Flowers
*FO Orchards & Crops
*FS Shrub
*FT Trees

===Class G: GROUND===
*GA Arid
*GL Lush
*GS Seasonal

===Class H: MESHES===
*HM Mesh

===Class I: PRODUCT===
*IC Container Category
*IP Passenger Category
*IB Bulkload Category
*IL Liquid Category

===Class J: TEXTURES===
*JC Corona
*JI Icon
*JP Particle Effects Texture
*JO Other Texture

===Class L: LIGHT RAIL & MONORAIL===
*LS Articulated train sets
*LT Trolleys, trams & streetcars
*LM Monorail vehicles

===Class M: MAINTENANCE of WAY===
*MA Camp vehicles
*MB Ballast cars
*MC Cranes/lifting
*MD Diagnostic vehicles (e.g. dynamometer)
*ME Instructional vehicles
*MF Fire vehicles
*MI Inspection vehicles
*MT Track vehicles (e.g. tamper)
*MP Snow ploughs
*MS Section cars (e.g. fairmont)
*MX Freight equipment (for MoW traffic)
*MW Weed spray

===Class O: ORGANISM===
*OA Animal Kingdom
*OH Human
**OHD Locomotive Driver

===Class P: PASSENGER & MAIL CARS===
*PA Suburban/short haul (no W.C.)
*PB Baggage cars
*PC Coach/chair cars
*PD Dome cars
*PH Bar/cafeteria cars
*PL Lounge cars
*PM Mail cars
*PO Observation cars
*PP Power cars
*PR Buffet/dining/restaurant cars
*PS Sleeping cars
*PU Special cars (e.g. Gaming Cars)
*PV Private cars
*PX Composite passenger cars

|
===Class R: RAILCARS & MULTIPLE UNIT SETS===
*RA AC electric
*RC DC electric
*RD Diesel & diesel electric
*RH Diesel hydraulic
*RP Petrol
*RS Steam

===Class S: SPLINES===
*SF Fences
*SR Roads
*SP Platforms
*SS Structure
*SV Vegetation

===Class T: TRACK===
*TB Bridge
*TC TestTrack Course
*TR Rails
*TT Tunnel
*TURF Turf Effect
*TF Fixed Track

===Class V: VEHICLES===
*VA Air
*VL Land
*VS Sea

===Class W: WAYSIDE===
*WA Signalling
*WS Trackside signage
*WX Accessories

===Class X: FREIGHT CARS===
*XA Auto transporter
**XAA Open sides
**XAB Auto box car
*XB Box car/covered van
**XBD Dangerous goods
**XBG General service
**XBI Insulated
*XF Flat
**XFA Articulated
**XFC Intermodal
**XFD Depressed center
**XFH Heavy duty
**XFM General service
*XG Gondola/open wagon
**XGB Bottom dumping
**XGC Combination bottom/end/side dumping
**XGE End dumping
**XGR Rotary dumping
**XGS Side dumping
**XGT Covered
*XH Hopper
**XHB Bottom dumping
**XHC Combination bottom/end/side dumping
**XHE End dumping
**XHR Rotary dumping
**XHS Side dumping
**XHT Covered
*XI Foundry
**XIB Bottle/torpedo cars
**XIT Tipper/slag cars
*XL Livestock
**XLA Single deck
**XLC Multiple deck and convertible
**XLH Horse box
*XR Refrigerated
**XRI Ice chilled
**XRM Mechanically chilled
*XS Special
**XSN Novelty
**XSU Unclassified
*XT Tanker
**XTA Domeless
**XTS Single dome
**XTM Multiple dome
*XV Ventilated car/louvred van
**XVG General service
**XVP Produce service

===Class Y: MAPS & SCENARIOS===
*YA ''unknown, needs update''
*YD Driver Command
*YH HTML-Asset
*YL Library
*YM Map
*YP Profile/Session
*YR Rule
*YS Scenario
*YT Tutorial
*YX Region

===Class Z: TRAIN PARTS===
*ZB Bogie/Truck
*ZE Enginespec
*ZH Hornsound
*ZI Interior
*ZP Pantographs
*ZS Enginesound
*ZX Displacement Map (PaintShed-Template Obsolete)
*ZY (Paintshed-Skin Obsolete)
|}
[[Category:Config Tag|category-class tag]]
{{ORP-bot|category-class tag}}

Index of Tags & Containers

2023-01-15T15:26:58Z

Christopher824: /* ta-tz */ added traffic-speed config tag

{{FUN-beg}}
===About this page===
This is a comprehensive list of tags and containers, where possible linked to the TrainzOnline detail page which covers the data element.
__NOTOC__
{| style="verticle-align:top; border: 2px solid grey; float:center;padding:1ex; align:center; margin-left:2.5%;margin-right:2.5%;"
! Navigable Click-table as Table of Contents
|-
|<hr/>Words beginning with strings between...
|-
|<big>
;{{void
}}[[{{PAGENAME}}#aa-ar|aa-ar]] {{void
}}[[{{PAGENAME}}#as-at|as-at]] {{void
}}[[{{PAGENAME}}#au-az|au-az]] {{void
}}[[{{PAGENAME}}#ba-bo|ba-bo]] {{void
}}[[{{PAGENAME}}#br-cg|br-cg]] {{void

}}[[{{PAGENAME}}#ch-cz|ch-cz]] {{void
}}[[{{PAGENAME}}#da-dz|da-dz]] {{void
}}[[{{PAGENAME}}#ea-ez|ea-ez]] {{void
}}[[{{PAGENAME}}#fa-gz|fa-gz]] {{void
}}[[{{PAGENAME}}#ha-hz|ha-hz]] {{void

}}[[{{PAGENAME}}#ia-iz|ia-iz]]
;{{void

}}[[{{PAGENAME}}#ka-kz|ka-kz]] {{void
}}[[{{PAGENAME}}#la-lz|la-lz]] {{void
}}[[{{PAGENAME}}#ma-mz|ma-mz]] {{void
}}[[{{PAGENAME}}#na-nz|na-nz]] {{void
}}[[{{PAGENAME}}#oa-oz|oa-oz]] {{void

}}[[{{PAGENAME}}#pa-pz|pa-pz]] {{void
}}[[{{PAGENAME}}#qu-rz|qu-rz]] {{void
}}[[{{PAGENAME}}#sa-sz|sa-sz]] {{void
}}[[{{PAGENAME}}#ta-tz|ta-tz]] {{void
}}[[{{PAGENAME}}#ua-vz|ua-vz]] {{void

}}[[{{PAGENAME}}#wa-zz|wa-zz]] 
</big>
|}
{{-}}

==aa-ar==
{| cellpadding="5" cellspacing="0" border="1"
|- style="background-color:#ffffcc;"
|width=15%|Tag or Container
|width=15%|Data Type
|width=15%|Parent
|width=15%|Applies to
|width=40%|Description
|-
|accel
|float,float
|smoke {
|smoke block
|Acceleration. First number is Gravity effect, second is wind effect. Default is 0,0.
|-
|adhesion
|?
|motor {
|engine
|?
|-
|adjust-cross-section-to-ground
|float
|?
|?
|a sub heading in the track container.
|?
|-
|air-drag-coefficient
|?
|motor {
|engine
|?
|-
|alias
|kuid
|config.txt
|general
|Kuid of the asset to be referenced as a basis for the new asset. For example TRS Traincars can reference archived locomotive mesh assets for use with custom textures. This process is done by aliasing the KUID of the archived traincars.
|-
|alias
|kuid
|config.txt
|paintshed-skin
|the kuid of the paintshed template the paintshed reskin is based on
|-
|allowed-categories {
|subcontainer
|queues-ID {
|industry
|The allowed product categories in this queue.
|-
|allowed-products {
|subcontainer
|queues-ID {
|industry
|The allowed products in this queue.
|-
|allows-mixing
|boolean
|config.txt
|product
|Products with this tag may be combined in a single queue along with other products of the same category. Eg. Lumber and 20ft Container on a flatcar. By default, allows-mixing is set to 0. Therefore by default, a queue will only allow one product-category at a time. To look at allows-mixing from another angle, liquid products should never have allows-mixing enabled. Otherwise you have the potential to mix petrol with oil within the same tanker.
|-
|altitude
|?
|config.txt
|region
|altitude of this region
|-
|ambient
|boolean
|soundscript-ID {
|mesh object
|0 or 1, default 0 is off. Ambient sounds have no 3D “position” and may be stereo. Non-ambient (positional) sounds are positioned on the object and must be mono - see attachment above
|-
|amount
|float
|inputs-ID {
|industry
|Amount required as input.
|-
|amount
|float
|outputs-ID {
|industry
|Amount to output.
|-
|angle
|float list degrees
|config.txt
|turntable
|Specifies the angles at which the turntable stops. Not used if the turntable is set up as animation.
|-
|angles
|float list
|mesh-table-ID {
|interior
|Rotational boundaries in radians relative to its attachment point.
|-
|anim
|[path/]filename.kin
|config.txt
|pantograph
|The “anim.kin” animation file for the pantograph
|-
|anim
|[path/]filename.kin
|effects-ID {
|animation effect
|Reference to the animation file (.kin)
|-
|anim
|[path/]filename.kin
|mesh-table-ID {
|mesh object
|The animation file (.kin) exported from 3dsmax.
|-
|animated-mesh
|mesh-table-ID {
|queues-ID {
|industry
|Animated mesh which changes as the queue becomes full.
|-
|animation-loop-speed
|float
|mesh-table-ID {
|mesh object
|This tag must be here if the asset is to animate when placed. If this tag is not here when placed the animation will not play by default, but may play if controlled by script. A different value (e.g. 0.5, 2.0) may be used in the tag to play the animation at a different speed from that created in 3dsmax.
|-
|animdist
|float
|config.txt
|bogey
|Leave this tag out if the bogey is not animated. The distance traveled in meters by the bogeys in 1 second (30 frames) of animation. Bogey animations (exported from 3ds Max) are called “anim.kin”.
|-
|}

==as-at==
{| cellpadding="5" cellspacing="0" border="1"
|- style="background-color:#ffffcc;"
|width=15%|Tag or Container
|width=15%|Data Type
|width=15%|Parent
|width=15%|Applies to
|width=40%|Description
|-
|asset-filename
|string
|config.txt
|general
|Obsolete
|-
|att
|helper
|attached-trigger-ID {
|industry
|Attachment point (stored in the mesh file)
|-
|att
|helper
|effects-ID {
|effects-ID {
|The effect insertion point. The attachment point must be orientated correctly in 3dsmax.
|-
|att
|helper
|mesh-table-ID {
|mesh object
|The mesh (and animation if present) is inserted at a mesh attachment point rather than the origin (without this line the mesh is placed relative to the origin of the parent model).
|-
|attached-track {
|container
|config.txt
|scenery with track
|Auto-generated spline track. Generated through attachment points located within the default mesh. Attached-tracks update automatically to the spline track connected to it. You may over-ride this auto-update feature by adding useadjoiningtracktype 0 Note. Correct track end attachment orientation is essential. The Y axis must point ‘out’ at the correct angle. The Z axis must point ‘up’.
|-
|attached-track-ID {
|subcontainer
|attached-track {
|scenery with track
|User supplied identifier
|-
|attached-trigger {
|container
|config.txt
|industry
|A Trigger is a point along an attached track with a specified radius. When a compatible rollingstock item enters this radius it triggers a set of commands,controlled through its script.
|-
|attached-trigger-ID {
|User supplied identifier
|attached-trigger {
|industry
|User supplied identifier
|-
|attachment
|helper
|smoke# {
|smoke block
|The attachment point (stored in the mesh file) to place the smoke effect.
|-
|attachment
|helper
|soundscript-ID {
|mesh object
|Attachment point on the object to which the sound is attached. Default: The sound will attach to the origin of parent object (not used for ambient sound)
|-
|attachment-points {
|subcontainer
|queues-ID {
|industry
|List of attachment points for this queue on which products are visualised. (Use this, OR animated-mesh)
|-
|att-parent
|mesh-table-ID {
|mesh-table-ID {
|mesh object
|The tag tells Trainz in which mesh the attachment point is located. The insertion attachment point is located within the mesh ‘name’ , as listed in the config.txt.
|-
|}
==au-az==
{| cellpadding="5" cellspacing="0" border="1"
|- style="background-color:#ffffcc;"
|width=15%|Tag or Container
|width=15%|Data Type
|width=15%|Parent
|width=15%|Applies to
|width=40%|Description
|-
|author
|string
|config.txt
|general
|Author, contact-email and contact-website are useful information, particularly if a user has a question on your models or would like to offer help or suggestions.
|-
|autobrakecylinder
|?
|volume {
|engine
|?
|-
|autobrakecylinder_start
|?
|pressure {
|engine
|?
|-
|autobrakecylindervent
|?
|flowsize {
|engine
|?
|-
|auto-create
|boolean
|mesh-table-ID {
|mesh object
|The model is generated automatically when placed, or when you load a map which includes the model. In some instances you don’t want the mesh visible (as this may be controlled through script). If auto-create is 0 the mesh will not be visible when placed.
|-
|autoname
|boolean
|config.txt
|general
|When enabled, automatically assigns a unique name to this object as it is placed.
|-
|autopilotmode
|boolean
|driver-settings {
|activity
|AI driver setting. (off, on)
|-
|auxreservoir
|?
|volume {
|engine
|?
|-
|auxreservoir_autobrakecylinder
|?
|flowsize {
|engine
|?
|-
|auxreservoir_no3
|?
|flowsize {
|engine
|?
|-
|auxreservoir_start
|decimal
|pressure {
|engine
|Auxiliary reservoir pressure on loading the game.
|-
|auxreservoir_trainbrakepipe
|?
|flowsize {
|engine
|?
|-
|auxreservoirvent
|?
|flowsize {
|engine
|?
|-
|axle-count
|?
|motor {
|engine
|?
|-
|-
|}
==ba-bo==
{| cellpadding="5" cellspacing="0" border="1"
|- style="background-color:#ffffcc;"
|width=15%|Tag or Container
|width=15%|Data Type
|width=15%|Parent
|width=15%|Applies to
|width=40%|Description
|-
|backdrop
|boolean
|config.txt
|scenery
|Specifies whether the object is treated as a backdrop or not. (stays visible even when far from the camera)
|-
|bendy
|boolean
|config.txt
|splines
|Switches how track is bent on corners, set as 1 allows the mesh to be deformed as the spline is bend around corners.
|-
|bogey
|kuid
|bogeys-ID {
|traincar
|Kuid of bogey asset.
|-
|bogey
|kuid
|config.txt
|traincar
|The bogey KUID number (default for a.bog0 and a.bog1)
|-
|bogey
|kuid
|tracksound {
|Tracksound
|The bogey to which this sound will apply.
|-
|bogey-#
|kuid
|config.txt
|traincar
|The bogey KUID number for a.bog# (Used only if different to a.bog0)
|-
|bogey-#-r
|kuid
|config.txt
|traincar
|Used instead of ‘bogey’ and bogey-1. The bogey will have reversed orientation. Note: This will cause bogey animation to play in reverse unless the attachment point for the bogey is also rotated 180 degrees in 3dmax.
|-
|bogey-r
|kuid
|config.txt
|traincar
|Used instead of ‘bogey’ and bogey-1. The bogey will have reversed orientation. Note: This will cause bogey animation to play in reverse unless the attachment point for the bogey is also rotated 180 degrees in 3dmax.
|-
|bogeys {
|container
|config.txt
|traincar
|The bogey container stores the bogeys used for the loco\rollingstock item.
|-
|bogeys-ID {
|subcontainer
|bogeys {
|traincar
|User supplied identifier
|-
|boiler-to-piston-flow
|?
|steam {
|steam-engine
|?
|-
|boiler-volume
|?
|steam {
|steam-engine
|?
|}
==br-cg==
{| cellpadding="5" cellspacing="0" border="1"
|- style="background-color:#ffffcc;"
|width=15%|Tag or Container
|width=15%|Data Type
|width=15%|Parent
|width=15%|Applies to
|width=40%|Description
|-
|brakefull
|decimal
|pressure {
|engine
|Brake pipe pressure in grams/m³ after full service reduction (for self lapping brakes).
|-
|brakeinitial
|decimal
|pressure {
|engine
|Brake pipe pressure in grams/m³ after initial service reduction (for self lapping brakes).
|-
|brakepipe
|decimal
|pressure {
|engine
|Brake pipe pressure in grams/m³ when fully charged.
|-
|brakeratio
|?
|motor {
|engine
|?
|-
|bridgetrack
|kuid
|config.txt
|splines
|Kuid of the track type to be used.
|-
|buffer-speed
|float metres/second
|config.txt
|trackside
|Used for buffers; specifies the maximum speed up to which the buffer will stop a train.
|-
|burn-rate
|decimal
|steam {
|steam-engine
|How much coal in kg/s is consumed when the loco is operating at the test parameters
|-
|burn-rate-idle
|decimal
|steam {
|steam-engine
|How much coal in kg/s is consumed when the loco is idle, purely to keep the fire burning
|-
|cabinsway
|float
|config.txt
|traincar
|Cabin sway multiplier. Eg -2.
|-
|camera#
|float list
|cameralist {
|interior
|A camera contains 5 numeric coordinates that determine the placement and orientation of the camera. These are: 0,0,0,0,0 =left/right, front/back, up/down, yaw, pitch To determine these variables add -freeintcam to the trainzoptions.txt. Pan around the interior using arrow keys and mouse. Co-ordinates are displayed at bottom-left of screen. industry asset’s script file.
|-
|cameradefault
|integer
|config.txt
|interior
|The in-cab camera view Trainz defaults to when entering the cab.
|-
|cameralist {
|container
|config.txt
|interior
|List of camera viewpoints
|-
|car#
|kuid
|config.txt
|map
|Each of these tags stores the kuid of a car to be used on the roads.
|-
|car#
|kuid
|config.txt
|region
|Each of these tags stores the kuid of a car to be used on the roads.
|-
|carrate
|float seconds
|config.txt
|splines
|(No longer Valid, except for splines which have 'isroad' set) Defined traffic density on road (minimum seconds between each car generated). 0 = No traffic. Number must be greater than 3. The game waits between 1 and 3 times this value (in seconds) between generating traffic on the spline.
|-
|casts_shadows
|boolean
|config.txt
|splines
|Toggles whether the shadow model is displayed.
|-
|category-class
|class code
|config.txt
|general
|The class code for this asset.
|-
|category-era
|era code
|config.txt
|general
|Era code list.
|-
|category-era-#
|era list
|config.txt
|general
|Era code.
|-
|category-keywords
|keyword list
|config.txt
|general
|Keyword list
|-
|category-region
|region list
|config.txt
|general
|A list of REGION codes or REGION GROUP codes,
|-
|category-region-#
|region code
|config.txt
|general
|A REGION code or REGION GROUP code.
|}

==ch-cz==
{| cellpadding="5" cellspacing="0" border="1"
|- style="background-color:#ffffcc;"
|width=15%|Tag or Container
|width=15%|Data Type
|width=15%|Parent
|width=15%|Applies to
|width=40%|Description
|-
|changeability
|0/1/2
|driver-settings {
|activity
|Propensity for weather to change. (none, periodic, extreme)
|-
|chunky_info
|float list
|config.txt
|splines
|These values (in metres) define the shape of the mesh created for the track.
|-
|chunky_mesh
|folder
|config.txt
|splines
|Name of texture to apply to rail. The texture must be within a directory of the same name (ie. “textureName\textureName.texture.txt”). The chunky_mesh value will simply be the name of this directory (ie. “textureName”).
|-
|class
|string
|config.txt
|general
|This refers to the class of asset within the script file (the class must match that stated in the script).
|-
|clutter-mesh
|kuid
|config.txt
|groundtexture
|Ground textures can now reference a mesh and insert the mesh automatically as the ground is painted. Painting over a clutter-mesh ground texture effectively deletes clutter meshes and texture. The mesh it refers to is can be standard scenery object kind mesh. Clutter-meshes must have only one Max material assigned to it only. Polycounts must be very low.
|-
|collate-meshes
|?
|config.txt
|trackside
|Enables clutter-mesh support (eg. fast trees)
|-
|collision-parent
|mesh-table-ID {
|mesh-table-ID {
|interior
|For collision-proxy meshes in an interior mesh-table, this specifies the parent object to be proxied. is 3.
|-
|color
|rgb value
|smoke# {
|smoke block
|The R,G,B color value of the effect.
|-
|company
|string
|config.txt
|traincar
|The Locomotive or car owner
|-
|compressor
|integer
|flowsize {
|engine
|Flowsize of the compressor
|-
|compressor
|decimal
|pressure {
|engine
|Compressor maximum pressure in grams/m³
|-
|conesize
|?
|smoke# {
|smoke block
|?
|-
|conflicts-with queues {
|subcontainer
|queues-ID {
|industry
|This queue and the conflicting queue(s) cannot be used simultaneously.
|-
|consists {
|container
|config.txt
|industry
|The consists tag stores information on consists that can be generated by the industry.
|-
|consists-ID {
|subcontainer
|consists {
|industry
|User supplied identifier
|-
|consists-vehicle-ID {
|subcontainer
|consists-ID {
|industry
|User supplied identifier
|-
|contact-email
|string
|config.txt
|general
|Author, contact-email and contact-website are useful information, particularly if a user has a question on your models or would like to offer help or suggestions.
|-
|contact-website
|string
|config.txt
|general
|Author, contact-email and contact-website are useful information, particularly if a user has a question on your models or would like to offer help or suggestions.
|-
|controlmethod
|0/1
|driver-settings {
|activity
|Driver control setting. (dcc, cabin)
|-
|coupling-mask
|boolean
|consists-ID {
|industry
|Coupling mask that applies to the consist. 0 will block off all coupling activity while “1” will mean you can couple with a vehicle.
|-
|critical-animation
|boolean
|mesh-table-ID {
|mesh object
|When enabled, this forces the animation to continue playing when off screen. Impacts performance when enabled.
|-
|custom-attachments
|?
|queues-ID {
|industry
|Not used.
|}
==da-dz==
{| cellpadding="5" cellspacing="0" border="1"
|- style="background-color:#ffffcc;"
|width=15%|Tag or Container
|width=15%|Data Type
|width=15%|Parent
|width=15%|Applies to
|width=40%|Description
|-
|decoupling-mask
|boolean
|consists-ID {
|industry
|Coupling mask that applies to the consist. 0 will mean you can’t decouple vehicles in the train while 1 means you can decouple vehicles.
|-
|default {
|subcontainer
|mesh-table {
|mesh object
|Main mesh of the asset
|-
|defaultjunction
|kuid
|config.txt
|region
|Default type of junction in this region.
|-
|default-mesh
|kuid
|effects-ID {
|attachment effect
|The KUID of the attached mesh.
|-
|default-night {
|subcontainer
|mesh-table {
|mesh object
|‘Main’ night window mesh on scenery and industry and traincar assets. Modeled to the same 3d space as the default mesh and is inserted at the default mesh origin.
|-
|default-night-forward {
|subcontainer
|mesh-table {
|mesh object
|The name for a submesh attached to a locomotive, to show a beam of light for example, in the direction of movement of the locomotive. Trainz recognises the name and turns on the correct mesh depending on the running direction.
|-
|default-night-reverse {
|subcontainer
|mesh-table {
|mesh object
|The name for a submesh attached to a locomotive, to show a beam of light for example, in the direction of movement of the locomotive. Trainz recognises the name and turns on the correct mesh depending on the running direction.
|-
|deraillevel
|0/1/2
|driver-settings {
|activity
|Derail setting. (none, arcade, realistic)
|-
|description
|string
|config.txt
|general
|Description of the asset.
|-
|description-##
|string
|config.txt
|general
|Translated description of the asset.
|-
|dighole
|float length, width
|config.txt
|scenery
|Specifies the number of grid segments (length, width) to be removed from the surveyor grid to accommodate the turntable pit.
|-
|direct-drive
|boolean
|config.txt
|bogey
|When direct-drive is present, the bogey animation is linked to the steam piston and physics system. If this tag is not included the piston and steam sounds will not work!
|-
|direction
|vector
|smoke# {
|smoke block
|The vector at which the smoke travels.
|-
|directional
|boolean
|effects-ID {
|corona effect
|The default for coronas is to be aligned to the attachment point to face the NEGATIVE Z direction. This is especially useful for Traincars.
|-
|disable-extra-track-sounds
|boolean
|config.txt
|traincar
|Disables the “click-clack” tracksounds. (0, 1)
|-
|distance
|min, max metres
|soundscript-ID {
|mesh object
|2 numbers (meters) 1st number is the distance at which the sound is played 100% 2nd number is the cut-off distance. Doesn’t affect the volume of the sound (Default: 50m, 150m)
|-
|ditch_color
|rgb value
|config.txt
|traincar
|RGB ditch light color. Eg. 255,255,255.
|-
|divider
|folder
|config.txt
|splines
|Name of the model to use as the middle bridge section. Placed in subfolder with same name.
|-
|don’t-flip-terminator
|boolean
|config.txt
|splines
|Terminator model isn’t mirrored on one side.
|-
|driver-settings {
|container
|config.txt
|activity
|Specify the settings of this scenario, similar to Driver’s settings screen
|-
|duration
|float
|process-ID {
|industry
|Length of time (in seconds) that the process runs for.
|-
|dynamic-brake {
|container
|dynamic-brake container
|engine
|A sequence of numeric subcontainer data structures referring to a specific throttle notch and specifying the speed (m/s) and a braking force (kN) value which together define a braking force graph for that throttle notch
|}
==ea-ez==
{| cellpadding="5" cellspacing="0" border="1"
|- style="background-color:#ffffcc;"
|width=15%|Tag or Container
|width=15%|Data Type
|width=15%|Parent
|width=15%|Applies to
|width=40%|Description
|-
|effects {
|subcontainer
|mesh-table-ID {
|mesh-table-ID {
|Optional mesh-table variations
|-
|effects {
|subcontainer
|mesh-table-ID {
|mesh object
|Optional mesh-table variations
|-
|effects-ID {
|subcontainer
|effects {
|effects {
|User supplied identifier
|-
|enabled
|boolean
|smoke# {
|smoke block
|Specifies whether the effect is enabled.
|-
|endcolor
|rgb value
|smoke# {
|smoke block
|The final color the smoke effect shifts to.
|-
|endlength
|float metres
|config.txt
|splines
|Length in meters of the initiator and terminator models.
|-
|engine
|boolean
|config.txt
|traincar
|States type of traincar. 0 for Rolling stock, 1 for Locomotive.
|-
|enginesound
|kuid
|config.txt
|traincar
|References the KUID number for the traincar’s sound.
|-
|enginespec
|kuid
|config.txt
|traincar
|References the engine KUID number. This specifies the driver physics boundaries for the traincar.
|-
|epreservoirpipe
|decimal
|flowsize {
|engine
|Flowsize of the electric pneumatic braking
|-
|epreservoirpipe
|decimal
|volume {
|engine
|For electro pneumatic braking. Not currently in use, generally leave this setting
|-
|epreservoirpipe_autobrakecylinder
|decimal
|flowsize {
|engine
|Flowsize of the electro pneumatic automatic brake cylinder reservoir.
|-
|epreservoirpipe_start
|?
|pressure {
|engine
|For electro pneumatic braking. Not currently in use, generally leave this setting.
|-
|equaliser
|decimal
|volume {
|engine
|Equalising reservoir volume.
|-
|equaliser_mainreservoir
|decimal
|flowsize {
|engine
|Flowsize of the equaliser main reservoir
|-
|equaliser_start
|decimal
|pressure {
|engine
|Equalising Reservoir pressure on loading Trainz
|-
|equaliservent
|decimal
|flowsize {
|engine
|Flowsize of the equaliser vent
|-
|equaliserventemergency
|decimal
|flowsize {
|engine
|Flowsize of the emergency equaliser vent
|-
|equaliserventhandleoff
|decimal
|flowsize {
|engine
|Flowsize of the equaliser to the atmosphere when in the "handle off" position
|-
|extensions {
|container
|config.txt
|all
|Asset specific data.
|}
==fa-gz==
{| cellpadding="5" cellspacing="0" border="1"
|- style="background-color:#ffffcc;"
|width=15%|Tag or Container
|width=15%|Data Type
|width=15%|Parent
|width=15%|Applies to
|width=40%|Description
|-
|faces
|camera/motion/down
|smoke# {
|smoke block
|The direction the smoke effect faces.
|-
|face-texture
|[path/]filename.texture
|config.txt
|drivercharacter
|This is the driver icon used in TRS. Must be 64x64 pixels
|-
|facing
|boolean
|consists-vehicle-ID {
|industry
|Indicates the direction of the vehicle.
|-
|file
|[path/]filename.tfx
|smoke# {
|smoke block
|The twinkle file to be used (optional).
|-
|firebox-efficiency
|decimal (0.0 -> 1.0)
|steam {
|steam-engine
|Efficiency of the firebox (higher is more efficient)
|-
|firebox-to-boiler-heat-flow
|decimal
|steam {
|steam-engine
|Rate of heat flow from firebox to boiler
|-
|firebox-to-boiler-heat-flow-idle
|decimal
|steam {
|steam-engine
|Rate of heat flow from firebox to boiler when idle
|-
|firebox-volume
|
|steam {
|steam-engine
|Physical volume of firebox in litres
|-
|flowsize {
|container
|config.txt
|engine
|Flowsize settings specify the rate of flow through the pipes.
|-
|fontcolor
|rgb value
|effects-ID {
|corona effect
|The color of the sign text in r.g.b.
|-
|fonts
|integer
|config.txt
|traincar
|Indicates how many types of numbering fonts used.
|-
|fontsize
|float metres
|effects-ID {
|corona effect
|The size of the sign text
|-
|fonts-path
|folder
|config.txt
|traincar
|Replaces asset-filename usage for ‘fonts’.
|-
|frame-rate
|float frames/second
|config.txt
|turntable
|Generally make this 30 (frames per second)
|-
|frequency
|float
|effects-ID {
|corona effect
|This variable specifies the flash frequency in Hz, e.g. 1 for once per second, 0.5 for once every 2 seconds, 2 for twice per second.
|-
|fuel
|decimal
|mass {
|engine
|Fuel level, not currently in use
|-
|fuel-energy
|decimal
|steam {
|steam-engine
|Relative energy in kilojoules per kilogram of coal
|-
|function
|'TrackSignal'
|config.txt
|trackside
|Must be set to 'TrackSignal'
|-
|grounded
|float metres
|config.txt
|splines
|Height in meters for the road to be offset from terrain.
|}
==ha-hz==
{| cellpadding="5" cellspacing="0" border="1"
|- style="background-color:#ffffcc;"
|width=15%|Tag or Container
|width=15%|Data Type
|width=15%|Parent
|width=15%|Applies to
|width=40%|Description
|-
|height
|float metres
|config.txt
|splines
|Height from the track level to the base. Must be a negative value in order to raise the bridge above the ground.
|-
|height
|integer
|thumbnails-ID {
|all
|Image height
|-
|height
|negative metres
|config.txt
|scenery
|Height from the track level to the base. Should be negative.
|-
|height-range
|min,max metres
|config.txt
|scenery
|height-range min, max eg: height-range –10, 100. Where min and max are values in meters.
|-
|hidden
|boolean
|config.txt
|splines
|Prevents the spline from being rendered.
|-
|highspeedexhauster
|decimal
|pressure {
|engine
|For vacuum braking - not currently in use
|-
|highspeedexhauster_vacuumbrakepipe
|decimal
|flowsize {
|engine
|For vacuum braking
|-
|hornsound
|kuid
|config.txt
|traincar
|References the KUID number for the traincar horn sound.
|}
==ia-iz==
{| cellpadding="5" cellspacing="0" border="1"
|- style="background-color:#ffffcc;"
|width=15%|Tag or Container
|width=15%|Data Type
|width=15%|Parent
|width=15%|Applies to
|width=40%|Description
|-
|icon0
|kuid
|config.txt
|general
|Deprecated. Use thumbnails container
|-
|icon1
|kuid
|config.txt
|general
|Deprecated. Use thumbnails container
|-
|icon2
|kuid
|config.txt
|general
|Deprecated. Use thumbnails container
|-
|icon3
|kuid
|config.txt
|general
|Deprecated. Use thumbnails container
|-
|icon-texture
|[path/]filename.texture
|config.txt
|product
|The in-game representation of the product when specifying the load type for a compatible rollingstock item (driver) Should be a 64x64 TGA.
|-
|image
|[path/]filename
|thumbnails-ID {
|all
|Image filename
|-
|indbrakefull
|?
|pressure {
|engine
|?
|-
|independantbrakecylinder
|?
|volume {
|engine
|?
|-
|independantbrakecylinder_start
|?
|pressure {
|engine
|?
|-
|info-page
|[path/]filename.html
|config.txt
|profile
|Filename of the HTML information page for the session.
|-
|inherit-velocity
|?
|smoke# {
|smoke block
|?
|-
|initial-boiler-temperature
|?
|steam {
|steam-engine
|?
|-
|initial-count
|integer
|queues-ID {
|industry
|The initial number of items in the queue.
|-
|initiator
|folder
|config.txt
|splines
|Name of model to use at start of bridge, placed in subfolder with same name.
|-
|inputs {
|subcontainer
|processID {
|industry
|Input process list
|-
|inputs-ID {
|subcontainer
|inputs {
|industry
|User supplied identifier
|-
|instance-type
|'instance'/'resource'
|config.txt
|product
|Instance-type: 'resource' is used when there is no mesh, or one only mesh is referenced in the mesh table (Ie Liquids, Bulk loads etc). 'instance' is used when more than one mesh is in the mesh table Ie: Passengers, General Goods. 200 max.‘size’ per Asset.
|-
|interior
|kuid
|config.txt
|traincar
|References the KUID number for the traincar interior cab view.
|-
|interpolate
|?
|smoke# {
|smoke block
|?
|-
|invisible
|boolean
|config.txt
|splines
|Specifies whether the object is invisible.
|-
|isroad
|boolean
|config.txt
|splines
|Isroad/Istrack. Two boolean tags detailing the behavior of the bridge. If the isroad is set to true, then cars are placed on the bridge. Both values should not be set to true.
|-
|istrack
|boolean
|config.txt
|splines
|Isroad/Istrack. Two boolean tags detailing the behavior of the bridge. If the isroad is set to true, then cars are placed on the bridge. Both values should not be set to true.
|-
|istunnel
|boolean
|config.txt
|splines
|Disables smoke effects for trains on track with this tag set. Useful for tunnels, engine houses, snow sheds - anywhere you don't want smoke going through the roof of a structure.
|-
|junction-lever-mesh
|subcontainer
|junction-vertices-ID {
|fixed track
|The mesh (selected from the mesh table) to be used as a junction lever.
|-
|junction-vertex
|helper
|junction-vertices-ID {
|fixed track
|The attachment point (located in mesh file) at which to place the lever.
|-
|junction-vertices {
|container
|config.txt
|fixed track
|The Junction-Vertices Container contains the tags needed to handle the lever portions of a fixed track.
|-
|junction-vertices-ID {
|container
|junction-vertices {
|fixed track
|User supplied identifier
|}
==ka-kz==
{| cellpadding="5" cellspacing="0" border="1"
|- style="background-color:#ffffcc;"
|width=15%|Tag or Container
|width=15%|Data Type
|width=15%|Parent
|width=15%|Applies to
|width=40%|Description
|-
|keyframes
|integer list
|config.txt
|turntable
|Specifies where on the animation the turntable is to stop.
|-
|kind
|'animation'
|effects-ID {
|effects-ID {
|This effect is used when a mesh has a variety of animations. Usually the animations will be controlled by a script related to the asset.
|-
|kind
|'attachment'
|effects-ID {
|effects-ID {
|In TRS we now have the ability to attach a mesh into another mesh by referencing it’s KUID through a meshtable.
|-
|kind
|'corona'
|effects-ID {
|effects-ID {
|A corona is a ‘glow’ light effect. It is a simple texture that is inserted at an attachment point within the mesh. Coronas can be added to any asset that uses a meshtable.
|-
|kind
|interior object kind
|mesh-table-ID {
|interior
|The type of interior object the particular mesh is. Affects the behavior of the mesh in game. Kinds: lever (Levers, switches, dials etc), animated-lever (Animated Levers etc Eg. in steam cabs), collision-proxy (Mouse collisions for animated levers), needle (Gauge needles, Speedo, brake pres.), pullrope (Pull rope horn as in the F7), light (Wheelslip light)
|-
|kind
|kind
|config.txt
|general
|Asset kind.
|-
|kind
|'name'
|effects-ID {
|effects-ID {
|Some assets may have editable signs. When you set an asset’s name in surveyor through the Edit Properties icon (‘?’ icon) the signage can be set-up to automatically update. The variables can be set for each sign.
|-
|kind
|'texture-replacement'
|effects-ID {
|effects-ID {
|This effect was created for rolling stock items to swap the visible texture of bulk loads (such as coal or woodchips).
|-
|kuid
|kuid
|config.txt
|general
|Asset kuid
|-
|kuid-table {
|container
|config.txt
|all
|List of all required dependencies.
|-
|kuid-table-ID {
|kuid
|kuid-table {
|all
|User supplied identifier
|}
==la-lz==
{| cellpadding="5" cellspacing="0" border="1"
|- style="background-color:#ffffcc;"
|width=15%|Tag or Container
|width=15%|Data Type
|width=15%|Parent
|width=15%|Applies to
|width=40%|Description
|-
|latitude
|?
|config.txt
|region
|latitude of this region
|-
|left-passenger-door {
|subcontainer
|mesh-table {
|mesh object
|Predefined submesh identifier. Left side passenger doors.
|-
|length
|float metres
|config.txt
|splines
|Length of track segment in meters
|-
|levels {
|subcontainer
|tracksound {
|Tracksound
|Relative sound levels. The sound is silent until 0.1 m/s, ramping up in volume until 10.0 m/s, constant maximum after that. Note, a value below 0.1 will not play a sound.
|-
|licence
|string
|config.txt
|general
|User licence details
|-
|lifetime
|float
|smoke# {
|smoke block
|Time in seconds that smoke particles exist for. Default is 3.
|-
|light
|boolean
|config.txt
|scenery
|Sets lighting to be used for object to be ambient or directional. 0 sets ambient lighting and object is light by general light value, 1 sets directional light which is affected by the position of the sun.
|-
|light
|boolean
|mesh-table-ID {
|mesh object
|Sets lighting to be used for object to be ambient or directional. 0 sets ambient lighting and object is light by general light value, 1 sets directional light which is affected by the position of the sun.
|-
|light_color
|rgb value
|config.txt
|traincar
|RGB headlight color. Eg. 255,255,255.
|-
|lights {
|container
|config.txt
|mosignal
|Signal lighting container. A list of coronas attached to each light point. Coronas are stored in each signal object’s directory alongside it’s textures.
|-
|lights-ID {
|subcontainer
|lights {
|mosignal
|Light point identifier.
|-
|limits
|float list
|mesh-table-ID {
|interior
|Mathematical boundaries Trainz uses determine the objects function. These values vary as different objects use different mathematical units.
|-
|longitude
|?
|config.txt
|region
|longitude of this region
|-
|loop
|float seconds
|smoke# {
|smoke block
|Time in seconds to loop the smoke sequence. Only valid if mode is set to time.
|-
|loopdelay
|float seconds
|smoke# {
|smoke block
|Delay (in seconds) before the effect is played again.
|-
|looped
|boolean
|effects-ID {
|animation effect
|Looped 1 (optional) Use only if the animation is looping (repeating). Default 0 (i.e. not looped).
|-
|looping
|boolean
|config.txt
|turntable
|specifies that the turntable can go all the way around, rather than stopping at a certain point.
|}
==ma-mz==
{| cellpadding="5" cellspacing="0" border="1"
|- style="background-color:#ffffcc;"
|width=15%|Tag or Container
|width=15%|Data Type
|width=15%|Parent
|width=15%|Applies to
|width=40%|Description
|-
|mainreservoir
|?
|pressure {
|engine
|?
|-
|mainreservoir
|?
|volume {
|engine
|?
|-
|mainreservoir_ep
|?
|flowsize {
|engine
|?
|-
|mainreservoir_start
|?
|pressure {
|engine
|?
|-
|main-reservoir-volume
|?
|steam {
|steam-engine
|?
|-
|map-kuid
|kuid
|config.txt
|profile
|Kuid of the map attached to this session.
|-
|mass
|float kg
|config.txt
|product
|The physical mass of the product. For Containers and Passengers this is calculated in kilograms/unit, while for Liquid and Bulk loads this is calculated in kilograms/litre.
|-
|mass
|integer kg
|config.txt
|traincar
|Mass in kilograms
|-
|mass {
|container
|config.txt
|engine
|?
|-
|max-accel
|?
|motor {
|engine
|?
|-
|max-coupler-gap
|float metres
|config.txt
|traincar
|maximum gap expected between couplers of this type
|-
|max-decel
|?
|motor {
|engine
|?
|-
|max-distance
|float
|tracksound {
|Tracksound
|Maximum distance at which the sound is played. Eg 1000
|-
|max-fire-coal-mass
|?
|steam {
|steam-engine
|?
|-
|max-fire-temperature
|?
|steam {
|steam-engine
|?
|-
|maximum-volume
|?
|steam {
|steam-engine
|?
|-
|maxrate
|float
|smoke# {
|smoke block
|The maximum rate at which particles are emitted.
|-
|maxsize
|float
|smoke# {
|smoke block
|?
|-
|maxspeed
|?
|motor {
|engine
|?
|-
|maxspeedkph
|float
|smoke# {
|smoke block
|?
|-
|maxvoltage
|?
|motor {
|engine
|?
|-
|mesh
|[path/]filename.im
|mesh-table-ID {
|mesh object
|The mesh name. This may include a sub-path. ie: mesh nightwindows/nightwindows.im, where the file nightwindows.im has been placed in the subdirectory nightwindows.
|-
|mesh
|[path/]filename.lm
|mesh-table-ID {
|mesh object
|The mesh name. This may include a sub-path. ie: mesh nightwindows/nightwindows.im, where the file nightwindows.im has been placed in the subdirectory nightwindows.
|-
|mesh
|[path/]filename.pm
|mesh-table-ID {
|mesh object
|The mesh name. This may include a sub-path. ie: mesh nightwindows/nightwindows.im, where the file nightwindows.im has been placed in the subdirectory nightwindows.
|-
|mesh
|kuid
|config.txt
|drivercharacter
|This refers to the kuid of the mesh asset inserted in to the locomotive mesh at a.driver0 (when in the Driver Module).
|-
|mesh-table {
|container
|config.txt
|mesh object
|This is the new and preferred method of asset mesh placement for most mesh asset types. It gives huge control over mesh placement and animations. There are some asset types that cannot use a meshtable. These include all Bridges, Tunnels, Rails, Pantographs and other Spline Objects (eg. Fences or Catenaries).
|-
|mesh-table-ID {
|subcontainer
|mesh-table {
|mesh object
|User supplied identifier
|-
|mesh-table-ID {
|subcontainer
|mesh-table {
|interior
|User supplied identifier
|-
|min-distance
|float
|tracksound {
|Tracksound
|Minimum distance at which the sound is played. Eg 0.
|-
|minimum-volume
|?
|steam {
|steam-engine
|?
|-
|minrate
|float
|smoke# {
|smoke block
|The minimum rate at which particles are emitted.
|-
|minsize
|float
|smoke# {
|smoke block
|?
|-
|mode
|speed/anim/timeofday/time
|smoke# {
|smoke block
|Describes the mode or type of this smoke effect. This affects how start and period are interpreted. (time | speed | anim | timeofday).
|-
|mode0 {
|subcontainer
|mesh-table {
|trackside
|Mesh showing lever in first position
|-
|mode0 {
|subcontainer
|mesh-table {
|mesh object
|Predefined submesh identifier. Mesh showing lever in first position
|-
|mode1 {
|subcontainer
|mesh-table {
|trackside
|Mesh showing lever in second position
|-
|mode1 {
|subcontainer
|mesh-table {
|mesh object
|Predefined submesh identifier. Mesh showing lever in second position
|-
|motor {
|container
|config.txt
|engine
|?
|-
|mousespeed
|float
|mesh-table-ID {
|interior
|This controls the use of the mouse on screen. Use this to control the mouse speed and push/pull direction for levers and dials. • mousespeed -1 Inverts mouse direction. • mousespeed 2 Doubles mouse speed in default direction. • mousespeed -0.5 Inverts mouse direction and halves the speed.
|-
|moving-friction-coefficient
|?
|motor {
|engine
|?
|}
==na-nz==
{| cellpadding="5" cellspacing="0" border="1"
|- style="background-color:#ffffcc;"
|width=15%|Tag or Container
|width=15%|Data Type
|width=15%|Parent
|width=15%|Applies to
|width=40%|Description
|-
|name
|<blank>
|effects-ID {
|name effect
|Leave blank to allow the name to be inserted by script without an initial default.
|-
|name
|'name'
|effects-ID {
|name effect
|When name name is specified, it uses the asset’s changeable name. Changed through the Edit Properties icon (the ‘?’ icon) in Surveyor.
|-
|name
|string
|effects-ID {
|name effect
|The default text when placed. If name Graceland (for example) was used, the sign would never be able to be changed even though the user may have changed the asset’s name in Surveyor.
|-
|night
|[path/]filename.tga
|config.txt
|environment
|Name of image file for night sky. File should be 256 x 256 pixel 24bit tga. The file extension should be excluded here, ie “QLD_Sky” rather than "qLD_Sky.texture.txt”.
|-
|night-mesh-base
|mesh-table-ID {
|mesh-table-ID {
|mesh object
|The mesh to which 'default-night' is linked. If the 'night-mesh-base' is hidden then 'default-night' will not be displayed.
|-
|nightmode
|home/lamp/constant
|config.txt
|scenery
|Only add this tag if you reference a default-night mesh in the mesh-table. Values: home, lamp or constant.
|-
|no3pipe
|?
|flowsize {
|engine
|?
|-
|no3pipe
|?
|volume {
|engine
|?
|-
|no3pipe_autobrakecylinder
|?
|flowsize {
|engine
|?
|-
|no3pipe_mainreservoir
|?
|flowsize {
|engine
|?
|-
|no3pipe_start
|?
|pressure {
|engine
|?
|-
|no3pipevent
|?
|flowsize {
|engine
|?
|-
|no4pipe
|?
|flowsize {
|engine
|?
|-
|no4pipe
|?
|volume {
|engine
|?
|-
|no4pipe_start
|?
|pressure {
|engine
|?
|-
|normal
|[path/]filename.tga
|config.txt
|environment
|Name of image file for normal sky. File should be 256 x 256 pixel 24bit tga. The file extension should be excluded here, ie “QLD_Sky” rather than "qLD_Sky.texture.txt”.
|-
|nostartdelay
|boolean
|soundscript-ID {
|mesh object
|0 or 1, default 0 If not set, the sound will have a short delay before playing, this stops flanging (flanging is a really nasty sound caused when several copies of the same sound are played at once).
|-
|notches
|float list
|mesh-table-ID {
|interior
|The position of notches within the angle boundaries. These are represented as decimal points between and including 0 and 1.
|-
|notchheight
|float list
|mesh-table-ID {
|interior
|The size of the notches specified.
|}
==oa-oz==
{| cellpadding="5" cellspacing="0" border="1"
|- style="background-color:#ffffcc;"
|width=15%|Tag or Container
|width=15%|Data Type
|width=15%|Parent
|width=15%|Applies to
|width=40%|Description
|-
|object-size
|float metres
|effects-ID {
|corona effect
|Size of the corona on the object when viewed up close Defaults to 0.15 (i.e. 0.15m)
|-
|obsolete-table {
|container
|config.txt
|all
|The obsolete-table describes the asset’s revision history.
|-
|ontheright
|boolean
|config.txt
|region
|Cars drive on the right side of the road.
|-
|opacity
|0..1
|mesh-table-ID {
|mesh object
|Controls the opacity of the mesh. Zero (invisible, not recommended) or one (solid).
|-
|opacity
|0..1
|mesh-table-ID {
|interior
|Usually used for the window mesh to give transparency (and the impression of reflection).
|-
|organisation
|string
|config.txt
|general
|Organisation name will show in Trainz in Railyard as the organisation for the model, for instance if you use Joe’s Trainz or Cripple Creek Logging Company.
|-
|origin
|string
|config.txt
|traincar
|The Country Abbreviation.
|-
|outputs {
|subcontainer
|process-ID {
|industry
|Output process list
|-
|outputs-ID {
|subcontainer
|outputs {
|industry
|User supplied identifier
|}
==pa-pz==
{| cellpadding="5" cellspacing="0" border="1"
|- style="background-color:#ffffcc;"
|width=15%|Tag or Container
|width=15%|Data Type
|width=15%|Parent
|width=15%|Applies to
|width=40%|Description
|-
|paintshed-skin-used
|kuid
|config.txt
|paintshed-skin
|Kuid of the paintshed skin used. (if applicable)
|-
|paintshed-skin-used
|kuid
|config.txt
|paintshed-template
|Kuid of the paintshed skin to be used for this template.
|-
|paintshed-template-used
|kuid
|config.txt
|paintshed-skin
|Kuid of the paintshed template used. (if applicable)
|-
|pantograph
|kuid
|config.txt
|traincar
|The pantograph kuid number inserted at a.pant0, a.pant1, etc. Use this tag only when needed.
|-
|passenger-height
|float metres
|config.txt
|industry
|This value sets the height of the passenger asset in metres, to suit the platform model height. (Doesn't work)
|-
|passenger-queue
|boolean
|queues-ID {
|industry
|Defines this as a passenger station queue.
|-
|period
|?
|smoke# {
|smoke block
|The usage of period depends on the value of the mode tag. If the mode is set to time, period is the duration of time this effect will remain active.
|-
|permit-commit
|boolean
|privileges {
|all
|Allows the end-user to commit changes to this asset.
|-
|permit-edit
|boolean
|privileges {
|all
|Allows the end-user to open this asset for editing
|-
|permit-listing
|boolean
|privileges {
|all
|Allows the end-user to view this object in the surveyor pickers (if it is of an appropriate kind.) Does not affect the visibility of the asset within the CMP asset list.
|-
|piston-angular-offsets
|?
|steam {
|steam-engine
|?
|-
|piston-area
|?
|steam {
|steam-engine
|?
|-
|piston-to-atmosphere-flow
|?
|steam {
|steam-engine
|?
|-
|piston-volume-max
|?
|steam {
|steam-engine
|?
|-
|piston-volume-min
|?
|steam {
|steam-engine
|?
|-
|pressure {
|container
|config.txt
|engine
|?
|-
|preview-mesh-kuid
|kuid
|mesh-table-ID {
|mesh object
|The mesh to be used in the surveyor preview area. This is useful when an asset has a large bounding box. Ie the "Airport” with it’s jet animation.
|-
|preview-scale
|float
|mesh-table-ID {
|mesh object
|Scale of the preview mesh.
|-
|priority
|float, 0 = highest
|tracksound {
|Tracksound
|The priority of the sound versus other sounds to be played. Lower values indicate a higher priority.
|-
|privileges {
|container
|config.txt
|all
|Limited content protection applies only to built-in (JArchived) assets.
|-
|processes {
|container
|config.txt
|industry
|Processes (required) The input and output settings of the industry. You can specify the amount of input and output for each queue referenced product as well as the duration (or rate) in seconds for that process to take place. All queues and processes are linked through the industry asset’s script file.
|-
|process-ID {
|subcontainer
|processes {
|industry
|User supplied identifier
|-
|product-category
|kuid
|config.txt
|product
|Kuid of applicable category for this product
|-
|product-id
|?
|config.txt
|paintshed-skin
|For paintshed support.
|-
|product-kuid
|kuid
|queues-ID {
|industry
|The product type used to fill ‘initial-count’
|-
|product-texture
|[path/]filename.texture
|config.txt
|product
|The texture to be used with load ‘texture-replacement’. Ie When a hopper loads woodchips instead of it’s default load of coal.
|-
|product-type
|?
|config.txt
|paintshed-skin
|For paintshed support.
|-
|product-version
|?
|config.txt
|paintshed-skin
|For paintshed support.
|}
==qu-rz==
{| cellpadding="5" cellspacing="0" border="1"
|- style="background-color:#ffffcc;"
|width=15%|Tag or Container
|width=15%|Data Type
|width=15%|Parent
|width=15%|Applies to
|width=40%|Description
|-
|queue
|queues-ID {
|inputs-ID {
|industry
|queue from which to take input.
|-
|queue
|queues-ID {
|outputs-ID {
|industry
|queue in which to place output.
|-
|queues {
|container
|config.txt
|industry
|The queues container states which product or products the industry can use. It contains the size of each product, the initial count when placed, and can refer to it’s visual load state whether through a load animation or attachment.
|-
|queues-ID {
|subcontainer
|queues {
|industry
|User supplied identifier
|-
|radius
|float
|attached-trigger-ID {
|industry
|Radius (in meters) of the trigger.
|-
|radius
|float
|mesh-table-ID {
|interior
|The notch position relative to the attachment point.
|-
|random-color-high-hsb
|hsb value
|config.txt
|scenery
|For clutter-mesh objects, specifies a color range for tinting purposes. HSB color space.
|-
|random-color-low-hsb
|hsb value
|config.txt
|scenery
|For clutter-mesh objects, specifies a color range for tinting purposes. HSB color space.
|-
|rate
|float particles/second
|smoke# {
|smoke block
|The rate of emission in particles per second for modes time, speed, and timeofday, or the number of particles to emit over the animation period for anim mode. Default is 4.
|- style="color:navy; background:lightyellow;"
|[[region]] (depreciated)
|region code
|config.txt
|general (obsolescent)
|Trainz 1.x legacy tag; the country region to which this asset belongs. This should be one of the Auran-supplied region names, but older content has shown full names.
|-
|repeat-delay
|random [min,max] seconds
|soundscript-ID {
|mesh object
|1 or 2 numbers (min, max, in sec) time to delay between the end of the sound playing, and playing it again randomised between(min .. max) default min is 0, default max is equal to min Notes: Repeat-delay now has two values rather than one. When upgrading old assets, make sure there is a repeat delay for both values or the sound will loop endlessly when triggered.
|-
|repeats
|integer
|config.txt
|splines
|The number of times the mesh is placed between spline points
|-
|resistance
|?
|motor {
|engine
|?
|-
|reversed
|boolean
|bogeys-ID {
|traincar
|Reverses the animation direction. Use when the bogie attachment point in the traincar asset has been rotated 180 degrees around the Z axis.
|-
|rgb
|rgb value
|config.txt
|splines
|This value should be left as default.
|-
|right-passenger-door {
|subcontainer
|mesh-table {
|mesh object
|Predefined submesh identifier. Right side passenger doors.
|-
|rollstep
|float degrees
|config.txt
|scenery
|Where n is a value in degrees. Used in conjunction with rotate-yz-range, rollstep lets you specify the step size of roll angles for this object. Other example values are 1, 5, 20 etc. The default rollstep is 1.0.
|-
|rotate
|boolean
|config.txt
|scenery
|Where n is 0 or 1 (default). This lets you disable rotation on a scenery object. 0 to disable, 1 to enable (default).
|-
|rotate-yz-range
|min,max degrees
|config.txt
|scenery
|Where min and max are values in degrees. This tag lets you set the roll / yz rotation range (normal object rotation is an xy rotation). If you want your scenery object to support rolling then use this tag to set the minimum and maximum roll range. By default, objects have a min/max roll range of 0 to 0.
|-
|rotstep
|float degrees
|config.txt
|general
|Where n is a value in degrees. This lets you specify the step size of rotation angles for this object. Other example values are 1, 10, 20, 90, 180 etc. The default rotstep is 1.0
|-
|running-number
|string
|consists-vehicle-ID {
|industry
|Running number of the vehicle.
|}

==sa-sz==
{| cellpadding="5" cellspacing="0" border="1"
|- style="background-color:#ffffcc;"
|width=15%|Tag or Container
|width=15%|Data Type
|width=15%|Parent
|width=15%|Applies to
|width=40%|Description
|-
|safety-valve-high-flow
|?
|steam {
|steam-engine
|?
|-
|safety-valve-high-pressure
|?
|steam {
|steam-engine
|?
|-
|safety-valve-low-flow
|?
|steam {
|steam-engine
|?
|-
|safety-valve-low-pressure
|?
|steam {
|steam-engine
|?
|-
|scale
|?
|smoke# {
|smoke block
|?
|-
|scale
|?
|mass {
|engine
|?
|-
|scale
|?
|pressure {
|engine
|?
|-
|scale
|?
|volume {
|engine
|?
|-
|script
|[path/]filename.gs
|config.txt
|general
|This refers to the name of the script file.
|-
|search-limit
|?
|config.txt
|trackside
|Not required. For internal use only.
|-
|shadow {
|subcontainer
|mesh-table {
|mesh object
|Predefined submesh identifier. Shadow mesh.
|-
|shadows
|?
|config.txt
|splines
|Undocumented
|-
|shift
|?
|smoke# {
|smoke block
|?
|-
|shovel-coal-mass
|?
|steam {
|steam-engine
|?
|-
|showhelp
|boolean
|driver-settings {
|activity
|Show Driver Help. (off, on)
|-
|show-in-consist-menu
|boolean
|consists-ID {
|industry
|Boolean flag that dictates whether this train appears in the consist menu (0 - false, 1 - true). The consist menu was along the bottom of the screen in the original Trainz and UTC but is no longer present. It effectively stopped a user from getting access to an AI train. Redundant for most uses except for legacy/scenario usage.
|-
|signals {
|container
|config.txt
|mosignal
|Sets out which aspects the signal is capable of displaying, and also which light points are activated when each state is displayed.
|-
|signals-ID {
|subcontainer
|lights {
|mosignal
|Signal point identifier.
|-
|size
|integer
|queues-ID {
|industry
|Size of queue.
|-
|smoke_fastlife
|float
|config.txt
|traincar
|Longevity of smoke particles at normal speed.
|-
|smoke_fastspeed
|?
|config.txt
|traincar
|?
|-
|smoke_height
|float
|config.txt
|traincar
|How hard particles are pushed out of the stack.
|-
|smoke_random
|float
|config.txt
|traincar
|Level of particle excitation.
|-
|smoke_shade
|float
|config.txt
|traincar
|Smoke opacity. (0 - 1)
|-
|smoke_slowlife
|float
|config.txt
|traincar
|Longevity of smoke particles at low speed.
|-
|smoken {
|container
|config.txt
|smoke block
|?
|-
|snapgrid
|float metres
|config.txt
|scenery
|Where n is a value in meters. This lets you specify the size of the grid the object snaps to. We recommend factors/fractions of 720 as this is the size of a base board and the positioning may do funny things across section borders. e.g. 1, 2, 5, 10, 20, 30, 40, 45, 60, 80, 90, 120, 180, 240, 360, 720. The default snapgrid is 10.
|-
|snapmode
|0/1/2
|config.txt
|scenery
|Where n is either 0 (default) , 1 or 2. Use snapmode to enable snapping of a scenery object to the snap grid. 0 will disable grid snapping (default), 1 will enable grid snapping, 2 will enable an offset grid snapping. Offset grid snapping will cause objects to be snapped to the grid but will also offset the object’s position by ½ the grid size – essentially positioning the object in between the normal grid lines.
|-
|sound {
|subcontainer
|soundscript-ID {
|mesh object
|List of .wav files to play (randomly picked)
|-
|soundscript {
|container
|config.txt
|mesh object
|Controls the looping sound made by the object.
|-
|soundscript-ID {
|subcontainer
|soundscript {
|mesh object
|User supplied identifier
|-
|speed
|float
|effects-ID {
|animation effect
|Speed factor of the animation. Default 1, 2 for double speed, 0.5 for half speed
|-
|speedlimit
|float metres/second
|config.txt
|trackside
|This value is the maximum speed allowed in meters per second
|-
|start
|?
|smoke# {
|smoke block
|The usage of stard depends on the value of the mode tag. If the mode is set to time, start is a set of time values in seconds after the creation of this effect’s parent object when this phase of the effect will start. If the mode is set to speed, start is a speed in meters per second (m/s) and period is not used. (Note: 1 m/s = 3.6 km/hr.) All other sequence attributes (rate, velocity, lifetime, minsize, maxsize) are interpolated so there are smooth transitions between phases. If the mode is set to anim, start is a value from 0.0 to 1.0 which describes the start time into the object’s animation cycle. If the mode is set to timeofday, start is a value from 0.0 to 1.0 which describes the time of day when this effect will start. Values range as follow: 0 - midnight, 0.25 - 6am, 0.5 - midday, 0.75 6pm, 1.0 - midnight.
|-
|start-enabled
|boolean
|process-ID {
|industry
|Specifies whether the process starts enabled.
|-
|startingtime
|0..1
|driver-settings {
|activity
|Time of day. Range is from 0 to 1 (0.5 - midday).
|-
|steam {
|container
|config.txt
|steam-engine
|?
|-
|storm
|[path/]filename.tga
|config.txt
|environment
|Name of image file for stormy sky. File should be 256 x 256 pixel 24bit tga. The file extension should be excluded here, ie “QLD_Sky” rather than "qLD_Sky.texture.txt”.
|-
|string-table {
|container
|config.txt
|all
|The string table stores a list of text strings to be used by the industry script.
|-
|string-table-## {
|container
|config.txt
|all
|These alternative string tables store translated strings
|-
|supports-null-driver-character
|boolean
|config.txt
|drivercommand
|Command can be executed without a driver present in the selected loco.
|-
|surface-area
|?
|motor {
|engine
|?
|-
|surveyor-name-label
|boolean
|config.txt
|general
|Specifies whether this item has floating name label text.
|-
|surveyor-only
|boolean
|config.txt
|general
|Adding this means the attached mesh will only be visible in Surveyor and not Driver.
|-
|surveyor-only
|boolean
|effects-ID {
|attachment effect
|Adding this means the attached mesh will only be visible in Surveyor and not Driver.
|}
==ta-tz==
{| cellpadding="5" cellspacing="0" border="1"
|- style="background-color:#ffffcc;"
|width=15%|Tag or Container
|width=15%|Data Type
|width=15%|Parent
|width=15%|Applies to
|width=40%|Description
|-
|tender
|boolean
|config.txt
|traincar
|Specifies that the traincar is a tender.
|-
|terminator
|folder
|config.txt
|splines
|Name of model to use at end of bridge, placed in subfolder with same name.
|-
|test-collisions
|boolean
|mesh-table-ID {
|interior
|Mouse cannot be used for this mesh. Collision mesh used instead. Ie animated-levers.
|-
|texture
|[path/]filename.texture
|config.txt
|general
|An image texture file.
|-
|texture
|[path]/filename.texture
|effects-ID {
|texture-replacement effect
|Texture reference denoting the texture file to be swapped by this effect.
|-
|texture
|kuid
|smoke# {
|smoke block
|Kuid of the texture to be used for the effect.
|-
|texture-kuid
|<blank>
|effects-ID {
|corona effect
|If the texture-kuid tag is not present the corona will use the default yellow/orange texture in TRS.
|-
|texture-kuid
|kuid
|effects-ID {
|corona effect
|Add this tag only when you want to specify your own texture for the corona. It specifies the KUID of a kind texture asset. See KIND TEXTURE.
|-
|textures {
|container
|config.txt
|texturegroup
|The textures container stores a list of additional textures to be used in the texture group.
|-
|three-part
|boolean
|config.txt
|hornsound
|Specifies that the hornsound has a beginning, middle and ending sound.
|-
|throttle-notches
|?
|motor {
|engine
|?
|-
|throttle-power {
|container
|config.txt
|engine
|?
|-
|thumbnails {
|container
|config.txt
|all
|Any asset may specify a thumbnail or preview image.
|-
|thumbnails-ID {
|subcontainer
|thumbnails {
|all
|User supplied identifier
|-
|timerate
|float
|driver-settings {
|activity
|Time progression. (1 - real-time, 2 - double speed etc.)
|-
|track
|kuid
|attached-track-ID {
|scenery with track
|Kuid of the track to be used.
|-
|track
|kuid
|tracksound {
|Tracksound
|The track type to which this sound will apply
|-
|track
|trackID
|attached-trigger-ID {
|industry
|The track name which the train must be on to trigger.
|-
|trackmark
|boolean
|config.txt
|trackside
|Specifies that the object is a trackmark.
|-
|trackoffsets
|float list, metres
|config.txt
|splines
|Distance in meters the rail/s are attached to the center of the spline. Any number of tracks can be attached to the spline, only splines with the same track offsets can be connected together.
|-
|track-parent
|kuid
|tracksound {
|Tracksound
|The parent (eg. bridge/industry/tunnel) of the track to which this sound will apply.
|-
|trackdirections
|float metres
|config.txt
|splines
|Specifies the direction of traffic for each of the road assets attached to the bridge,

0 = traffic to flow in one direction for the dual lanes attached at -3.5 metres,
1 = traffic to flow in the opposite direction for the dual lanes placed at 3.5 metres.
|-
|trackside
|float metres
|config.txt
|trackside
|This is a value that is the distance in meters the object is placed relative to the center of the track. Negative values will put the object on the left side of the track, and positive values will appear on the right.
|-
|track-sound
|kuid
|tracksound {
|Tracksound
|The kuid of the tracksound object to be used.
|-
|tracksound {
|container
|config.txt
|Tracksound
|A sound asset that is referenced by track or bogeys to play a different sound from the default track/train sound (for example when a train travels over a bridge or through a tunnel).
|-
|trainbrakepipe
|?
|flowsize {
|engine
|?
|-
|trainbrakepipe
|?
|volume {
|engine
|?
|-
|trainbrakepipe_reservoir
|?
|flowsize {
|engine
|?
|-
|trainbrakepipe_start
|?
|pressure {
|engine
|?
|-
|trainbrakepipevent
|?
|flowsize {
|engine
|?
|-
|trainz-build
|build code
|config.txt
|general
|The Trainz build is the version number for which this asset was created.
|-
|traffic-speed
|int
|config.txt
|spline
|'''Only applicable to splines which have 'isroad' set.''' Defines the carz speed limit of the road in meters per second. Carz currently travel at up to 80%-110% (depending on the car) of the speed limit, except when overtaking.
|-
|trigger
|boolean
|config.txt
|trackside
|Specifies that the object is a trigger.
|-
|trigger
|string
|soundscript-ID {
|mesh object
|A trigger may be used in an event file (.evt) associated with an animation. It plays at selected key frames of animation as defined in the event file. Sound files may triggered in this manner, and from scripting. Used in the mojunction example (switch lever) the “toggle” action is automatically triggered when the lever is operated and the sound plays.
|-
|turntable {
|mesh-table-ID {
|mesh-table {
|turntable
|Predefined submesh identifier
|-
|turntable {
|subcontainer
|mesh-table {
|mesh object
|Predefined submesh identifier.
|-
|two-part
|boolean
|config.txt
|hornsound
|Indicates that the Railyard and Driver hornsounds are different. The Driver hornsound is looping. If this tag is not present, the hornsound defauts to UTC equivalent non-looping format.
|-
|type
|string
|config.txt
|scenery
|Specify a type for the model that will be used in the Surveyor menu drop down menu for Track or Object type.
|}

==ua-vz==
{| cellpadding="5" cellspacing="0" border="1"
|- style="background-color:#ffffcc;"
|width=15%|Tag or Container
|width=15%|Data Type
|width=15%|Parent
|width=15%|Applies to
|width=40%|Description
|-
|uncached_alphas
|boolean
|config.txt
|splines
|This is used in certain situations to improve alpha sorting. This should only be set to 1 for tracks that use an alpha texture and are always placed flat
|-
|unit_mesh
|folder
|config.txt
|splines
|For mesh-reducing track, the filename of the long mesh, which must be placed in a subdirectory of the same name as the mesh. Only the file name is entered, not the directory name nor the file extension. For example, the full pathname and extension is “rockwall/rockwall.im”. Enter only “rockwall” in the text input box.
|-
|upright
|boolean
|config.txt
|splines
|Specifies whether the bridge “legs” point vertically, or perpendicular to the spline.
|-
|useadjoiningtracktype
|boolean
|attached-track-ID {
|scenery with track
|Indicates whether the track type should change to match that of the first track joined to the object.
|-
|use-gradient-track
|boolean
|config.txt
|scenery
|This means to use the spline gradient rather than following the ground height.
|-
|use-parent-bounds
|boolean
|mesh-table {
|mesh object
|Specifies that the mesh should use the bounds of the parent object for visibility culling. Use with caution.
|-
|username
|string
|config.txt
|general
|The human-readable English name of this asset.
|-
|username-##
|string
|config.txt
|general
|The human-readable translated name of this asset.
|-
|vacuumbrakecylinder
|?
|volume {
|engine
|?
|-
|vacuumbrakecylinder_start
|?
|pressure {
|engine
|?
|-
|vacuumbrakecylinder_vacuumbrakepipe
|?
|flowsize {
|engine
|?
|-
|vacuumbrakepipe
|?
|volume {
|engine
|?
|-
|vacuumbrakepipe
|?
|flowsize {
|engine
|?
|-
|vacuumbrakepipe_start
|?
|pressure {
|engine
|?
|-
|vacuumbrakepipereleasevent
|?
|flowsize {
|engine
|?
|-
|vacuumbrakepipevent
|?
|flowsize {
|engine
|?
|-
|vacuumbrakereservoir
|?
|volume {
|engine
|?
|-
|vacuumbrakereservoir_start
|?
|pressure {
|engine
|?
|-
|vacuumbrakereservoir_vacuumbrakepipe
|?
|flowsize {
|engine
|?
|-
|value-range
|min,max time of day
|soundscript-ID {
|mesh object
|2 numbers, currently used only for day/night sound effects. Midnight is 0.5, midday = 0.0 or 1.0 Where the numbers are not the same, this sets the start and end times for the sound to play. Default 0,0 (off)
|-
|vehicle
|kuid
|consists-vehicle-ID {
|industry
|The kuid of the vehicle to be used.
|-
|velocity
|float
|smoke# {
|smoke block
|The initial speed of emitted smoke particles. Default is 1.
|-
|vertices {
|subcontainer
|attached-track-ID {
|scenery with track
|Attachment points at which to place track.
|-
|visible-on-minimap
|boolean
|config.txt
|splines
|Specifies whether the object\track is displayed on the minimap.
|-
|volume
|0..1
|soundscript-ID {
|mesh object
|Gain of the sound Default 1.0 = 100%
|-
|volume {
|container
|config.txt
|engine
|?
|}
==wa-zz==
{| cellpadding="5" cellspacing="0" border="1"
|- style="background-color:#ffffcc;"
|width=15%|Tag or Container
|width=15%|Data Type
|width=15%|Parent
|width=15%|Applies to
|width=40%|Description
|-
|water
|kuid
|config.txt
|map
|Undocumented
|-
|watercolor
|rgb value
|config.txt
|region
|RGB color value of the water for the region.
|-
|water-injector-rate
|?
|steam {
|steam-engine
|?
|-
|wave-shift
|?
|effects-ID {
|corona effect
|Affects the flashing intensity pattren on the corona.
|-
|weather
|0..7
|driver-settings {
|activity
|Weather setting. (clear, cloudy, drizzle, rain, stormy, light snow, medium snow, heavy snow)
|-
|westinghouse-volume
|?
|steam {
|steam-engine
|?
|-
|width
|float metres
|config.txt
|splines
|Width of track mesh in meters.
|-
|width
|integer
|thumbnails-ID {
|all
|Image width
|-
|workingscale
|?
|config.txt
|map
|Undocumented
|-
|workingunits
|?
|config.txt
|map
|Undocumented
|-
|[["world-origin" container|world-origin]]
|container
|config.txt
|map
|Undocumented, latitude, longitude, and altitude
|-
|}
==Notes==
 

;TBDL - should have something here about things discarded, moved and used differently version to version.

==Categories==
{{ORP-bot}}<div> {{FUN-bot}}

Grade Crossing XING BNSF50 CDE

2022-12-26T23:39:45Z

Christopher824:

'''Updated originals by BNSF50'''

Restored and/or replace bell to restore and/or reduce clicking sound. All assets updated to build 3.5 and available through the DLS. The NRC or 'no road crossing' and ATWS or 'advanced train warning system' are designed to work with boat's ATLS and the TRC system. Scripts updated to new TANE SP2 standards replacing obsolete function calls and tested in TRS19 and TRS22.
 

'''Terminology'''

2L 2 Lane Road
2T 2 Tracks
315 Opposite of 45 degrees
45 45 degrees
90 90 degrees
ATLS Advanced Traffic Light System
ATWS Advanced Train Warning System
CA Canada
FEC Florida East Coast
Inc. Incandesent
LED Light Emitting Diode
NRC No Road Crossing
OH Overhead
Ped Pedestrian
TRC Trigger Rail Crossing
US United States
WSL With Side Lights
 
'''To find these easily, seach 'CDE Xing' in your Content Manager or Surveyor seach'''
 
* <kuid:647907:102757> Grade Xing NRC ATWS Ped Gate No Sign CDE
* <kuid:647907:102957> Grade Xing US Inc. 2L 2T 315 WSL CDE
* <kuid2:647907:101677:1> Grade Xing NRC ATWS 3 CDE
* <kuid:647907:102837> Grade Xing US OH 2L 3T CDE
* <kuid:647907:102965> Grade Xing FEC 4L 45R Cantilever CDE
* <kuid:647907:102964> Grade Xing FEC 4L 90R Cantilever CDE
* <kuid2:647907:101662:1> Grade Xing NRC ATWS CDE
* <kuid:647907:102710> Grade Xing US 2L 1T US&S v1 Wig Wag CDE
* <kuid:647907:102966> Grade Xing FEC 4L 315R Cantilever CDE
* <kuid2:647907:101928:1> Grade Xing US Inc. 2L 1T 45 CDE
* <kuid2:647907:101672:1> Grade Xing NRC ATWS 2 CDE
* <kuid:647907:102736> Grade Xing NRC 4L Gated Circa 1950's CDE
* <kuid:647907:102739> Grade Xing NRC Gated Circa 1950's CDE
* <kuid:647907:102742> Grade Xing NRC STOP Circa 1950's CDE
* <kuid2:647907:101782:2> Grade Xing NRC LED Gated 2L CDE
* <kuid:647907:102960> Grade Xing US OH 4L 4T CDE
* <kuid2:647907:102064:1> Grade Xing US OH 4L 2T CDE
* <kuid2:647907:101872:2> Grade Xing NRC OH 2L Gated CDE
* <kuid2:647907:101935:1> Grade Xing US OH 2L 2T CDE
* <kuid2:647907:101807:1> Grade Xing NRC OH 4L Gated CDE
* <kuid:647907:102749> Grade Xing NRC OH 4L Gated FEC CDE
* <kuid:647907:102953> Grade Xing US Inc. 2L 2T CDE
* <kuid2:647907:101929:1> Grade Xing US Inc. 2L 1T 315 CDE
* <kuid:647907:102697> Grade Xing NRC Skull and Crossbones CDE
* <kuid:647907:102691> Grade Xing NRC US Inc. 2L Gated CDE
* <kuid2:647907:101858:3> Grade Xing US Inc. 2L 1T CDE
* <kuid:647907:102690> Grade Xing NRC US Inc. 4L Gated CDE
* <kuid:647907:102958> Grade Xing US 4L 4T CDE
* <kuid:647907:102702> Grade Xing NRC Wig Wag Peach Basket V5 CDE
* <kuid:647907:102726> Grade Xing US 2L 1T Banjo CDE
* <kuid:647907:102713> Grade Xing US 2L 1T v2 Wig Wag CDE
* <kuid:647907:102717> Grade Xing US 2L 1T v3 Harpes Wig Wag CDE
* <kuid2:647907:101888:2> Grade Xing US OH 2L 1T W Catwalk CDE
* <kuid:647907:102720> Grade Xing US 2L 1T v4 Upper Quadrant Wig Wag CDE
* <kuid2:647907:102962:1> Grade Xing US OH 4L 4T 315 CDE
* <kuid2:647907:102066:1> Grade Xing US OH 4L 2T 45 CDE
* <kuid:647907:102706> Grade Xing US 2L 1T Wig Wag CDE
* <kuid:647907:102707> Grade Xing US 2L 2T v2 Wig Wag CDE
* <kuid:647907:102955> Grade Xing US Inc. 2L 2T 45 CDE
* <kuid:647907:102956> Grade Xing US Inc. 2L 2T 45 WSL CDE
* <kuid:647907:102954> Grade Xing US Inc. 2L 2T 315 CDE
* <kuid2:647907:101906:1> Grade Xing US OH 2L 1T 45R W Catwalk CDE
* <kuid2:647907:101902:1> Grade Xing US OH 2L 1T 315R W Catwalk CDE
* <kuid2:647907:101898:2> Grade Xing US OH 2L 1T CDE
* <kuid:647907:102886> Grade Xing US OH 2L 2T 45 CDE
* <kuid:647907:102868> Grade Xing US OH 4L 1T 45 CDE
* <kuid2:647907:101891:1> Grade Xing US OH 4L 1T CDE
* <kuid:647907:102961> Grade Xing US OH 4L 4T 45 CDE
* <kuid2:647907:102065:1> Grade Xing US OH 4L 2T 315 CDE
* <kuid:647907:102852> Grade Xing US OH 4L 3T CDE
 
Note from Clem aka BNSF50;
A special thanks to the following Trainz members for contributing to the working script's of these crossings, Fwassner, MartinVK, Phil Cambell and Andi06. Without their help, these crossings would not be animated. Also thank's to the many Trainz members who input praise, help and constructive critisism on the forum which enabled me to refine the crossings to what they are now. Please read the instructions located in the main folder for details on added features.

Grade Crossing XING BNSF50 CDE

2022-12-26T19:50:32Z

Christopher824:

'''Updated originals by BNSF50'''

Restored and/or replace bell to restore and/or reduce clicking sound. All assets updated to build 3.5 and available through the DLS. The NRC or 'no road crossing' and ATWS or 'advanced train warning system' are designed to work with boat's ATLS and the TRC system. Scripts updated to new TANE SP2 standards replacing obsolete function calls and tested in TRS19 and TRS22.
 

'''Terminology'''

2L 2 Lane Road
2T 2 Tracks
315 Opposite of 45 degrees
45 45 degrees
90 90 degrees
ATLS Advanced Traffic Light System
ATWS Advanced Train Warning System
CA Canada
FEC Florida East Coast
Inc. Incandesent
LED Light Emitting Diode
NRC No Road Crossing
OH Overhead
Ped Pedestrian
TRC Trigger Rail Crossing
US United States
 
'''To find these easily, seach 'CDE Xing' in your Content Manager or Surveyor seach'''
 
* <kuid:647907:102757> Grade Xing NRC ATWS Ped Gate No Sign CDE
* <kuid:647907:102957> Grade Xing US Inc. 2L 2T 315 WSL CDE
* <kuid2:647907:101677:1> Grade Xing NRC ATWS 3 CDE
* <kuid:647907:102837> Grade Xing US OH 2L 3T CDE
* <kuid:647907:102965> Grade Xing FEC 4L 45R Cantilever CDE
* <kuid:647907:102964> Grade Xing FEC 4L 90R Cantilever CDE
* <kuid2:647907:101662:1> Grade Xing NRC ATWS CDE
* <kuid:647907:102710> Grade Xing US 2L 1T US&S v1 Wig Wag CDE
* <kuid:647907:102966> Grade Xing FEC 4L 315R Cantilever CDE
* <kuid2:647907:101928:1> Grade Xing US Inc. 2L 1T 45 CDE
* <kuid2:647907:101672:1> Grade Xing NRC ATWS 2 CDE
* <kuid:647907:102736> Grade Xing NRC 4L Gated Circa 1950's CDE
* <kuid:647907:102739> Grade Xing NRC Gated Circa 1950's CDE
* <kuid:647907:102742> Grade Xing NRC STOP Circa 1950's CDE
* <kuid2:647907:101782:2> Grade Xing NRC LED Gated 2L CDE
* <kuid:647907:102960> Grade Xing US OH 4L 4T CDE
* <kuid2:647907:102064:1> Grade Xing US OH 4L 2T CDE
* <kuid2:647907:101872:2> Grade Xing NRC OH 2L Gated CDE
* <kuid2:647907:101935:1> Grade Xing US OH 2L 2T CDE
* <kuid2:647907:101807:1> Grade Xing NRC OH 4L Gated CDE
* <kuid:647907:102749> Grade Xing NRC OH 4L Gated FEC CDE
* <kuid:647907:102953> Grade Xing US Inc. 2L 2T CDE
* <kuid2:647907:101929:1> Grade Xing US Inc. 2L 1T 315 CDE
* <kuid:647907:102697> Grade Xing NRC Skull and Crossbones CDE
* <kuid:647907:102691> Grade Xing NRC US Inc. 2L Gated CDE
* <kuid2:647907:101858:3> Grade Xing US Inc. 2L 1T CDE
* <kuid:647907:102690> Grade Xing NRC US Inc. 4L Gated CDE
* <kuid:647907:102958> Grade Xing US 4L 4T CDE
* <kuid:647907:102702> Grade Xing NRC Wig Wag Peach Basket V5 CDE
* <kuid:647907:102726> Grade Xing US 2L 1T Banjo CDE
* <kuid:647907:102713> Grade Xing US 2L 1T v2 Wig Wag CDE
* <kuid:647907:102717> Grade Xing US 2L 1T v3 Harpes Wig Wag CDE
* <kuid2:647907:101888:2> Grade Xing US OH 2L 1T W Catwalk CDE
* <kuid:647907:102720> Grade Xing US 2L 1T v4 Upper Quadrant Wig Wag CDE
* <kuid2:647907:102962:1> Grade Xing US OH 4L 4T 315 CDE
* <kuid2:647907:102066:1> Grade Xing US OH 4L 2T 45 CDE
* <kuid:647907:102706> Grade Xing US 2L 1T Wig Wag CDE
* <kuid:647907:102707> Grade Xing US 2L 2T v2 Wig Wag CDE
* <kuid:647907:102955> Grade Xing US Inc. 2L 2T 45 CDE
* <kuid:647907:102956> Grade Xing US Inc. 2L 2T 45 WSL CDE
* <kuid:647907:102954> Grade Xing US Inc. 2L 2T 315 CDE
* <kuid2:647907:101906:1> Grade Xing US OH 2L 1T 45R W Catwalk CDE
* <kuid2:647907:101902:1> Grade Xing US OH 2L 1T 315R W Catwalk CDE
* <kuid2:647907:101898:2> Grade Xing US OH 2L 1T CDE
* <kuid:647907:102886> Grade Xing US OH 2L 2T 45 CDE
* <kuid:647907:102868> Grade Xing US OH 4L 1T 45 CDE
* <kuid2:647907:101891:1> Grade Xing US OH 4L 1T CDE
* <kuid:647907:102961> Grade Xing US OH 4L 4T 45 CDE
* <kuid2:647907:102065:1> Grade Xing US OH 4L 2T 315 CDE
* <kuid:647907:102852> Grade Xing US OH 4L 3T CDE
 
Note from Clem aka BNSF50;
A special thanks to the following Trainz members for contributing to the working script's of these crossings, Fwassner, MartinVK, Phil Cambell and Andi06. Without their help, these crossings would not be animated. Also thank's to the many Trainz members who input praise, help and constructive critisism on the forum which enabled me to refine the crossings to what they are now. Please read the instructions located in the main folder for details on added features.

Grade Crossing XING BNSF50 CDE

2022-12-26T19:10:03Z

Christopher824:

'''Updated originals by BNSF50'''

Restored and/or replace bell to restore and/or reduce clicking sound. All assets updated to build 3.5 and available through the DLS. The NRC or 'no road crossing' and ATWS or 'advanced train warning system' are designed to work with boat's ATLS and the TRC system. Scripts updated to new TANE SP2 standards replacing obsolete function calls and tested in TRS19 and TRS22.
 

'''Terminology'''

2L 2 Lane Road
2T 2 Tracks
315 Opposite of 45 degrees
45 45 degrees
90 90 degrees
ATWS Advanced Train Warning System
FEC Florida East Coast
Inc. Incandesent
LED Light Emitting Diode
NRC No Road Crossing
OH Overhead
Ped Pedestrian
 
'''To find these easily, seach 'CDE Xing' in your Content Manager or Surveyor seach'''
 
* <kuid:647907:102757> Grade Xing NRC ATWS Ped Gate No Sign CDE
* <kuid:647907:102957> Grade Xing US Inc. 2L 2T 315 WSL CDE
* <kuid2:647907:101677:1> Grade Xing NRC ATWS 3 CDE
* <kuid:647907:102837> Grade Xing US OH 2L 3T CDE
* <kuid:647907:102965> Grade Xing FEC 4L 45R Cantilever CDE
* <kuid:647907:102964> Grade Xing FEC 4L 90R Cantilever CDE
* <kuid2:647907:101662:1> Grade Xing NRC ATWS CDE
* <kuid:647907:102710> Grade Xing US 2L 1T US&S v1 Wig Wag CDE
* <kuid:647907:102966> Grade Xing FEC 4L 315R Cantilever CDE
* <kuid2:647907:101928:1> Grade Xing US Inc. 2L 1T 45 CDE
* <kuid2:647907:101672:1> Grade Xing NRC ATWS 2 CDE
* <kuid:647907:102736> Grade Xing NRC 4L Gated Circa 1950's CDE
* <kuid:647907:102739> Grade Xing NRC Gated Circa 1950's CDE
* <kuid:647907:102742> Grade Xing NRC STOP Circa 1950's CDE
* <kuid2:647907:101782:2> Grade Xing NRC LED Gated 2L CDE
* <kuid:647907:102960> Grade Xing US OH 4L 4T CDE
* <kuid2:647907:102064:1> Grade Xing US OH 4L 2T CDE
* <kuid2:647907:101872:2> Grade Xing NRC OH 2L Gated CDE
* <kuid2:647907:101935:1> Grade Xing US OH 2L 2T CDE
* <kuid2:647907:101807:1> Grade Xing NRC OH 4L Gated CDE
* <kuid:647907:102749> Grade Xing NRC OH 4L Gated FEC CDE
* <kuid:647907:102953> Grade Xing US Inc. 2L 2T CDE
* <kuid2:647907:101929:1> Grade Xing US Inc. 2L 1T 315 CDE
* <kuid:647907:102697> Grade Xing NRC Skull and Crossbones CDE
* <kuid:647907:102691> Grade Xing NRC US Inc. 2L Gated CDE
* <kuid2:647907:101858:3> Grade Xing US Inc. 2L 1T CDE
* <kuid:647907:102690> Grade Xing NRC US Inc. 4L Gated CDE
* <kuid:647907:102958> Grade Xing US 4L 4T CDE
* <kuid:647907:102702> Grade Xing NRC Wig Wag Peach Basket V5 CDE
* <kuid:647907:102726> Grade Xing US 2L 1T Banjo CDE
* <kuid:647907:102713> Grade Xing US 2L 1T v2 Wig Wag CDE
* <kuid:647907:102717> Grade Xing US 2L 1T v3 Harpes Wig Wag CDE
* <kuid2:647907:101888:2> Grade Xing US OH 2L 1T W Catwalk CDE
* <kuid:647907:102720> Grade Xing US 2L 1T v4 Upper Quadrant Wig Wag CDE
* <kuid2:647907:102962:1> Grade Xing US OH 4L 4T 315 CDE
* <kuid2:647907:102066:1> Grade Xing US OH 4L 2T 45 CDE
* <kuid:647907:102706> Grade Xing US 2L 1T Wig Wag CDE
* <kuid:647907:102707> Grade Xing US 2L 2T v2 Wig Wag CDE
* <kuid:647907:102955> Grade Xing US Inc. 2L 2T 45 CDE
* <kuid:647907:102956> Grade Xing US Inc. 2L 2T 45 WSL CDE
* <kuid:647907:102954> Grade Xing US Inc. 2L 2T 315 CDE
* <kuid2:647907:101906:1> Grade Xing US OH 2L 1T 45R W Catwalk CDE
* <kuid2:647907:101902:1> Grade Xing US OH 2L 1T 315R W Catwalk CDE
* <kuid2:647907:101898:2> Grade Xing US OH 2L 1T CDE
* <kuid:647907:102886> Grade Xing US OH 2L 2T 45 CDE
* <kuid:647907:102868> Grade Xing US OH 4L 1T 45 CDE
* <kuid2:647907:101891:1> Grade Xing US OH 4L 1T CDE
* <kuid:647907:102961> Grade Xing US OH 4L 4T 45 CDE
* <kuid2:647907:102065:1> Grade Xing US OH 4L 2T 315 CDE
* <kuid:647907:102852> Grade Xing US OH 4L 3T CDE
 
Note from Clem aka BNSF50;
A special thanks to the following Trainz members for contributing to the working script's of these crossings, Fwassner, MartinVK, Phil Cambell and Andi06. Without their help, these crossings would not be animated. Also thank's to the many Trainz members who input praise, help and constructive critisism on the forum which enabled me to refine the crossings to what they are now. Please read the instructions located in the main folder for details on added features.

Grade Crossing XING BNSF50 CDE

2022-12-26T18:50:11Z

Christopher824: added more xing's

Updated originals by BNSF50, restored and/or replace bell to restore and/or reduce clicking sound. All assets updated to build 3.5 and available through the DLS. The NRC or 'no road crossing' and ATWS or 'advanced train warning system' are designed to work with boat's ATLS and the TRC system. These revised assets have fully functional updated Property ? scripts.

To find these easily, seach 'CDE Xing' in your Content Manager or Surveyor seach
 
* <kuid:647907:102757> Grade Xing NRC ATWS Ped Gate No Sign CDE
* <kuid:647907:102957> Grade Xing US Inc. 2L 2T 315 WSL CDE
* <kuid2:647907:101677:1> Grade Xing NRC ATWS 3 CDE
* <kuid:647907:102837> Grade Xing US OH 2L 3T CDE
* <kuid:647907:102965> Grade Xing FEC 4L 45R Cantilever CDE
* <kuid:647907:102964> Grade Xing FEC 4L 90R Cantilever CDE
* <kuid2:647907:101662:1> Grade Xing NRC ATWS CDE
* <kuid:647907:102710> Grade Xing US 2L 1T US&S v1 Wig Wag CDE
* <kuid:647907:102966> Grade Xing FEC 4L 315R Cantilever CDE
* <kuid2:647907:101928:1> Grade Xing US Inc. 2L 1T 45 CDE
* <kuid2:647907:101672:1> Grade Xing NRC ATWS 2 CDE
* <kuid:647907:102736> Grade Xing NRC 4L Gated Circa 1950's CDE
* <kuid:647907:102739> Grade Xing NRC Gated Circa 1950's CDE
* <kuid:647907:102742> Grade Xing NRC STOP Circa 1950's CDE
* <kuid2:647907:101782:2> Grade Xing NRC LED Gated 2L CDE
* <kuid:647907:102960> Grade Xing US OH 4L 4T CDE
* <kuid2:647907:102064:1> Grade Xing US OH 4L 2T CDE
* <kuid2:647907:101872:2> Grade Xing NRC OH 2L Gated CDE
* <kuid2:647907:101935:1> Grade Xing US OH 2L 2T CDE
* <kuid2:647907:101807:1> Grade Xing NRC OH 4L Gated CDE
* <kuid:647907:102749> Grade Xing NRC OH 4L Gated FEC CDE
* <kuid:647907:102953> Grade Xing US Inc. 2L 2T CDE
* <kuid2:647907:101929:1> Grade Xing US Inc. 2L 1T 315 CDE
* <kuid:647907:102697> Grade Xing NRC Skull and Crossbones CDE
* <kuid:647907:102691> Grade Xing NRC US Inc. 2L Gated CDE
* <kuid2:647907:101858:3> Grade Xing US Inc. 2L 1T CDE
* <kuid:647907:102690> Grade Xing NRC US Inc. 4L Gated CDE
* <kuid:647907:102958> Grade Xing US 4L 4T CDE
* <kuid:647907:102702> Grade Xing NRC Wig Wag Peach Basket V5 CDE
* <kuid:647907:102726> Grade Xing US 2L 1T Banjo CDE
* <kuid:647907:102713> Grade Xing US 2L 1T v2 Wig Wag CDE
* <kuid:647907:102717> Grade Xing US 2L 1T v3 Harpes Wig Wag CDE
* <kuid2:647907:101888:2> Grade Xing US OH 2L 1T W Catwalk CDE
* <kuid:647907:102720> Grade Xing US 2L 1T v4 Upper Quadrant Wig Wag CDE
* <kuid2:647907:102962:1> Grade Xing US OH 4L 4T 315 CDE
* <kuid2:647907:102066:1> Grade Xing US OH 4L 2T 45 CDE
* <kuid:647907:102706> Grade Xing US 2L 1T Wig Wag CDE
* <kuid:647907:102707> Grade Xing US 2L 2T v2 Wig Wag CDE
* <kuid:647907:102955> Grade Xing US Inc. 2L 2T 45 CDE
* <kuid:647907:102956> Grade Xing US Inc. 2L 2T 45 WSL CDE
* <kuid:647907:102954> Grade Xing US Inc. 2L 2T 315 CDE
* <kuid2:647907:101906:1> Grade Xing US OH 2L 1T 45R W Catwalk CDE
* <kuid2:647907:101902:1> Grade Xing US OH 2L 1T 315R W Catwalk CDE
* <kuid2:647907:101898:2> Grade Xing US OH 2L 1T CDE
* <kuid:647907:102886> Grade Xing US OH 2L 2T 45 CDE
* <kuid:647907:102868> Grade Xing US OH 4L 1T 45 CDE
* <kuid2:647907:101891:1> Grade Xing US OH 4L 1T CDE
* <kuid:647907:102961> Grade Xing US OH 4L 4T 45 CDE
* <kuid2:647907:102065:1> Grade Xing US OH 4L 2T 315 CDE
* <kuid:647907:102852> Grade Xing US OH 4L 3T CDE
 
Note from Clem aka BNSF50;
A special thanks to the following Trainz members for contributing to the working script's of these crossings, Fwassner, MartinVK, Phil Cambell and Andi06. Without their help, these crossings would not be animated. Also thank's to the many Trainz members who input praise, help and constructive critisism on the forum which enabled me to refine the crossings to what they are now. Please read the instructions located in the main folder for details on added features.

Christopher824

2022-11-10T16:27:54Z

Christopher824:

'''Driver''' 
<KUID:647907:100674> 
Last Updated: 29th Nov 2020 
File Size: 51.24 kb 
Minimum TANE SP2/SP3 build 4.5

CDE Trainz Driver Christopher824. TANE (sp2 or higher) and TRS19. 
Uses standing male driver mesh by Auran. Free to use for personal use. 

[[File:Christopher824 1024.jpg]]

More info can be found on the CDE Trainz website; 
'''[https://cdetrainz.com/assets_asset.aspx?aid=13 CDE Trainz Website - USA]'''

File:Christopher824 1024.jpg

2022-11-10T16:25:05Z

Christopher824: Christopher824

Christopher824

2022-11-10T16:17:16Z

Christopher824:

'''Driver''' 
<KUID:647907:100674> 
Last Updated: 29th Nov 2020 
File Size: 51.24 kb 
Minimum TANE SP2/SP3 build 4.5

CDE Trainz Driver Christopher824. TANE (sp2 or higher) and TRS19. 
Uses standing male driver mesh by Auran. Free to use for personal use. 

More info can be found on the CDE Trainz website; 
'''[https://cdetrainz.com/assets_asset.aspx?aid=13 CDE Trainz Website - USA]'''

Content

2022-11-10T16:12:37Z

Christopher824: Undo revision 27297 by Thomastrain673 (talk)

This page aims to list and describe all content available for [[TS2009]].

Content detail pages should have a 'Content/' prefix and are linked by inclusion in one of the following categories. Each individual content page should include a description of the content including real-life photos, compatibility and usage information, a link to the content creator's wiki page and a download station helper link. It is recommended that content detail pages do not include off-site links, as Trainz users will not be able to follow these.

* [[:Category:Rolling Stock]]
* [[:Category:Scenery]]
* [[:Category:Routes]]
* [[:Category:Scripts]]
* [[:Category:Track]]
* [[:Category:Operations]]

[[Category:Trainz Wiki]]

TCCP Beta Testing

2022-11-10T16:09:21Z

Christopher824:

'''[[TCCP]]''' 
This page is a guide for Trainz Content Creation Program or 'TCCP' 
TCCP Content Creators should look '''[[TCCP Content Creation]]'''

'''Under Development''' The contents and the layout of this page is under development.

Trainz Content Creation Program or TCCP allows you to become a Beta Tester for new DLC content. You will be part of the development team that makes it happen.

TCCP Content Creation

2022-11-10T16:08:52Z

Christopher824:

'''[[TCCP]]''' 
This page is a guide for Trainz Content Creation Program or 'TCCP' 
TCCP Beta Testers should look here '''[[TCCP Beta Testing]]'''

'''Under Development''' The contents and the layout of this page is under development.

Trainz Content Creation Program or TCCP allows you to become a Registered Content Creator with N3V Auran. You will be eligible to upload Content which may be made available for download by Trainz users, and, for Approved Content, to receive a share of revenues for sales relating to your Content.

=Getting Started=

==Set Up Account==
Your first step is to get a TCCP account at [https://tccp.auran.com/ '''tccp.auran.com''']
When you create your account use your My Trainz username and password. You will be asked to accept the EULA terms and conditions. This account will be the same for content creation and beta testing, so please do not try to create multiple accounts.

Once you have an account created you can find a lot more detailed instructions under [https://tccp.auran.com/documentation.php '''tccp.auran.com/documentation.php'''].

This video also explains most of what you need to get up and running. It is a long video but is split into sections so you can skip to what you need: [https://www.youtube.com/watch?v=6J9Bhq5vIxk&t=65s '''DETAILED VIDEO''']

==Connect With Other Creators==
More heads are better than one. There are differnt ways to connect with other content creators and you should be involved with this. Trainz is a community based platform, and as such you need to be involed to help gaurantee success. You will find if you are a team player, you will benifit from the team. Here are some avenues to connect;

* [https://forums.auran.com/trainz/forum.php Trainz Forums]
* Trainz Discord channel For this you will need an invite, see the Trainz Forums above.

=Creating A Package=

==Thumbnails==

Your primary asset(s), Routes, Sessions, Rolling Stock and Locos must have the proper set of thumbnails. To add the thumbnails to your asset, edit the config.txt and make sure it looks like the code below, take note of the dimensions and filenames listed for each thumbnail. If you do not have the correct size thumbnails or filenames, you will need to create or modify them. If the 'default' thumbnail is not named 'thumbnail.jpg', it will not create the auto generated 'new' session thumbnail when a new session is created.

thumbnails
{
0
{
image "0.jpg"
width 1280
height 800
}

1
{
image "1.jpg"
width 1280
height 800
}

2
{
image "2.jpg"
width 1280
height 800
}

default
{
image "thumbnail.jpg"
width 512
height 384
}
}

==TCCP Manager==
Current TCCP projects can be from a TRS19 or TRS22 build. Do not try to create a package using a Beta Build. If you can submit your project in TRS19 SP5, then you can target both TRS19 and TRS22 customers. Open Trainz and look for the Developer Tab. It can be found from the Launcher and the Content Manager.
* Select 'Open TCCP Project List'
* Right Click inside window and select 'Create New Project...'

Once the panel opens, type in a Title. Then type a description in the text box, it can be anything as these will not be the final title or description, so it could just be a note at this point. If you close this dialog without giving it a Title or a Description, you will get an error. If you wish to still quit, close the dialog a second time and it will abandon the project. If you close the dialog with a Title and Description, a TCCP Project ID will be assigned to your project and now can be found on the TCCP website.

In the TCCP Project List, your project will now be listed. You can right click on it and it will give you the option of 'Edit Project...' and 'View Project on TCCP Website...'.

When you choose edit project, the window that pops up it will now have your title on the menu bar. The first list box is where you place the assets you have made and wish to distribute. You will need to open a Content Manager window, and drag your creation(s) into it. The second box is which from the first box you want to encode as payware. You can now drag from the first box to the second box to populate it. If you are a route creator, and wish to have an unlocked base session, you would leave that session out of the second box.

==Using newer asset versions where available==
Checkbox - ''need more info on this setting?'' Default leave unchecked.

==Uploading==

Once you have populated the two list boxes, click the 'Upload Package' button on the bottom right of the dialog.
*.TZARC - Trainz Archive File
The manager will attempt to build your files into a .tzarc file. It will add every dependancy the package needs into the file. If succesful it will upload it to the TCCP build machine.

==Errors==
* '''Payware''' You can not include payware in your project, this includes dependencies.
* '''Packaged and not avialable''' This will happen from time to time. There are different ways to fix this. You could edit your creation and remove the offending asset. You could clone the asset if the license allows or you have permission, then upload it to the DLS, then replace your old one with the new one from the DLS. Or you could open a helpdesk ticket if there is an earlier version on the DLS. If the only version available is the packaged one, then you must remove or clone.
* '''Unfeasable''' You already have a built package on the TCCP website. You will need to go to the website and cancel the package, then delete the .tzarc file. You will now be able to upload your package.
* '''Unknown Errors''' 

=TCCP Package Setup=

==Login==

Once you have uploaded your .tzarc file you will need to login at the TCCP website and navigate to your file or Package. The top level, or the Apps Dashboard, has 3 major sections. Content, Beta Testing and Documentation. Your file will be in the Content section or the Content Creator Dashboard. At the bottom of the page will be a list of your projects. Click on the title of your package in the list to continue to the Content Creator Project.

==Package==

You are required to fill in all the fields before clicking the 'Update Package' button at the bottom of this page. What is entered here can be changed before you submit it to the build machine, so don't be worried if it's not 100% accurate at this point. The Title and Description will overright the Trainz TCCP Manager, so this is important to remember if you need to modify your .tzac file and re-upload it.

==Images==

Upload at least six 1280 (width) x 800 (height) marketing screenshots and one 600 (width) x 262 (height) Trainz Store header image for your product. Accepted upload formats: 'png' or 'jpg'. Please ensure to include a 1280x800 resolution version of the 600x262 header image in the screenshots section as well, as this is required for creating the header images for Steam.

These images will not effect the images in your assets config.txt file.

Optionally you can upload a YouTube video.

==Files==

You can have only one .tzarc file uploaded for a project. If you need to change something, you will have to delete the file from this page. Depending at which stage your project is in, you may need to Cancel Beta and/or Cancel Project

==Beta Testing==

Before you submit for Beta Testing you should add your own questions as part of your Beta so testers have specific details to test with your content. You can add specific testing questions under the Test Plan Tools

==Assets==

==Notifications==

 

=Build Machine=

Near the top of each Content Creator Project page is a status box showing the current build status of the package. Once your package has passed all the requirements, the Submit To Build Queue button will appear.

* Prepare For Submission
* Building Your package is building. It may take up to a couple of hours or more to build the project.
* Failed
* Success Your package passed and can now be submitted for Beta Testing
* Live N3V has approved your package and it is now on the store.

 

=Beta Testing=

==Test Quesions==

==Tickets==

 

=Final Review=

Once you have addressed all tickets opened during the beta test, which could mean that you will have to submit a new beta, again, to confirm the fixes. Your package will pass beta and go into Final Review. This is where it is now scrutinized by the N3V staff.

Per Zec,
"''Something I've been meaning to do for quite a while is post up a bit of a 'guide' on how we generally review DLC packs. This isn't a hard and fast method, but should help you guys to review your content yourselves before submission There is a difference between routes/sessions and traincars, as they involve different aspects of gameplay. For all content, I will verify that the advertised content is included (ie route, sessions, traincars, consists, etc). This is based on what you advertise in the description (ie if you say there are 5 sessions and I only see 4, I'll send it back to you to double check).''"

After verifying the content is installed, and is fully active, and no open tickets.

==Routes / Sessions==

For routes/sessions:
* Each session is loaded into Driver, and then verified that the session loads successfully
* Drive the session for a few minutes, or untill the first navigation mark or task is complete. This is to ensure that the session is starting correctly, and the initial rules are working correctly. It also ensures that the locomotives and rolling stock at the start of the session are working correctly (ie brakes releasing correctly, and so on).
* Take a quick fly over of the route to make sure it all is loading correctly
* If the DLC pack also advertises custom/specific locomotives and rolling stock, then this will also be reviewed using the below.

==Traincar==

For traincar DLC packs:
* Check that the advertised traincars and consists are present
* Place the traincars onto a blank route, that has the track sitting directly on top of water. This allows me to check that the traincar has a water reflection that works properly, looks like the traincar, and isn't badly broken/distorted.
* For passenger coaches, place them onto a test route with a passenger station to check that the doors work as expected with a passenger station.
* For all traincars, place them onto the KSC2 route, and do a check for obvious mesh/LOD issues (ie obvious changes in the look of the loco when moving toward/away from it). This includes distortions to the texture map, or smoothing issues, on lower LODs.
* At this point, also do a check that all controls work. This means that using keyboard and HUD controls work for all main controls (reverser, throttle, dynamic brake^, train brake, independent brake, headlight, ditch lights^, pantographs^, sander, and of course simple controls mode).
^The controls marked with this are 'optional' on traincars, so are only checked where that item has them fitted. The independent brake, although not always fitted in the cab view, should generally be operational on traincars since the HUD control is available. Dynamic brake, OTOH, is generally acceptable if it is not functional (but it absolutely should be
functional on locos fitted with one).
* Quickly try any advertised scripted functions to make sure these work.
* For locos, take the locomotive for a short drive in Driver to make sure that they drive appropriately (note, this isn't necessarily a check for prototypical operation, but more just to make sure that they operate correctly as a locomotive in general). This also allows checking that sounds are working correctly/etc.
* For rolling stock, do the same, but use a builtin locomotive to haul them.

As a final note regarding traincar DLC packs. It is expected that locomotives and rolling stock scripts will not break default functionality.

Examples of this are startup/shutdown scripts that are off by default. For the average user who purchases a loco with this, they will have no way to know how to startup the locomotive, and hence are stuck with a locomotive that to them simply does not work. For startup/shutdown scripts there are two options for this, one is to simply have the loco on by default and allow the player to choose to turn it off in the properties, and then allow them to go through the startup sequence. Another, as seen on the Frecciarossa train DLC, would be to have the train pop up with a message to provide startup options.

Another example would be custom throttle/brake controls that prevent the HUD controls, DCC controls, or keyboard controls from working. Again the average player who purchases this DLC pack will not know what is happening and will see this content as being broken. In this case you must ensure that custom controls correctly respond to the HUD and keyboard.

==Review Results==

If any issues are found during review, these will be reported via the beta testing bug report system in TCCP. If no issues are found we will then process the DLC pack to PreviewPass for 2 weeks, then release publicly after the 2 week PreviewPass. Note that in some cases, very minor issues might be reported but we may still process to previewpass, these issues should be resolved in an update during previewpass or after release, normally we'll note this in the bug report.

==Request Skip Beta==

Depending on the issues noted, we will generally let you know if you can request skip beta on the package after resolving the noted issues, however if we don't you can choose to request this after building the package. However if the issues noted were something that needs testing, we will reject the skip beta so that it can go through another round of beta testing. Otherwise we will review the DLC pack again, double checking that reported bugs are resolved.
 

=Getting Paid=

In order to get paid for your work, you will need a verified PayPal account. Then you will need an Affiliatly account linked to the PayPal account.

==Affiliatly Account==

You will need to setup an [https://www.affiliatly.com/af-102715/affiliate.panel '''Affiliatly Account''']

Start earning royalties and commissions from your Trainz hobby today.

Are you a Trainz Content Creator? Expand your own website sales and earn commissions on all your items sold through the Trainz Store and via other online stores such as Steam and Mac App Store. (Submit your content through [https://tccp.auran.com/ '''this link''']). Commissions are 50% of the sale price for direct purchases. You will also receive commissions on Silver and Gold subscriptions that download your DLC content. The amount of these commissions vary and a detailed chart can be found under the TCCP website Documentation section.

Do you run a Trainz website or Youtube Channel? Use your Affiliatly link to earn commissions on sales through our store. Each time a user clicks on your link then purchases an item in the next week, you earn a 10% commission on that sale. This could result in a total of 60% on a direct sale.

Registration is free. Sign up now to get your Affiliatly ID and begin earning commissions and royalties. The website tracks the royalties earned for referrals and sales through our TrainzPortal store and shows payments to your nominated account. The amount shown may be less than you will actuallly receive as the subscription revenue does not show here, which is calculated on the processing date as it's a shared revenue.

Once you have set up your account you will be given an Affiliatly ID number. Log back into the TCCP website, and in the Content Creator Dashboard choose Options. Enter your ID and Save. WARNING: Double check your Affiliatly ID. Adding the wrong ID could mean the wrong account is paid!

==PayPal Account==

In order to get paid, you must have a PayPal account linked to your Affiliaty account. You will get paid on the 15th or 16th of each month, depending on your time zone and when they process your account. You must have at least $100 US in earnings before you will get paid.

TCCP Content Creation

2022-11-10T16:08:37Z

Christopher824:

'''[[TCCP]]'''
This page is a guide for Trainz Content Creation Program or 'TCCP' 
TCCP Beta Testers should look here '''[[TCCP Beta Testing]]'''

'''Under Development''' The contents and the layout of this page is under development.

Trainz Content Creation Program or TCCP allows you to become a Registered Content Creator with N3V Auran. You will be eligible to upload Content which may be made available for download by Trainz users, and, for Approved Content, to receive a share of revenues for sales relating to your Content.

=Getting Started=

==Set Up Account==
Your first step is to get a TCCP account at [https://tccp.auran.com/ '''tccp.auran.com''']
When you create your account use your My Trainz username and password. You will be asked to accept the EULA terms and conditions. This account will be the same for content creation and beta testing, so please do not try to create multiple accounts.

Once you have an account created you can find a lot more detailed instructions under [https://tccp.auran.com/documentation.php '''tccp.auran.com/documentation.php'''].

This video also explains most of what you need to get up and running. It is a long video but is split into sections so you can skip to what you need: [https://www.youtube.com/watch?v=6J9Bhq5vIxk&t=65s '''DETAILED VIDEO''']

==Connect With Other Creators==
More heads are better than one. There are differnt ways to connect with other content creators and you should be involved with this. Trainz is a community based platform, and as such you need to be involed to help gaurantee success. You will find if you are a team player, you will benifit from the team. Here are some avenues to connect;

* [https://forums.auran.com/trainz/forum.php Trainz Forums]
* Trainz Discord channel For this you will need an invite, see the Trainz Forums above.

=Creating A Package=

==Thumbnails==

Your primary asset(s), Routes, Sessions, Rolling Stock and Locos must have the proper set of thumbnails. To add the thumbnails to your asset, edit the config.txt and make sure it looks like the code below, take note of the dimensions and filenames listed for each thumbnail. If you do not have the correct size thumbnails or filenames, you will need to create or modify them. If the 'default' thumbnail is not named 'thumbnail.jpg', it will not create the auto generated 'new' session thumbnail when a new session is created.

thumbnails
{
0
{
image "0.jpg"
width 1280
height 800
}

1
{
image "1.jpg"
width 1280
height 800
}

2
{
image "2.jpg"
width 1280
height 800
}

default
{
image "thumbnail.jpg"
width 512
height 384
}
}

==TCCP Manager==
Current TCCP projects can be from a TRS19 or TRS22 build. Do not try to create a package using a Beta Build. If you can submit your project in TRS19 SP5, then you can target both TRS19 and TRS22 customers. Open Trainz and look for the Developer Tab. It can be found from the Launcher and the Content Manager.
* Select 'Open TCCP Project List'
* Right Click inside window and select 'Create New Project...'

Once the panel opens, type in a Title. Then type a description in the text box, it can be anything as these will not be the final title or description, so it could just be a note at this point. If you close this dialog without giving it a Title or a Description, you will get an error. If you wish to still quit, close the dialog a second time and it will abandon the project. If you close the dialog with a Title and Description, a TCCP Project ID will be assigned to your project and now can be found on the TCCP website.

In the TCCP Project List, your project will now be listed. You can right click on it and it will give you the option of 'Edit Project...' and 'View Project on TCCP Website...'.

When you choose edit project, the window that pops up it will now have your title on the menu bar. The first list box is where you place the assets you have made and wish to distribute. You will need to open a Content Manager window, and drag your creation(s) into it. The second box is which from the first box you want to encode as payware. You can now drag from the first box to the second box to populate it. If you are a route creator, and wish to have an unlocked base session, you would leave that session out of the second box.

==Using newer asset versions where available==
Checkbox - ''need more info on this setting?'' Default leave unchecked.

==Uploading==

Once you have populated the two list boxes, click the 'Upload Package' button on the bottom right of the dialog.
*.TZARC - Trainz Archive File
The manager will attempt to build your files into a .tzarc file. It will add every dependancy the package needs into the file. If succesful it will upload it to the TCCP build machine.

==Errors==
* '''Payware''' You can not include payware in your project, this includes dependencies.
* '''Packaged and not avialable''' This will happen from time to time. There are different ways to fix this. You could edit your creation and remove the offending asset. You could clone the asset if the license allows or you have permission, then upload it to the DLS, then replace your old one with the new one from the DLS. Or you could open a helpdesk ticket if there is an earlier version on the DLS. If the only version available is the packaged one, then you must remove or clone.
* '''Unfeasable''' You already have a built package on the TCCP website. You will need to go to the website and cancel the package, then delete the .tzarc file. You will now be able to upload your package.
* '''Unknown Errors''' 

=TCCP Package Setup=

==Login==

Once you have uploaded your .tzarc file you will need to login at the TCCP website and navigate to your file or Package. The top level, or the Apps Dashboard, has 3 major sections. Content, Beta Testing and Documentation. Your file will be in the Content section or the Content Creator Dashboard. At the bottom of the page will be a list of your projects. Click on the title of your package in the list to continue to the Content Creator Project.

==Package==

You are required to fill in all the fields before clicking the 'Update Package' button at the bottom of this page. What is entered here can be changed before you submit it to the build machine, so don't be worried if it's not 100% accurate at this point. The Title and Description will overright the Trainz TCCP Manager, so this is important to remember if you need to modify your .tzac file and re-upload it.

==Images==

Upload at least six 1280 (width) x 800 (height) marketing screenshots and one 600 (width) x 262 (height) Trainz Store header image for your product. Accepted upload formats: 'png' or 'jpg'. Please ensure to include a 1280x800 resolution version of the 600x262 header image in the screenshots section as well, as this is required for creating the header images for Steam.

These images will not effect the images in your assets config.txt file.

Optionally you can upload a YouTube video.

==Files==

You can have only one .tzarc file uploaded for a project. If you need to change something, you will have to delete the file from this page. Depending at which stage your project is in, you may need to Cancel Beta and/or Cancel Project

==Beta Testing==

Before you submit for Beta Testing you should add your own questions as part of your Beta so testers have specific details to test with your content. You can add specific testing questions under the Test Plan Tools

==Assets==

==Notifications==

 

=Build Machine=

Near the top of each Content Creator Project page is a status box showing the current build status of the package. Once your package has passed all the requirements, the Submit To Build Queue button will appear.

* Prepare For Submission
* Building Your package is building. It may take up to a couple of hours or more to build the project.
* Failed
* Success Your package passed and can now be submitted for Beta Testing
* Live N3V has approved your package and it is now on the store.

 

=Beta Testing=

==Test Quesions==

==Tickets==

 

=Final Review=

Once you have addressed all tickets opened during the beta test, which could mean that you will have to submit a new beta, again, to confirm the fixes. Your package will pass beta and go into Final Review. This is where it is now scrutinized by the N3V staff.

Per Zec,
"''Something I've been meaning to do for quite a while is post up a bit of a 'guide' on how we generally review DLC packs. This isn't a hard and fast method, but should help you guys to review your content yourselves before submission There is a difference between routes/sessions and traincars, as they involve different aspects of gameplay. For all content, I will verify that the advertised content is included (ie route, sessions, traincars, consists, etc). This is based on what you advertise in the description (ie if you say there are 5 sessions and I only see 4, I'll send it back to you to double check).''"

After verifying the content is installed, and is fully active, and no open tickets.

==Routes / Sessions==

For routes/sessions:
* Each session is loaded into Driver, and then verified that the session loads successfully
* Drive the session for a few minutes, or untill the first navigation mark or task is complete. This is to ensure that the session is starting correctly, and the initial rules are working correctly. It also ensures that the locomotives and rolling stock at the start of the session are working correctly (ie brakes releasing correctly, and so on).
* Take a quick fly over of the route to make sure it all is loading correctly
* If the DLC pack also advertises custom/specific locomotives and rolling stock, then this will also be reviewed using the below.

==Traincar==

For traincar DLC packs:
* Check that the advertised traincars and consists are present
* Place the traincars onto a blank route, that has the track sitting directly on top of water. This allows me to check that the traincar has a water reflection that works properly, looks like the traincar, and isn't badly broken/distorted.
* For passenger coaches, place them onto a test route with a passenger station to check that the doors work as expected with a passenger station.
* For all traincars, place them onto the KSC2 route, and do a check for obvious mesh/LOD issues (ie obvious changes in the look of the loco when moving toward/away from it). This includes distortions to the texture map, or smoothing issues, on lower LODs.
* At this point, also do a check that all controls work. This means that using keyboard and HUD controls work for all main controls (reverser, throttle, dynamic brake^, train brake, independent brake, headlight, ditch lights^, pantographs^, sander, and of course simple controls mode).
^The controls marked with this are 'optional' on traincars, so are only checked where that item has them fitted. The independent brake, although not always fitted in the cab view, should generally be operational on traincars since the HUD control is available. Dynamic brake, OTOH, is generally acceptable if it is not functional (but it absolutely should be
functional on locos fitted with one).
* Quickly try any advertised scripted functions to make sure these work.
* For locos, take the locomotive for a short drive in Driver to make sure that they drive appropriately (note, this isn't necessarily a check for prototypical operation, but more just to make sure that they operate correctly as a locomotive in general). This also allows checking that sounds are working correctly/etc.
* For rolling stock, do the same, but use a builtin locomotive to haul them.

As a final note regarding traincar DLC packs. It is expected that locomotives and rolling stock scripts will not break default functionality.

Examples of this are startup/shutdown scripts that are off by default. For the average user who purchases a loco with this, they will have no way to know how to startup the locomotive, and hence are stuck with a locomotive that to them simply does not work. For startup/shutdown scripts there are two options for this, one is to simply have the loco on by default and allow the player to choose to turn it off in the properties, and then allow them to go through the startup sequence. Another, as seen on the Frecciarossa train DLC, would be to have the train pop up with a message to provide startup options.

Another example would be custom throttle/brake controls that prevent the HUD controls, DCC controls, or keyboard controls from working. Again the average player who purchases this DLC pack will not know what is happening and will see this content as being broken. In this case you must ensure that custom controls correctly respond to the HUD and keyboard.

==Review Results==

If any issues are found during review, these will be reported via the beta testing bug report system in TCCP. If no issues are found we will then process the DLC pack to PreviewPass for 2 weeks, then release publicly after the 2 week PreviewPass. Note that in some cases, very minor issues might be reported but we may still process to previewpass, these issues should be resolved in an update during previewpass or after release, normally we'll note this in the bug report.

==Request Skip Beta==

Depending on the issues noted, we will generally let you know if you can request skip beta on the package after resolving the noted issues, however if we don't you can choose to request this after building the package. However if the issues noted were something that needs testing, we will reject the skip beta so that it can go through another round of beta testing. Otherwise we will review the DLC pack again, double checking that reported bugs are resolved.
 

=Getting Paid=

In order to get paid for your work, you will need a verified PayPal account. Then you will need an Affiliatly account linked to the PayPal account.

==Affiliatly Account==

You will need to setup an [https://www.affiliatly.com/af-102715/affiliate.panel '''Affiliatly Account''']

Start earning royalties and commissions from your Trainz hobby today.

Are you a Trainz Content Creator? Expand your own website sales and earn commissions on all your items sold through the Trainz Store and via other online stores such as Steam and Mac App Store. (Submit your content through [https://tccp.auran.com/ '''this link''']). Commissions are 50% of the sale price for direct purchases. You will also receive commissions on Silver and Gold subscriptions that download your DLC content. The amount of these commissions vary and a detailed chart can be found under the TCCP website Documentation section.

Do you run a Trainz website or Youtube Channel? Use your Affiliatly link to earn commissions on sales through our store. Each time a user clicks on your link then purchases an item in the next week, you earn a 10% commission on that sale. This could result in a total of 60% on a direct sale.

Registration is free. Sign up now to get your Affiliatly ID and begin earning commissions and royalties. The website tracks the royalties earned for referrals and sales through our TrainzPortal store and shows payments to your nominated account. The amount shown may be less than you will actuallly receive as the subscription revenue does not show here, which is calculated on the processing date as it's a shared revenue.

Once you have set up your account you will be given an Affiliatly ID number. Log back into the TCCP website, and in the Content Creator Dashboard choose Options. Enter your ID and Save. WARNING: Double check your Affiliatly ID. Adding the wrong ID could mean the wrong account is paid!

==PayPal Account==

In order to get paid, you must have a PayPal account linked to your Affiliaty account. You will get paid on the 15th or 16th of each month, depending on your time zone and when they process your account. You must have at least $100 US in earnings before you will get paid.

TCCP Beta Testing

2022-11-10T16:07:58Z

Christopher824:

This page is a guide for Trainz Content Creation Program or 'TCCP' 
TCCP Content Creators should look '''[[TCCP Content Creation]]'''

'''Under Development''' The contents and the layout of this page is under development.

Trainz Content Creation Program or TCCP allows you to become a Beta Tester for new DLC content. You will be part of the development team that makes it happen.

TCCP

2022-11-10T16:02:03Z

Christopher824:

This page is a guide for the Trainz Content Creation Program or 'TCCP'

The TCCP allows developers and Trainz users to interact. Users with a valid TRS19 or TRS22 product can use this system. Beta testers can try new upcoming routes and rolling stock for a 2 week beta for free. No need for a membership.

TCCP Beta Testers should look here '''[[TCCP Beta Testing]]'''

TCCP Content Creators '''[[TCCP Content Creation]]'''

'''Under Development''' The contents and the layout of this page are under development.

Trainz Content Creation Program or TCCP allows you to become a Registered Content Creator with N3V Auran. You will be eligible to upload Content which may be made available for download by Trainz users, and, for Approved Content, to receive a share of revenues for sales relating to your Content.

Beta Testers can use the content for free during the beta test periods. Any Trainz user with a valid license can sign up and take advantage of this.

TCCP

2022-11-10T15:58:50Z

Christopher824:

TCCP Content Creation

2022-11-10T15:50:28Z

Christopher824: Created page with "This page is a guide for Trainz Content Creation Program or 'TCCP' TCCP Beta Testers should look here '''TCCP Beta Testing''' '''Under Development''' The contents an..."

This page is a guide for Trainz Content Creation Program or 'TCCP' 
TCCP Beta Testers should look here '''[[TCCP Beta Testing]]'''

'''Under Development''' The contents and the layout of this page is under development.

Trainz Content Creation Program or TCCP allows you to become a Registered Content Creator with N3V Auran. You will be eligible to upload Content which may be made available for download by Trainz users, and, for Approved Content, to receive a share of revenues for sales relating to your Content.

=Getting Started=

==Set Up Account==
Your first step is to get a TCCP account at [https://tccp.auran.com/ '''tccp.auran.com''']
When you create your account use your My Trainz username and password. You will be asked to accept the EULA terms and conditions. This account will be the same for content creation and beta testing, so please do not try to create multiple accounts.

Once you have an account created you can find a lot more detailed instructions under [https://tccp.auran.com/documentation.php '''tccp.auran.com/documentation.php'''].

This video also explains most of what you need to get up and running. It is a long video but is split into sections so you can skip to what you need: [https://www.youtube.com/watch?v=6J9Bhq5vIxk&t=65s '''DETAILED VIDEO''']

==Connect With Other Creators==
More heads are better than one. There are differnt ways to connect with other content creators and you should be involved with this. Trainz is a community based platform, and as such you need to be involed to help gaurantee success. You will find if you are a team player, you will benifit from the team. Here are some avenues to connect;

* [https://forums.auran.com/trainz/forum.php Trainz Forums]
* Trainz Discord channel For this you will need an invite, see the Trainz Forums above.

=Creating A Package=

==Thumbnails==

Your primary asset(s), Routes, Sessions, Rolling Stock and Locos must have the proper set of thumbnails. To add the thumbnails to your asset, edit the config.txt and make sure it looks like the code below, take note of the dimensions and filenames listed for each thumbnail. If you do not have the correct size thumbnails or filenames, you will need to create or modify them. If the 'default' thumbnail is not named 'thumbnail.jpg', it will not create the auto generated 'new' session thumbnail when a new session is created.

thumbnails
{
0
{
image "0.jpg"
width 1280
height 800
}

1
{
image "1.jpg"
width 1280
height 800
}

2
{
image "2.jpg"
width 1280
height 800
}

default
{
image "thumbnail.jpg"
width 512
height 384
}
}

==TCCP Manager==
Current TCCP projects can be from a TRS19 or TRS22 build. Do not try to create a package using a Beta Build. If you can submit your project in TRS19 SP5, then you can target both TRS19 and TRS22 customers. Open Trainz and look for the Developer Tab. It can be found from the Launcher and the Content Manager.
* Select 'Open TCCP Project List'
* Right Click inside window and select 'Create New Project...'

Once the panel opens, type in a Title. Then type a description in the text box, it can be anything as these will not be the final title or description, so it could just be a note at this point. If you close this dialog without giving it a Title or a Description, you will get an error. If you wish to still quit, close the dialog a second time and it will abandon the project. If you close the dialog with a Title and Description, a TCCP Project ID will be assigned to your project and now can be found on the TCCP website.

In the TCCP Project List, your project will now be listed. You can right click on it and it will give you the option of 'Edit Project...' and 'View Project on TCCP Website...'.

When you choose edit project, the window that pops up it will now have your title on the menu bar. The first list box is where you place the assets you have made and wish to distribute. You will need to open a Content Manager window, and drag your creation(s) into it. The second box is which from the first box you want to encode as payware. You can now drag from the first box to the second box to populate it. If you are a route creator, and wish to have an unlocked base session, you would leave that session out of the second box.

==Using newer asset versions where available==
Checkbox - ''need more info on this setting?'' Default leave unchecked.

==Uploading==

Once you have populated the two list boxes, click the 'Upload Package' button on the bottom right of the dialog.
*.TZARC - Trainz Archive File
The manager will attempt to build your files into a .tzarc file. It will add every dependancy the package needs into the file. If succesful it will upload it to the TCCP build machine.

==Errors==
* '''Payware''' You can not include payware in your project, this includes dependencies.
* '''Packaged and not avialable''' This will happen from time to time. There are different ways to fix this. You could edit your creation and remove the offending asset. You could clone the asset if the license allows or you have permission, then upload it to the DLS, then replace your old one with the new one from the DLS. Or you could open a helpdesk ticket if there is an earlier version on the DLS. If the only version available is the packaged one, then you must remove or clone.
* '''Unfeasable''' You already have a built package on the TCCP website. You will need to go to the website and cancel the package, then delete the .tzarc file. You will now be able to upload your package.
* '''Unknown Errors''' 

=TCCP Package Setup=

==Login==

Once you have uploaded your .tzarc file you will need to login at the TCCP website and navigate to your file or Package. The top level, or the Apps Dashboard, has 3 major sections. Content, Beta Testing and Documentation. Your file will be in the Content section or the Content Creator Dashboard. At the bottom of the page will be a list of your projects. Click on the title of your package in the list to continue to the Content Creator Project.

==Package==

You are required to fill in all the fields before clicking the 'Update Package' button at the bottom of this page. What is entered here can be changed before you submit it to the build machine, so don't be worried if it's not 100% accurate at this point. The Title and Description will overright the Trainz TCCP Manager, so this is important to remember if you need to modify your .tzac file and re-upload it.

==Images==

Upload at least six 1280 (width) x 800 (height) marketing screenshots and one 600 (width) x 262 (height) Trainz Store header image for your product. Accepted upload formats: 'png' or 'jpg'. Please ensure to include a 1280x800 resolution version of the 600x262 header image in the screenshots section as well, as this is required for creating the header images for Steam.

These images will not effect the images in your assets config.txt file.

Optionally you can upload a YouTube video.

==Files==

You can have only one .tzarc file uploaded for a project. If you need to change something, you will have to delete the file from this page. Depending at which stage your project is in, you may need to Cancel Beta and/or Cancel Project

==Beta Testing==

Before you submit for Beta Testing you should add your own questions as part of your Beta so testers have specific details to test with your content. You can add specific testing questions under the Test Plan Tools

==Assets==

==Notifications==

 

=Build Machine=

Near the top of each Content Creator Project page is a status box showing the current build status of the package. Once your package has passed all the requirements, the Submit To Build Queue button will appear.

* Prepare For Submission
* Building Your package is building. It may take up to a couple of hours or more to build the project.
* Failed
* Success Your package passed and can now be submitted for Beta Testing
* Live N3V has approved your package and it is now on the store.

 

=Beta Testing=

==Test Quesions==

==Tickets==

 

=Final Review=

Once you have addressed all tickets opened during the beta test, which could mean that you will have to submit a new beta, again, to confirm the fixes. Your package will pass beta and go into Final Review. This is where it is now scrutinized by the N3V staff.

Per Zec,
"''Something I've been meaning to do for quite a while is post up a bit of a 'guide' on how we generally review DLC packs. This isn't a hard and fast method, but should help you guys to review your content yourselves before submission There is a difference between routes/sessions and traincars, as they involve different aspects of gameplay. For all content, I will verify that the advertised content is included (ie route, sessions, traincars, consists, etc). This is based on what you advertise in the description (ie if you say there are 5 sessions and I only see 4, I'll send it back to you to double check).''"

After verifying the content is installed, and is fully active, and no open tickets.

==Routes / Sessions==

For routes/sessions:
* Each session is loaded into Driver, and then verified that the session loads successfully
* Drive the session for a few minutes, or untill the first navigation mark or task is complete. This is to ensure that the session is starting correctly, and the initial rules are working correctly. It also ensures that the locomotives and rolling stock at the start of the session are working correctly (ie brakes releasing correctly, and so on).
* Take a quick fly over of the route to make sure it all is loading correctly
* If the DLC pack also advertises custom/specific locomotives and rolling stock, then this will also be reviewed using the below.

==Traincar==

For traincar DLC packs:
* Check that the advertised traincars and consists are present
* Place the traincars onto a blank route, that has the track sitting directly on top of water. This allows me to check that the traincar has a water reflection that works properly, looks like the traincar, and isn't badly broken/distorted.
* For passenger coaches, place them onto a test route with a passenger station to check that the doors work as expected with a passenger station.
* For all traincars, place them onto the KSC2 route, and do a check for obvious mesh/LOD issues (ie obvious changes in the look of the loco when moving toward/away from it). This includes distortions to the texture map, or smoothing issues, on lower LODs.
* At this point, also do a check that all controls work. This means that using keyboard and HUD controls work for all main controls (reverser, throttle, dynamic brake^, train brake, independent brake, headlight, ditch lights^, pantographs^, sander, and of course simple controls mode).
^The controls marked with this are 'optional' on traincars, so are only checked where that item has them fitted. The independent brake, although not always fitted in the cab view, should generally be operational on traincars since the HUD control is available. Dynamic brake, OTOH, is generally acceptable if it is not functional (but it absolutely should be
functional on locos fitted with one).
* Quickly try any advertised scripted functions to make sure these work.
* For locos, take the locomotive for a short drive in Driver to make sure that they drive appropriately (note, this isn't necessarily a check for prototypical operation, but more just to make sure that they operate correctly as a locomotive in general). This also allows checking that sounds are working correctly/etc.
* For rolling stock, do the same, but use a builtin locomotive to haul them.

As a final note regarding traincar DLC packs. It is expected that locomotives and rolling stock scripts will not break default functionality.

Examples of this are startup/shutdown scripts that are off by default. For the average user who purchases a loco with this, they will have no way to know how to startup the locomotive, and hence are stuck with a locomotive that to them simply does not work. For startup/shutdown scripts there are two options for this, one is to simply have the loco on by default and allow the player to choose to turn it off in the properties, and then allow them to go through the startup sequence. Another, as seen on the Frecciarossa train DLC, would be to have the train pop up with a message to provide startup options.

Another example would be custom throttle/brake controls that prevent the HUD controls, DCC controls, or keyboard controls from working. Again the average player who purchases this DLC pack will not know what is happening and will see this content as being broken. In this case you must ensure that custom controls correctly respond to the HUD and keyboard.

==Review Results==

If any issues are found during review, these will be reported via the beta testing bug report system in TCCP. If no issues are found we will then process the DLC pack to PreviewPass for 2 weeks, then release publicly after the 2 week PreviewPass. Note that in some cases, very minor issues might be reported but we may still process to previewpass, these issues should be resolved in an update during previewpass or after release, normally we'll note this in the bug report.

==Request Skip Beta==

Depending on the issues noted, we will generally let you know if you can request skip beta on the package after resolving the noted issues, however if we don't you can choose to request this after building the package. However if the issues noted were something that needs testing, we will reject the skip beta so that it can go through another round of beta testing. Otherwise we will review the DLC pack again, double checking that reported bugs are resolved.
 

=Getting Paid=

In order to get paid for your work, you will need a verified PayPal account. Then you will need an Affiliatly account linked to the PayPal account.

==Affiliatly Account==

You will need to setup an [https://www.affiliatly.com/af-102715/affiliate.panel '''Affiliatly Account''']

Start earning royalties and commissions from your Trainz hobby today.

Are you a Trainz Content Creator? Expand your own website sales and earn commissions on all your items sold through the Trainz Store and via other online stores such as Steam and Mac App Store. (Submit your content through [https://tccp.auran.com/ '''this link''']). Commissions are 50% of the sale price for direct purchases. You will also receive commissions on Silver and Gold subscriptions that download your DLC content. The amount of these commissions vary and a detailed chart can be found under the TCCP website Documentation section.

Do you run a Trainz website or Youtube Channel? Use your Affiliatly link to earn commissions on sales through our store. Each time a user clicks on your link then purchases an item in the next week, you earn a 10% commission on that sale. This could result in a total of 60% on a direct sale.

Registration is free. Sign up now to get your Affiliatly ID and begin earning commissions and royalties. The website tracks the royalties earned for referrals and sales through our TrainzPortal store and shows payments to your nominated account. The amount shown may be less than you will actuallly receive as the subscription revenue does not show here, which is calculated on the processing date as it's a shared revenue.

Once you have set up your account you will be given an Affiliatly ID number. Log back into the TCCP website, and in the Content Creator Dashboard choose Options. Enter your ID and Save. WARNING: Double check your Affiliatly ID. Adding the wrong ID could mean the wrong account is paid!

==PayPal Account==

In order to get paid, you must have a PayPal account linked to your Affiliaty account. You will get paid on the 15th or 16th of each month, depending on your time zone and when they process your account. You must have at least $100 US in earnings before you will get paid.

TCCP

2022-11-10T15:42:15Z

Christopher824:

TCCP Beta Testing

2022-11-10T15:36:37Z

Christopher824: Created page with "This page is a guide for Trainz Content Creation Program or 'TCCP' TCCP Content Creators should look HERE '''Under Development''' The contents and the layout of this pag..."

This page is a guide for Trainz Content Creation Program or 'TCCP' 
TCCP Content Creators should look HERE

'''Under Development''' The contents and the layout of this page is under development.

Trainz Content Creation Program or TCCP allows you to become a Beta Tester for new DLC content. You will be part of the development team that makes it happen.

TCCP

2022-11-10T15:31:57Z

Christopher824: /* Thumbnails */

This page is a guide for Trainz Content Creation Program or 'TCCP' 
TCCP Beta Testers should look HERE

'''Under Development''' The contents and the layout of this page is under development.

Trainz Content Creation Program or TCCP allows you to become a Registered Content Creator with N3V Auran. You will be eligible to upload Content which may be made available for download by Trainz users, and, for Approved Content, to receive a share of revenues for sales relating to your Content.

=Getting Started=

==Set Up Account==
Your first step is to get a TCCP account at [https://tccp.auran.com/ '''tccp.auran.com''']
When you create your account use your My Trainz username and password. You will be asked to accept the EULA terms and conditions. This account will be the same for content creation and beta testing, so please do not try to create multiple accounts.

Once you have an account created you can find a lot more detailed instructions under [https://tccp.auran.com/documentation.php '''tccp.auran.com/documentation.php'''].

This video also explains most of what you need to get up and running. It is a long video but is split into sections so you can skip to what you need: [https://www.youtube.com/watch?v=6J9Bhq5vIxk&t=65s '''DETAILED VIDEO''']

==Connect With Other Creators==
More heads are better than one. There are differnt ways to connect with other content creators and you should be involved with this. Trainz is a community based platform, and as such you need to be involed to help gaurantee success. You will find if you are a team player, you will benifit from the team. Here are some avenues to connect;

* [https://forums.auran.com/trainz/forum.php Trainz Forums]
* Trainz Discord channel For this you will need an invite, see the Trainz Forums above.

=Creating A Package=

==Thumbnails==

Your primary asset(s), Routes, Sessions, Rolling Stock and Locos must have the proper set of thumbnails. To add the thumbnails to your asset, edit the config.txt and make sure it looks like the code below, take note of the dimensions and filenames listed for each thumbnail. If you do not have the correct size thumbnails or filenames, you will need to create or modify them. If the 'default' thumbnail is not named 'thumbnail.jpg', it will not create the auto generated 'new' session thumbnail when a new session is created.

thumbnails
{
0
{
image "0.jpg"
width 1280
height 800
}

1
{
image "1.jpg"
width 1280
height 800
}

2
{
image "2.jpg"
width 1280
height 800
}

default
{
image "thumbnail.jpg"
width 512
height 384
}
}

==TCCP Manager==
Current TCCP projects can be from a TRS19 or TRS22 build. Do not try to create a package using a Beta Build. If you can submit your project in TRS19 SP5, then you can target both TRS19 and TRS22 customers. Open Trainz and look for the Developer Tab. It can be found from the Launcher and the Content Manager.
* Select 'Open TCCP Project List'
* Right Click inside window and select 'Create New Project...'

Once the panel opens, type in a Title. Then type a description in the text box, it can be anything as these will not be the final title or description, so it could just be a note at this point. If you close this dialog without giving it a Title or a Description, you will get an error. If you wish to still quit, close the dialog a second time and it will abandon the project. If you close the dialog with a Title and Description, a TCCP Project ID will be assigned to your project and now can be found on the TCCP website.

In the TCCP Project List, your project will now be listed. You can right click on it and it will give you the option of 'Edit Project...' and 'View Project on TCCP Website...'.

When you choose edit project, the window that pops up it will now have your title on the menu bar. The first list box is where you place the assets you have made and wish to distribute. You will need to open a Content Manager window, and drag your creation(s) into it. The second box is which from the first box you want to encode as payware. You can now drag from the first box to the second box to populate it. If you are a route creator, and wish to have an unlocked base session, you would leave that session out of the second box.

==Using newer asset versions where available==
Checkbox - ''need more info on this setting?'' Default leave unchecked.

==Uploading==

Once you have populated the two list boxes, click the 'Upload Package' button on the bottom right of the dialog.
*.TZARC - Trainz Archive File
The manager will attempt to build your files into a .tzarc file. It will add every dependancy the package needs into the file. If succesful it will upload it to the TCCP build machine.

==Errors==
* '''Payware''' You can not include payware in your project, this includes dependencies.
* '''Packaged and not avialable''' This will happen from time to time. There are different ways to fix this. You could edit your creation and remove the offending asset. You could clone the asset if the license allows or you have permission, then upload it to the DLS, then replace your old one with the new one from the DLS. Or you could open a helpdesk ticket if there is an earlier version on the DLS. If the only version available is the packaged one, then you must remove or clone.
* '''Unfeasable''' You already have a built package on the TCCP website. You will need to go to the website and cancel the package, then delete the .tzarc file. You will now be able to upload your package.
* '''Unknown Errors''' 

=TCCP Package Setup=

==Login==

Once you have uploaded your .tzarc file you will need to login at the TCCP website and navigate to your file or Package. The top level, or the Apps Dashboard, has 3 major sections. Content, Beta Testing and Documentation. Your file will be in the Content section or the Content Creator Dashboard. At the bottom of the page will be a list of your projects. Click on the title of your package in the list to continue to the Content Creator Project.

==Package==

You are required to fill in all the fields before clicking the 'Update Package' button at the bottom of this page. What is entered here can be changed before you submit it to the build machine, so don't be worried if it's not 100% accurate at this point. The Title and Description will overright the Trainz TCCP Manager, so this is important to remember if you need to modify your .tzac file and re-upload it.

==Images==

Upload at least six 1280 (width) x 800 (height) marketing screenshots and one 600 (width) x 262 (height) Trainz Store header image for your product. Accepted upload formats: 'png' or 'jpg'. Please ensure to include a 1280x800 resolution version of the 600x262 header image in the screenshots section as well, as this is required for creating the header images for Steam.

These images will not effect the images in your assets config.txt file.

Optionally you can upload a YouTube video.

==Files==

You can have only one .tzarc file uploaded for a project. If you need to change something, you will have to delete the file from this page. Depending at which stage your project is in, you may need to Cancel Beta and/or Cancel Project

==Beta Testing==

Before you submit for Beta Testing you should add your own questions as part of your Beta so testers have specific details to test with your content. You can add specific testing questions under the Test Plan Tools

==Assets==

==Notifications==

 

=Build Machine=

Near the top of each Content Creator Project page is a status box showing the current build status of the package. Once your package has passed all the requirements, the Submit To Build Queue button will appear.

* Prepare For Submission
* Building Your package is building. It may take up to a couple of hours or more to build the project.
* Failed
* Success Your package passed and can now be submitted for Beta Testing
* Live N3V has approved your package and it is now on the store.

 

=Beta Testing=

==Test Quesions==

==Tickets==

 

=Final Review=

Once you have addressed all tickets opened during the beta test, which could mean that you will have to submit a new beta, again, to confirm the fixes. Your package will pass beta and go into Final Review. This is where it is now scrutinized by the N3V staff.

Per Zec,
"''Something I've been meaning to do for quite a while is post up a bit of a 'guide' on how we generally review DLC packs. This isn't a hard and fast method, but should help you guys to review your content yourselves before submission There is a difference between routes/sessions and traincars, as they involve different aspects of gameplay. For all content, I will verify that the advertised content is included (ie route, sessions, traincars, consists, etc). This is based on what you advertise in the description (ie if you say there are 5 sessions and I only see 4, I'll send it back to you to double check).''"

After verifying the content is installed, and is fully active, and no open tickets.

==Routes / Sessions==

For routes/sessions:
* Each session is loaded into Driver, and then verified that the session loads successfully
* Drive the session for a few minutes, or untill the first navigation mark or task is complete. This is to ensure that the session is starting correctly, and the initial rules are working correctly. It also ensures that the locomotives and rolling stock at the start of the session are working correctly (ie brakes releasing correctly, and so on).
* Take a quick fly over of the route to make sure it all is loading correctly
* If the DLC pack also advertises custom/specific locomotives and rolling stock, then this will also be reviewed using the below.

==Traincar==

For traincar DLC packs:
* Check that the advertised traincars and consists are present
* Place the traincars onto a blank route, that has the track sitting directly on top of water. This allows me to check that the traincar has a water reflection that works properly, looks like the traincar, and isn't badly broken/distorted.
* For passenger coaches, place them onto a test route with a passenger station to check that the doors work as expected with a passenger station.
* For all traincars, place them onto the KSC2 route, and do a check for obvious mesh/LOD issues (ie obvious changes in the look of the loco when moving toward/away from it). This includes distortions to the texture map, or smoothing issues, on lower LODs.
* At this point, also do a check that all controls work. This means that using keyboard and HUD controls work for all main controls (reverser, throttle, dynamic brake^, train brake, independent brake, headlight, ditch lights^, pantographs^, sander, and of course simple controls mode).
^The controls marked with this are 'optional' on traincars, so are only checked where that item has them fitted. The independent brake, although not always fitted in the cab view, should generally be operational on traincars since the HUD control is available. Dynamic brake, OTOH, is generally acceptable if it is not functional (but it absolutely should be
functional on locos fitted with one).
* Quickly try any advertised scripted functions to make sure these work.
* For locos, take the locomotive for a short drive in Driver to make sure that they drive appropriately (note, this isn't necessarily a check for prototypical operation, but more just to make sure that they operate correctly as a locomotive in general). This also allows checking that sounds are working correctly/etc.
* For rolling stock, do the same, but use a builtin locomotive to haul them.

As a final note regarding traincar DLC packs. It is expected that locomotives and rolling stock scripts will not break default functionality.

Examples of this are startup/shutdown scripts that are off by default. For the average user who purchases a loco with this, they will have no way to know how to startup the locomotive, and hence are stuck with a locomotive that to them simply does not work. For startup/shutdown scripts there are two options for this, one is to simply have the loco on by default and allow the player to choose to turn it off in the properties, and then allow them to go through the startup sequence. Another, as seen on the Frecciarossa train DLC, would be to have the train pop up with a message to provide startup options.

Another example would be custom throttle/brake controls that prevent the HUD controls, DCC controls, or keyboard controls from working. Again the average player who purchases this DLC pack will not know what is happening and will see this content as being broken. In this case you must ensure that custom controls correctly respond to the HUD and keyboard.

==Review Results==

If any issues are found during review, these will be reported via the beta testing bug report system in TCCP. If no issues are found we will then process the DLC pack to PreviewPass for 2 weeks, then release publicly after the 2 week PreviewPass. Note that in some cases, very minor issues might be reported but we may still process to previewpass, these issues should be resolved in an update during previewpass or after release, normally we'll note this in the bug report.

==Request Skip Beta==

Depending on the issues noted, we will generally let you know if you can request skip beta on the package after resolving the noted issues, however if we don't you can choose to request this after building the package. However if the issues noted were something that needs testing, we will reject the skip beta so that it can go through another round of beta testing. Otherwise we will review the DLC pack again, double checking that reported bugs are resolved.
 

=Getting Paid=

In order to get paid for your work, you will need a verified PayPal account. Then you will need an Affiliatly account linked to the PayPal account.

==Affiliatly Account==

You will need to setup an [https://www.affiliatly.com/af-102715/affiliate.panel '''Affiliatly Account''']

Start earning royalties and commissions from your Trainz hobby today.

Are you a Trainz Content Creator? Expand your own website sales and earn commissions on all your items sold through the Trainz Store and via other online stores such as Steam and Mac App Store. (Submit your content through [https://tccp.auran.com/ '''this link''']). Commissions are 50% of the sale price for direct purchases. You will also receive commissions on Silver and Gold subscriptions that download your DLC content. The amount of these commissions vary and a detailed chart can be found under the TCCP website Documentation section.

Do you run a Trainz website or Youtube Channel? Use your Affiliatly link to earn commissions on sales through our store. Each time a user clicks on your link then purchases an item in the next week, you earn a 10% commission on that sale. This could result in a total of 60% on a direct sale.

Registration is free. Sign up now to get your Affiliatly ID and begin earning commissions and royalties. The website tracks the royalties earned for referrals and sales through our TrainzPortal store and shows payments to your nominated account. The amount shown may be less than you will actuallly receive as the subscription revenue does not show here, which is calculated on the processing date as it's a shared revenue.

Once you have set up your account you will be given an Affiliatly ID number. Log back into the TCCP website, and in the Content Creator Dashboard choose Options. Enter your ID and Save. WARNING: Double check your Affiliatly ID. Adding the wrong ID could mean the wrong account is paid!

==PayPal Account==

In order to get paid, you must have a PayPal account linked to your Affiliaty account. You will get paid on the 15th or 16th of each month, depending on your time zone and when they process your account. You must have at least $100 US in earnings before you will get paid.

TCCP

2022-11-10T15:27:07Z

Christopher824: /* Set Up Account */

This page is a guide for Trainz Content Creation Program or 'TCCP' 
TCCP Beta Testers should look HERE

'''Under Development''' The contents and the layout of this page is under development.

Trainz Content Creation Program or TCCP allows you to become a Registered Content Creator with N3V Auran. You will be eligible to upload Content which may be made available for download by Trainz users, and, for Approved Content, to receive a share of revenues for sales relating to your Content.

=Getting Started=

==Set Up Account==
Your first step is to get a TCCP account at [https://tccp.auran.com/ '''tccp.auran.com''']
When you create your account use your My Trainz username and password. You will be asked to accept the EULA terms and conditions. This account will be the same for content creation and beta testing, so please do not try to create multiple accounts.

Once you have an account created you can find a lot more detailed instructions under [https://tccp.auran.com/documentation.php '''tccp.auran.com/documentation.php'''].

This video also explains most of what you need to get up and running. It is a long video but is split into sections so you can skip to what you need: [https://www.youtube.com/watch?v=6J9Bhq5vIxk&t=65s '''DETAILED VIDEO''']

==Connect With Other Creators==
More heads are better than one. There are differnt ways to connect with other content creators and you should be involved with this. Trainz is a community based platform, and as such you need to be involed to help gaurantee success. You will find if you are a team player, you will benifit from the team. Here are some avenues to connect;

* [https://forums.auran.com/trainz/forum.php Trainz Forums]
* Trainz Discord channel For this you will need an invite, see the Trainz Forums above.

=Creating A Package=

==Thumbnails==

Your primary asset(s), Routes, Sessions, Rolling Stock and Locos must have the proper set of thumbnails. To add the thumbnails to your asset, edit the config.txt and make sure it looks like the code below, take note of the dimensions and filenames listed for each thumbnail. If you do not have the correct size thumbnails or filenames, you will need to create or modify them.

thumbnails
{
0
{
image "0.jpg"
width 1280
height 800
}

1
{
image "1.jpg"
width 1280
height 800
}

2
{
image "2.jpg"
width 1280
height 800
}

default
{
image "thumbnail.jpg"
width 512
height 384
}
}

==TCCP Manager==
Current TCCP projects can be from a TRS19 or TRS22 build. Do not try to create a package using a Beta Build. If you can submit your project in TRS19 SP5, then you can target both TRS19 and TRS22 customers. Open Trainz and look for the Developer Tab. It can be found from the Launcher and the Content Manager.
* Select 'Open TCCP Project List'
* Right Click inside window and select 'Create New Project...'

Once the panel opens, type in a Title. Then type a description in the text box, it can be anything as these will not be the final title or description, so it could just be a note at this point. If you close this dialog without giving it a Title or a Description, you will get an error. If you wish to still quit, close the dialog a second time and it will abandon the project. If you close the dialog with a Title and Description, a TCCP Project ID will be assigned to your project and now can be found on the TCCP website.

In the TCCP Project List, your project will now be listed. You can right click on it and it will give you the option of 'Edit Project...' and 'View Project on TCCP Website...'.

When you choose edit project, the window that pops up it will now have your title on the menu bar. The first list box is where you place the assets you have made and wish to distribute. You will need to open a Content Manager window, and drag your creation(s) into it. The second box is which from the first box you want to encode as payware. You can now drag from the first box to the second box to populate it. If you are a route creator, and wish to have an unlocked base session, you would leave that session out of the second box.

==Using newer asset versions where available==
Checkbox - ''need more info on this setting?'' Default leave unchecked.

==Uploading==

Once you have populated the two list boxes, click the 'Upload Package' button on the bottom right of the dialog.
*.TZARC - Trainz Archive File
The manager will attempt to build your files into a .tzarc file. It will add every dependancy the package needs into the file. If succesful it will upload it to the TCCP build machine.

==Errors==
* '''Payware''' You can not include payware in your project, this includes dependencies.
* '''Packaged and not avialable''' This will happen from time to time. There are different ways to fix this. You could edit your creation and remove the offending asset. You could clone the asset if the license allows or you have permission, then upload it to the DLS, then replace your old one with the new one from the DLS. Or you could open a helpdesk ticket if there is an earlier version on the DLS. If the only version available is the packaged one, then you must remove or clone.
* '''Unfeasable''' You already have a built package on the TCCP website. You will need to go to the website and cancel the package, then delete the .tzarc file. You will now be able to upload your package.
* '''Unknown Errors''' 

=TCCP Package Setup=

==Login==

Once you have uploaded your .tzarc file you will need to login at the TCCP website and navigate to your file or Package. The top level, or the Apps Dashboard, has 3 major sections. Content, Beta Testing and Documentation. Your file will be in the Content section or the Content Creator Dashboard. At the bottom of the page will be a list of your projects. Click on the title of your package in the list to continue to the Content Creator Project.

==Package==

You are required to fill in all the fields before clicking the 'Update Package' button at the bottom of this page. What is entered here can be changed before you submit it to the build machine, so don't be worried if it's not 100% accurate at this point. The Title and Description will overright the Trainz TCCP Manager, so this is important to remember if you need to modify your .tzac file and re-upload it.

==Images==

Upload at least six 1280 (width) x 800 (height) marketing screenshots and one 600 (width) x 262 (height) Trainz Store header image for your product. Accepted upload formats: 'png' or 'jpg'. Please ensure to include a 1280x800 resolution version of the 600x262 header image in the screenshots section as well, as this is required for creating the header images for Steam.

These images will not effect the images in your assets config.txt file.

Optionally you can upload a YouTube video.

==Files==

You can have only one .tzarc file uploaded for a project. If you need to change something, you will have to delete the file from this page. Depending at which stage your project is in, you may need to Cancel Beta and/or Cancel Project

==Beta Testing==

Before you submit for Beta Testing you should add your own questions as part of your Beta so testers have specific details to test with your content. You can add specific testing questions under the Test Plan Tools

==Assets==

==Notifications==

 

=Build Machine=

Near the top of each Content Creator Project page is a status box showing the current build status of the package. Once your package has passed all the requirements, the Submit To Build Queue button will appear.

* Prepare For Submission
* Building Your package is building. It may take up to a couple of hours or more to build the project.
* Failed
* Success Your package passed and can now be submitted for Beta Testing
* Live N3V has approved your package and it is now on the store.

 

=Beta Testing=

==Test Quesions==

==Tickets==

 

=Final Review=

Once you have addressed all tickets opened during the beta test, which could mean that you will have to submit a new beta, again, to confirm the fixes. Your package will pass beta and go into Final Review. This is where it is now scrutinized by the N3V staff.

Per Zec,
"''Something I've been meaning to do for quite a while is post up a bit of a 'guide' on how we generally review DLC packs. This isn't a hard and fast method, but should help you guys to review your content yourselves before submission There is a difference between routes/sessions and traincars, as they involve different aspects of gameplay. For all content, I will verify that the advertised content is included (ie route, sessions, traincars, consists, etc). This is based on what you advertise in the description (ie if you say there are 5 sessions and I only see 4, I'll send it back to you to double check).''"

After verifying the content is installed, and is fully active, and no open tickets.

==Routes / Sessions==

For routes/sessions:
* Each session is loaded into Driver, and then verified that the session loads successfully
* Drive the session for a few minutes, or untill the first navigation mark or task is complete. This is to ensure that the session is starting correctly, and the initial rules are working correctly. It also ensures that the locomotives and rolling stock at the start of the session are working correctly (ie brakes releasing correctly, and so on).
* Take a quick fly over of the route to make sure it all is loading correctly
* If the DLC pack also advertises custom/specific locomotives and rolling stock, then this will also be reviewed using the below.

==Traincar==

For traincar DLC packs:
* Check that the advertised traincars and consists are present
* Place the traincars onto a blank route, that has the track sitting directly on top of water. This allows me to check that the traincar has a water reflection that works properly, looks like the traincar, and isn't badly broken/distorted.
* For passenger coaches, place them onto a test route with a passenger station to check that the doors work as expected with a passenger station.
* For all traincars, place them onto the KSC2 route, and do a check for obvious mesh/LOD issues (ie obvious changes in the look of the loco when moving toward/away from it). This includes distortions to the texture map, or smoothing issues, on lower LODs.
* At this point, also do a check that all controls work. This means that using keyboard and HUD controls work for all main controls (reverser, throttle, dynamic brake^, train brake, independent brake, headlight, ditch lights^, pantographs^, sander, and of course simple controls mode).
^The controls marked with this are 'optional' on traincars, so are only checked where that item has them fitted. The independent brake, although not always fitted in the cab view, should generally be operational on traincars since the HUD control is available. Dynamic brake, OTOH, is generally acceptable if it is not functional (but it absolutely should be
functional on locos fitted with one).
* Quickly try any advertised scripted functions to make sure these work.
* For locos, take the locomotive for a short drive in Driver to make sure that they drive appropriately (note, this isn't necessarily a check for prototypical operation, but more just to make sure that they operate correctly as a locomotive in general). This also allows checking that sounds are working correctly/etc.
* For rolling stock, do the same, but use a builtin locomotive to haul them.

As a final note regarding traincar DLC packs. It is expected that locomotives and rolling stock scripts will not break default functionality.

Examples of this are startup/shutdown scripts that are off by default. For the average user who purchases a loco with this, they will have no way to know how to startup the locomotive, and hence are stuck with a locomotive that to them simply does not work. For startup/shutdown scripts there are two options for this, one is to simply have the loco on by default and allow the player to choose to turn it off in the properties, and then allow them to go through the startup sequence. Another, as seen on the Frecciarossa train DLC, would be to have the train pop up with a message to provide startup options.

Another example would be custom throttle/brake controls that prevent the HUD controls, DCC controls, or keyboard controls from working. Again the average player who purchases this DLC pack will not know what is happening and will see this content as being broken. In this case you must ensure that custom controls correctly respond to the HUD and keyboard.

==Review Results==

If any issues are found during review, these will be reported via the beta testing bug report system in TCCP. If no issues are found we will then process the DLC pack to PreviewPass for 2 weeks, then release publicly after the 2 week PreviewPass. Note that in some cases, very minor issues might be reported but we may still process to previewpass, these issues should be resolved in an update during previewpass or after release, normally we'll note this in the bug report.

==Request Skip Beta==

Depending on the issues noted, we will generally let you know if you can request skip beta on the package after resolving the noted issues, however if we don't you can choose to request this after building the package. However if the issues noted were something that needs testing, we will reject the skip beta so that it can go through another round of beta testing. Otherwise we will review the DLC pack again, double checking that reported bugs are resolved.
 

=Getting Paid=

In order to get paid for your work, you will need a verified PayPal account. Then you will need an Affiliatly account linked to the PayPal account.

==Affiliatly Account==

You will need to setup an [https://www.affiliatly.com/af-102715/affiliate.panel '''Affiliatly Account''']

Start earning royalties and commissions from your Trainz hobby today.

Are you a Trainz Content Creator? Expand your own website sales and earn commissions on all your items sold through the Trainz Store and via other online stores such as Steam and Mac App Store. (Submit your content through [https://tccp.auran.com/ '''this link''']). Commissions are 50% of the sale price for direct purchases. You will also receive commissions on Silver and Gold subscriptions that download your DLC content. The amount of these commissions vary and a detailed chart can be found under the TCCP website Documentation section.

Do you run a Trainz website or Youtube Channel? Use your Affiliatly link to earn commissions on sales through our store. Each time a user clicks on your link then purchases an item in the next week, you earn a 10% commission on that sale. This could result in a total of 60% on a direct sale.

Registration is free. Sign up now to get your Affiliatly ID and begin earning commissions and royalties. The website tracks the royalties earned for referrals and sales through our TrainzPortal store and shows payments to your nominated account. The amount shown may be less than you will actuallly receive as the subscription revenue does not show here, which is calculated on the processing date as it's a shared revenue.

Once you have set up your account you will be given an Affiliatly ID number. Log back into the TCCP website, and in the Content Creator Dashboard choose Options. Enter your ID and Save. WARNING: Double check your Affiliatly ID. Adding the wrong ID could mean the wrong account is paid!

==PayPal Account==

In order to get paid, you must have a PayPal account linked to your Affiliaty account. You will get paid on the 15th or 16th of each month, depending on your time zone and when they process your account. You must have at least $100 US in earnings before you will get paid.

TCCP

2022-11-10T15:22:56Z

Christopher824:

This page is a guide for Trainz Content Creation Program or 'TCCP' 
TCCP Beta Testers should look HERE

'''Under Development''' The contents and the layout of this page is under development.

Trainz Content Creation Program or TCCP allows you to become a Registered Content Creator with N3V Auran. You will be eligible to upload Content which may be made available for download by Trainz users, and, for Approved Content, to receive a share of revenues for sales relating to your Content.

=Getting Started=

==Set Up Account==
Your first step is to get a TCCP account at [https://tccp.auran.com/ '''tccp.auran.com''']
When you create your account use your My Trainz username and password. You will be asked to accept the EULA terms and conditions.

Once you have an account created you can find a lot more detailed instructions under [https://tccp.auran.com/documentation.php '''tccp.auran.com/documentation.php'''].

This video also explains most of what you need to get up and running. It is a long video but is split into sections so you can skip to what you need: [https://www.youtube.com/watch?v=6J9Bhq5vIxk&t=65s '''DETAILED VIDEO''']

==Connect With Other Creators==
More heads are better than one. There are differnt ways to connect with other content creators and you should be involved with this. Trainz is a community based platform, and as such you need to be involed to help gaurantee success. You will find if you are a team player, you will benifit from the team. Here are some avenues to connect;

* [https://forums.auran.com/trainz/forum.php Trainz Forums]
* Trainz Discord channel For this you will need an invite, see the Trainz Forums above.

=Creating A Package=

==Thumbnails==

Your primary asset(s), Routes, Sessions, Rolling Stock and Locos must have the proper set of thumbnails. To add the thumbnails to your asset, edit the config.txt and make sure it looks like the code below, take note of the dimensions and filenames listed for each thumbnail. If you do not have the correct size thumbnails or filenames, you will need to create or modify them.

thumbnails
{
0
{
image "0.jpg"
width 1280
height 800
}

1
{
image "1.jpg"
width 1280
height 800
}

2
{
image "2.jpg"
width 1280
height 800
}

default
{
image "thumbnail.jpg"
width 512
height 384
}
}

==TCCP Manager==
Current TCCP projects can be from a TRS19 or TRS22 build. Do not try to create a package using a Beta Build. If you can submit your project in TRS19 SP5, then you can target both TRS19 and TRS22 customers. Open Trainz and look for the Developer Tab. It can be found from the Launcher and the Content Manager.
* Select 'Open TCCP Project List'
* Right Click inside window and select 'Create New Project...'

Once the panel opens, type in a Title. Then type a description in the text box, it can be anything as these will not be the final title or description, so it could just be a note at this point. If you close this dialog without giving it a Title or a Description, you will get an error. If you wish to still quit, close the dialog a second time and it will abandon the project. If you close the dialog with a Title and Description, a TCCP Project ID will be assigned to your project and now can be found on the TCCP website.

In the TCCP Project List, your project will now be listed. You can right click on it and it will give you the option of 'Edit Project...' and 'View Project on TCCP Website...'.

When you choose edit project, the window that pops up it will now have your title on the menu bar. The first list box is where you place the assets you have made and wish to distribute. You will need to open a Content Manager window, and drag your creation(s) into it. The second box is which from the first box you want to encode as payware. You can now drag from the first box to the second box to populate it. If you are a route creator, and wish to have an unlocked base session, you would leave that session out of the second box.

==Using newer asset versions where available==
Checkbox - ''need more info on this setting?'' Default leave unchecked.

==Uploading==

Once you have populated the two list boxes, click the 'Upload Package' button on the bottom right of the dialog.
*.TZARC - Trainz Archive File
The manager will attempt to build your files into a .tzarc file. It will add every dependancy the package needs into the file. If succesful it will upload it to the TCCP build machine.

==Errors==
* '''Payware''' You can not include payware in your project, this includes dependencies.
* '''Packaged and not avialable''' This will happen from time to time. There are different ways to fix this. You could edit your creation and remove the offending asset. You could clone the asset if the license allows or you have permission, then upload it to the DLS, then replace your old one with the new one from the DLS. Or you could open a helpdesk ticket if there is an earlier version on the DLS. If the only version available is the packaged one, then you must remove or clone.
* '''Unfeasable''' You already have a built package on the TCCP website. You will need to go to the website and cancel the package, then delete the .tzarc file. You will now be able to upload your package.
* '''Unknown Errors''' 

=TCCP Package Setup=

==Login==

Once you have uploaded your .tzarc file you will need to login at the TCCP website and navigate to your file or Package. The top level, or the Apps Dashboard, has 3 major sections. Content, Beta Testing and Documentation. Your file will be in the Content section or the Content Creator Dashboard. At the bottom of the page will be a list of your projects. Click on the title of your package in the list to continue to the Content Creator Project.

==Package==

You are required to fill in all the fields before clicking the 'Update Package' button at the bottom of this page. What is entered here can be changed before you submit it to the build machine, so don't be worried if it's not 100% accurate at this point. The Title and Description will overright the Trainz TCCP Manager, so this is important to remember if you need to modify your .tzac file and re-upload it.

==Images==

Upload at least six 1280 (width) x 800 (height) marketing screenshots and one 600 (width) x 262 (height) Trainz Store header image for your product. Accepted upload formats: 'png' or 'jpg'. Please ensure to include a 1280x800 resolution version of the 600x262 header image in the screenshots section as well, as this is required for creating the header images for Steam.

These images will not effect the images in your assets config.txt file.

Optionally you can upload a YouTube video.

==Files==

You can have only one .tzarc file uploaded for a project. If you need to change something, you will have to delete the file from this page. Depending at which stage your project is in, you may need to Cancel Beta and/or Cancel Project

==Beta Testing==

Before you submit for Beta Testing you should add your own questions as part of your Beta so testers have specific details to test with your content. You can add specific testing questions under the Test Plan Tools

==Assets==

==Notifications==

 

=Build Machine=

Near the top of each Content Creator Project page is a status box showing the current build status of the package. Once your package has passed all the requirements, the Submit To Build Queue button will appear.

* Prepare For Submission
* Building Your package is building. It may take up to a couple of hours or more to build the project.
* Failed
* Success Your package passed and can now be submitted for Beta Testing
* Live N3V has approved your package and it is now on the store.

 

=Beta Testing=

==Test Quesions==

==Tickets==

 

=Final Review=

Once you have addressed all tickets opened during the beta test, which could mean that you will have to submit a new beta, again, to confirm the fixes. Your package will pass beta and go into Final Review. This is where it is now scrutinized by the N3V staff.

Per Zec,
"''Something I've been meaning to do for quite a while is post up a bit of a 'guide' on how we generally review DLC packs. This isn't a hard and fast method, but should help you guys to review your content yourselves before submission There is a difference between routes/sessions and traincars, as they involve different aspects of gameplay. For all content, I will verify that the advertised content is included (ie route, sessions, traincars, consists, etc). This is based on what you advertise in the description (ie if you say there are 5 sessions and I only see 4, I'll send it back to you to double check).''"

After verifying the content is installed, and is fully active, and no open tickets.

==Routes / Sessions==

For routes/sessions:
* Each session is loaded into Driver, and then verified that the session loads successfully
* Drive the session for a few minutes, or untill the first navigation mark or task is complete. This is to ensure that the session is starting correctly, and the initial rules are working correctly. It also ensures that the locomotives and rolling stock at the start of the session are working correctly (ie brakes releasing correctly, and so on).
* Take a quick fly over of the route to make sure it all is loading correctly
* If the DLC pack also advertises custom/specific locomotives and rolling stock, then this will also be reviewed using the below.

==Traincar==

For traincar DLC packs:
* Check that the advertised traincars and consists are present
* Place the traincars onto a blank route, that has the track sitting directly on top of water. This allows me to check that the traincar has a water reflection that works properly, looks like the traincar, and isn't badly broken/distorted.
* For passenger coaches, place them onto a test route with a passenger station to check that the doors work as expected with a passenger station.
* For all traincars, place them onto the KSC2 route, and do a check for obvious mesh/LOD issues (ie obvious changes in the look of the loco when moving toward/away from it). This includes distortions to the texture map, or smoothing issues, on lower LODs.
* At this point, also do a check that all controls work. This means that using keyboard and HUD controls work for all main controls (reverser, throttle, dynamic brake^, train brake, independent brake, headlight, ditch lights^, pantographs^, sander, and of course simple controls mode).
^The controls marked with this are 'optional' on traincars, so are only checked where that item has them fitted. The independent brake, although not always fitted in the cab view, should generally be operational on traincars since the HUD control is available. Dynamic brake, OTOH, is generally acceptable if it is not functional (but it absolutely should be
functional on locos fitted with one).
* Quickly try any advertised scripted functions to make sure these work.
* For locos, take the locomotive for a short drive in Driver to make sure that they drive appropriately (note, this isn't necessarily a check for prototypical operation, but more just to make sure that they operate correctly as a locomotive in general). This also allows checking that sounds are working correctly/etc.
* For rolling stock, do the same, but use a builtin locomotive to haul them.

As a final note regarding traincar DLC packs. It is expected that locomotives and rolling stock scripts will not break default functionality.

Examples of this are startup/shutdown scripts that are off by default. For the average user who purchases a loco with this, they will have no way to know how to startup the locomotive, and hence are stuck with a locomotive that to them simply does not work. For startup/shutdown scripts there are two options for this, one is to simply have the loco on by default and allow the player to choose to turn it off in the properties, and then allow them to go through the startup sequence. Another, as seen on the Frecciarossa train DLC, would be to have the train pop up with a message to provide startup options.

Another example would be custom throttle/brake controls that prevent the HUD controls, DCC controls, or keyboard controls from working. Again the average player who purchases this DLC pack will not know what is happening and will see this content as being broken. In this case you must ensure that custom controls correctly respond to the HUD and keyboard.

==Review Results==

If any issues are found during review, these will be reported via the beta testing bug report system in TCCP. If no issues are found we will then process the DLC pack to PreviewPass for 2 weeks, then release publicly after the 2 week PreviewPass. Note that in some cases, very minor issues might be reported but we may still process to previewpass, these issues should be resolved in an update during previewpass or after release, normally we'll note this in the bug report.

==Request Skip Beta==

Depending on the issues noted, we will generally let you know if you can request skip beta on the package after resolving the noted issues, however if we don't you can choose to request this after building the package. However if the issues noted were something that needs testing, we will reject the skip beta so that it can go through another round of beta testing. Otherwise we will review the DLC pack again, double checking that reported bugs are resolved.
 

=Getting Paid=

In order to get paid for your work, you will need a verified PayPal account. Then you will need an Affiliatly account linked to the PayPal account.

==Affiliatly Account==

You will need to setup an [https://www.affiliatly.com/af-102715/affiliate.panel '''Affiliatly Account''']

Start earning royalties and commissions from your Trainz hobby today.

Are you a Trainz Content Creator? Expand your own website sales and earn commissions on all your items sold through the Trainz Store and via other online stores such as Steam and Mac App Store. (Submit your content through [https://tccp.auran.com/ '''this link''']). Commissions are 50% of the sale price for direct purchases. You will also receive commissions on Silver and Gold subscriptions that download your DLC content. The amount of these commissions vary and a detailed chart can be found under the TCCP website Documentation section.

Do you run a Trainz website or Youtube Channel? Use your Affiliatly link to earn commissions on sales through our store. Each time a user clicks on your link then purchases an item in the next week, you earn a 10% commission on that sale. This could result in a total of 60% on a direct sale.

Registration is free. Sign up now to get your Affiliatly ID and begin earning commissions and royalties. The website tracks the royalties earned for referrals and sales through our TrainzPortal store and shows payments to your nominated account. The amount shown may be less than you will actuallly receive as the subscription revenue does not show here, which is calculated on the processing date as it's a shared revenue.

Once you have set up your account you will be given an Affiliatly ID number. Log back into the TCCP website, and in the Content Creator Dashboard choose Options. Enter your ID and Save. WARNING: Double check your Affiliatly ID. Adding the wrong ID could mean the wrong account is paid!

==PayPal Account==

In order to get paid, you must have a PayPal account linked to your Affiliaty account. You will get paid on the 15th or 16th of each month, depending on your time zone and when they process your account. You must have at least $100 US in earnings before you will get paid.

TCCP

2022-11-10T15:01:16Z

Christopher824:

This page is a guide for Trainz Content Creation Program or 'TCCP' 
TCCP Beta Testers should look HERE

'''Under Development''' The contents and the layout of this page is under development.

Trainz Content Creation Program or TCCP allows you to become a Registered Content Creator with N3V Auran. You will be eligible to upload Content which may be made available for download by Trainz users, and, for Approved Content, to receive a share of revenues for sales relating to your Content.

=Getting Started=

==Set Up Account==
Your first step is to get a TCCP account at [https://tccp.auran.com/ '''tccp.auran.com''']
When you create your account use your My Trainz username and password. You will be asked to accept the EULA terms and conditions.

Once you have an account created you can find a lot more detailed instructions under [https://tccp.auran.com/documentation.php '''tccp.auran.com/documentation.php'''].

This video also explains most of what you need to get up and running. It is a long video but is split into sections so you can skip to what you need: [https://www.youtube.com/watch?v=6J9Bhq5vIxk&t=65s '''DETAILED VIDEO''']

==Connect With Other Creators==
More heads are better than one. There are differnt ways to connect with other content creators and you should be involved with this. Trainz is a community based platform, and as such you need to be involed to help gaurantee success. You will find if you are a team player, you will benifit from the team. Here are some avenues to connect;

* [https://forums.auran.com/trainz/forum.php Trainz Forums]
* Trainz Discord channel For this you will need an invite, see the Trainz Forums above.

=Creating A Package=

==Thumbnails==

Your primary asset(s), Routes, Sessions, Rolling Stock and Locos must have the proper set of thumbnails. To add the thumbnails to your asset, edit the config.txt and make sure it looks like the code below, take note of the dimensions and filenames listed for each thumbnail. If you do not have the correct size thumbnails or filenames, you will need to create or modify them.

thumbnails
{
0
{
image "0.jpg"
width 1280
height 800
}

1
{
image "1.jpg"
width 1280
height 800
}

2
{
image "2.jpg"
width 1280
height 800
}

default
{
image "thumbnail.jpg"
width 512
height 384
}
}

==TCCP Manager==
Current TCCP projects can be from a TRS19 or TRS22 build. Do not try to create a package using a Beta Build. If you can submit your project in TRS19 SP5, then you can target both TRS19 and TRS22 customers. Open Trainz and look for the Developer Tab. It can be found from the Launcher and the Content Manager.
* Select 'Open TCCP Project List'
* Right Click inside window and select 'Create New Project...'

Once the panel opens, type in a Title. Then type a description in the text box, it can be anything as these will not be the final title or description, so it could just be a note at this point. If you close this dialog without giving it a Title or a Description, you will get an error. If you wish to still quit, close the dialog a second time and it will abandon the project. If you close the dialog with a Title and Description, a TCCP Project ID will be assigned to your project and now can be found on the TCCP website.

In the TCCP Project List, your project will now be listed. You can right click on it and it will give you the option of 'Edit Project...' and 'View Project on TCCP Website...'.

When you choose edit project, the window that pops up it will now have your title on the menu bar. The first list box is where you place the assets you have made and wish to distribute. You will need to open a Content Manager window, and drag your creation(s) into it. The second box is which from the first box you want to encode as payware. You can now drag from the first box to the second box to populate it. If you are a route creator, and wish to have an unlocked base session, you would leave that session out of the second box.

==Using newer asset versions where available==
Checkbox - ''need more info on this setting?'' Default leave unchecked.

==Uploading==

Once you have populated the two list boxes, click the 'Upload Package' button on the bottom right of the dialog.
*.TZARC - Trainz Archive File
The manager will attempt to build your files into a .tzarc file. It will add every dependancy the package needs into the file. If succesful it will upload it to the TCCP build machine.

==Errors==
* '''Payware''' You can not include payware in your project, this includes dependencies.
* '''Packaged and not avialable''' This will happen from time to time. There are different ways to fix this. You could edit your creation and remove the offending asset. You could clone the asset if the license allows or you have permission, then upload it to the DLS, then replace your old one with the new one from the DLS. Or you could open a helpdesk ticket if there is an earlier version on the DLS. If the only version available is the packaged one, then you must remove or clone.
* '''Unfeasable''' You already have a built package on the TCCP website. You will need to go to the website and cancel the package, then delete the .tzarc file. You will now be able to upload your package.
* '''Unknown Errors''' 

=TCCP Package Setup=

==Login==

Once you have uploaded your .tzarc file you will need to login at the TCCP website and navigate to your file or Package. The top level, or the Apps Dashboard, has 3 major sections. Content, Beta Testing and Documentation. Your file will be in the Content section or the Content Creator Dashboard. At the bottom of the page will be a list of your projects. Click on the title of your package in the list to continue to the Content Creator Project.

==Package==

You are required to fill in all the fields before clicking the 'Update Package' button at the bottom of this page. What is entered here can be changed before you submit it to the build machine, so don't be worried if it's not 100% accurate at this point. The Title and Description will overright the Trainz TCCP Manager, so this is important to remember if you need to modify your .tzac file and re-upload it.

==Images==

Upload at least six 1280 (width) x 800 (height) marketing screenshots and one 600 (width) x 262 (height) Trainz Store header image for your product. Accepted upload formats: 'png' or 'jpg'. Please ensure to include a 1280x800 resolution version of the 600x262 header image in the screenshots section as well, as this is required for creating the header images for Steam.

These images will not effect the images in your assets config.txt file.

Optionally you can upload a YouTube video.

==Files==

You can have only one .tzarc file uploaded for a project. If you need to change something, you will have to delete the file from this page. Depending at which stage your project is in, you may need to Cancel Beta and/or Cancel Project

==Beta Testing==

Before you submit for Beta Testing you should add your own questions as part of your Beta so testers have specific details to test with your content. You can add specific testing questions under the Test Plan Tools

==Assets==

==Notifications==

 

=Build Machine=

Near the top of each Content Creator Project page is a status box showing the current build status of the package. Once your package has passed all the requirements, the Submit To Build Queue button will appear.

* Prepare For Submission
* Building Your package is building. It may take up to a couple of hours or more to build the project.
* Failed
* Success Your package passed and can now be submitted for Beta Testing
* Live N3V has approved your package and it is now on the store.

 

=Beta Testing=

==Test Quesions==

==Tickets==

=Final Review=

Once you have addressed all tickets opened during the beta test, which could mean that you will have to submit a new beta, again, to confirm the fixes. Your package will pass beta and go into Final Review. This is where it is now scrutinized by the N3V staff.

Per Zec,
"''Something I've been meaning to do for quite a while is post up a bit of a 'guide' on how we generally review DLC packs. This isn't a hard and fast method, but should help you guys to review your content yourselves before submission There is a difference between routes/sessions and traincars, as they involve different aspects of gameplay. For all content, I will verify that the advertised content is included (ie route, sessions, traincars, consists, etc). This is based on what you advertise in the description (ie if you say there are 5 sessions and I only see 4, I'll send it back to you to double check).''"

After verifying the content is installed, and is fully active, and no open tickets.

==Routes / Sessions==

For routes/sessions:
* Each session is loaded into Driver, and then verified that the session loads successfully
* Drive the session for a few minutes, or untill the first navigation mark or task is complete. This is to ensure that the session is starting correctly, and the initial rules are working correctly. It also ensures that the locomotives and rolling stock at the start of the session are working correctly (ie brakes releasing correctly, and so on).
* Take a quick fly over of the route to make sure it all is loading correctly
* If the DLC pack also advertises custom/specific locomotives and rolling stock, then this will also be reviewed using the below.

==Traincar==

For traincar DLC packs:
* Check that the advertised traincars and consists are present
* Place the traincars onto a blank route, that has the track sitting directly on top of water. This allows me to check that the traincar has a water reflection that works properly, looks like the traincar, and isn't badly broken/distorted.
* For passenger coaches, place them onto a test route with a passenger station to check that the doors work as expected with a passenger station.
* For all traincars, place them onto the KSC2 route, and do a check for obvious mesh/LOD issues (ie obvious changes in the look of the loco when moving toward/away from it). This includes distortions to the texture map, or smoothing issues, on lower LODs.
* At this point, also do a check that all controls work. This means that using keyboard and HUD controls work for all main controls (reverser, throttle, dynamic brake^, train brake, independent brake, headlight, ditch lights^, pantographs^, sander, and of course simple controls mode).
^The controls marked with this are 'optional' on traincars, so are only checked where that item has them fitted. The independent brake, although not always fitted in the cab view, should generally be operational on traincars since the HUD control is available. Dynamic brake, OTOH, is generally acceptable if it is not functional (but it absolutely should be
functional on locos fitted with one).
* Quickly try any advertised scripted functions to make sure these work.
* For locos, take the locomotive for a short drive in Driver to make sure that they drive appropriately (note, this isn't necessarily a check for prototypical operation, but more just to make sure that they operate correctly as a locomotive in general). This also allows checking that sounds are working correctly/etc.
* For rolling stock, do the same, but use a builtin locomotive to haul them.

==Review Results==

If any issues are found during review, these will be reported via the beta testing bug report system in TCCP. If no issues are found we will then process the DLC pack to PreviewPass for 2 weeks, then release publicly after the 2 week PreviewPass. Note that in some cases, very minor issues might be reported but we may still process to previewpass, these issues should be resolved in an update during previewpass or after release, normally we'll note this in the bug report.

==Request Skip Beta==

Depending on the issues noted, we will generally let you know if you can request skip beta on the package after resolving the noted issues, however if we don't you can choose to request this after building the package. However if the issues noted were something that needs testing, we will reject the skip beta so that it can go through another round of beta testing. Otherwise we will review the DLC pack again, double checking that reported bugs are resolved.

=Getting Paid=

==Affiliatly Account==

You will need to setup an [https://www.affiliatly.com/af-102715/affiliate.panel '''Affiliatly Account''']

Start earning royalties and commissions from your Trainz hobby today.

Are you a Trainz Content Creator? Expand your own website sales and earn commissions on all your items sold through the Trainz Store and via other online stores such as Steam and Mac App Store. (Submit your content through [https://tccp.auran.com/ '''this link''']). Commissions are 50% of the sale price for direct purchases. You will also receive commissions on Silver and Gold subscriptions that download your DLC content. The amount of these commissions vary and a detailed chart can be found under the TCCP website Documentation section.

Do you run a Trainz website or Youtube Channel? Use your Affiliatly link to earn commissions on sales through our store. Each time a user clicks on your link then purchases an item in the next week, you earn a 10% commission on that sale. This could result in a total of 60% on a direct sale.

Registration is free. Sign up now to get your Affiliatly ID and begin earning commissions and royalties. The website tracks the royalties earned for referrals and sales through our TrainzPortal store and shows payments to your nominated account. The amount shown may be less than you will actuallly receive as the subscription revenue does not show here, which is calculated on the processing date as it's a shared revenue.

Once you have set up your account you will be given an Affiliatly ID number. Log back into the TCCP website, and in the Content Creator Dashboard choose Options. Enter your ID and Save. WARNING: Double check your Affiliatly ID. Adding the wrong ID could mean the wrong account is paid!

==PayPal Account==

In order to get paid, you must have a PayPal account linked to your Affiliaty account. You will get paid on the 15th or 16th of each month, depending on your time zone and when they process your account. You must have at least $100 US in earnings before you will get paid.

Class JunctionBase

2022-10-24T16:12:40Z

Christopher824: /* RequestPermit */

*[[TrainzScript Library Reference|API Hierarchy]]
**[[Class GSObject|GSObject]] *
***[[Class GameObject|GameObject]]
****[[Class TrainzGameObject|TrainzGameObject]]
****[[Class PropertyObject|PropertyObject]] *
*****[[Class MeshObject|MeshObject]]
******[[Class MapObject|MapObject]]
*******JunctionBase *

 
*Interface methods to control and obtain information about the status of Junction objects.
*This class relates equally to switch levers controlling spline track junctions and to the junction nodes attached to Fixed Track Junction objects.
 

==Constants & Messages==

===Junction States===
*These values define the directions possible through a junction object.
 
{{TableHeader|width=95%|margin=15px}}
|width=375|public define int DIRECTION_LEFT = 0 ||Left junction direction.
|-
|public define int DIRECTION_FORWARD = 1 ||Forward junction direction (straight on for three way points).
|-
|public define int DIRECTION_RIGHT = 2 ||Right junction direction.
|-
|public define int DIRECTION_BACKWARD = -1 ||Backward junction direction (leading approach).
|-
|public define int DIRECTION_NONE = 3 ||No junction direction or error condition.
|}
 

==Related Messages==
*Messages sent to and from Junction objects are listed below:
 
{{TableHeader|width=50%|margin=15px}}
|-
|bgcolor="#EEEEEE"|'''Major'''||bgcolor="#EEEEEE"|'''Minor'''||bgcolor="#EEEEEE"|'''Source'''||bgcolor="#EEEEEE" |'''Destination'''
|-
|Junction||Toggled||Junction||Broadcast
|-
|[[Object Messages|Junction]]||Enter||Junction||Train
|-
|[[Object Messages|Junction]]||InnerEnter||Junction||Train
|-
|[[Object Messages|Junction]]||Stopped||Junction||Train
|-
|[[Object Messages|Junction]]||InnerLeave||Junction||Train
|-
|[[Object Messages|Junction]]||Leave||Junction||Train
|-
|[[Object Messages|Object]]||Enter||Train||Junction
|-
|[[Object Messages|Object]]||InnerEnter||Train||Junction
|-
|[[Object Messages|Object]]||Stopped||Train||Junction
|-
|[[Object Messages|Object]]||InnerLeave||Train||Junction
|-
|[[Object Messages|Object]]||Leave||Train||Junction
|}
 

==Methods==

===AllowManualControl===
{{MethodHeader|public native voidAllowManualControl(bool allow)}}
;Parameters
*'''allow''' = True to allow the user to toggle the junction, false otherwise.
;Returned Value
*None
;Syntax;
AllowManualControl(true);
;Notes
 

===GetDebugString===
{{MethodHeader|public string GetDebugString(void)}}
;Parameters
*None
;Returned Value
*A string that contains the node ID and name of the MapObject associated with this junction. If successful, the returned string will include the node ID and name of the MapObject. Otherwise an error string will be returned instead.
;Syntax;
Interface.Print(GetDebugString());
;Notes
 

===GetDirection===
{{MethodHeader|public native int GetDirection(void)}}
;Parameters
*None
;Returned Value
*One of the [[#Junction States|Junction State]] constants indicating the current direction of the junction.
;Syntax;
int direction = GetDirection();
;Notes
 

===GetDirectionToTrain===
{{MethodHeader|public native int GetDirectionToTrain(Train train)}}
;Parameters
*'''train''' = A reference to a train located within 15 track stretches of the junction.
;Returned Value
*One of the [[#Junction States|Junction State]] constants indicating the track on which the train was found.
;Syntax;
int approachPath = GetDirectionToTrain(train);
;Notes
*DIRECTION_NONE is returned if the train is not within range.
 

===GetGameObject===
{{MethodHeader|public native GameObject GetGameObject(void)}}
;Parameters
*None
;Returned Value
*A reference to the GameObject associated with this junction.
;Syntax;
GameObject go = junction.GetGameObject();
;Notes
*For a trackside spline junction this method returns the junction lever object.
*For an embedded junction in a fixed track junction the object returned is the embedded junction node.
*In either case null is returned on failure.
 

===GetManualControl===
{{MethodHeader|public native bool GetManualControl(void)}}
;Parameters
*None
;Returned Value
*True if the user is allowed to toggle this junction, false otherwise.
;Syntax;
bool locked = !GetManualControl();
;Notes
 

===GetMapObject===
{{MethodHeader|public native MapObject GetMapObject(void)}}
;Parameters
*None
;Returned Value
*A reference to the MapObject associated with this junction.
;Syntax;
MapObject mo = junction.GetMapObject();
;Notes
*For a trackside spline junction this method returns the junction lever object.
*For an embedded junction in a fixed track piece the object returned is the fixed track parent object.
*In either case null is returned on failure.
 

===JunctionInnerReEnter===
{{MethodHeader|public native bool JunctionInnerReEnter(int node)}}
;Parameters
*'''node''' = Node Id of train as returned by Train.GetId().
;Returned Value
*None
;Syntax;
junction.JunctionInnerReEnter(train);
;Notes
*The effect of this method is to cause a new ''Junction,InnerEnter'' message to be sent to the Junction if any part of the train is within the inner trigger radius.
 

===JunctionReEnter===
{{MethodHeader|public native bool JunctionReEnter(int node)}}
;Parameters
*'''node''' = Node Id of train as returned by Train.GetId().
;Returned Value
*None
;Syntax;
junction.JunctionReEnter(train);
;Notes
*The effect of this method is to cause a new ''Junction,Enter'' message to be sent to the Junction if any part of the train is within the default outer trigger radius.
 

===RequestPermit===
{{MethodHeader|public native Permit RequestPermit(SecrityToken myToken, GameObject obj, int direction)}}
;Parameters
*'''obj''' = Object requesting the [[Class Permit|Permit]].
;Returned Value
*Returns a Permit for ''obj'' to control the junction.
;Syntax;
Permit permit = RequestPermit(myToken, train, 0);
;Notes
*Although a Permit is always returned, it may not necessarily be granted.
*If you do not include all three parameters, the method will be marked Obsolete.
 

===RequestTrackPermit===
{{MethodHeader|public native Permit RequestTrackPermit(GameObject obj, int direction)}}
;Parameters
*'''obj''' = Object requesting the [[Class Permit|Permit]].
*'''direction''' = One of the [[#Junction States|Junction State]] constants indicating the direction of the track relative to the current junction.
;Returned Value
*Returns a Permit for ''obj'' to control the specified track.
;Syntax;
Permit permit = RequestTrackPermit(train, DIRECTION_LEFT);
;Notes
*Although a Permit is always returned, it may not necessarily be granted.
 

===SetDirection===
{{MethodHeader|public native bool SetDirection(SecurityToken myToken, int direction)}}
;Parameters
*'''direction''' = New direction to set.
;Returned Value
*True if the junction is changed, False if the direction is unchanged or if the specified direction was invalid for this junction.
;Syntax;
if (junction.SetDirection(myToken, DIRECTION_LEFT)) Interface.Print("Junction now set to the left");
;Notes
*This method switches the junction unconditionally, disregarding any Permits that may exist.
*If you do not include the SecurityToken, the method will be marked Obsolete.
 

===SwitchForTrain===
{{MethodHeader|public native bool SwitchForTrain(Train train, int direction)}}
;Parameters
*'''train''' = Train that is to pass over the junction.
*'''direction''' = One of the [[#Junction States|Junction State]] constants indicating the current position of the train relative junction.
;Returned Value
*True if the junction is changed, False if the direction is unchanged or if the specified direction was invalid for this junction.
;Syntax;
junction.SwitchForTrain(train,DIRECTION_BACKWARD);
;Notes
*The new direction must be on the opposite side of the junction to the train's current position.
*This method switches the junction unconditionally, disregarding any Permits that may exist.
 

==Related Methods==
[[Class SceneryWithTrack#GetAttachedJunctions|SceneryWithTrack.GetAttachedJunctions()]] 
[[Class World#GetJunctionList|World.GetJunctionList()]] 
 

==Categories==
[[Category:Script Class]]

Class JunctionBase

2022-10-24T16:10:55Z

Christopher824: /* RequestPermit */

*[[TrainzScript Library Reference|API Hierarchy]]
**[[Class GSObject|GSObject]] *
***[[Class GameObject|GameObject]]
****[[Class TrainzGameObject|TrainzGameObject]]
****[[Class PropertyObject|PropertyObject]] *
*****[[Class MeshObject|MeshObject]]
******[[Class MapObject|MapObject]]
*******JunctionBase *

 
*Interface methods to control and obtain information about the status of Junction objects.
*This class relates equally to switch levers controlling spline track junctions and to the junction nodes attached to Fixed Track Junction objects.
 

==Constants & Messages==

===Junction States===
*These values define the directions possible through a junction object.
 
{{TableHeader|width=95%|margin=15px}}
|width=375|public define int DIRECTION_LEFT = 0 ||Left junction direction.
|-
|public define int DIRECTION_FORWARD = 1 ||Forward junction direction (straight on for three way points).
|-
|public define int DIRECTION_RIGHT = 2 ||Right junction direction.
|-
|public define int DIRECTION_BACKWARD = -1 ||Backward junction direction (leading approach).
|-
|public define int DIRECTION_NONE = 3 ||No junction direction or error condition.
|}
 

==Related Messages==
*Messages sent to and from Junction objects are listed below:
 
{{TableHeader|width=50%|margin=15px}}
|-
|bgcolor="#EEEEEE"|'''Major'''||bgcolor="#EEEEEE"|'''Minor'''||bgcolor="#EEEEEE"|'''Source'''||bgcolor="#EEEEEE" |'''Destination'''
|-
|Junction||Toggled||Junction||Broadcast
|-
|[[Object Messages|Junction]]||Enter||Junction||Train
|-
|[[Object Messages|Junction]]||InnerEnter||Junction||Train
|-
|[[Object Messages|Junction]]||Stopped||Junction||Train
|-
|[[Object Messages|Junction]]||InnerLeave||Junction||Train
|-
|[[Object Messages|Junction]]||Leave||Junction||Train
|-
|[[Object Messages|Object]]||Enter||Train||Junction
|-
|[[Object Messages|Object]]||InnerEnter||Train||Junction
|-
|[[Object Messages|Object]]||Stopped||Train||Junction
|-
|[[Object Messages|Object]]||InnerLeave||Train||Junction
|-
|[[Object Messages|Object]]||Leave||Train||Junction
|}
 

==Methods==

===AllowManualControl===
{{MethodHeader|public native voidAllowManualControl(bool allow)}}
;Parameters
*'''allow''' = True to allow the user to toggle the junction, false otherwise.
;Returned Value
*None
;Syntax;
AllowManualControl(true);
;Notes
 

===GetDebugString===
{{MethodHeader|public string GetDebugString(void)}}
;Parameters
*None
;Returned Value
*A string that contains the node ID and name of the MapObject associated with this junction. If successful, the returned string will include the node ID and name of the MapObject. Otherwise an error string will be returned instead.
;Syntax;
Interface.Print(GetDebugString());
;Notes
 

===GetDirection===
{{MethodHeader|public native int GetDirection(void)}}
;Parameters
*None
;Returned Value
*One of the [[#Junction States|Junction State]] constants indicating the current direction of the junction.
;Syntax;
int direction = GetDirection();
;Notes
 

===GetDirectionToTrain===
{{MethodHeader|public native int GetDirectionToTrain(Train train)}}
;Parameters
*'''train''' = A reference to a train located within 15 track stretches of the junction.
;Returned Value
*One of the [[#Junction States|Junction State]] constants indicating the track on which the train was found.
;Syntax;
int approachPath = GetDirectionToTrain(train);
;Notes
*DIRECTION_NONE is returned if the train is not within range.
 

===GetGameObject===
{{MethodHeader|public native GameObject GetGameObject(void)}}
;Parameters
*None
;Returned Value
*A reference to the GameObject associated with this junction.
;Syntax;
GameObject go = junction.GetGameObject();
;Notes
*For a trackside spline junction this method returns the junction lever object.
*For an embedded junction in a fixed track junction the object returned is the embedded junction node.
*In either case null is returned on failure.
 

===GetManualControl===
{{MethodHeader|public native bool GetManualControl(void)}}
;Parameters
*None
;Returned Value
*True if the user is allowed to toggle this junction, false otherwise.
;Syntax;
bool locked = !GetManualControl();
;Notes
 

===GetMapObject===
{{MethodHeader|public native MapObject GetMapObject(void)}}
;Parameters
*None
;Returned Value
*A reference to the MapObject associated with this junction.
;Syntax;
MapObject mo = junction.GetMapObject();
;Notes
*For a trackside spline junction this method returns the junction lever object.
*For an embedded junction in a fixed track piece the object returned is the fixed track parent object.
*In either case null is returned on failure.
 

===JunctionInnerReEnter===
{{MethodHeader|public native bool JunctionInnerReEnter(int node)}}
;Parameters
*'''node''' = Node Id of train as returned by Train.GetId().
;Returned Value
*None
;Syntax;
junction.JunctionInnerReEnter(train);
;Notes
*The effect of this method is to cause a new ''Junction,InnerEnter'' message to be sent to the Junction if any part of the train is within the inner trigger radius.
 

===JunctionReEnter===
{{MethodHeader|public native bool JunctionReEnter(int node)}}
;Parameters
*'''node''' = Node Id of train as returned by Train.GetId().
;Returned Value
*None
;Syntax;
junction.JunctionReEnter(train);
;Notes
*The effect of this method is to cause a new ''Junction,Enter'' message to be sent to the Junction if any part of the train is within the default outer trigger radius.
 

===RequestPermit===
{{MethodHeader|public native Permit RequestPermit(SecrityToken sToken, GameObject obj, int direction)}}
;Parameters
*'''obj''' = Object requesting the [[Class Permit|Permit]].
;Returned Value
*Returns a Permit for ''obj'' to control the junction.
;Syntax;
Permit permit = RequestPermit(sToken, train, 0);
;Notes
*Although a Permit is always returned, it may not necessarily be granted.
*If you do not include all three parameters, the method will be marked Obsolete.
 

===RequestTrackPermit===
{{MethodHeader|public native Permit RequestTrackPermit(GameObject obj, int direction)}}
;Parameters
*'''obj''' = Object requesting the [[Class Permit|Permit]].
*'''direction''' = One of the [[#Junction States|Junction State]] constants indicating the direction of the track relative to the current junction.
;Returned Value
*Returns a Permit for ''obj'' to control the specified track.
;Syntax;
Permit permit = RequestTrackPermit(train, DIRECTION_LEFT);
;Notes
*Although a Permit is always returned, it may not necessarily be granted.
 

===SetDirection===
{{MethodHeader|public native bool SetDirection(SecurityToken myToken, int direction)}}
;Parameters
*'''direction''' = New direction to set.
;Returned Value
*True if the junction is changed, False if the direction is unchanged or if the specified direction was invalid for this junction.
;Syntax;
if (junction.SetDirection(myToken, DIRECTION_LEFT)) Interface.Print("Junction now set to the left");
;Notes
*This method switches the junction unconditionally, disregarding any Permits that may exist.
*If you do not include the SecurityToken, the method will be marked Obsolete.
 

===SwitchForTrain===
{{MethodHeader|public native bool SwitchForTrain(Train train, int direction)}}
;Parameters
*'''train''' = Train that is to pass over the junction.
*'''direction''' = One of the [[#Junction States|Junction State]] constants indicating the current position of the train relative junction.
;Returned Value
*True if the junction is changed, False if the direction is unchanged or if the specified direction was invalid for this junction.
;Syntax;
junction.SwitchForTrain(train,DIRECTION_BACKWARD);
;Notes
*The new direction must be on the opposite side of the junction to the train's current position.
*This method switches the junction unconditionally, disregarding any Permits that may exist.
 

==Related Methods==
[[Class SceneryWithTrack#GetAttachedJunctions|SceneryWithTrack.GetAttachedJunctions()]] 
[[Class World#GetJunctionList|World.GetJunctionList()]] 
 

==Categories==
[[Category:Script Class]]

Class JunctionBase

2022-10-24T16:09:38Z

Christopher824: /* RequestPermit */

*[[TrainzScript Library Reference|API Hierarchy]]
**[[Class GSObject|GSObject]] *
***[[Class GameObject|GameObject]]
****[[Class TrainzGameObject|TrainzGameObject]]
****[[Class PropertyObject|PropertyObject]] *
*****[[Class MeshObject|MeshObject]]
******[[Class MapObject|MapObject]]
*******JunctionBase *

 
*Interface methods to control and obtain information about the status of Junction objects.
*This class relates equally to switch levers controlling spline track junctions and to the junction nodes attached to Fixed Track Junction objects.
 

==Constants & Messages==

===Junction States===
*These values define the directions possible through a junction object.
 
{{TableHeader|width=95%|margin=15px}}
|width=375|public define int DIRECTION_LEFT = 0 ||Left junction direction.
|-
|public define int DIRECTION_FORWARD = 1 ||Forward junction direction (straight on for three way points).
|-
|public define int DIRECTION_RIGHT = 2 ||Right junction direction.
|-
|public define int DIRECTION_BACKWARD = -1 ||Backward junction direction (leading approach).
|-
|public define int DIRECTION_NONE = 3 ||No junction direction or error condition.
|}
 

==Related Messages==
*Messages sent to and from Junction objects are listed below:
 
{{TableHeader|width=50%|margin=15px}}
|-
|bgcolor="#EEEEEE"|'''Major'''||bgcolor="#EEEEEE"|'''Minor'''||bgcolor="#EEEEEE"|'''Source'''||bgcolor="#EEEEEE" |'''Destination'''
|-
|Junction||Toggled||Junction||Broadcast
|-
|[[Object Messages|Junction]]||Enter||Junction||Train
|-
|[[Object Messages|Junction]]||InnerEnter||Junction||Train
|-
|[[Object Messages|Junction]]||Stopped||Junction||Train
|-
|[[Object Messages|Junction]]||InnerLeave||Junction||Train
|-
|[[Object Messages|Junction]]||Leave||Junction||Train
|-
|[[Object Messages|Object]]||Enter||Train||Junction
|-
|[[Object Messages|Object]]||InnerEnter||Train||Junction
|-
|[[Object Messages|Object]]||Stopped||Train||Junction
|-
|[[Object Messages|Object]]||InnerLeave||Train||Junction
|-
|[[Object Messages|Object]]||Leave||Train||Junction
|}
 

==Methods==

===AllowManualControl===
{{MethodHeader|public native voidAllowManualControl(bool allow)}}
;Parameters
*'''allow''' = True to allow the user to toggle the junction, false otherwise.
;Returned Value
*None
;Syntax;
AllowManualControl(true);
;Notes
 

===GetDebugString===
{{MethodHeader|public string GetDebugString(void)}}
;Parameters
*None
;Returned Value
*A string that contains the node ID and name of the MapObject associated with this junction. If successful, the returned string will include the node ID and name of the MapObject. Otherwise an error string will be returned instead.
;Syntax;
Interface.Print(GetDebugString());
;Notes
 

===GetDirection===
{{MethodHeader|public native int GetDirection(void)}}
;Parameters
*None
;Returned Value
*One of the [[#Junction States|Junction State]] constants indicating the current direction of the junction.
;Syntax;
int direction = GetDirection();
;Notes
 

===GetDirectionToTrain===
{{MethodHeader|public native int GetDirectionToTrain(Train train)}}
;Parameters
*'''train''' = A reference to a train located within 15 track stretches of the junction.
;Returned Value
*One of the [[#Junction States|Junction State]] constants indicating the track on which the train was found.
;Syntax;
int approachPath = GetDirectionToTrain(train);
;Notes
*DIRECTION_NONE is returned if the train is not within range.
 

===GetGameObject===
{{MethodHeader|public native GameObject GetGameObject(void)}}
;Parameters
*None
;Returned Value
*A reference to the GameObject associated with this junction.
;Syntax;
GameObject go = junction.GetGameObject();
;Notes
*For a trackside spline junction this method returns the junction lever object.
*For an embedded junction in a fixed track junction the object returned is the embedded junction node.
*In either case null is returned on failure.
 

===GetManualControl===
{{MethodHeader|public native bool GetManualControl(void)}}
;Parameters
*None
;Returned Value
*True if the user is allowed to toggle this junction, false otherwise.
;Syntax;
bool locked = !GetManualControl();
;Notes
 

===GetMapObject===
{{MethodHeader|public native MapObject GetMapObject(void)}}
;Parameters
*None
;Returned Value
*A reference to the MapObject associated with this junction.
;Syntax;
MapObject mo = junction.GetMapObject();
;Notes
*For a trackside spline junction this method returns the junction lever object.
*For an embedded junction in a fixed track piece the object returned is the fixed track parent object.
*In either case null is returned on failure.
 

===JunctionInnerReEnter===
{{MethodHeader|public native bool JunctionInnerReEnter(int node)}}
;Parameters
*'''node''' = Node Id of train as returned by Train.GetId().
;Returned Value
*None
;Syntax;
junction.JunctionInnerReEnter(train);
;Notes
*The effect of this method is to cause a new ''Junction,InnerEnter'' message to be sent to the Junction if any part of the train is within the inner trigger radius.
 

===JunctionReEnter===
{{MethodHeader|public native bool JunctionReEnter(int node)}}
;Parameters
*'''node''' = Node Id of train as returned by Train.GetId().
;Returned Value
*None
;Syntax;
junction.JunctionReEnter(train);
;Notes
*The effect of this method is to cause a new ''Junction,Enter'' message to be sent to the Junction if any part of the train is within the default outer trigger radius.
 

===RequestPermit===
{{MethodHeader|public native Permit RequestPermit(SecrityToken sToken, GameObject obj, int direction)}}
;Parameters
*'''obj''' = Object requesting the [[Class Permit|Permit]].
;Returned Value
*Returns a Permit for ''obj'' to control the junction.
;Syntax;
Permit permit = RequestPermit(sToken, train, 0);
;Notes
*Although a Permit is always returned, it may not necessarily be granted.
*
 

===RequestTrackPermit===
{{MethodHeader|public native Permit RequestTrackPermit(GameObject obj, int direction)}}
;Parameters
*'''obj''' = Object requesting the [[Class Permit|Permit]].
*'''direction''' = One of the [[#Junction States|Junction State]] constants indicating the direction of the track relative to the current junction.
;Returned Value
*Returns a Permit for ''obj'' to control the specified track.
;Syntax;
Permit permit = RequestTrackPermit(train, DIRECTION_LEFT);
;Notes
*Although a Permit is always returned, it may not necessarily be granted.
 

===SetDirection===
{{MethodHeader|public native bool SetDirection(SecurityToken myToken, int direction)}}
;Parameters
*'''direction''' = New direction to set.
;Returned Value
*True if the junction is changed, False if the direction is unchanged or if the specified direction was invalid for this junction.
;Syntax;
if (junction.SetDirection(myToken, DIRECTION_LEFT)) Interface.Print("Junction now set to the left");
;Notes
*This method switches the junction unconditionally, disregarding any Permits that may exist.
*If you do not include the SecurityToken, the method will be marked Obsolete.
 

===SwitchForTrain===
{{MethodHeader|public native bool SwitchForTrain(Train train, int direction)}}
;Parameters
*'''train''' = Train that is to pass over the junction.
*'''direction''' = One of the [[#Junction States|Junction State]] constants indicating the current position of the train relative junction.
;Returned Value
*True if the junction is changed, False if the direction is unchanged or if the specified direction was invalid for this junction.
;Syntax;
junction.SwitchForTrain(train,DIRECTION_BACKWARD);
;Notes
*The new direction must be on the opposite side of the junction to the train's current position.
*This method switches the junction unconditionally, disregarding any Permits that may exist.
 

==Related Methods==
[[Class SceneryWithTrack#GetAttachedJunctions|SceneryWithTrack.GetAttachedJunctions()]] 
[[Class World#GetJunctionList|World.GetJunctionList()]] 
 

==Categories==
[[Category:Script Class]]

Class JunctionBase

2022-10-24T16:07:50Z

Christopher824: /* RequestPermit */

*[[TrainzScript Library Reference|API Hierarchy]]
**[[Class GSObject|GSObject]] *
***[[Class GameObject|GameObject]]
****[[Class TrainzGameObject|TrainzGameObject]]
****[[Class PropertyObject|PropertyObject]] *
*****[[Class MeshObject|MeshObject]]
******[[Class MapObject|MapObject]]
*******JunctionBase *

 
*Interface methods to control and obtain information about the status of Junction objects.
*This class relates equally to switch levers controlling spline track junctions and to the junction nodes attached to Fixed Track Junction objects.
 

==Constants & Messages==

===Junction States===
*These values define the directions possible through a junction object.
 
{{TableHeader|width=95%|margin=15px}}
|width=375|public define int DIRECTION_LEFT = 0 ||Left junction direction.
|-
|public define int DIRECTION_FORWARD = 1 ||Forward junction direction (straight on for three way points).
|-
|public define int DIRECTION_RIGHT = 2 ||Right junction direction.
|-
|public define int DIRECTION_BACKWARD = -1 ||Backward junction direction (leading approach).
|-
|public define int DIRECTION_NONE = 3 ||No junction direction or error condition.
|}
 

==Related Messages==
*Messages sent to and from Junction objects are listed below:
 
{{TableHeader|width=50%|margin=15px}}
|-
|bgcolor="#EEEEEE"|'''Major'''||bgcolor="#EEEEEE"|'''Minor'''||bgcolor="#EEEEEE"|'''Source'''||bgcolor="#EEEEEE" |'''Destination'''
|-
|Junction||Toggled||Junction||Broadcast
|-
|[[Object Messages|Junction]]||Enter||Junction||Train
|-
|[[Object Messages|Junction]]||InnerEnter||Junction||Train
|-
|[[Object Messages|Junction]]||Stopped||Junction||Train
|-
|[[Object Messages|Junction]]||InnerLeave||Junction||Train
|-
|[[Object Messages|Junction]]||Leave||Junction||Train
|-
|[[Object Messages|Object]]||Enter||Train||Junction
|-
|[[Object Messages|Object]]||InnerEnter||Train||Junction
|-
|[[Object Messages|Object]]||Stopped||Train||Junction
|-
|[[Object Messages|Object]]||InnerLeave||Train||Junction
|-
|[[Object Messages|Object]]||Leave||Train||Junction
|}
 

==Methods==

===AllowManualControl===
{{MethodHeader|public native voidAllowManualControl(bool allow)}}
;Parameters
*'''allow''' = True to allow the user to toggle the junction, false otherwise.
;Returned Value
*None
;Syntax;
AllowManualControl(true);
;Notes
 

===GetDebugString===
{{MethodHeader|public string GetDebugString(void)}}
;Parameters
*None
;Returned Value
*A string that contains the node ID and name of the MapObject associated with this junction. If successful, the returned string will include the node ID and name of the MapObject. Otherwise an error string will be returned instead.
;Syntax;
Interface.Print(GetDebugString());
;Notes
 

===GetDirection===
{{MethodHeader|public native int GetDirection(void)}}
;Parameters
*None
;Returned Value
*One of the [[#Junction States|Junction State]] constants indicating the current direction of the junction.
;Syntax;
int direction = GetDirection();
;Notes
 

===GetDirectionToTrain===
{{MethodHeader|public native int GetDirectionToTrain(Train train)}}
;Parameters
*'''train''' = A reference to a train located within 15 track stretches of the junction.
;Returned Value
*One of the [[#Junction States|Junction State]] constants indicating the track on which the train was found.
;Syntax;
int approachPath = GetDirectionToTrain(train);
;Notes
*DIRECTION_NONE is returned if the train is not within range.
 

===GetGameObject===
{{MethodHeader|public native GameObject GetGameObject(void)}}
;Parameters
*None
;Returned Value
*A reference to the GameObject associated with this junction.
;Syntax;
GameObject go = junction.GetGameObject();
;Notes
*For a trackside spline junction this method returns the junction lever object.
*For an embedded junction in a fixed track junction the object returned is the embedded junction node.
*In either case null is returned on failure.
 

===GetManualControl===
{{MethodHeader|public native bool GetManualControl(void)}}
;Parameters
*None
;Returned Value
*True if the user is allowed to toggle this junction, false otherwise.
;Syntax;
bool locked = !GetManualControl();
;Notes
 

===GetMapObject===
{{MethodHeader|public native MapObject GetMapObject(void)}}
;Parameters
*None
;Returned Value
*A reference to the MapObject associated with this junction.
;Syntax;
MapObject mo = junction.GetMapObject();
;Notes
*For a trackside spline junction this method returns the junction lever object.
*For an embedded junction in a fixed track piece the object returned is the fixed track parent object.
*In either case null is returned on failure.
 

===JunctionInnerReEnter===
{{MethodHeader|public native bool JunctionInnerReEnter(int node)}}
;Parameters
*'''node''' = Node Id of train as returned by Train.GetId().
;Returned Value
*None
;Syntax;
junction.JunctionInnerReEnter(train);
;Notes
*The effect of this method is to cause a new ''Junction,InnerEnter'' message to be sent to the Junction if any part of the train is within the inner trigger radius.
 

===JunctionReEnter===
{{MethodHeader|public native bool JunctionReEnter(int node)}}
;Parameters
*'''node''' = Node Id of train as returned by Train.GetId().
;Returned Value
*None
;Syntax;
junction.JunctionReEnter(train);
;Notes
*The effect of this method is to cause a new ''Junction,Enter'' message to be sent to the Junction if any part of the train is within the default outer trigger radius.
 

===RequestPermit===
{{MethodHeader|public native Permit RequestPermit(SecrityToken sToken, GameObject obj, int direction)}}
;Parameters
*'''obj''' = Object requesting the [[Class Permit|Permit]].
;Returned Value
*Returns a Permit for ''obj'' to control the junction.
;Syntax;
Permit permit = RequestPermit(sToken, train, "0");
;Notes
*Although a Permit is always returned, it may not necessarily be granted.
*
 

===RequestTrackPermit===
{{MethodHeader|public native Permit RequestTrackPermit(GameObject obj, int direction)}}
;Parameters
*'''obj''' = Object requesting the [[Class Permit|Permit]].
*'''direction''' = One of the [[#Junction States|Junction State]] constants indicating the direction of the track relative to the current junction.
;Returned Value
*Returns a Permit for ''obj'' to control the specified track.
;Syntax;
Permit permit = RequestTrackPermit(train, DIRECTION_LEFT);
;Notes
*Although a Permit is always returned, it may not necessarily be granted.
 

===SetDirection===
{{MethodHeader|public native bool SetDirection(SecurityToken myToken, int direction)}}
;Parameters
*'''direction''' = New direction to set.
;Returned Value
*True if the junction is changed, False if the direction is unchanged or if the specified direction was invalid for this junction.
;Syntax;
if (junction.SetDirection(myToken, DIRECTION_LEFT)) Interface.Print("Junction now set to the left");
;Notes
*This method switches the junction unconditionally, disregarding any Permits that may exist.
*If you do not include the SecurityToken, the method will be marked Obsolete.
 

===SwitchForTrain===
{{MethodHeader|public native bool SwitchForTrain(Train train, int direction)}}
;Parameters
*'''train''' = Train that is to pass over the junction.
*'''direction''' = One of the [[#Junction States|Junction State]] constants indicating the current position of the train relative junction.
;Returned Value
*True if the junction is changed, False if the direction is unchanged or if the specified direction was invalid for this junction.
;Syntax;
junction.SwitchForTrain(train,DIRECTION_BACKWARD);
;Notes
*The new direction must be on the opposite side of the junction to the train's current position.
*This method switches the junction unconditionally, disregarding any Permits that may exist.
 

==Related Methods==
[[Class SceneryWithTrack#GetAttachedJunctions|SceneryWithTrack.GetAttachedJunctions()]] 
[[Class World#GetJunctionList|World.GetJunctionList()]] 
 

==Categories==
[[Category:Script Class]]

Class JunctionBase

2022-10-24T15:51:46Z

Christopher824: /* SetDirection */

*[[TrainzScript Library Reference|API Hierarchy]]
**[[Class GSObject|GSObject]] *
***[[Class GameObject|GameObject]]
****[[Class TrainzGameObject|TrainzGameObject]]
****[[Class PropertyObject|PropertyObject]] *
*****[[Class MeshObject|MeshObject]]
******[[Class MapObject|MapObject]]
*******JunctionBase *

 
*Interface methods to control and obtain information about the status of Junction objects.
*This class relates equally to switch levers controlling spline track junctions and to the junction nodes attached to Fixed Track Junction objects.
 

==Constants & Messages==

===Junction States===
*These values define the directions possible through a junction object.
 
{{TableHeader|width=95%|margin=15px}}
|width=375|public define int DIRECTION_LEFT = 0 ||Left junction direction.
|-
|public define int DIRECTION_FORWARD = 1 ||Forward junction direction (straight on for three way points).
|-
|public define int DIRECTION_RIGHT = 2 ||Right junction direction.
|-
|public define int DIRECTION_BACKWARD = -1 ||Backward junction direction (leading approach).
|-
|public define int DIRECTION_NONE = 3 ||No junction direction or error condition.
|}
 

==Related Messages==
*Messages sent to and from Junction objects are listed below:
 
{{TableHeader|width=50%|margin=15px}}
|-
|bgcolor="#EEEEEE"|'''Major'''||bgcolor="#EEEEEE"|'''Minor'''||bgcolor="#EEEEEE"|'''Source'''||bgcolor="#EEEEEE" |'''Destination'''
|-
|Junction||Toggled||Junction||Broadcast
|-
|[[Object Messages|Junction]]||Enter||Junction||Train
|-
|[[Object Messages|Junction]]||InnerEnter||Junction||Train
|-
|[[Object Messages|Junction]]||Stopped||Junction||Train
|-
|[[Object Messages|Junction]]||InnerLeave||Junction||Train
|-
|[[Object Messages|Junction]]||Leave||Junction||Train
|-
|[[Object Messages|Object]]||Enter||Train||Junction
|-
|[[Object Messages|Object]]||InnerEnter||Train||Junction
|-
|[[Object Messages|Object]]||Stopped||Train||Junction
|-
|[[Object Messages|Object]]||InnerLeave||Train||Junction
|-
|[[Object Messages|Object]]||Leave||Train||Junction
|}
 

==Methods==

===AllowManualControl===
{{MethodHeader|public native voidAllowManualControl(bool allow)}}
;Parameters
*'''allow''' = True to allow the user to toggle the junction, false otherwise.
;Returned Value
*None
;Syntax;
AllowManualControl(true);
;Notes
 

===GetDebugString===
{{MethodHeader|public string GetDebugString(void)}}
;Parameters
*None
;Returned Value
*A string that contains the node ID and name of the MapObject associated with this junction. If successful, the returned string will include the node ID and name of the MapObject. Otherwise an error string will be returned instead.
;Syntax;
Interface.Print(GetDebugString());
;Notes
 

===GetDirection===
{{MethodHeader|public native int GetDirection(void)}}
;Parameters
*None
;Returned Value
*One of the [[#Junction States|Junction State]] constants indicating the current direction of the junction.
;Syntax;
int direction = GetDirection();
;Notes
 

===GetDirectionToTrain===
{{MethodHeader|public native int GetDirectionToTrain(Train train)}}
;Parameters
*'''train''' = A reference to a train located within 15 track stretches of the junction.
;Returned Value
*One of the [[#Junction States|Junction State]] constants indicating the track on which the train was found.
;Syntax;
int approachPath = GetDirectionToTrain(train);
;Notes
*DIRECTION_NONE is returned if the train is not within range.
 

===GetGameObject===
{{MethodHeader|public native GameObject GetGameObject(void)}}
;Parameters
*None
;Returned Value
*A reference to the GameObject associated with this junction.
;Syntax;
GameObject go = junction.GetGameObject();
;Notes
*For a trackside spline junction this method returns the junction lever object.
*For an embedded junction in a fixed track junction the object returned is the embedded junction node.
*In either case null is returned on failure.
 

===GetManualControl===
{{MethodHeader|public native bool GetManualControl(void)}}
;Parameters
*None
;Returned Value
*True if the user is allowed to toggle this junction, false otherwise.
;Syntax;
bool locked = !GetManualControl();
;Notes
 

===GetMapObject===
{{MethodHeader|public native MapObject GetMapObject(void)}}
;Parameters
*None
;Returned Value
*A reference to the MapObject associated with this junction.
;Syntax;
MapObject mo = junction.GetMapObject();
;Notes
*For a trackside spline junction this method returns the junction lever object.
*For an embedded junction in a fixed track piece the object returned is the fixed track parent object.
*In either case null is returned on failure.
 

===JunctionInnerReEnter===
{{MethodHeader|public native bool JunctionInnerReEnter(int node)}}
;Parameters
*'''node''' = Node Id of train as returned by Train.GetId().
;Returned Value
*None
;Syntax;
junction.JunctionInnerReEnter(train);
;Notes
*The effect of this method is to cause a new ''Junction,InnerEnter'' message to be sent to the Junction if any part of the train is within the inner trigger radius.
 

===JunctionReEnter===
{{MethodHeader|public native bool JunctionReEnter(int node)}}
;Parameters
*'''node''' = Node Id of train as returned by Train.GetId().
;Returned Value
*None
;Syntax;
junction.JunctionReEnter(train);
;Notes
*The effect of this method is to cause a new ''Junction,Enter'' message to be sent to the Junction if any part of the train is within the default outer trigger radius.
 

===RequestPermit===
{{MethodHeader|public native Permit RequestPermit(GameObject obj)}}
;Parameters
*'''obj''' = Object requesting the [[Class Permit|Permit]].
;Returned Value
*Returns a Permit for ''obj'' to control the junction.
;Syntax;
Permit permit = RequestPermit(train);
;Notes
*Although a Permit is always returned, it may not necessarily be granted.
 

===RequestTrackPermit===
{{MethodHeader|public native Permit RequestTrackPermit(GameObject obj, int direction)}}
;Parameters
*'''obj''' = Object requesting the [[Class Permit|Permit]].
*'''direction''' = One of the [[#Junction States|Junction State]] constants indicating the direction of the track relative to the current junction.
;Returned Value
*Returns a Permit for ''obj'' to control the specified track.
;Syntax;
Permit permit = RequestTrackPermit(train, DIRECTION_LEFT);
;Notes
*Although a Permit is always returned, it may not necessarily be granted.
 

===SetDirection===
{{MethodHeader|public native bool SetDirection(SecurityToken myToken, int direction)}}
;Parameters
*'''direction''' = New direction to set.
;Returned Value
*True if the junction is changed, False if the direction is unchanged or if the specified direction was invalid for this junction.
;Syntax;
if (junction.SetDirection(myToken, DIRECTION_LEFT)) Interface.Print("Junction now set to the left");
;Notes
*This method switches the junction unconditionally, disregarding any Permits that may exist.
*If you do not include the SecurityToken, the method will be marked Obsolete.
 

===SwitchForTrain===
{{MethodHeader|public native bool SwitchForTrain(Train train, int direction)}}
;Parameters
*'''train''' = Train that is to pass over the junction.
*'''direction''' = One of the [[#Junction States|Junction State]] constants indicating the current position of the train relative junction.
;Returned Value
*True if the junction is changed, False if the direction is unchanged or if the specified direction was invalid for this junction.
;Syntax;
junction.SwitchForTrain(train,DIRECTION_BACKWARD);
;Notes
*The new direction must be on the opposite side of the junction to the train's current position.
*This method switches the junction unconditionally, disregarding any Permits that may exist.
 

==Related Methods==
[[Class SceneryWithTrack#GetAttachedJunctions|SceneryWithTrack.GetAttachedJunctions()]] 
[[Class World#GetJunctionList|World.GetJunctionList()]] 
 

==Categories==
[[Category:Script Class]]

Class JunctionBase

2022-10-24T15:51:12Z

Christopher824: /* SetDirection */

*[[TrainzScript Library Reference|API Hierarchy]]
**[[Class GSObject|GSObject]] *
***[[Class GameObject|GameObject]]
****[[Class TrainzGameObject|TrainzGameObject]]
****[[Class PropertyObject|PropertyObject]] *
*****[[Class MeshObject|MeshObject]]
******[[Class MapObject|MapObject]]
*******JunctionBase *

 
*Interface methods to control and obtain information about the status of Junction objects.
*This class relates equally to switch levers controlling spline track junctions and to the junction nodes attached to Fixed Track Junction objects.
 

==Constants & Messages==

===Junction States===
*These values define the directions possible through a junction object.
 
{{TableHeader|width=95%|margin=15px}}
|width=375|public define int DIRECTION_LEFT = 0 ||Left junction direction.
|-
|public define int DIRECTION_FORWARD = 1 ||Forward junction direction (straight on for three way points).
|-
|public define int DIRECTION_RIGHT = 2 ||Right junction direction.
|-
|public define int DIRECTION_BACKWARD = -1 ||Backward junction direction (leading approach).
|-
|public define int DIRECTION_NONE = 3 ||No junction direction or error condition.
|}
 

==Related Messages==
*Messages sent to and from Junction objects are listed below:
 
{{TableHeader|width=50%|margin=15px}}
|-
|bgcolor="#EEEEEE"|'''Major'''||bgcolor="#EEEEEE"|'''Minor'''||bgcolor="#EEEEEE"|'''Source'''||bgcolor="#EEEEEE" |'''Destination'''
|-
|Junction||Toggled||Junction||Broadcast
|-
|[[Object Messages|Junction]]||Enter||Junction||Train
|-
|[[Object Messages|Junction]]||InnerEnter||Junction||Train
|-
|[[Object Messages|Junction]]||Stopped||Junction||Train
|-
|[[Object Messages|Junction]]||InnerLeave||Junction||Train
|-
|[[Object Messages|Junction]]||Leave||Junction||Train
|-
|[[Object Messages|Object]]||Enter||Train||Junction
|-
|[[Object Messages|Object]]||InnerEnter||Train||Junction
|-
|[[Object Messages|Object]]||Stopped||Train||Junction
|-
|[[Object Messages|Object]]||InnerLeave||Train||Junction
|-
|[[Object Messages|Object]]||Leave||Train||Junction
|}
 

==Methods==

===AllowManualControl===
{{MethodHeader|public native voidAllowManualControl(bool allow)}}
;Parameters
*'''allow''' = True to allow the user to toggle the junction, false otherwise.
;Returned Value
*None
;Syntax;
AllowManualControl(true);
;Notes
 

===GetDebugString===
{{MethodHeader|public string GetDebugString(void)}}
;Parameters
*None
;Returned Value
*A string that contains the node ID and name of the MapObject associated with this junction. If successful, the returned string will include the node ID and name of the MapObject. Otherwise an error string will be returned instead.
;Syntax;
Interface.Print(GetDebugString());
;Notes
 

===GetDirection===
{{MethodHeader|public native int GetDirection(void)}}
;Parameters
*None
;Returned Value
*One of the [[#Junction States|Junction State]] constants indicating the current direction of the junction.
;Syntax;
int direction = GetDirection();
;Notes
 

===GetDirectionToTrain===
{{MethodHeader|public native int GetDirectionToTrain(Train train)}}
;Parameters
*'''train''' = A reference to a train located within 15 track stretches of the junction.
;Returned Value
*One of the [[#Junction States|Junction State]] constants indicating the track on which the train was found.
;Syntax;
int approachPath = GetDirectionToTrain(train);
;Notes
*DIRECTION_NONE is returned if the train is not within range.
 

===GetGameObject===
{{MethodHeader|public native GameObject GetGameObject(void)}}
;Parameters
*None
;Returned Value
*A reference to the GameObject associated with this junction.
;Syntax;
GameObject go = junction.GetGameObject();
;Notes
*For a trackside spline junction this method returns the junction lever object.
*For an embedded junction in a fixed track junction the object returned is the embedded junction node.
*In either case null is returned on failure.
 

===GetManualControl===
{{MethodHeader|public native bool GetManualControl(void)}}
;Parameters
*None
;Returned Value
*True if the user is allowed to toggle this junction, false otherwise.
;Syntax;
bool locked = !GetManualControl();
;Notes
 

===GetMapObject===
{{MethodHeader|public native MapObject GetMapObject(void)}}
;Parameters
*None
;Returned Value
*A reference to the MapObject associated with this junction.
;Syntax;
MapObject mo = junction.GetMapObject();
;Notes
*For a trackside spline junction this method returns the junction lever object.
*For an embedded junction in a fixed track piece the object returned is the fixed track parent object.
*In either case null is returned on failure.
 

===JunctionInnerReEnter===
{{MethodHeader|public native bool JunctionInnerReEnter(int node)}}
;Parameters
*'''node''' = Node Id of train as returned by Train.GetId().
;Returned Value
*None
;Syntax;
junction.JunctionInnerReEnter(train);
;Notes
*The effect of this method is to cause a new ''Junction,InnerEnter'' message to be sent to the Junction if any part of the train is within the inner trigger radius.
 

===JunctionReEnter===
{{MethodHeader|public native bool JunctionReEnter(int node)}}
;Parameters
*'''node''' = Node Id of train as returned by Train.GetId().
;Returned Value
*None
;Syntax;
junction.JunctionReEnter(train);
;Notes
*The effect of this method is to cause a new ''Junction,Enter'' message to be sent to the Junction if any part of the train is within the default outer trigger radius.
 

===RequestPermit===
{{MethodHeader|public native Permit RequestPermit(GameObject obj)}}
;Parameters
*'''obj''' = Object requesting the [[Class Permit|Permit]].
;Returned Value
*Returns a Permit for ''obj'' to control the junction.
;Syntax;
Permit permit = RequestPermit(train);
;Notes
*Although a Permit is always returned, it may not necessarily be granted.
 

===RequestTrackPermit===
{{MethodHeader|public native Permit RequestTrackPermit(GameObject obj, int direction)}}
;Parameters
*'''obj''' = Object requesting the [[Class Permit|Permit]].
*'''direction''' = One of the [[#Junction States|Junction State]] constants indicating the direction of the track relative to the current junction.
;Returned Value
*Returns a Permit for ''obj'' to control the specified track.
;Syntax;
Permit permit = RequestTrackPermit(train, DIRECTION_LEFT);
;Notes
*Although a Permit is always returned, it may not necessarily be granted.
 

===SetDirection===
{{MethodHeader|public native bool SetDirection(SecurityToken sToken, int direction)}}
;Parameters
*'''direction''' = New direction to set.
;Returned Value
*True if the junction is changed, False if the direction is unchanged or if the specified direction was invalid for this junction.
;Syntax;
if (junction.SetDirection(sToken, DIRECTION_LEFT)) Interface.Print("Junction now set to the left");
;Notes
*This method switches the junction unconditionally, disregarding any Permits that may exist.
*If you do not include the SecurityToken, the method will be marked Obsolete.
 

===SwitchForTrain===
{{MethodHeader|public native bool SwitchForTrain(Train train, int direction)}}
;Parameters
*'''train''' = Train that is to pass over the junction.
*'''direction''' = One of the [[#Junction States|Junction State]] constants indicating the current position of the train relative junction.
;Returned Value
*True if the junction is changed, False if the direction is unchanged or if the specified direction was invalid for this junction.
;Syntax;
junction.SwitchForTrain(train,DIRECTION_BACKWARD);
;Notes
*The new direction must be on the opposite side of the junction to the train's current position.
*This method switches the junction unconditionally, disregarding any Permits that may exist.
 

==Related Methods==
[[Class SceneryWithTrack#GetAttachedJunctions|SceneryWithTrack.GetAttachedJunctions()]] 
[[Class World#GetJunctionList|World.GetJunctionList()]] 
 

==Categories==
[[Category:Script Class]]

Class JunctionBase

2022-10-24T15:46:07Z

Christopher824: /* SetDirection */

*[[TrainzScript Library Reference|API Hierarchy]]
**[[Class GSObject|GSObject]] *
***[[Class GameObject|GameObject]]
****[[Class TrainzGameObject|TrainzGameObject]]
****[[Class PropertyObject|PropertyObject]] *
*****[[Class MeshObject|MeshObject]]
******[[Class MapObject|MapObject]]
*******JunctionBase *

 
*Interface methods to control and obtain information about the status of Junction objects.
*This class relates equally to switch levers controlling spline track junctions and to the junction nodes attached to Fixed Track Junction objects.
 

==Constants & Messages==

===Junction States===
*These values define the directions possible through a junction object.
 
{{TableHeader|width=95%|margin=15px}}
|width=375|public define int DIRECTION_LEFT = 0 ||Left junction direction.
|-
|public define int DIRECTION_FORWARD = 1 ||Forward junction direction (straight on for three way points).
|-
|public define int DIRECTION_RIGHT = 2 ||Right junction direction.
|-
|public define int DIRECTION_BACKWARD = -1 ||Backward junction direction (leading approach).
|-
|public define int DIRECTION_NONE = 3 ||No junction direction or error condition.
|}
 

==Related Messages==
*Messages sent to and from Junction objects are listed below:
 
{{TableHeader|width=50%|margin=15px}}
|-
|bgcolor="#EEEEEE"|'''Major'''||bgcolor="#EEEEEE"|'''Minor'''||bgcolor="#EEEEEE"|'''Source'''||bgcolor="#EEEEEE" |'''Destination'''
|-
|Junction||Toggled||Junction||Broadcast
|-
|[[Object Messages|Junction]]||Enter||Junction||Train
|-
|[[Object Messages|Junction]]||InnerEnter||Junction||Train
|-
|[[Object Messages|Junction]]||Stopped||Junction||Train
|-
|[[Object Messages|Junction]]||InnerLeave||Junction||Train
|-
|[[Object Messages|Junction]]||Leave||Junction||Train
|-
|[[Object Messages|Object]]||Enter||Train||Junction
|-
|[[Object Messages|Object]]||InnerEnter||Train||Junction
|-
|[[Object Messages|Object]]||Stopped||Train||Junction
|-
|[[Object Messages|Object]]||InnerLeave||Train||Junction
|-
|[[Object Messages|Object]]||Leave||Train||Junction
|}
 

==Methods==

===AllowManualControl===
{{MethodHeader|public native voidAllowManualControl(bool allow)}}
;Parameters
*'''allow''' = True to allow the user to toggle the junction, false otherwise.
;Returned Value
*None
;Syntax;
AllowManualControl(true);
;Notes
 

===GetDebugString===
{{MethodHeader|public string GetDebugString(void)}}
;Parameters
*None
;Returned Value
*A string that contains the node ID and name of the MapObject associated with this junction. If successful, the returned string will include the node ID and name of the MapObject. Otherwise an error string will be returned instead.
;Syntax;
Interface.Print(GetDebugString());
;Notes
 

===GetDirection===
{{MethodHeader|public native int GetDirection(void)}}
;Parameters
*None
;Returned Value
*One of the [[#Junction States|Junction State]] constants indicating the current direction of the junction.
;Syntax;
int direction = GetDirection();
;Notes
 

===GetDirectionToTrain===
{{MethodHeader|public native int GetDirectionToTrain(Train train)}}
;Parameters
*'''train''' = A reference to a train located within 15 track stretches of the junction.
;Returned Value
*One of the [[#Junction States|Junction State]] constants indicating the track on which the train was found.
;Syntax;
int approachPath = GetDirectionToTrain(train);
;Notes
*DIRECTION_NONE is returned if the train is not within range.
 

===GetGameObject===
{{MethodHeader|public native GameObject GetGameObject(void)}}
;Parameters
*None
;Returned Value
*A reference to the GameObject associated with this junction.
;Syntax;
GameObject go = junction.GetGameObject();
;Notes
*For a trackside spline junction this method returns the junction lever object.
*For an embedded junction in a fixed track junction the object returned is the embedded junction node.
*In either case null is returned on failure.
 

===GetManualControl===
{{MethodHeader|public native bool GetManualControl(void)}}
;Parameters
*None
;Returned Value
*True if the user is allowed to toggle this junction, false otherwise.
;Syntax;
bool locked = !GetManualControl();
;Notes
 

===GetMapObject===
{{MethodHeader|public native MapObject GetMapObject(void)}}
;Parameters
*None
;Returned Value
*A reference to the MapObject associated with this junction.
;Syntax;
MapObject mo = junction.GetMapObject();
;Notes
*For a trackside spline junction this method returns the junction lever object.
*For an embedded junction in a fixed track piece the object returned is the fixed track parent object.
*In either case null is returned on failure.
 

===JunctionInnerReEnter===
{{MethodHeader|public native bool JunctionInnerReEnter(int node)}}
;Parameters
*'''node''' = Node Id of train as returned by Train.GetId().
;Returned Value
*None
;Syntax;
junction.JunctionInnerReEnter(train);
;Notes
*The effect of this method is to cause a new ''Junction,InnerEnter'' message to be sent to the Junction if any part of the train is within the inner trigger radius.
 

===JunctionReEnter===
{{MethodHeader|public native bool JunctionReEnter(int node)}}
;Parameters
*'''node''' = Node Id of train as returned by Train.GetId().
;Returned Value
*None
;Syntax;
junction.JunctionReEnter(train);
;Notes
*The effect of this method is to cause a new ''Junction,Enter'' message to be sent to the Junction if any part of the train is within the default outer trigger radius.
 

===RequestPermit===
{{MethodHeader|public native Permit RequestPermit(GameObject obj)}}
;Parameters
*'''obj''' = Object requesting the [[Class Permit|Permit]].
;Returned Value
*Returns a Permit for ''obj'' to control the junction.
;Syntax;
Permit permit = RequestPermit(train);
;Notes
*Although a Permit is always returned, it may not necessarily be granted.
 

===RequestTrackPermit===
{{MethodHeader|public native Permit RequestTrackPermit(GameObject obj, int direction)}}
;Parameters
*'''obj''' = Object requesting the [[Class Permit|Permit]].
*'''direction''' = One of the [[#Junction States|Junction State]] constants indicating the direction of the track relative to the current junction.
;Returned Value
*Returns a Permit for ''obj'' to control the specified track.
;Syntax;
Permit permit = RequestTrackPermit(train, DIRECTION_LEFT);
;Notes
*Although a Permit is always returned, it may not necessarily be granted.
 

===SetDirection===
{{MethodHeader|public native bool SetDirection(SecurityToken, int direction)}}
;Parameters
*'''direction''' = New direction to set.
;Returned Value
*True if the junction is changed, False if the direction is unchanged or if the specified direction was invalid for this junction.
;Syntax;
if (junction.SetDirection(SecurityToken, DIRECTION_LEFT)) Interface.Print("Junction now set to the left");
;Notes
*This method switches the junction unconditionally, disregarding any Permits that may exist.
*If you do not include the SecurityToken, the method will be marked Obsolete.
 

===SwitchForTrain===
{{MethodHeader|public native bool SwitchForTrain(Train train, int direction)}}
;Parameters
*'''train''' = Train that is to pass over the junction.
*'''direction''' = One of the [[#Junction States|Junction State]] constants indicating the current position of the train relative junction.
;Returned Value
*True if the junction is changed, False if the direction is unchanged or if the specified direction was invalid for this junction.
;Syntax;
junction.SwitchForTrain(train,DIRECTION_BACKWARD);
;Notes
*The new direction must be on the opposite side of the junction to the train's current position.
*This method switches the junction unconditionally, disregarding any Permits that may exist.
 

==Related Methods==
[[Class SceneryWithTrack#GetAttachedJunctions|SceneryWithTrack.GetAttachedJunctions()]] 
[[Class World#GetJunctionList|World.GetJunctionList()]] 
 

==Categories==
[[Category:Script Class]]

Class JunctionBase

2022-10-24T15:45:51Z

Christopher824: /* SetDirection */

*[[TrainzScript Library Reference|API Hierarchy]]
**[[Class GSObject|GSObject]] *
***[[Class GameObject|GameObject]]
****[[Class TrainzGameObject|TrainzGameObject]]
****[[Class PropertyObject|PropertyObject]] *
*****[[Class MeshObject|MeshObject]]
******[[Class MapObject|MapObject]]
*******JunctionBase *

 
*Interface methods to control and obtain information about the status of Junction objects.
*This class relates equally to switch levers controlling spline track junctions and to the junction nodes attached to Fixed Track Junction objects.
 

==Constants & Messages==

===Junction States===
*These values define the directions possible through a junction object.
 
{{TableHeader|width=95%|margin=15px}}
|width=375|public define int DIRECTION_LEFT = 0 ||Left junction direction.
|-
|public define int DIRECTION_FORWARD = 1 ||Forward junction direction (straight on for three way points).
|-
|public define int DIRECTION_RIGHT = 2 ||Right junction direction.
|-
|public define int DIRECTION_BACKWARD = -1 ||Backward junction direction (leading approach).
|-
|public define int DIRECTION_NONE = 3 ||No junction direction or error condition.
|}
 

==Related Messages==
*Messages sent to and from Junction objects are listed below:
 
{{TableHeader|width=50%|margin=15px}}
|-
|bgcolor="#EEEEEE"|'''Major'''||bgcolor="#EEEEEE"|'''Minor'''||bgcolor="#EEEEEE"|'''Source'''||bgcolor="#EEEEEE" |'''Destination'''
|-
|Junction||Toggled||Junction||Broadcast
|-
|[[Object Messages|Junction]]||Enter||Junction||Train
|-
|[[Object Messages|Junction]]||InnerEnter||Junction||Train
|-
|[[Object Messages|Junction]]||Stopped||Junction||Train
|-
|[[Object Messages|Junction]]||InnerLeave||Junction||Train
|-
|[[Object Messages|Junction]]||Leave||Junction||Train
|-
|[[Object Messages|Object]]||Enter||Train||Junction
|-
|[[Object Messages|Object]]||InnerEnter||Train||Junction
|-
|[[Object Messages|Object]]||Stopped||Train||Junction
|-
|[[Object Messages|Object]]||InnerLeave||Train||Junction
|-
|[[Object Messages|Object]]||Leave||Train||Junction
|}
 

==Methods==

===AllowManualControl===
{{MethodHeader|public native voidAllowManualControl(bool allow)}}
;Parameters
*'''allow''' = True to allow the user to toggle the junction, false otherwise.
;Returned Value
*None
;Syntax;
AllowManualControl(true);
;Notes
 

===GetDebugString===
{{MethodHeader|public string GetDebugString(void)}}
;Parameters
*None
;Returned Value
*A string that contains the node ID and name of the MapObject associated with this junction. If successful, the returned string will include the node ID and name of the MapObject. Otherwise an error string will be returned instead.
;Syntax;
Interface.Print(GetDebugString());
;Notes
 

===GetDirection===
{{MethodHeader|public native int GetDirection(void)}}
;Parameters
*None
;Returned Value
*One of the [[#Junction States|Junction State]] constants indicating the current direction of the junction.
;Syntax;
int direction = GetDirection();
;Notes
 

===GetDirectionToTrain===
{{MethodHeader|public native int GetDirectionToTrain(Train train)}}
;Parameters
*'''train''' = A reference to a train located within 15 track stretches of the junction.
;Returned Value
*One of the [[#Junction States|Junction State]] constants indicating the track on which the train was found.
;Syntax;
int approachPath = GetDirectionToTrain(train);
;Notes
*DIRECTION_NONE is returned if the train is not within range.
 

===GetGameObject===
{{MethodHeader|public native GameObject GetGameObject(void)}}
;Parameters
*None
;Returned Value
*A reference to the GameObject associated with this junction.
;Syntax;
GameObject go = junction.GetGameObject();
;Notes
*For a trackside spline junction this method returns the junction lever object.
*For an embedded junction in a fixed track junction the object returned is the embedded junction node.
*In either case null is returned on failure.
 

===GetManualControl===
{{MethodHeader|public native bool GetManualControl(void)}}
;Parameters
*None
;Returned Value
*True if the user is allowed to toggle this junction, false otherwise.
;Syntax;
bool locked = !GetManualControl();
;Notes
 

===GetMapObject===
{{MethodHeader|public native MapObject GetMapObject(void)}}
;Parameters
*None
;Returned Value
*A reference to the MapObject associated with this junction.
;Syntax;
MapObject mo = junction.GetMapObject();
;Notes
*For a trackside spline junction this method returns the junction lever object.
*For an embedded junction in a fixed track piece the object returned is the fixed track parent object.
*In either case null is returned on failure.
 

===JunctionInnerReEnter===
{{MethodHeader|public native bool JunctionInnerReEnter(int node)}}
;Parameters
*'''node''' = Node Id of train as returned by Train.GetId().
;Returned Value
*None
;Syntax;
junction.JunctionInnerReEnter(train);
;Notes
*The effect of this method is to cause a new ''Junction,InnerEnter'' message to be sent to the Junction if any part of the train is within the inner trigger radius.
 

===JunctionReEnter===
{{MethodHeader|public native bool JunctionReEnter(int node)}}
;Parameters
*'''node''' = Node Id of train as returned by Train.GetId().
;Returned Value
*None
;Syntax;
junction.JunctionReEnter(train);
;Notes
*The effect of this method is to cause a new ''Junction,Enter'' message to be sent to the Junction if any part of the train is within the default outer trigger radius.
 

===RequestPermit===
{{MethodHeader|public native Permit RequestPermit(GameObject obj)}}
;Parameters
*'''obj''' = Object requesting the [[Class Permit|Permit]].
;Returned Value
*Returns a Permit for ''obj'' to control the junction.
;Syntax;
Permit permit = RequestPermit(train);
;Notes
*Although a Permit is always returned, it may not necessarily be granted.
 

===RequestTrackPermit===
{{MethodHeader|public native Permit RequestTrackPermit(GameObject obj, int direction)}}
;Parameters
*'''obj''' = Object requesting the [[Class Permit|Permit]].
*'''direction''' = One of the [[#Junction States|Junction State]] constants indicating the direction of the track relative to the current junction.
;Returned Value
*Returns a Permit for ''obj'' to control the specified track.
;Syntax;
Permit permit = RequestTrackPermit(train, DIRECTION_LEFT);
;Notes
*Although a Permit is always returned, it may not necessarily be granted.
 

===SetDirection===
{{MethodHeader|public native bool SetDirection (SecurityToken, int direction)}}
;Parameters
*'''direction''' = New direction to set.
;Returned Value
*True if the junction is changed, False if the direction is unchanged or if the specified direction was invalid for this junction.
;Syntax;
if (junction.SetDirection(SecurityToken, DIRECTION_LEFT)) Interface.Print("Junction now set to the left");
;Notes
*This method switches the junction unconditionally, disregarding any Permits that may exist.
*If you do not include the SecurityToken, the method will be marked Obsolete.
 

===SwitchForTrain===
{{MethodHeader|public native bool SwitchForTrain(Train train, int direction)}}
;Parameters
*'''train''' = Train that is to pass over the junction.
*'''direction''' = One of the [[#Junction States|Junction State]] constants indicating the current position of the train relative junction.
;Returned Value
*True if the junction is changed, False if the direction is unchanged or if the specified direction was invalid for this junction.
;Syntax;
junction.SwitchForTrain(train,DIRECTION_BACKWARD);
;Notes
*The new direction must be on the opposite side of the junction to the train's current position.
*This method switches the junction unconditionally, disregarding any Permits that may exist.
 

==Related Methods==
[[Class SceneryWithTrack#GetAttachedJunctions|SceneryWithTrack.GetAttachedJunctions()]] 
[[Class World#GetJunctionList|World.GetJunctionList()]] 
 

==Categories==
[[Category:Script Class]]

Class JunctionBase

2022-10-24T15:44:32Z

Christopher824: /* SetDirection */

*[[TrainzScript Library Reference|API Hierarchy]]
**[[Class GSObject|GSObject]] *
***[[Class GameObject|GameObject]]
****[[Class TrainzGameObject|TrainzGameObject]]
****[[Class PropertyObject|PropertyObject]] *
*****[[Class MeshObject|MeshObject]]
******[[Class MapObject|MapObject]]
*******JunctionBase *

 
*Interface methods to control and obtain information about the status of Junction objects.
*This class relates equally to switch levers controlling spline track junctions and to the junction nodes attached to Fixed Track Junction objects.
 

==Constants & Messages==

===Junction States===
*These values define the directions possible through a junction object.
 
{{TableHeader|width=95%|margin=15px}}
|width=375|public define int DIRECTION_LEFT = 0 ||Left junction direction.
|-
|public define int DIRECTION_FORWARD = 1 ||Forward junction direction (straight on for three way points).
|-
|public define int DIRECTION_RIGHT = 2 ||Right junction direction.
|-
|public define int DIRECTION_BACKWARD = -1 ||Backward junction direction (leading approach).
|-
|public define int DIRECTION_NONE = 3 ||No junction direction or error condition.
|}
 

==Related Messages==
*Messages sent to and from Junction objects are listed below:
 
{{TableHeader|width=50%|margin=15px}}
|-
|bgcolor="#EEEEEE"|'''Major'''||bgcolor="#EEEEEE"|'''Minor'''||bgcolor="#EEEEEE"|'''Source'''||bgcolor="#EEEEEE" |'''Destination'''
|-
|Junction||Toggled||Junction||Broadcast
|-
|[[Object Messages|Junction]]||Enter||Junction||Train
|-
|[[Object Messages|Junction]]||InnerEnter||Junction||Train
|-
|[[Object Messages|Junction]]||Stopped||Junction||Train
|-
|[[Object Messages|Junction]]||InnerLeave||Junction||Train
|-
|[[Object Messages|Junction]]||Leave||Junction||Train
|-
|[[Object Messages|Object]]||Enter||Train||Junction
|-
|[[Object Messages|Object]]||InnerEnter||Train||Junction
|-
|[[Object Messages|Object]]||Stopped||Train||Junction
|-
|[[Object Messages|Object]]||InnerLeave||Train||Junction
|-
|[[Object Messages|Object]]||Leave||Train||Junction
|}
 

==Methods==

===AllowManualControl===
{{MethodHeader|public native voidAllowManualControl(bool allow)}}
;Parameters
*'''allow''' = True to allow the user to toggle the junction, false otherwise.
;Returned Value
*None
;Syntax;
AllowManualControl(true);
;Notes
 

===GetDebugString===
{{MethodHeader|public string GetDebugString(void)}}
;Parameters
*None
;Returned Value
*A string that contains the node ID and name of the MapObject associated with this junction. If successful, the returned string will include the node ID and name of the MapObject. Otherwise an error string will be returned instead.
;Syntax;
Interface.Print(GetDebugString());
;Notes
 

===GetDirection===
{{MethodHeader|public native int GetDirection(void)}}
;Parameters
*None
;Returned Value
*One of the [[#Junction States|Junction State]] constants indicating the current direction of the junction.
;Syntax;
int direction = GetDirection();
;Notes
 

===GetDirectionToTrain===
{{MethodHeader|public native int GetDirectionToTrain(Train train)}}
;Parameters
*'''train''' = A reference to a train located within 15 track stretches of the junction.
;Returned Value
*One of the [[#Junction States|Junction State]] constants indicating the track on which the train was found.
;Syntax;
int approachPath = GetDirectionToTrain(train);
;Notes
*DIRECTION_NONE is returned if the train is not within range.
 

===GetGameObject===
{{MethodHeader|public native GameObject GetGameObject(void)}}
;Parameters
*None
;Returned Value
*A reference to the GameObject associated with this junction.
;Syntax;
GameObject go = junction.GetGameObject();
;Notes
*For a trackside spline junction this method returns the junction lever object.
*For an embedded junction in a fixed track junction the object returned is the embedded junction node.
*In either case null is returned on failure.
 

===GetManualControl===
{{MethodHeader|public native bool GetManualControl(void)}}
;Parameters
*None
;Returned Value
*True if the user is allowed to toggle this junction, false otherwise.
;Syntax;
bool locked = !GetManualControl();
;Notes
 

===GetMapObject===
{{MethodHeader|public native MapObject GetMapObject(void)}}
;Parameters
*None
;Returned Value
*A reference to the MapObject associated with this junction.
;Syntax;
MapObject mo = junction.GetMapObject();
;Notes
*For a trackside spline junction this method returns the junction lever object.
*For an embedded junction in a fixed track piece the object returned is the fixed track parent object.
*In either case null is returned on failure.
 

===JunctionInnerReEnter===
{{MethodHeader|public native bool JunctionInnerReEnter(int node)}}
;Parameters
*'''node''' = Node Id of train as returned by Train.GetId().
;Returned Value
*None
;Syntax;
junction.JunctionInnerReEnter(train);
;Notes
*The effect of this method is to cause a new ''Junction,InnerEnter'' message to be sent to the Junction if any part of the train is within the inner trigger radius.
 

===JunctionReEnter===
{{MethodHeader|public native bool JunctionReEnter(int node)}}
;Parameters
*'''node''' = Node Id of train as returned by Train.GetId().
;Returned Value
*None
;Syntax;
junction.JunctionReEnter(train);
;Notes
*The effect of this method is to cause a new ''Junction,Enter'' message to be sent to the Junction if any part of the train is within the default outer trigger radius.
 

===RequestPermit===
{{MethodHeader|public native Permit RequestPermit(GameObject obj)}}
;Parameters
*'''obj''' = Object requesting the [[Class Permit|Permit]].
;Returned Value
*Returns a Permit for ''obj'' to control the junction.
;Syntax;
Permit permit = RequestPermit(train);
;Notes
*Although a Permit is always returned, it may not necessarily be granted.
 

===RequestTrackPermit===
{{MethodHeader|public native Permit RequestTrackPermit(GameObject obj, int direction)}}
;Parameters
*'''obj''' = Object requesting the [[Class Permit|Permit]].
*'''direction''' = One of the [[#Junction States|Junction State]] constants indicating the direction of the track relative to the current junction.
;Returned Value
*Returns a Permit for ''obj'' to control the specified track.
;Syntax;
Permit permit = RequestTrackPermit(train, DIRECTION_LEFT);
;Notes
*Although a Permit is always returned, it may not necessarily be granted.
 

===SetDirection===
{{MethodHeader|public native bool SetDirection (SecurityToken, int direction)}}
;Parameters
*'''direction''' = New direction to set.
;Returned Value
*True if the junction is changed, False if the direction is unchanged or if the specified direction was invalid for this junction.
;Syntax;
if (junction.SetDirection(DIRECTION_LEFT)) Interface.Print("Junction now set to the left");
;Notes
*This method switches the junction unconditionally, disregarding any Permits that may exist.
*If you do not include the SecurityToken, the method will be labeled Obsolete.
 

===SwitchForTrain===
{{MethodHeader|public native bool SwitchForTrain(Train train, int direction)}}
;Parameters
*'''train''' = Train that is to pass over the junction.
*'''direction''' = One of the [[#Junction States|Junction State]] constants indicating the current position of the train relative junction.
;Returned Value
*True if the junction is changed, False if the direction is unchanged or if the specified direction was invalid for this junction.
;Syntax;
junction.SwitchForTrain(train,DIRECTION_BACKWARD);
;Notes
*The new direction must be on the opposite side of the junction to the train's current position.
*This method switches the junction unconditionally, disregarding any Permits that may exist.
 

==Related Methods==
[[Class SceneryWithTrack#GetAttachedJunctions|SceneryWithTrack.GetAttachedJunctions()]] 
[[Class World#GetJunctionList|World.GetJunctionList()]] 
 

==Categories==
[[Category:Script Class]]

Class Router

2022-10-12T17:29:53Z

Christopher824: /* PostMessage */

__FORCETOC__
*[[TrainzScript Language Reference|API Hierarchy]]
**Router
 

*The Router class handles the transmission of messages between game objects and contains methods to provide references to specific objects given their name or Id.
 

==Constants==

{{TableHeader|width=95%|margin=15px}}
|-
|public define int MESSAGE_BROADCAST = 0||The message will be sent to all objects in the Router
|}
 

==GetGameObject==
{{MethodHeader|public native GameObject GetGameObject(string uniqueName) public native GameObject GetGameObject(int uniqueId)}}
;Parameters
*'''uniqueName''' = Name of object as assigned in Surveyor.
*'''uniqueId''' = Id of object as assigned by the Router for each session.
;Returned Value
*A reference to the GameObject described, null if no such object exists.
;Syntax
GameObject go = Router.GetGameObject(vehicle.GetName());
;Notes
*The objects name will normally be its username with a unique serial added by the game when the object is placed.
*This name can be edited by the user.
*Remember that not all objects will be named.
*Although Surveyor issues a warning on any attempt to name an object using a name which already exists, no restriction is actually enforced.
*As a result it is possible that a name will not be unique.
*Reference to an object's Id on the other hand is guaranteed to be unique for the current session.
*Ids are not preserved between sessions.
 

==Info==
{{MethodHeader|public native void Router.Info(void)}}
;Parameters
*None
;Returned Value
*None
;Syntax
Router.Info();
;Notes
*Logs current Router information to ''jetlog.txt''.
*Used for debugging a session.
 

==PostMessage==
{{MethodHeader|public obsolete native void PostMessage(int srcId, int dstId, string major, string minor, float delay)}}
;Parameters
*'''srcId''' = GameObject to specify as the message source.
*'''dstId''' = GameObject to specify as the message destination.
*'''major''' = Message major string.
*'''minor''' = Message minor string.
*'''delay''' = Number of seconds to wait before the message is dispatched, can be 0.0.
;Returned Value
*None
;Syntax
Router.PostMessage(Router,Router.MESSAGE_BROADCAST,"Sinking","StartThePumps",0.0);
;Notes
*Router.PostMessage provides the facility for code which does not belong to a GameObject thread to post a message,
*Since these scripts will not have a GameObject Id an alternative source must be specified.
*Specifying ''0'' as the source will make the message apper to emanate from the Router itself.
*Specifying MESSAGE_BROADCAST as the destination will send the message to all GameObjects on the map.
 
This Method is obsolete, it uses an integer lookup with the Router, which now needs to be an object lookup. To use PostMessage without the Router, use a GameObject PostMessage instead. Only the destination is required.

Was - Router.PostMessage (me.GetId(), me.GetId(), "Timer-Event", "", 2.0);
Now - PostMessage(me, "Timer-Event", "", 2.0);

Was - Router.PostMessage (me.GetId(), nMyTrainID, "Animation-Event", "Left-Opening", 0.0);
Now - PostMessage(myTrain, "Animation-Event", "Left-Opening", 0.0);

Was - MeshObject objAsset = cast<MeshObject>Router.GetGameObject(sAssetName);
Now - MeshObject objAsset = cast<MeshObject>(cast<GameObject> msg.src);
 

==Related Methods==
*[[Class GameObject#ClearMessages|GameObject.ClearMessages()]]
*[[Class GameObject#PostMessage|GameObject.PostMessage()]]
*[[Class GameObject#SendMessage|GameObject.SendMessage()]]
*[[Class GameObject#Sniff|GameObject.Sniff()]]

==Categories==
[[Category:Script Class]]

Class Router

2022-10-12T17:24:28Z

Christopher824: /* PostMessage */

__FORCETOC__
*[[TrainzScript Language Reference|API Hierarchy]]
**Router
 

*The Router class handles the transmission of messages between game objects and contains methods to provide references to specific objects given their name or Id.
 

==Constants==

{{TableHeader|width=95%|margin=15px}}
|-
|public define int MESSAGE_BROADCAST = 0||The message will be sent to all objects in the Router
|}
 

==GetGameObject==
{{MethodHeader|public native GameObject GetGameObject(string uniqueName) public native GameObject GetGameObject(int uniqueId)}}
;Parameters
*'''uniqueName''' = Name of object as assigned in Surveyor.
*'''uniqueId''' = Id of object as assigned by the Router for each session.
;Returned Value
*A reference to the GameObject described, null if no such object exists.
;Syntax
GameObject go = Router.GetGameObject(vehicle.GetName());
;Notes
*The objects name will normally be its username with a unique serial added by the game when the object is placed.
*This name can be edited by the user.
*Remember that not all objects will be named.
*Although Surveyor issues a warning on any attempt to name an object using a name which already exists, no restriction is actually enforced.
*As a result it is possible that a name will not be unique.
*Reference to an object's Id on the other hand is guaranteed to be unique for the current session.
*Ids are not preserved between sessions.
 

==Info==
{{MethodHeader|public native void Router.Info(void)}}
;Parameters
*None
;Returned Value
*None
;Syntax
Router.Info();
;Notes
*Logs current Router information to ''jetlog.txt''.
*Used for debugging a session.
 

==PostMessage==
{{MethodHeader|public obsolete native void PostMessage(int srcId, int dstId, string major, string minor, float delay)}}
;Parameters
*'''srcId''' = GameObject to specify as the message source.
*'''dstId''' = GameObject to specify as the message destination.
*'''major''' = Message major string.
*'''minor''' = Message minor string.
*'''delay''' = Number of seconds to wait before the message is dispatched, can be 0.0.
;Returned Value
*None
;Syntax
Router.PostMessage(Router,Router.MESSAGE_BROADCAST,"Sinking","StartThePumps",0.0);
;Notes
*Router.PostMessage provides the facility for code which does not belong to a GameObject thread to post a message,
*Since these scripts will not have a GameObject Id an alternative source must be specified.
*Specifying ''0'' as the source will make the message apper to emanate from the Router itself.
*Specifying MESSAGE_BROADCAST as the destination will send the message to all GameObjects on the map.
 
This Method is obsolete, it uses an integer lookup with the Router, which now needs to be an object lookup. To use PostMessage without the Router, use a GameObject PostMessage instead. Only the destination is required.

Was - Router.PostMessage (me.GetId(), me.GetId(), "Timer-Event", "", 2.0);
Now - PostMessage(me, "Timer-Event", "", 2.0);

Was - Router.PostMessage (me.GetId(), nMyTrainID, "Animation-Event", "Left-Opening", 0.0);
Now - PostMessage(myTrain, "Animation-Event", "Left-Opening", 0.0);

==Related Methods==
*[[Class GameObject#ClearMessages|GameObject.ClearMessages()]]
*[[Class GameObject#PostMessage|GameObject.PostMessage()]]
*[[Class GameObject#SendMessage|GameObject.SendMessage()]]
*[[Class GameObject#Sniff|GameObject.Sniff()]]

==Categories==
[[Category:Script Class]]

Class Router

2022-10-12T17:21:20Z

Christopher824: /* PostMessage */

__FORCETOC__
*[[TrainzScript Language Reference|API Hierarchy]]
**Router
 

*The Router class handles the transmission of messages between game objects and contains methods to provide references to specific objects given their name or Id.
 

==Constants==

{{TableHeader|width=95%|margin=15px}}
|-
|public define int MESSAGE_BROADCAST = 0||The message will be sent to all objects in the Router
|}
 

==GetGameObject==
{{MethodHeader|public native GameObject GetGameObject(string uniqueName) public native GameObject GetGameObject(int uniqueId)}}
;Parameters
*'''uniqueName''' = Name of object as assigned in Surveyor.
*'''uniqueId''' = Id of object as assigned by the Router for each session.
;Returned Value
*A reference to the GameObject described, null if no such object exists.
;Syntax
GameObject go = Router.GetGameObject(vehicle.GetName());
;Notes
*The objects name will normally be its username with a unique serial added by the game when the object is placed.
*This name can be edited by the user.
*Remember that not all objects will be named.
*Although Surveyor issues a warning on any attempt to name an object using a name which already exists, no restriction is actually enforced.
*As a result it is possible that a name will not be unique.
*Reference to an object's Id on the other hand is guaranteed to be unique for the current session.
*Ids are not preserved between sessions.
 

==Info==
{{MethodHeader|public native void Router.Info(void)}}
;Parameters
*None
;Returned Value
*None
;Syntax
Router.Info();
;Notes
*Logs current Router information to ''jetlog.txt''.
*Used for debugging a session.
 

==PostMessage==
{{MethodHeader|public obsolete native void PostMessage(int srcId, int dstId, string major, string minor, float delay)}}
;Parameters
*'''srcId''' = GameObject to specify as the message source.
*'''dstId''' = GameObject to specify as the message destination.
*'''major''' = Message major string.
*'''minor''' = Message minor string.
*'''delay''' = Number of seconds to wait before the message is dispatched, can be 0.0.
;Returned Value
*None
;Syntax
Router.PostMessage(Router,Router.MESSAGE_BROADCAST,"Sinking","StartThePumps",0.0);
;Notes
*Router.PostMessage provides the facility for code which does not belong to a GameObject thread to post a message,
*Since these scripts will not have a GameObject Id an alternative source must be specified.
*Specifying ''0'' as the source will make the message apper to emanate from the Router itself.
*Specifying MESSAGE_BROADCAST as the destination will send the message to all GameObjects on the map.
 
This Method is obsolete, it uses an integer lookup with the Router, which now needs to be an object lookup. To use PostMessage without the Router, use a GameObject PostMessage instead. Only the destination is required.

Was - Router.PostMessage (me.GetId(), me.GetId(), "Timer-Event", "", 2.0);
Now - PostMessage(me, "Timer-Event", "", 2.0);

Was - Router.PostMessage (me.GetId(), nMyTrainID, "Animation-Event", "Left-Opening", 0.0);
Now - PostMessage(myTrain, "Timer-Event", "", 0.0);

==Related Methods==
*[[Class GameObject#ClearMessages|GameObject.ClearMessages()]]
*[[Class GameObject#PostMessage|GameObject.PostMessage()]]
*[[Class GameObject#SendMessage|GameObject.SendMessage()]]
*[[Class GameObject#Sniff|GameObject.Sniff()]]

==Categories==
[[Category:Script Class]]

Class Router

2022-10-12T17:09:33Z

Christopher824: /* PostMessage */

__FORCETOC__
*[[TrainzScript Language Reference|API Hierarchy]]
**Router
 

*The Router class handles the transmission of messages between game objects and contains methods to provide references to specific objects given their name or Id.
 

==Constants==

{{TableHeader|width=95%|margin=15px}}
|-
|public define int MESSAGE_BROADCAST = 0||The message will be sent to all objects in the Router
|}
 

==GetGameObject==
{{MethodHeader|public native GameObject GetGameObject(string uniqueName) public native GameObject GetGameObject(int uniqueId)}}
;Parameters
*'''uniqueName''' = Name of object as assigned in Surveyor.
*'''uniqueId''' = Id of object as assigned by the Router for each session.
;Returned Value
*A reference to the GameObject described, null if no such object exists.
;Syntax
GameObject go = Router.GetGameObject(vehicle.GetName());
;Notes
*The objects name will normally be its username with a unique serial added by the game when the object is placed.
*This name can be edited by the user.
*Remember that not all objects will be named.
*Although Surveyor issues a warning on any attempt to name an object using a name which already exists, no restriction is actually enforced.
*As a result it is possible that a name will not be unique.
*Reference to an object's Id on the other hand is guaranteed to be unique for the current session.
*Ids are not preserved between sessions.
 

==Info==
{{MethodHeader|public native void Router.Info(void)}}
;Parameters
*None
;Returned Value
*None
;Syntax
Router.Info();
;Notes
*Logs current Router information to ''jetlog.txt''.
*Used for debugging a session.
 

==PostMessage==
{{MethodHeader|public obsolete native void PostMessage(int srcId, int dstId, string major, string minor, float delay)}}
;Parameters
*'''srcId''' = GameObject to specify as the message source.
*'''dstId''' = GameObject to specify as the message destination.
*'''major''' = Message major string.
*'''minor''' = Message minor string.
*'''delay''' = Number of seconds to wait before the message is dispatched, can be 0.0.
;Returned Value
*None
;Syntax
Router.PostMessage(Router,Router.MESSAGE_BROADCAST,"Sinking","StartThePumps",0.0);
;Notes
*Router.PostMessage provides the facility for code which does not belong to a GameObject thread to post a message,
*Since these scripts will not have a GameObject Id an alternative source must be specified.
*Specifying ''0'' as the source will make the message apper to emanate from the Router itself.
*Specifying MESSAGE_BROADCAST as the destination will send the message to all GameObjects on the map.
 
This Method is obsolete, it uses an integer lookup with the Router, which now needs to be an object lookup. To use PostMessage without the Router, use a GameObject PostMessage instead. Only the destination is required.

Was - Router.PostMessage (me.GetId(), me.GetId(), "Timer-Event", "", 2.0);
Now - PostMessage(me, "Timer-Event", "", 2.0);

Was - Router.PostMessage (me.GetId(), nMyTrainID, "Animation-Event", "Left-Opening", 0.0);
Now - PostMessage(myTrain, "Timer-Event", "", 2.0);

==Related Methods==
*[[Class GameObject#ClearMessages|GameObject.ClearMessages()]]
*[[Class GameObject#PostMessage|GameObject.PostMessage()]]
*[[Class GameObject#SendMessage|GameObject.SendMessage()]]
*[[Class GameObject#Sniff|GameObject.Sniff()]]

==Categories==
[[Category:Script Class]]

Class Router

2022-10-12T17:07:20Z

Christopher824: /* PostMessage */

__FORCETOC__
*[[TrainzScript Language Reference|API Hierarchy]]
**Router
 

*The Router class handles the transmission of messages between game objects and contains methods to provide references to specific objects given their name or Id.
 

==Constants==

{{TableHeader|width=95%|margin=15px}}
|-
|public define int MESSAGE_BROADCAST = 0||The message will be sent to all objects in the Router
|}
 

==GetGameObject==
{{MethodHeader|public native GameObject GetGameObject(string uniqueName) public native GameObject GetGameObject(int uniqueId)}}
;Parameters
*'''uniqueName''' = Name of object as assigned in Surveyor.
*'''uniqueId''' = Id of object as assigned by the Router for each session.
;Returned Value
*A reference to the GameObject described, null if no such object exists.
;Syntax
GameObject go = Router.GetGameObject(vehicle.GetName());
;Notes
*The objects name will normally be its username with a unique serial added by the game when the object is placed.
*This name can be edited by the user.
*Remember that not all objects will be named.
*Although Surveyor issues a warning on any attempt to name an object using a name which already exists, no restriction is actually enforced.
*As a result it is possible that a name will not be unique.
*Reference to an object's Id on the other hand is guaranteed to be unique for the current session.
*Ids are not preserved between sessions.
 

==Info==
{{MethodHeader|public native void Router.Info(void)}}
;Parameters
*None
;Returned Value
*None
;Syntax
Router.Info();
;Notes
*Logs current Router information to ''jetlog.txt''.
*Used for debugging a session.
 

==PostMessage==
{{MethodHeader|public obsolete native void PostMessage(int srcId, int dstId, string major, string minor, float delay)}}
;Parameters
*'''srcId''' = GameObject to specify as the message source.
*'''dstId''' = GameObject to specify as the message destination.
*'''major''' = Message major string.
*'''minor''' = Message minor string.
*'''delay''' = Number of seconds to wait before the message is dispatched, can be 0.0.
;Returned Value
*None
;Syntax
Router.PostMessage(Router,Router.MESSAGE_BROADCAST,"Sinking","StartThePumps",0.0);
;Notes
*Router.PostMessage provides the facility for code which does not belong to a GameObjject thread to post a message,
*Since these scripts will not have a GameObject Id an alternative source must be specified.
*Specifying ''0'' as the source will make the message apper to emanate from the Router itself.
*Specifying MESSAGE_BROADCAST as the destination will send the message to all GameObjects on the map.
 
This Method is obsolete, it uses an integer lookup with the Router, which now needs to be an object lookup
To use PostMessage without the Router, use a GameObject PostMessage instead.

Was - Router.PostMessage (me.GetId(), me.GetId(), "Timer-Event", "", 2.0);
Now - PostMessage(me, "Timer-Event", "", 2.0);

Was - Router.PostMessage (me.GetId(), nMyTrainID, "Animation-Event", "Left-Opening", 0.0);
Now - PostMessage(myTrain, "Timer-Event", "", 2.0);

==Related Methods==
*[[Class GameObject#ClearMessages|GameObject.ClearMessages()]]
*[[Class GameObject#PostMessage|GameObject.PostMessage()]]
*[[Class GameObject#SendMessage|GameObject.SendMessage()]]
*[[Class GameObject#Sniff|GameObject.Sniff()]]

==Categories==
[[Category:Script Class]]

Using Context with Trainzscript

2022-10-12T14:34:29Z

Christopher824:

[[Image:context_icon.jpg]] 
* Context is a freeware programmer's editor which can be downloaded from [https://www.contexteditor.org/downloads/ '''contexteditor.org/downloads/'''].
* Highlighters for script files and for config.txt files can be downloaded by [[Media:TrainzScript.chl.zip|'''Clicking Here''']] These are not essential for TRS2006 but are needed for TS2009 onwards. They show keywords, text strings and numbers in different colours and help to show where there might be missing quote marks and other problems with your code. A highlighter for config.txt files is included.
* Install the program and copy the highlighter files to ''\Program Files\Context\Highlighters.''
* To integrate the compiler select ''Option\Environment Options'' from Context's menu and then select the ''Execute Keys'' tab.
* Click on ''Add'' and enter the file extension ''gs''
* In the box at the top select one of the function keys and make these entries: 

[[Image:ContextOptions.jpg]] 

* Click OK to close the dialogue.
* Close Context.
* Create a new file called ''compile2006.bat'' in ''C:\Program Files\Auran\'' (use whatever name and location you prefer)
* Add this text to the batch file, you may need to modify paths or filenames:

@echo off
set gsc="C:\Program Files\Auran\TRS2006\Bin"
set include="C:\Program Files\Auran\TRS2006\Scripts"
%gsc%\gsc.exe %1 -i%include% -pc:\windows\temp
set gsc=
set include=
pause

* Reopen Context and load a script file.
* Press F11, your script file will be saved and then checked by the compiler, if all has gone well you will see this: 

[[Image:CompiledOK.jpg]] 

* If there are any problems with the script details will be given together with the line number of the error.
* Interpreting these can be something of a black art, don't worry it will become easier as time passes. 

==Compiling in Context with TrainzUtil.exe for TS2009, TS2010, and TS12==

'''TrainzUtil.exe''' is used to compile scripts in TS2009 onwards.

Set up a Context execute key as follows:

1. Open a trainz script in Context. You must have a Trainz Script highlighter file installed.

2. Call up the execute keys setup by clicking on 'Options/Environment Options' in the main menu.

3. Click on the 'Execute Keys' tab to get the execute keys set-up window. The window is the same
as the one illustrated above.

4. Click on a 'User exec key' (eg F10)

5. Assuming you have TS2010, put the following string, or equivalent for your installation, into
the 'Execute' box (including the quote signs)
'''"C:\Program Files\Auran\TS2010\bin\TrainzUtil.exe"'''

6. Put the following into the 'Start in' box (including the quote signs)
'''"%p"'''

7. Put the following, or equivalent for your installation, into the 'Parameters' box
'''compile %n -i"c:\Program Files\Auran\TS2010\Scripts" -pC:\temp'''

8. Turn on the 'Capture console output'.

9. In the 'Compiler output parser rule' put the following
'''%f(%l)'''

10. Click on the 'Apply' button to save.

Your setup for TS2010 compiling should look as below:- 
[[Image:ConTEXT_setup_TS2010.jpg]] 
Now when you press F10 the script should be compiled and error checked by TrainzUtil for TS2010. 

==Compiling in Context with TrainzUtil.exe for Trainz A New Era==

'''TrainzUtil.exe''' can be used to syntax-check scripts in T:ANE.

Please note that the T:ANE launch window must be open for this to work, and that you must set the advanced debugging options as below.

[[Image:TANE_debug_setup_1.jpg]] 

Also please note that I have T:ANE installed on E: drive (a solid state drive), and that I have moved my user data to that drive.
The settings below should work for the default locations of the data.

Additionally note that this setup uses an undocumented feature for trainzutil.exe for T:ANE. The compile feature has been unsupported for some time now. Scripts are now checked by the validation process.

Set up a Context execute key as follows:

1. Open a T:ANE trainz script in Context. You must have a Trainz Script highlighter file installed.

2. Call up the execute keys setup by clicking on 'Options/Environment Options' in the main menu.

3. Click on the 'Execute Keys' tab to get the execute keys set-up window. The window is the same
as the one illustrated above.

4. Click on a 'User exec key' (eg F11)

5. Assuming you have T:ANE, put the following string, or equivalent for your installation, into
the 'Execute' box (including the quote signs)
'''"E:\N3V Games\Trainz A New Era\TrainzUtil.exe"'''

6. Put the following into the 'Start in' box (including the quote signs)
'''"%p"'''

7. Put the following, or equivalent for your installation, into the 'Parameters' box
'''compile %n -i"E:\N3V Games\Trainz A New Era\resources\Scripts" -pC:\temp'''

8. Turn on the 'Capture console output'.

9. In the 'Compiler output parser rule' put the following
'''%f(%l)'''

10. Click on the 'Apply' button to save.

Now when you press F11 the script should be syntax-checked by TrainzUtil for T:ANE.

The image below shows a T:ANE trainz script in ConTEXT. 
Note the different colours for keywords, text, numbers and comments. 
The script has a deliberate error in line 93 to illustrate how the output from the syntax-check is displayed. 
[[Image:TANE_script_in_ConTEXT.jpg]]

Using Context with Trainzscript

2022-10-12T14:20:55Z

Christopher824: Updated ConTEXT website link

[[Image:context_icon.jpg]] 
* Context is a freeware programmer's editor which can be downloaded from [https://www.contexteditor.org/downloads/ '''contexteditor.org/downloads/'''].
* Highlighters for script files and for config.txt files can be downloaded by [[Media:TrainzScript.chl.zip|clicking here.]] These are not essential for TRS2006 but are needed for TS2009 onwards. They show keywords, text strings and numbers in different colours and help to show where there might be missing quote marks and other problems with your code. A highlighter for config.txt files is included.
* Install the program and copy the highlighter files to ''\Program Files\Context\Highlighters.''
* To integrate the compiler select ''Option\Environment Options'' from Context's menu and then select the ''Execute Keys'' tab.
* Click on ''Add'' and enter the file extension ''gs''
* In the box at the top select one of the function keys and make these entries: 

[[Image:ContextOptions.jpg]] 

* Click OK to close the dialogue.
* Close Context.
* Create a new file called ''compile2006.bat'' in ''C:\Program Files\Auran\'' (use whatever name and location you prefer)
* Add this text to the batch file, you may need to modify paths or filenames:

@echo off
set gsc="C:\Program Files\Auran\TRS2006\Bin"
set include="C:\Program Files\Auran\TRS2006\Scripts"
%gsc%\gsc.exe %1 -i%include% -pc:\windows\temp
set gsc=
set include=
pause

* Reopen Context and load a script file.
* Press F11, your script file will be saved and then checked by the compiler, if all has gone well you will see this: 

[[Image:CompiledOK.jpg]] 

* If there are any problems with the script details will be given together with the line number of the error.
* Interpreting these can be something of a black art, don't worry it will become easier as time passes. 

==Compiling in Context with TrainzUtil.exe for TS2009, TS2010, and TS12==

'''TrainzUtil.exe''' is used to compile scripts in TS2009 onwards.

Set up a Context execute key as follows:

1. Open a trainz script in Context. You must have a Trainz Script highlighter file installed.

2. Call up the execute keys setup by clicking on 'Options/Environment Options' in the main menu.

3. Click on the 'Execute Keys' tab to get the execute keys set-up window. The window is the same
as the one illustrated above.

4. Click on a 'User exec key' (eg F10)

5. Assuming you have TS2010, put the following string, or equivalent for your installation, into
the 'Execute' box (including the quote signs)
'''"C:\Program Files\Auran\TS2010\bin\TrainzUtil.exe"'''

6. Put the following into the 'Start in' box (including the quote signs)
'''"%p"'''

7. Put the following, or equivalent for your installation, into the 'Parameters' box
'''compile %n -i"c:\Program Files\Auran\TS2010\Scripts" -pC:\temp'''

8. Turn on the 'Capture console output'.

9. In the 'Compiler output parser rule' put the following
'''%f(%l)'''

10. Click on the 'Apply' button to save.

Your setup for TS2010 compiling should look as below:- 
[[Image:ConTEXT_setup_TS2010.jpg]] 
Now when you press F10 the script should be compiled and error checked by TrainzUtil for TS2010. 

==Compiling in Context with TrainzUtil.exe for Trainz A New Era==

'''TrainzUtil.exe''' can be used to syntax-check scripts in T:ANE.

Please note that the T:ANE launch window must be open for this to work, and that you must set the advanced debugging options as below.

[[Image:TANE_debug_setup_1.jpg]] 

Also please note that I have T:ANE installed on E: drive (a solid state drive), and that I have moved my user data to that drive.
The settings below should work for the default locations of the data.

Additionally note that this setup uses an undocumented feature for trainzutil.exe for T:ANE. The compile feature has been unsupported for some time now. Scripts are now checked by the validation process.

Set up a Context execute key as follows:

1. Open a T:ANE trainz script in Context. You must have a Trainz Script highlighter file installed.

2. Call up the execute keys setup by clicking on 'Options/Environment Options' in the main menu.

3. Click on the 'Execute Keys' tab to get the execute keys set-up window. The window is the same
as the one illustrated above.

4. Click on a 'User exec key' (eg F11)

5. Assuming you have T:ANE, put the following string, or equivalent for your installation, into
the 'Execute' box (including the quote signs)
'''"E:\N3V Games\Trainz A New Era\TrainzUtil.exe"'''

6. Put the following into the 'Start in' box (including the quote signs)
'''"%p"'''

7. Put the following, or equivalent for your installation, into the 'Parameters' box
'''compile %n -i"E:\N3V Games\Trainz A New Era\resources\Scripts" -pC:\temp'''

8. Turn on the 'Capture console output'.

9. In the 'Compiler output parser rule' put the following
'''%f(%l)'''

10. Click on the 'Apply' button to save.

Now when you press F11 the script should be syntax-checked by TrainzUtil for T:ANE.

The image below shows a T:ANE trainz script in ConTEXT. 
Note the different colours for keywords, text, numbers and comments. 
The script has a deliberate error in line 93 to illustrate how the output from the syntax-check is displayed. 
[[Image:TANE_script_in_ConTEXT.jpg]]

TCCP

2022-10-12T14:06:34Z

Christopher824: /* Affiliatly Account */

TCCP

2022-10-12T14:00:33Z

Christopher824: /* Affiliatly Account */

TCCP

2022-10-12T13:58:44Z

Christopher824: /* Affiliatly Account */

TCCP

2022-10-12T13:52:38Z

Christopher824:

TCCP

2022-10-12T10:21:54Z

Christopher824: