TrainzOnline - User contributions [en]

Index of Tags & Containers

2021-04-19T15:19:51Z

Zikchil: /* br-cg */

{{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...
|-
|<p><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></p>
|}
{{-}}

==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
|?
|-
|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
|<i>No longer Valid.</i> Defined traffic density on road (minimum seconds between each car generated). 0 = No traffic. Number must be greater than 3.
|-
|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]] <br/>(depreciated)
|region code
|config.txt
|general <br/>(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.
|-
|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,<br/>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}}

Help:Content Manager:Download Station And Downloading

2021-03-30T14:36:49Z

Zikchil: /* First Class Tickets */

The Download Station provides access to many thousands of new assets for Trainz. For TRS2019, we recommend using Content Manager to search the Download Station, and then download content from the Download Station.

[[File:content-manager-download-station.jpg|600px]]

==Searching for Content==
Searching for content on the Download Station is performed using a combination of the filters system (starting with the predefined Download Station filter), and the if desired the 'search' box at the top right.

As an example, we will look for Victorian Railways rolling stock on the Download Station.

# Click on the [[Help:ContentManager:Getting_Started#Predefined_Filters|Predefined Filters]] drop down
# Click on the 'Download Station' option in the list. This will then display every available asset on the Download Station.
# Click on the grey arrow to the right of 'Filters:' to open the [[Help:ContentManager:Getting_Started#The_Filters_Tool|Filters Tool]]
# Click on the '+' button at the right hand end of the current filter to add a new filter
# Click on the left hand drop down box of the new filter, and set it to 'category'
# Click on the right hand drop down box of the new filter, and set it to 'rolling stock'
# Add another filter, and set the left hand box to 'name', then enter VR into the right hand box

You will then see all 'rolling stock' assets with 'VR' in the name listed. You can add further filters if required to help filter this list some more.

==Downloading Content==
When you find an asset to download, left click on it to select it, then right click and click on Download.

You can also find the 'Download' option under the Content menu at the top of the Content Manager window.

You can download multiple assets by holding the CTRL key, then left clicking on each asset in the Asset List, then right click and click on Download (or open the Content Menu and click on Download).

If you have a active First Class Ticket, you can also have multiple download windows open at the same time.

==First Class Tickets==
First Class Tickets provide access to the First Class Download Station server, which provides unlimited daily access at higher speeds with a guaranteed connection. First Class Ticket subscriptions can be purchased from the [[https://store.trainzportal.com/products/first-class-ticket/ Trainz Store]]

If you do not have an active First Class Ticket, then you will still be able to access the Download Station. However you will be limited to a slower download speed (approximately 5KB/s currently), with a 100MB/day download limit. If there are a large number of people downloading at the same time, you may get an "Unable to download...Too many connections" message. Simply retry at a later time or purchase a First Class Ticket for guaranteed access.

==Video Guide==
You can also find a Video Guide for downloading content with Trainz Content on the N3V Games YouTube channel.

[https://youtu.be/mTzyx9Kx7Ug Link to Video]

Return To: [[Help:Content_Manager|Content Manager Help]]

[[Category:TRS19]][[Category:Help]]

Help:TRS19 Trainz Settings

2021-02-22T21:58:29Z

Zikchil: /* Internet Tab */

The Trainz Settings window provides access to a range of settings for Trainz, including performance settings, the location of your LocalData folder, and more.

== General Tab==
The General Tab provides access to screen resolution and other general options of Trainz.

[[File:2018-06-13 122616.png|270px]]

===Display Selection===
The Display Selection box provides an option for you to select which display (screen) to use. If you only have one display, then only one option will be available.

===Full Screen===
The Full Screen option allows you to force Trainz to run in Full Screen mode with no borders. This will run at the [[#Display Resolution|Display Resolution]] selected. You can also toggle full screen whilst running Trainz by pressing ALT + Enter on your keyboard.

When not in full screen, Trainz will run in a window which you can adjust by dragging the edges or corners to the size you want. This will automatically adjust the resolution to match.

===Display Resolution===
The Display Resolution option can only be changed when the [[#Full Screen|Full Screen]] option is enabled.

This option allows you to set the display resolution of Trainz when running in full screen mode, including when toggled with the ALT + Enter keyboard command.

===Vertical Sync===
The Vertical Sync option is used to help with smoothness when running Trainz, particularly at lower frame rates.

====Full====
At full, whenever the frame rate drops below 60frames per second (FPS) there will be a 'skip' in smoothness. If the frame rate is consistently below 60 then there will be regular skipping of frames. If you see frame rates above 60FPS, but still inconsistent then this option will help make Trainz run smoother.

====Half====
The default setting is Half. This forces the maximum number of frames to be 30FPS at all times. This allows a much smoother frame rate if your computer runs below 60FPS and above 30FPS. If you see frame rates below 30FPS then you may still see skips.

====None====
Setting Vertical Sync to 'None' will turn Vertical Sync off completely. In this case there will be no capping of the framerate, and as such it may vary a lot which may cause stuttering. On very high performance hardware you may wish to try running with Vertical Sync off.

===Language===
This options allows you to change the language that TRS2019 displays.

===Compatibility Mode===
This option allows you to select <b><i>compatibility mode for <u>scripts</u> in Trainz</i></b>.
*This currently defaults to 'Maximize Compatibility' and should remain so, unless you're developing scripts for routes and sessions made in TRS2019.
*Developers may wish to try running in 'stream objects' or 'maximize performance' mods to test for script performance changes.
**Running one of the other options may cause older scripts to not function, objects to not work properly or not render at all in game.
**This <b><i>developer tool</i></b> should not be interpreted to be a performance tool similar to a GFX card setting for "best quality \ best performance".

===Manage content as thumbnails===
This option allows you to set Trainz Content to display all content as thumbnails, rather than as a list.

===Enable game controller support===
This option enables support for game controllers, such as the Rail Driver controller. See the [[Help:TANE_Raildriver|Rail Driver]] page for further information on setting up a RailDriver controller with Trainz.

== Install Tab ==
The install tab provides access to change the LocalData folder, and to check for updates for Trainz.

[[File:2018-06-13 122628.png|270px]]

===Local Data folder===
Your LocalData folder contains all of your downloaded/installed content, as well as your settings for Trainz. This will default to the AppData on C:\ drive (for Windows), or the Library directory on the main drive (OSx/Mac). If you have limited space on your main drive then it may be ideal to move it to another drive.

You can specify an alternate location for storing content by pressing the '...' button. To avoid dataloss if you have already created or downloaded content, please see [[Help:Moving_Content|Moving Content]] for information on moving your existing LocalData.

===Check for Trainz updates...===
This option will check for any available updates for Trainz.

===Change Trainz update stream===
This option will allow you to change the update stream for Trainz, such as to access a public beta test.

==Performance Tab==
The Performance tab provides many options that adjust the graphics in Trainz, which in turn allow you to tune the look and performance of Trainz. Please note, many of these options require you to restart Trainz (close all windows, including the launcher window, then re-open Trainz) to take effect. The higher the setting, the greater the detail but also the greater the impact it will have on performance, depending on your hardware. These settings are also adjusted by the [[Help:Performance_Configurator|Performance Configurator]].

[[File:2018-06-13 122553.png|270px]]

Please see the [[Help:Video_Settings|Video Settings]] page for information on each of these settings, and how to tune these settings for different hardware configurations.

== MyTrainz Tab==
The MyTrainz tab (formerly the "Internet" tab) allows you to view and set your MyTrainz account details, and view your First Class Ticket status.

[[File:2018-06-13 122607.png|270px]]

===MyTrainz account===
Your MyTrainz account is the account registered on the Trainz Store, Trainz Portal, or Auran.com websites. If you do not yet have one, then click on the Create Account button to create a new account.

This account provides access to all of the online features in Trainz, including the Download Station!

Once created, enter your username and password into the boxes provided and then press enter to allow Trainz to log in. Please Note, your username and password are case sensitive. For Trainz Store purchases, Trainz will be automatically registered to the username it was purchased through.

For Steam and Mac AppStore purchases, Trainz is registered to your account when it first logs into the first MyTrainz account entered into the settings.

You can only register Trainz to one MyTrainz account. Your registration is not transferable to another account.

===First Class Ticket Status===
Your First Class Ticket status is shown here. First Class Tickets provide access to the First Class server on the Download Station to download new content for Trainz at faster speeds, without any daily download limits and provides priority download access over the free server. You only need one First Class Ticket per account, it will then be available to all versions registered to that account.

==Dev Tab==
The Dev tab provides a range of displays and settings intended for content developers.

[[File:2018-06-13 122612.png|270px]]

===UserID===
This is the UserID number for your account. This number is the first number used in the asset id/kuid number of any content that you create.

===Daily backups to keep===
When content is removed by Trainz, either by you or during part of a database update or rebuild (ie the content is damaged, or there is another item with the same AssetID installed), it will be moved to the Backups folder of your LocalData.

This option allows you to set how many days worth of backups will be kept. Currently defaults to 1. Please note, these backups may not always be usable, and are intended for advanced users only. We recommend keeping manual backups of content yourself. See [[Help:Backing_Up_Content|Backing Up Content]] for instructions on this.

===Time Scaling===
This allows you to speed up Trainz, such as to allow you to run through sessions much quicker to allow you to debug a session easily.

===Debug render===
TBC

===Enable advanced debug tools===
This option allows you to enable advanced debug tools, such as script debug tools and Post Processing tools.

===Show Script Exception Notifications===
This allows you to enable the script exception notifications in Trainz. These indicate issues/errors with scripts in Trainz, and are useful for debugging scripted functions (ie driver commands, custom scripts for trains, etc) that may not be working as expected.

Script exceptions will appear in Trainz as a red 'bug' icon at the bottom right. Click on this to view the script exceptions that have appeared up to that point in the session. If none have appeared, the red bug icon will not appear.

===Log script output===
This will allow the script output to be placed into the Logs. You can view the logs by clicking on 'Developer', then click on 'Show Logs'. You may wish to 'Clear Logs' first to start with a clean display.

===Log script message handling===
This option will allow the logging of script message handling in Trainz.

Return to [[TRS19 | TRS19 Home Page]] - [[Help:TRS19_Launcher|TRS2019 Launcher]] - [[Help:TRS19|TRS19 Help]]
[[Category:TRS19]][[Category:Help]]

"Smoke" container

2020-10-14T14:24:04Z

Zikchil: /* dampening */

A smoke container is effectively a PFX (particle effects) emitter that defines smoke and similar effects produced by assets. Smoke tags take the form smokeX where X is a number. There is no maximum number of smoke tags but they must be numbered sequentially (i.e. smoke0,smoke1,smoke2,etc). Smoke blocks have two sections: main and sequence properties. Main properties describe the attributes that stay the same for the life of the emitter. Sequence properties describe a set of one or more phases/periods in the smoke emission sequence.

==Supported Tags==
Each smoke container supports the following tags. Each tag is shown here with its default value.

texture <KUID:-1:6329>
file ""
attachment ""
mode "time"
accel 0,0,0
conesize 0.2,0.2,1
direction 0,0,1
enable-steam-physics 0
enabled 1
faces "camera"
inherit-Velocity 0
loop -1
loopdelay 0
loop-amount 0
minrate 0
maxrate 20
maxspeedkph 0
start 0
period -1
color 255,255,255,255
endcolor 255,255,255,255
rate 4
velocity 1
lifetime 3
minsize 0
maxsize 3
mass 1
mass-scale .5
drag .36
spring .17
dampening .02
physics-delay 0

===Main Properties===
====accel====
:Type: Decimal List
:Default: 0,0,0
:Compulsory: No
:Desc: Sets the acceleration conditions for the smoke particles. First value is gravity, second is (optional) wind effect. Default is 0,0. A third (deprecated) form exists with three parameters - this uses the first two values to calculate the wind effect and the third as gravity.
====attachment====
:Type: String
:Default: ""
:Compulsory: Yes (3.4)
:Desc: The name of the attachment point at which to generate the PFX. Attachment points are specified in the mesh file during creation.
====conesize====
:Type: Decimal List
:Default: 0.2,0.2,1
:Compulsory: No
:Desc: Specifies the cone in which the particles are emitted. When a particle is created it will be given an initial velocity vector with its direction being a random vector in this cone and its speed being taken from the 'velocity' tag. The cone tag is a decimal list of 1, 2 or 3 values (in meters). The first two values specify the width and depth (x and y) of the cone, and the third value specifies it's height. If the height isn't provided a value of 1 will be used, if only one value is provided it will be used for both the width and height. The default value if the tag isn't provided at all is (0.2,0.2,1.0).
====direction====
:Type: 3D Vector (x,y,z)
:Default: 0,0,1
:Compulsory: No
:Desc: Sets the direction the particle emitter is facing. The direction will default to (0,0,1) if not supplied (straight up).
====enable-steam-physics====
:Type: Boolean
:Default: 0 (false)
:Compulsory: No
:Desc: Enables some of the more advanced smoke/steam related particle physics (drag, spring & dampening).
====enabled====
:Type: Boolean
:Default: 1 (true)
:Compulsory: No
:Desc: Sets whether the particle emitter is enabled.
====faces====
:Type: String
:Default: "camera"
:Compulsory: No
:Desc: Sets the direction the particle faces. Can be one of the following values:
:*'''camera''' - The particles are drawn so that they always face the camera (Default)
:*'''motion''' - The particles are drawn so that they face the direction they are travelling.
:*'''down''' - The particles are drawn facing down.
====file====
:Type: String (filename of effect)
:Default: ""
:Compulsory: No
:Desc: Specifies that the particle emitter settings should be read in from a file generated by the Twinkles PFX tool.
====inherit-velocity====
:Type: Boolean
:Default: 0
:Compulsory: No
:Desc: Causes particles to inherit the velocity of the emitter, default is off.
====loop====
:Type: Decimal
:Default: -1
:Compulsory: No
:Desc: Sets the time, in seconds, after which to loop the smoke sequence. Valid only for modes 'time' and 'anim2'. Can be set to -1 to imply that it loops after the length of the sequence, this is the default behaviour.
====loopdelay====
:Type: Decimal
:Default: 0
:Compulsory: No
:Desc: Specifies the delay, in seconds, until the sequence loops again.
====loop-amount====
:Type: Integer
:Default: 0
:Compulsory: No
:Desc: Sets the number of times the sequence should loop.

====maxrate====
:Type: Integer
:Default: 20
:Compulsory: No
:Desc: Sets the maximum particle emission rate for the entire sequence.

====maxspeedkph====
:Type: Decimal
:Default: 0
:Compulsory: No
:Desc: For cone emitters, this will set the maximum speed of the particles, in kph.
====minrate====
:Type: Integer
:Default: 0
:Compulsory: No
:Desc: Sets the minimum particle emission rate for the entire sequence. Defaults to 0.
====mode====
:Type: String
:Default: "time"
:Compulsory: Yes (3.4)
:Desc: The PFX emitter mode. Smoke effects can contain a number of cycled 'phases', the mode defines how the 'start' and 'period' tags are interpreted to control the progression between each smoke phase. Mode must be one of the following values (defaults to "time" if not specified).
{|class="wikitable"
|-
!Mode Value!!Description
|-
|style="width: 20%;"|'''time'''||'start' is a list of time values (in seconds) after the creation of the parent object when the next phase of the effect will start, 'period' is the duration of time the phase will remain active.
|-
|'''timeofday'''||'start' is the time of day to start the next phase. The time of day is specified as a decimal from 0 to 1, where 0 is 0:00.00 AM and 1 is 12:59.59 PM.
|-
|'''anim'''||'start' specifies a time in the assets animation cycle to start the next phase. 'period' is the time over which the phase is active. The time in the anim cycle is specified as a decimal between 0 and 1. 'start' + 'period' must not exceed 1.
|-
|'''anim2'''||Same as 'anim' with some additional tags (interpolate, loop, loopdelay)
|-
|'''speed'''||'start' is a speed, in meters per second, to start the next phase. 'period' is not used.
|-
|'''custom'''||UNKNOWN
|-
|'''cyldrainl'''||Toggled on and off by the Draincock command. The significance of "l" vs "r" is unknown.
|-
|'''cyldrainr'''||Toggled on and off by the Draincock command. The significance of "l" vs "r" is unknown.
|-
|'''stack'''||Synchronized to the drivers and is meant for a steam locomotive's smoke stack.
|-
|'''whistle'''||Turns on and off when the whistle is turned on and off.
|-
|'''generator'''||UNKNOWN
|-
|'''lowpressurevalve'''||Turns on when the boiler pressure exceeds the low pressure safety valve's setting (defined in enginespec). (?)
|-
|'''highpressurevalve'''||Turns on when the boiler pressure exceeds the high pressure safety valve's setting (defined in enginespec). (?)
|-
|'''blow0'''||UNKNOWN (blowdown?)
|-
|'''blow1'''||UNKNOWN (blowdown?)
|-
|'''fire-temperature'''||UNKNOWN
|-
|'''boiler-temperature'''||UNKNOWN
|}
:Only the 'time' and 'timeofday' modes are valid for scenery objects, other modes are intended for use with assets such as locomotives.
====texture====
:Type: KUID
:Default: <kuid:-1:6329>
:Compulsory: No
:Desc: Sets the kuid of the texture to use for the particles, defaults to <KUID:-1:6329> (Steam).

===Sequence Properties===
Per-phase tags are specified as value lists. If a list is included and if it is applicable to the mode then the number of items in the list must be the same as the number of phases (ie: the number of items in the 'start' list).

====color====
:Type: Color List (RGBA, 0 to 255)
:Default: 255,255,255,255 (if not compulsory)
:Compulsory: Yes (3.4)
:Desc: Specifies the initial color of the PFX texture. From build 2.9, failing to include a color tag will create a validation warning or error. Note: This is a per-phase tag so the number of (4-element) colors should match the number of phases. However, it is also valid to provide a single color to be used for all phases.

====dampening====
:Type: Decimal List
:Default: 0.02
:Compulsory: No
:Desc: The spring damping constant for particles created in this phase. The spring damping constant affects the 'stability' of the link between individual particles (see 'spring'). Requires the 'enable-steam-physics' tag. Defaults to 0.02.

====drag====
:Type: Decimal List
:Default: 0.36
:Compulsory: No
:Desc: The drag constant for the particle created in this phase. This specifes the resistance against the particles ability to move freely through the air. If not specified the drag constant will default to 0.36, increasing the value will cause particles to be more strongly affected by wind. Requires the 'enable-steam-physics' tag.
====endcolor====
:Type: Color List (RGBA, 0 to 255)
:Default: 255,255,255,255 (white, opaque)
:Compulsory: No
:Desc: Specifies the ending color of the PFX texture. Note: This is a per-phase tag so the number of (4-element) colors should match the number of phases. However, it is also valid to provide a single color to be used for all phases.

====lifetime====
:Type: Float list
:Default: 3
:Compulsory: Yes (3.4)
:Desc: Specifies the time, in seconds, that the particles exist for in this phase (defaults to 2).
====mass====
:Type: Decimal List
:Default: 1
:Compulsory: No
:Desc: The initial mass, in kilograms, of the particles created in this phase..
====mass-scale====
:Type: Decimal List
:Default: 0.5
:Compulsory: No
:Desc: The percentage of mass lost over the particles life time for this phase. This allows particles to become lighter as they dissipate into the air. The value is specified as a percentage where 1 is 100% and will default to 0.5 (50%).
====maxsize====
:Type: Decimal List
:Default: 3
:Compulsory: Yes (3.4)
:Desc: Specifies the ending size of the particles created in this phase. Note: This is a per-phase tag so the number of list items should match the number of phases. However, it is also valid to provide a single value to be used for all phases. (TBD - Units?),

====minsize====
:Type: Decimal List
:Default: 0
:Compulsory: Yes (3.4)
:Desc: Specifies the starting size of the particles created in this phase. Note: This is a per-phase tag so the number of list items should match the number of phases. However, it is also valid to provide a single value to be used for all phases. (TBD - Units?),

====period====
:Type: Decimal List
:Default: -1
:Compulsory: No
:Desc: Specifies the duration of this phase, 'period' behaves differently depending on 'mode' and is not always used (see mode for details). Period can be set to -1 to imply that the phase is active until the next phase begins or the last phase ends: this is the default behaviour. (Note: only mode "time" valid?) (Note: Current validation does not check the count of items in the period list?)

To produce continuous smoke with a scenery item use a mode of 'time' and a period of -1.

====physics-delay====
:Type: Decimal List
:Default: 0
:Compulsory: No
:Desc: Delay, in seconds, before particles are affected by world physics.
====rate====
:Type: Integer List
:Default: 4
:Compulsory: Yes (3.4)
:Desc: Specifies the rate of particle emission in each phase. For most modes this is set to the number of particles to emit per second, for 'anim' and 'anim2' however this is the number of particles to emit over the animation period. The default rate is 4. See also 'minrate' and 'maxrate'.
====spring====
:Type: Decimal List
:Default: 0.17
:Compulsory: No
:Desc: The spring constant for particles created in this phase. The spring constant specifies how the strong the link is between individual particles. By default the spring constant is 0.17 if not specified, increasing the value will cause the particles to be more rigidly linked to each others movement. Requires the 'enable-steam-physics' tag.
====start====
:Type: Decimal List
:Default: 0
:Compulsory: No
:Desc: Specifies when to start this phase, 'start' behaves differently depending on 'mode' (see mode for details). Start will default to a single item with a value of 0. The number of items in this list defines the number of phases.
====velocity====
:Type: Decimal List
:Default: 1
:Compulsory: Yes (3.4)
:Desc: Specifies the initial speed of the emitted particles for this phase. Speed is specified in meters per second, the default value is 1m/s.

==Example Config.txt==
Sample [[config.txt file]] for a scenery asset that produces smoke:

region Britain
kind scenery
type Industrial
light 1
smoke0
{
attachment a.smoke
mode timeofday
color 150,150,150,250
accel 1,0.3,0
start 0.25, 0.5
period 0.25, 0.125
rate 8
velocity 3
lifetime 5
minsize 0.5
maxsize 2
}

Sample [[config.txt file]] for a steam train with four smoke emitters.
*Dark smoke from the main chimney stack that is dependent on the trains velocity (a.smoke, Y axis pointing up),
*A constant steam trail from a small safety pipe on top (a.steam.safety, Y axis pointing up),
*2 steam trails on each side of the train that alternately expel steam keyed to the animation of the trains wheels (a.steam.l, a.steam.r, Y axis pointing outwards).

kind traincar
bogey 0
engine 1
name Steam Train
mass 100000
enginespec <KUID:0:0>
enginesound <KUID:0:0>
hornsound <KUID:0:0>
interior <KUID:0:0>

smoke0
{
attachment a.steam.l
mode anim
color 255,255,255,150
start 0
period 0.4
rate 2
velocity 1
lifetime 2
minsize 0.05
maxsize 1
}
smoke1
{
attachment a.steam.r
mode anim
color 255,255,255,150
start 0.5
period 0.4
rate 2
velocity 1
lifetime 2
minsize 0.05
maxsize 1
}
smoke2
{
attachment a.steam.safety
mode time
color 255,255,255,150
rate 2
velocity 1
lifetime 2
minsize 0.05
maxsize 1
}
smoke3
{
attachment a.smoke0
mode speed
color 100,100,100,200
start 0,10,20,30
rate 3,5,7,9
velocity 3,4,5,5
lifetime 4,3,2.5,2
minsize 0.3
maxsize 2
}

==Categories==
[[Category:Config Container|S]]

Help:TRS19 Trainz Settings

2020-09-29T14:41:24Z

Zikchil: /* Compatibility Mode */

The Trainz Settings window provides access to a range of settings for Trainz, including performance settings, the location of your LocalData folder, and more.

== General Tab==
The General Tab provides access to screen resolution and other general options of Trainz.

[[File:2018-06-13 122616.png|270px]]

===Display Selection===
The Display Selection box provides an option for you to select which display (screen) to use. If you only have one display, then only one option will be available.

===Full Screen===
The Full Screen option allows you to force Trainz to run in Full Screen mode with no borders. This will run at the [[#Display Resolution|Display Resolution]] selected. You can also toggle full screen whilst running Trainz by pressing ALT + Enter on your keyboard.

When not in full screen, Trainz will run in a window which you can adjust by dragging the edges or corners to the size you want. This will automatically adjust the resolution to match.

===Display Resolution===
The Display Resolution option can only be changed when the [[#Full Screen|Full Screen]] option is enabled.

This option allows you to set the display resolution of Trainz when running in full screen mode, including when toggled with the ALT + Enter keyboard command.

===Vertical Sync===
The Vertical Sync option is used to help with smoothness when running Trainz, particularly at lower frame rates.

====Full====
At full, whenever the frame rate drops below 60frames per second (FPS) there will be a 'skip' in smoothness. If the frame rate is consistently below 60 then there will be regular skipping of frames. If you see frame rates above 60FPS, but still inconsistent then this option will help make Trainz run smoother.

====Half====
The default setting is Half. This forces the maximum number of frames to be 30FPS at all times. This allows a much smoother frame rate if your computer runs below 60FPS and above 30FPS. If you see frame rates below 30FPS then you may still see skips.

====None====
Setting Vertical Sync to 'None' will turn Vertical Sync off completely. In this case there will be no capping of the framerate, and as such it may vary a lot which may cause stuttering. On very high performance hardware you may wish to try running with Vertical Sync off.

===Language===
This options allows you to change the language that TRS2019 displays.

===Compatibility Mode===
This option allows you to select <b><i>compatibility mode for <u>scripts</u> in Trainz</i></b>.
*This currently defaults to 'Maximize Compatibility' and should remain so, unless you're developing scripts for routes and sessions made in TRS2019.
*Developers may wish to try running in 'stream objects' or 'maximize performance' mods to test for script performance changes.
**Running one of the other options may cause older scripts to not function, objects to not work properly or not render at all in game.
**This <b><i>developer tool</i></b> should not be interpreted to be a performance tool similar to a GFX card setting for "best quality \ best performance".

===Manage content as thumbnails===
This option allows you to set Trainz Content to display all content as thumbnails, rather than as a list.

===Enable game controller support===
This option enables support for game controllers, such as the Rail Driver controller. See the [[Help:TANE_Raildriver|Rail Driver]] page for further information on setting up a RailDriver controller with Trainz.

== Install Tab ==
The install tab provides access to change the LocalData folder, and to check for updates for Trainz.

[[File:2018-06-13 122628.png|270px]]

===Local Data folder===
Your LocalData folder contains all of your downloaded/installed content, as well as your settings for Trainz. This will default to the AppData on C:\ drive (for Windows), or the Library directory on the main drive (OSx/Mac). If you have limited space on your main drive then it may be ideal to move it to another drive.

You can specify an alternate location for storing content by pressing the '...' button. To avoid dataloss if you have already created or downloaded content, please see [[Help:Moving_Content|Moving Content]] for information on moving your existing LocalData.

===Check for Trainz updates...===
This option will check for any available updates for Trainz.

===Change Trainz update stream===
This option will allow you to change the update stream for Trainz, such as to access a public beta test.

==Performance Tab==
The Performance tab provides many options that adjust the graphics in Trainz, which in turn allow you to tune the look and performance of Trainz. Please note, many of these options require you to restart Trainz (close all windows, including the launcher window, then re-open Trainz) to take effect. The higher the setting, the greater the detail but also the greater the impact it will have on performance, depending on your hardware. These settings are also adjusted by the [[Help:Performance_Configurator|Performance Configurator]].

[[File:2018-06-13 122553.png|270px]]

Please see the [[Help:Video_Settings|Video Settings]] page for information on each of these settings, and how to tune these settings for different hardware configurations.

== Internet Tab==
The Internet Tab allows you to view and set your MyTrainz account details, and view your First Class Ticket status.

[[File:2018-06-13 122607.png|270px]]

===MyTrainz account===
Your MyTrainz account is the account registered on the Trainz Store, Trainz Portal, or Auran.com websites. If you do not yet have one, then click on the Create Account button to create a new account.

This account provides access to all of the online features in Trainz, including the Download Station!

Once created, enter your username and password into the boxes provided and then press enter to allow Trainz to log in. Please Note, your username and password are case sensitive. For Trainz Store purchases, Trainz will be automatically registered to the username it was purchased through.

For Steam and Mac AppStore purchases, Trainz is registered to your account when it first logs into the first MyTrainz account entered into the settings.

You can only register Trainz to one MyTrainz account. Your registration is not transferable to another account.

===First Class Ticket Status===
Your First Class Ticket status is shown here. First Class Tickets provide access to the First Class server on the Download Station to download new content for Trainz at faster speeds, without any daily download limits and provides priority download access over the free server. You only need one First Class Ticket per account, it will then be available to all versions registered to that account.

==Dev Tab==
The Dev tab provides a range of displays and settings intended for content developers.

[[File:2018-06-13 122612.png|270px]]

===UserID===
This is the UserID number for your account. This number is the first number used in the asset id/kuid number of any content that you create.

===Daily backups to keep===
When content is removed by Trainz, either by you or during part of a database update or rebuild (ie the content is damaged, or there is another item with the same AssetID installed), it will be moved to the Backups folder of your LocalData.

This option allows you to set how many days worth of backups will be kept. Currently defaults to 1. Please note, these backups may not always be usable, and are intended for advanced users only. We recommend keeping manual backups of content yourself. See [[Help:Backing_Up_Content|Backing Up Content]] for instructions on this.

===Time Scaling===
This allows you to speed up Trainz, such as to allow you to run through sessions much quicker to allow you to debug a session easily.

===Debug render===
TBC

===Enable advanced debug tools===
This option allows you to enable advanced debug tools, such as script debug tools and Post Processing tools.

===Show Script Exception Notifications===
This allows you to enable the script exception notifications in Trainz. These indicate issues/errors with scripts in Trainz, and are useful for debugging scripted functions (ie driver commands, custom scripts for trains, etc) that may not be working as expected.

Script exceptions will appear in Trainz as a red 'bug' icon at the bottom right. Click on this to view the script exceptions that have appeared up to that point in the session. If none have appeared, the red bug icon will not appear.

===Log script output===
This will allow the script output to be placed into the Logs. You can view the logs by clicking on 'Developer', then click on 'Show Logs'. You may wish to 'Clear Logs' first to start with a clean display.

===Log script message handling===
This option will allow the logging of script message handling in Trainz.

Return to [[TRS19 | TRS19 Home Page]] - [[Help:TRS19_Launcher|TRS2019 Launcher]] - [[Help:TRS19|TRS19 Help]]
[[Category:TRS19]][[Category:Help]]

Help:Replacing Missing Assets

2020-08-24T15:34:20Z

Zikchil: /* Locating the missing dependencies */

Many assets on the Download Station, and even 3rd party websites, will use only assets found on the Download Station, or that are built-in within Trainz.

However sometimes assets used in a route may be a part of a payware DLC pack you do not own, or might be from a 3rd party website, or may no longer be available. This doesn't mean that the route won't work, but it might require a few steps to get the route fully working.

Note, at the current time, the "bulk asset update/replace" tool does not allow replacing missing or faulty dependencies.

==Deleting missing assets==
The quickest, and simplest, option is to simply delete missing assets from the route by following these steps:

#Load the route into Surveyor using Edit Route
#Click on Tools Menu on the top menubar
#Click on 'Delete Missing Assets'
#Click "OK" on the warning message
#Save the route under a new name

Realize that saving the route under a new name will disconnect all existing sessions. These sessions remain associated with the old route name. Each can be associated with the new route by individually editing the respective config file.

==Locating the missing dependencies==
Alternatively, you can try to locate the missing dependencies. The best way to do this is to search for the missing dependency's AssetID (kuid) number. You can find this by following these steps:

#Click on Manage Content on the launcher screen
#Enter the route's name into the search box at the top right
#Right click on the route
#Click on 'List dependencies recursively'
#Click on the 'Status' column to sort by status
#Scroll through the list until you find assets with any of the following status:
#*'''Not Installed, Payware (not active)''' - This indicates that you do have access to the DLC package the dependency is a part of, and the asset is not installed
#*'''Installed, Payware (not active)''' - This indicates that, although the asset is installed, you do have access to the DLC package the dependency is a part of. You will need to own the DLC package to be able to use this asset.
#*'''Installed, Faulty''' - This indicates that the asset is installed, but is faulty.
#**You will need to either delete the asset (then use [[#Delete_Missing_Assets|Delete Missing Assets]] to delete it from the route), or try to repair the asset.
#*'''Installed, Missing Dependencies''' - This indicates that the asset is installed, but has one or more dependencies that are not yet installed.
#**You will need to try to locate the dependencies to install them, or delete the asset and then use [[#Delete_Missing_Assets|Delete Missing Assets]] to delete it from the route
#*'''Installed, Faulty Dependencies''' - This indicates that the asset is installed, but has faulty dependencies.
#**You will need to either delete the asset (then use [[#Delete_Missing_Assets|Delete Missing Assets]] to delete it from the route), or try to repair the asset.
#*'''Available from DLS''' - This indicates that the asset is not installed, but is available to download from the Download Station. Right click on it, then click on Download to begin downloading.
#*'''Unknown''' - This indicates that the asset is not installed, and is not available on the Download Station.
#Once you have found the assets with 'unknown' shown for the status, you can try searching for the AssetID number (found in the AssetID column) online to possibly find the asset.
#*The asset ID number can be entered into a search engine such as Google, which may sometimes show the website the asset is from.
#*Alternatively, it may show forum posts where the asset has been mentioned, possibly with it's download location.

Return To:
*[[Help:TRS2019_Surveyor|Surveyor]]
*[[Help:TRS19|TRS19 Help Page]]

[[Category:TRS19]]
[[Category: Help]]

Help:Moving Content

2020-05-20T16:20:25Z

Zikchil: /* Creating a New Local Data Folder */

Trainz stores additional content and user settings separately from the Trainz installation folder. A platform-specific default path is used, which can be accessed in your platform-specific file manager as described below. This folder may grow to a substantial size over time. If required, you may specify an alternate location for storing your content.

These instructions apply to TANE build 82340 and above. The same steps can be used for TRS2019, just replace 'TANE' with 'TRS2019' for folder names!

=Locating your Local Data Folder=

From the launcher of any Trainz installation, you can click the "Trainz Settings" button and then switch to the "Install" tab to see the full path to that installation's local data folder. You can navigate directly to that path using your system's file manager, however please keep in mind that the parent folders of the default location may be hidden on some systems so simply starting at the top level of your computer and working your way down may not work.

In order to navigate directly to the local data folder's default location, the following steps can be used:

==Windows==
In Windows, the local data folder is stored by default at a subfolder of "C:\Users\<username>\AppData\Local\N3V Games\TANE" (where "<username>" is the username of the logged-in Windows user account.)

You may access this location in Windows Explorer by entering the path "%appdata%\..\Local\N3V Games\TANE" into the Window Explorer address bar. At this location you will see one or more local data folders, corresponding with your various Trainz installations. The name of each folder here includes a random character string which has no meaning but simply allows for multiple installs to coexist without overwriting each other's data files.

You will also find a text file at this location named "userdata-redirect-map.txt" which lists the correlation between each Trainz installation and its local data folder. While it is possible to hand-edit this file using a program such as WordPad.exe, it is not recommended due to the potential for data loss.

==Mac OS X==
In Mac OS X, the local data folder is stored by default at a subfolder of "/Users/<username>/Library/Containers/com.n3vgames.tane" (where "<username>" is the username of the logged-in Mac OS X user account.)

You may access this location in Finder by using "Go To" (command-shift-G) and then entering the address "~/Library/Containers/com.n3vgames.tane/Data". At this location you will see one or more local data folders, corresponding with your various Trainz installations. The name of each folder here includes a random character string which has no meaning but simply allows for multiple installs to coexist without overwriting each other's data files.

You will also find a file at this location named "userdata-redirect-map.txt" which lists the correlation between each Trainz installation and its local data folder. It is typically not possible to hand-edit this file due to the way that Mac OS X encodes file paths.

=Copy\Move\Archive your Local Data Folder=

# Open "Launcher > Trainz Settings > Install tab".
#:* Note the path displayed in the "Local Data Folder" field (this is your current data directory where your user content resides).
#:* <i>Recommended...</i>
#::* Highlight and Copy this path to Notepad.
#::* Verify all other tabs contain the settings you want, including your authentication credentials.<br>
# Open Windows Explorer and navigate to the current data folder (you may paste the path from step 1 to open directly).
# Open a second instance of Windows Explorer and create a new empty folder at the desired location (e.g. D:\TANE_Content)
#:* Highlight and Copy this new path to your clipboard
#:* Paste this new path into the "Local Data Folder" field
# Close the Settings dialog
#:* ...there will be a prompt telling you about restarting, acknowledge it.
#:* ...close the Launcher
# Focus on the first instance of Windows Explorer, copy all files\folders here into the new folder (the 2nd instance of Explorer).
#:* i.e. folders like backup, cache, etc plus assets.tdx and keystore.tdx.
# Start the launcher
#:* If you're watching the new directory in Explorer you'll see some changes occur (files added).
# '''OPTIONAL''' - Access "Trainz Settings".
#:* All settings verified in step 1 should be present on all tabs.
# Click "Start Trainz"
# Application will launch as expected.
#:* If content is missing, or if a database repair commences, or you're prompted to login, you have made a mistake and will need to re-check the settings above.
<br>
'''Benefits of this process...'''
* Provides a method for you to create data directories using naming conventions easily tracked by humans (as opposed to the machine name Trainz generates for its folders)
* Allows you to move content between builds and patches without resorting to CDP export\import.
* Allows you to work independently from your "source content" making changes without risk and...,
* Point back to your old folder anytime you need a reference or to check "how it worked" before you started modifying content.
* Creates a backup of the "old" content folder and optionally archive\delete the old folder to free up space.

'''WARNING:'''
* DO NOT ever delete the C:\Users\<pc name>\AppData\Local\N3V Games\TANE folder OR the userdata-redirect-map.txt file in that folder.
:* This file is required by TANE to ensure the Local Data Folder is found.
:* If the redirect file does not exist, TANE will create a new one and create a new local data folder in the default location and you are back to your starting point.
<br>
'''TROUBLESHOOTING:'''
* If a new unused /build xxxxxxxx folder is created in the default location upon restarting, you have not followed the steps correctly - please review the steps again.
* If you are asked to enter your username again, you have not followed the steps correctly - please review the steps again.

=Creating a New Local Data Folder=

Sometimes your Local Data Folder can end up with corrupt data. In this case, the solution is to create a new folder which contains no 3rd party content. From there, you can then IMPORT your old content and work out which items may be causing issues.

# Open the Launcher > Trainz Settings > Install (tab).
#:*...see the "Local Data Folder" field, this is the path for your game data.
#:*...the default path is C:\Users\<username>\AppData\Local\N3V Games\<version>\build folder
#::*The default build folder uses an alphanumeric system generated name. The next steps are important to make sure you are looking at the correct folder if you have more than one
#Highlight the full path and use CTRL+C to copy it.
#Open Windows Explorer and paste (CTRL+V) the path into the Explorer address dropdown (usually opens to "this PC")
#:*Key-press <Enter>.
#:*You are now in your games current data directory.
#Navigate up one directory level (you can use the little "up arrow" on the left of of the address dropdown)
#Create a new folder and give it a name
#Now double-click into this new folder (it will be empty), and copy the path just like you did in the above step #2.
#Now go back to Launcher > Trainz Settings > Install tab, paste the new path, replacing the current path, in the "Local Data Folder" field
#Close the Trainz Settings form (a message will appear saying the game needs a restart, click OK, then close the Launcher too)
#Restart the game. A few things will happen
#:*...(if TRS19), you'll see the "Trainz Performance Configuration" dialog. you can select an option or click "Skip..." on the lower right.
#:*...in Explorer you'll see the folder get populated with some new sub-folders and files.
#:*...you'll need to provide your user name\password in Trainz Settings > Internet (tab)
#Click Start Trainz and complete the database build. Now your game is pointing to a "clean data directory".

NOTES:
*This process does not copy any of your local content across, this mirrors a first time installation with built-in content only. You may hear this referred to as "baseline".
*This is applicable to TANE & TRS19 (minus the performance config), and may be used to easily swap between testing & working folders.

Return to [[Help:TRS19|TRS19 Help Page]]<br>
Additional Info: [[Help:Importing Content|Importing Content]]

[[Category:TRS19]]
[[Category: Help]]

Help:TurfFX Effect Layer

2020-02-18T22:36:28Z

Zikchil: /* Hardware Limitations */

The TurfFX Effect Layer is an [[Effect Layer]] type which is used to render grass (and similar foliage). As with all effect layers, turf is painted onto the terrain and automatically generates appropriate geometry for the area surrounding the camera. As compared to the [[Clutter Effect Layer]], TurfFX offers less flexibility but substantial improvements to performance which in turn allows for greater density at greater draw distances and effective wind-synchronised animation.

=Turffx Overview=

A TurfFx asset is made up of individual polygon blades with many options to configure each blade in your Turf Effect Layer and within the asset itself. The individual asset creation process is explained in [[Effect_Layer_Assets]].

==Trainz - Content Creation - #36 - Turf Effects (part 1)==
[https://youtu.be/0zTqYRMIqCs Video]

This first tutorial on Turf Effects explains how to get up and running with painting some grass around your route. The next tutorials on turf will dive into detailed information on all the below parameters.

==Trainz - Content Creation - #37 - Turf Effects (part 2) - Parameters Explained==
[https://youtu.be/4Yc7epaBoDc Video]

This second tutorial on Turf Effects explains in detail all the parameters that come with a Turf Effect Layer.

== Creating and Editing Turffx Layers in Surveyor==

[[File:turfeffectlayeredit.jpg]]

NOTE: To return to ground editing mode you select "Ground" option in the dropdown list in the above image

=== Effect Layer Window ===

The Effect Layers window allows you to edit your effect properties. The UI in this window will change based on what effect you choose (clutter, turf, something else).

We've included some defaults to get you started with TurfFX, and suggest you experiment with each control to customise your effect.

[[file:turf_defaults.jpg]]

==== Select ====

This allows you to select any existing effect layers to view and edit their parameters.

[[File:turfeffectlayerselection.jpg]]

==== Delete ====

This button will delete the currently selected effect layer.

[[File:effectlayerwindow1b.jpg]]

=== Add ===

This button will allow you to create a new effect layer.

[[File:effectlayerwindow1c.jpg]]

==== Name ====

Enter a name for your effect layer.

[[File:turfeffectlayername.jpg]]

==== Turffx-Asset ====

Select a "Turf" asset you want to use in your turffx layer from the dropdown list. Once selected and named, you can customise how this particular layer will be configured wherever it is painted throughout the route.

Note that if you want short grass and long grass, you need to create two different TurfFX layers, or use the Turffx-Height-Scale data binding.

[[File:turfeffectlayerasset.jpg]]

==== Turffx-Density Data Binding ====

The "turffx-density" options and associated "default" value control the [[Effect Layer Data Binding]] (read this link for details) which controls the density of this turffx layer across the route. Density ranges from 0.0 (no turf present) to 1.0 (maximum density).

[[File:turfeffectlayerdensity.jpg]]

[[File:turfeffectlayerdensitydefaultvalue.jpg]]

[[file:turfdensity1.jpg]]

[[file:turfdensity2.jpg]]

[[file:turfdensity3.jpg]]

NOTE: The turffx-density parameter (int1, int2, int4 ...etc) determines how accurate your density will be when painting with the height up/down and sensitivity radius in the topology tab. For example, int1 will give you 1 click while painting to get 100% density (off or on). Int4 will give you 1 click for 1/3rd density, 2 clicks for 2/3rds density, 3 clicks for 3/3rds density. Obviously the more accuracy you need the more data will need to be stored so use the appropriate data binding for the effect you require.

==== Turffx-Height-Scale Data Binding ====

The "turffx-height-scale" options and associated "constant" value control the [[Effect Layer Data Binding]] (read this link for details) which controls the height of this turffx layer across the route. Height ranges from 0.0 (no turf present) to 1.0 (maximum height).

[[File:2018-12-18 105752.png]]

NOTE: The turffx-height-scale parameter (int1, int2, int4 ...etc) determines how accurate your height scale data will be when painting with the height up/down and sensitivity radius in the topology tab. For example, int1 will give you 1 click while painting to get 100% height (i.e. the height is either off or on). Int4 will give you 1 click for 1/3rd height, 2 clicks for 2/3rds height, 3 clicks for full height. Obviously the more accuracy you need the more data will need to be stored so use the appropriate data binding for the effect you require.

==== Geometry-Scale ====

This changes the height of your blade geometry in meters. (So unless you want 1000m high effects, we suggest using low numbers). ;)

[[File:turfeffectlayergeometryscale.jpg]]

==== Blade-Width ====

This changes the width of your blade geometry in meters.

[[File:turfeffectlayerbladewidth.jpg]]

==== Blade-Width-Noise ====

This adds random variation to the width of your blade geometry.

[[File:turfeffectlayerbladewidthnoise.jpg]]

==== Blade-Height-Noise ====

This adds random variation to the height of your blade geometry.

[[File:turfeffectlayerbladeheight.jpg]]

==== Width-Scale-Near ====

This defines the shape of your blade geometry up close to the camera.

[[File:turfeffectlayerwidthscalenear.jpg]]

==== Width-Scale-Far ====

This defines the shape of your blade geometry in the distance.

[[File:turfeffectlayerwidthscalefar.jpg]]

[[file:turfshape.jpg]]

==== Bending-Scale ====

Defines how much your blade geometry will bend in the wind. (bending strength for wind animation)

[[File:turfeffectlayerbendingscale.jpg]]

==== Dispersal ====

Dispersal controls the radius around a seed point to place individual grass blades.

[[File:turfeffectlayerdispersal.jpg]]

[[file:turftdispersal.jpg]]

==== Bunching ====

Bunching controls radial alignment of individual grass blades around the seed point. Bunching equal to one (1) produces maximally aligned distribution of grass blades, while zero (0) would result in completely random distribution.

[[File:turfeffectlayerbunching.jpg]]

[[file:turftbunching.jpg]]

==== Expansion-constant ====

: This affects how many grass blades will be at each point in the grid. Tweaking this number will change the density.
: Expansion = "expansion-constant" + "expansion-multiplier" * "value0"

: Try a starting value of 0.3.

==== Expansion-multiplier ====

: This affects how many grass blades will be at each point in the grid. Tweaking this number will change the density.
: Expansion = "expansion-constant" + "expansion-multiplier" * "value0"
: Try a starting value of 0.3

==== Number-of-seeds-multiplier ====

: This affects how many new points in each grid to sprout grass blades. Tweaking this number will change the density.
: Number of Seeds = "number-of-seeds-multiplier" * "value0"
: Try a starting value of 0.3

== Painting Turffx ==

=== Using Height Up and Down Tool===

Effect Layers are selected in the Advanced Topology Tab. When you change from Ground to any of the Effect Layers you have created, the Height Up, Height Down and Radius tools are used much like the tools in the Paint Tab.

[[File:turfeffectlayerpainting.jpg]]

=== Using Area Fill Tool===
You can also select an area and fill the area with your selected Effect Layer Binding. Set the Effect Fill Density slider when using the Fill tool to adjust the density of your effect layer.

=== Painting Tips ===
* Effect Layers are data intensive, and so you need to work out where you require precision (e.g. in highly visible areas) and where you can use much less precision (e.g. away from the track areas)
* Using 2.5m precision everywhere will consume your scene budget very quickly.
* Using the turffx-height-scale tool will raise or lower existing effect layers only. (i.e. you need to paint some density prior to adjusting the height)
* Experiment with different values such as using 0.001 for dispersal to get that "clumpy" look (then try 0.05, 0.5 etc for different looks)
* TurfFX is currently not supported during route merge.

== New TurfFX Tools (2020) ==

These new tools will be delivered as part of the Trainz Plus update for Q1 2020 and provide a range of new options to make your task of adding effect layers and using them, easier and more flexible.

=== Adding Effect Layers ===
You can now choose from a range of Preset options and edit those options as much as you like.

To access these options, go to Topology Tab -> Advanced Section -> Edit/Add effect layers.

If there are no Effect layers already used in the route, you'll be prompted to create a new one.

Add a name and chose either Turffx or Clutter.<br>
TIP: You can save your TurfFX\Clutter settings as a CDP.

[[File:2020-01-24_105930.png|900px]]

==== Option 1: Using a preset ====
# Select an Effect Preset using either the arrow keys or dropdown list.
# (Optional) Toggle the Advanced options so that you can edit the settings as required.
# Press the check (tick) button to close the Effect Layers window.
Note: Turf Effects can only render in one viewport. This means if you have the Effect Layers preview window showing the turf will be rendered in that window and not in your route.
When closing the Effect Layers window any turffx already painted in your route will begin rendering again after a short delay (~5 seconds).

==== Option 2: Using a preset and editing it ====
# Select an Effect Preset.
# Toggle Advanced Options.
# Edit the Advanced Options.
# Press the check (tick) button to close the Effect Layers window.
Note: Turf Effects can only render in one viewport. This means if you have the Effect Layers preview window showing the turf will be rendered in that window and not in your route.
When closing the Effect Layers window any turffx already painted in your route will begin rendering again after a short delay (~5 seconds).

====Presets versus Named Effect Layers====
It is important to note the difference between Presets and Effect Layers.

Presets are assets. This means they can be saved, uploaded to the DLS, or shared via .cdp. However, you cannot paint using a "Preset" directly.

# To paint, you need to create an "Effect Layer" (which can be made by selecting a Preset).
# Effect Layers are created per route.
# Click the + icon to create a new Effect Layer and give it a name (which can be the same as the Preset name if you like).
# Click the Tick to save the Effect Layer.
# This named Effect Layer is then available in the dropdown list in the Topology > Advanced tab.

NOTE: If you click the Save icon, you will create a new Preset. Of course you can do both, so that when you start another route, you have the Preset available to select when you create a new Effect Layer.

=== Masking Options ===
There are new options in the Advanced Section that determine whether effect layers will or won't be painted in various areas. These options are:
* Avoid-water (Effects will NOT appear under a water layer)
* Altitude-range (Effects will NOT appear outside the max/min altitude set)
* Gradient-range (Effects will NOT appear if the slope exceeds the limit you set)
* Ground-texture-mask (Effects WILL appear ONLY upon the textures you add to the mask)

EXAMPLE:
* To apply a mask, open the Advanced Options and scroll down (enlarge the window if required)
* To add a texture mask click the Add Asset + button
* Enter the name of each texture you want the effect layer to apply to
* Save your effect layer
* Close the editing too and use the painting tools to paint your effect ont he listed texture(s).
* See [[Effect_Layer#Painting_Effect_Layers|Painting_Effect_Layers]] for how to apply the mask.

TIP:
* The accuracy (precision) of effect layers depends on [[TurfFX_Effect_Layer#Turffx-Density_Data_Binding | turffx-density]] settings.
* The higher the precision (for example float16 or float32 using 10m, 5m or 2.5m grid), the more data required and the larger your route will be.
* For texture masking, ensure you add all the textures you want a specific effect layer to appear on.
** If setting more than one mask, all criteria have to be satisfied, so if your effect is not appearing, check all your masks to see what terrain or textures are required
** To delete a mask, move the slider all the way left and click the "x" that appears on that row.

=== Other New Tools ===

====Get Effect====
The Get Effect tool is useful to find which "Effect Layer" is painted in a specific area. Once identified, you can then edit the configuration or select the Effect Layer from the dropdown list in Topology > Advanced.

# Click Edit/Add effect layers
# Click the Get Effect tool. The Preview window is automatically closed and the Effect Layers will display in the world after a few seconds
# Hover your mouse over various effect layers in the 3D world.
# As you move your mouse around the terrain, all of the effect layers (both Turffx and Clutter layers) in that area will be listed in the mouseover help dialog
# If you want to then paint with an identified effect layer, simply select it from the dropdown list in Topology > Advanced
# If you want to edit it, click the ground in that area to load the item in the Effect Layers window
# If you want to edit an item from further down the mouseover list, select the appropriate Effect Layer name from the dropdown in the Effect Layers window.

==== Save as new Preset ====
You can now save your own configurations to allow you to chose the same effect configuration in a different route.

Note that you will still need to create and name a new Effect Layer in the new route.

# Click Topology Tab -> Advanced Section -> Edit/Add effect layers to open the Effect Layers window.
# Choose a Preset from the dropdown list in the Effect Layers window.
# Click the Advanced Toggle to expand the window
# Adjust the various configurable values to modify the Preset
# View the changes in the Preview window
# When happy with the results, click the Save icon above the Preview window
# The Save dialog opens and you can either save as the same name to overwrite that Preset, or change the name to create a new Preset asset.

TIP:
* When painting or filling, if you're wondering why something isn't applying to an area, check your mask settings for that effect layer.

=== Bulk Editing Effect Layers ===

You can now also use the "Bulk Edit" tool to rapidly update a route from older versions of Trainz to use the TurfFX layers. This will place an effect layer ON TOP of an existing ground texture.

[[File:2020-01-24_125216.png|600px]]

# To access the Topology -> Advanced Section -> [ Select an Effect Layer you have created for this route ] -> Click on the "Bulk fill effect layer" icon.
# The "Bulk Asset Update/Replace" window appears.
# In “Assets to update” list, use the Picker to select one or more existing ground textures that you want to apply the effect layer to (or drag a texture from the Paint tab).
# In “Asset to update with” select the Effect layer to use by dragging from the Topology Advanced tab Effect layer dropdown list.
# To change the "median" density or height variation use the “Autofill density/height” slider. Which aspect is adjusted depends upon which “TurfFX” option you have selected under the Topology -> Advanced Section -> TurfFX drop down.
# (Optional) To randomise fill density click the checkbox and adjust the slider to either create a more uniform fill (0%) to a random fill (100%).
# (Optional) To further customise where the effects are painted, click the "Skip areas with" checkbox then choose either "Data for this binding" and "Data for effect layers of this type" from the dropdown. This will skip any effect layer vertices which already have effect layer data.
# Click "Begin" to bulk paint the effect layer on your configuration.

TIPS:
* Data for this binding means "any grid that has the selected effect layer on it".
* Data for effect layers of this type means "any grid that has the selected effect layer type (i.e. turf or clutter)"
* If you have applied any of the new "masking" options (Avoid-water, Altitude-range, Gradient-range, Ground-texture-mask) to the effect layer you are using, then the results you see in the world will depend on each of the configured settings
** i.e. If you're wondering why something isn't applying to an area, check your mask settings.
* Bulk Edit adds the effect layer ON TOP of the ground texture. It does not replace the ground texture. To replace a texture, drag another texture into the “Asset to update with” box.
* Use a [[TurfFX_Effect_Layer#Turffx-Density_Data_Binding | turffx-density]] higher than Int1 to have a greater range of density (precision).

== Bulk Paint Under Splines (2020)==
With the latest Trainz Plus update (Q1 2020), there is also a new tool designed to quickly apply ballast under your track. Of course you can also apply any other texture under a spline such as grass along a roadside, or fence line.

# From the Tools Menu Select "Bulk Asset Update/Replace".
# In “Assets to update” list, use the Picker to select one or more existing splines, or drag more splines from the Track list.
# In “Asset to update with” select the ground texture you want to use as fill.
# Under the Paint Tab -> Radius, change the radius to the width you wish to paint. (The smallest radius will give a 10m wide texture).
# Click "Begin" to bulk paint the ground texture under the spline chosen.

=Example Usage=

== Short Grass ==
Watch the video tutorial on Short Grass [[https://youtu.be/AgaaPBjHZyA HERE]]

[[File:tfx_short.jpg|1000px]]

[[File:tfx_short_info.jpg|493px]]

== Medium Grass ==
Watch the video tutorial on Medium Grass [[https://youtu.be/5TTwidjCuuQ HERE]]

== Long Grass ==
Watch the video tutorial on Long Grass [[https://youtu.be/qoH5OfcgfjU HERE]]

[[File:tfx_long.jpg|1000px]]

[[File:tfx_long_info.jpg|493px]]

== Long Grass + Long Seed Grass ==
Watch the video tutorial on Long Seed Grass [[https://youtu.be/l04As0QFFPQ HERE]]

[[File:tfx_long_seed.jpg|1000px]]

[[File:tfx_long_info.jpg|493px]] [[File:tfx_long_seed_info.jpg|493px]]

== Turf ==
[[File:tfx_turf.jpg|1000px]]

[[File:tfx_turf_info.jpg|493px]]

== Cut Turf ==
[[File:tfx_turf_cut.jpg|1000px]]

[[File:tfx_turf_cut_info.jpg|493px]]

== Other ==
[[File:TurfFX-Example0.jpg|1000px]]

[[File:TurfFX-Example1.jpg|1000px]]

=Clutter Effect Layer=

For help on editing and using the [[Help:Effect_Layer_Dialog|Clutter Effect layer]], click the link.

=Hardware Limitations=
TurfFX is developed by NVIDIA and is designed to takes advantage of high-end GPU's with substantial amounts of VRAM.

1. TurfFX is currently supported only for Windows.

2. Whereas Trainz will typically run (albeit slowly, or at reduced settings) on below-spec computers, TurfFX will need to be disabled entirely if the GPU is insufficient. We expect the minimum of a GeForce GTX 750 to get reasonable performance.

3. With TurfFX disabled, the Effect Layers are ignored entirely, and there is no performance penalty for those objects that are disabled.
* TurfFX may be disabled via "Launcher > Trainz Settings > Performance tab > Detail scenery:..."

=TurfFx Asset Creation=
For detailed information on creating new grass types, crops, weeds etc, please visit [[Effect_Layer_Assets]]

=See Also=
[[Help:Effect_Layer_Dialog]]<br>
[[Clutter_Effect_Layer]]

Back to [[Effect_Layer]]<br>
Back to [[Help:TRS19]]

[[Category:Content creation]]
[[Category:TRS19]]
[[Category:Help]]

Help:TurfFX Effect Layer

2020-02-13T23:32:08Z

Zikchil: /* Masking Options */

The TurfFX Effect Layer is an [[Effect Layer]] type which is used to render grass (and similar foliage). As with all effect layers, turf is painted onto the terrain and automatically generates appropriate geometry for the area surrounding the camera. As compared to the [[Clutter Effect Layer]], TurfFX offers less flexibility but substantial improvements to performance which in turn allows for greater density at greater draw distances and effective wind-synchronised animation.

=Turffx Overview=

A TurfFx asset is made up of individual polygon blades with many options to configure each blade in your Turf Effect Layer and within the asset itself. The individual asset creation process is explained in [[Effect_Layer_Assets]].

==Trainz - Content Creation - #36 - Turf Effects (part 1)==
[https://youtu.be/0zTqYRMIqCs Video]

This first tutorial on Turf Effects explains how to get up and running with painting some grass around your route. The next tutorials on turf will dive into detailed information on all the below parameters.

==Trainz - Content Creation - #37 - Turf Effects (part 2) - Parameters Explained==
[https://youtu.be/4Yc7epaBoDc Video]

This second tutorial on Turf Effects explains in detail all the parameters that come with a Turf Effect Layer.

== Creating and Editing Turffx Layers in Surveyor==

[[File:turfeffectlayeredit.jpg]]

NOTE: To return to ground editing mode you select "Ground" option in the dropdown list in the above image

=== Effect Layer Window ===

The Effect Layers window allows you to edit your effect properties. The UI in this window will change based on what effect you choose (clutter, turf, something else).

We've included some defaults to get you started with TurfFX, and suggest you experiment with each control to customise your effect.

[[file:turf_defaults.jpg]]

==== Select ====

This allows you to select any existing effect layers to view and edit their parameters.

[[File:turfeffectlayerselection.jpg]]

==== Delete ====

This button will delete the currently selected effect layer.

[[File:effectlayerwindow1b.jpg]]

=== Add ===

This button will allow you to create a new effect layer.

[[File:effectlayerwindow1c.jpg]]

==== Name ====

Enter a name for your effect layer.

[[File:turfeffectlayername.jpg]]

==== Turffx-Asset ====

Select a "Turf" asset you want to use in your turffx layer from the dropdown list. Once selected and named, you can customise how this particular layer will be configured wherever it is painted throughout the route.

Note that if you want short grass and long grass, you need to create two different TurfFX layers, or use the Turffx-Height-Scale data binding.

[[File:turfeffectlayerasset.jpg]]

==== Turffx-Density Data Binding ====

The "turffx-density" options and associated "default" value control the [[Effect Layer Data Binding]] (read this link for details) which controls the density of this turffx layer across the route. Density ranges from 0.0 (no turf present) to 1.0 (maximum density).

[[File:turfeffectlayerdensity.jpg]]

[[File:turfeffectlayerdensitydefaultvalue.jpg]]

[[file:turfdensity1.jpg]]

[[file:turfdensity2.jpg]]

[[file:turfdensity3.jpg]]

NOTE: The turffx-density parameter (int1, int2, int4 ...etc) determines how accurate your density will be when painting with the height up/down and sensitivity radius in the topology tab. For example, int1 will give you 1 click while painting to get 100% density (off or on). Int4 will give you 1 click for 1/3rd density, 2 clicks for 2/3rds density, 3 clicks for 3/3rds density. Obviously the more accuracy you need the more data will need to be stored so use the appropriate data binding for the effect you require.

==== Turffx-Height-Scale Data Binding ====

The "turffx-height-scale" options and associated "constant" value control the [[Effect Layer Data Binding]] (read this link for details) which controls the height of this turffx layer across the route. Height ranges from 0.0 (no turf present) to 1.0 (maximum height).

[[File:2018-12-18 105752.png]]

NOTE: The turffx-height-scale parameter (int1, int2, int4 ...etc) determines how accurate your height scale data will be when painting with the height up/down and sensitivity radius in the topology tab. For example, int1 will give you 1 click while painting to get 100% height (i.e. the height is either off or on). Int4 will give you 1 click for 1/3rd height, 2 clicks for 2/3rds height, 3 clicks for full height. Obviously the more accuracy you need the more data will need to be stored so use the appropriate data binding for the effect you require.

==== Geometry-Scale ====

This changes the height of your blade geometry in meters. (So unless you want 1000m high effects, we suggest using low numbers). ;)

[[File:turfeffectlayergeometryscale.jpg]]

==== Blade-Width ====

This changes the width of your blade geometry in meters.

[[File:turfeffectlayerbladewidth.jpg]]

==== Blade-Width-Noise ====

This adds random variation to the width of your blade geometry.

[[File:turfeffectlayerbladewidthnoise.jpg]]

==== Blade-Height-Noise ====

This adds random variation to the height of your blade geometry.

[[File:turfeffectlayerbladeheight.jpg]]

==== Width-Scale-Near ====

This defines the shape of your blade geometry up close to the camera.

[[File:turfeffectlayerwidthscalenear.jpg]]

==== Width-Scale-Far ====

This defines the shape of your blade geometry in the distance.

[[File:turfeffectlayerwidthscalefar.jpg]]

[[file:turfshape.jpg]]

==== Bending-Scale ====

Defines how much your blade geometry will bend in the wind. (bending strength for wind animation)

[[File:turfeffectlayerbendingscale.jpg]]

==== Dispersal ====

Dispersal controls the radius around a seed point to place individual grass blades.

[[File:turfeffectlayerdispersal.jpg]]

[[file:turftdispersal.jpg]]

==== Bunching ====

Bunching controls radial alignment of individual grass blades around the seed point. Bunching equal to one (1) produces maximally aligned distribution of grass blades, while zero (0) would result in completely random distribution.

[[File:turfeffectlayerbunching.jpg]]

[[file:turftbunching.jpg]]

==== Expansion-constant ====

: This affects how many grass blades will be at each point in the grid. Tweaking this number will change the density.
: Expansion = "expansion-constant" + "expansion-multiplier" * "value0"

: Try a starting value of 0.3.

==== Expansion-multiplier ====

: This affects how many grass blades will be at each point in the grid. Tweaking this number will change the density.
: Expansion = "expansion-constant" + "expansion-multiplier" * "value0"
: Try a starting value of 0.3

==== Number-of-seeds-multiplier ====

: This affects how many new points in each grid to sprout grass blades. Tweaking this number will change the density.
: Number of Seeds = "number-of-seeds-multiplier" * "value0"
: Try a starting value of 0.3

== Painting Turffx ==

=== Using Height Up and Down Tool===

Effect Layers are selected in the Advanced Topology Tab. When you change from Ground to any of the Effect Layers you have created, the Height Up, Height Down and Radius tools are used much like the tools in the Paint Tab.

[[File:turfeffectlayerpainting.jpg]]

=== Using Area Fill Tool===
You can also select an area and fill the area with your selected Effect Layer Binding. Set the Effect Fill Density slider when using the Fill tool to adjust the density of your effect layer.

=== Painting Tips ===
* Effect Layers are data intensive, and so you need to work out where you require precision (e.g. in highly visible areas) and where you can use much less precision (e.g. away from the track areas)
* Using 2.5m precision everywhere will consume your scene budget very quickly.
* Using the turffx-height-scale tool will raise or lower existing effect layers only. (i.e. you need to paint some density prior to adjusting the height)
* Experiment with different values such as using 0.001 for dispersal to get that "clumpy" look (then try 0.05, 0.5 etc for different looks)
* TurfFX is currently not supported during route merge.

== New TurfFX Tools (2020) ==

These new tools will be delivered as part of the Trainz Plus update for Q1 2020 and provide a range of new options to make your task of adding effect layers and using them, easier and more flexible.

=== Adding Effect Layers ===
You can now choose from a range of Preset options and edit those options as much as you like.

To access these options, go to Topology Tab -> Advanced Section -> Edit/Add effect layers.

If there are no Effect layers already used in the route, you'll be prompted to create a new one.

Add a name and chose either Turffx or Clutter.<br>
TIP: You can save your TurfFX\Clutter settings as a CDP.

[[File:2020-01-24_105930.png|900px]]

==== Option 1: Using a preset ====
# Select an Effect Preset using either the arrow keys or dropdown list.
# (Optional) Toggle the Advanced options so that you can edit the settings as required.
# Press the check (tick) button to close the Effect Layers window.
Note: Turf Effects can only render in one viewport. This means if you have the Effect Layers preview window showing the turf will be rendered in that window and not in your route.
When closing the Effect Layers window any turffx already painted in your route will begin rendering again after a short delay (~5 seconds).

==== Option 2: Using a preset and editing it ====
# Select an Effect Preset.
# Toggle Advanced Options.
# Edit the Advanced Options.
# Press the check (tick) button to close the Effect Layers window.
Note: Turf Effects can only render in one viewport. This means if you have the Effect Layers preview window showing the turf will be rendered in that window and not in your route.
When closing the Effect Layers window any turffx already painted in your route will begin rendering again after a short delay (~5 seconds).

====Presets versus Named Effect Layers====
It is important to note the difference between Presets and Effect Layers.

Presets are assets. This means they can be saved, uploaded to the DLS, or shared via .cdp. However, you cannot paint using a "Preset" directly.

# To paint, you need to create an "Effect Layer" (which can be made by selecting a Preset).
# Effect Layers are created per route.
# Click the + icon to create a new Effect Layer and give it a name (which can be the same as the Preset name if you like).
# Click the Tick to save the Effect Layer.
# This named Effect Layer is then available in the dropdown list in the Topology > Advanced tab.

NOTE: If you click the Save icon, you will create a new Preset. Of course you can do both, so that when you start another route, you have the Preset available to select when you create a new Effect Layer.

=== Masking Options ===
There are new options in the Advanced Section that determine whether effect layers will or won't be painted in various areas. These options are:
* Avoid-water (Effects will NOT appear under a water layer)
* Altitude-range (Effects will NOT appear outside the max/min altitude set)
* Gradient-range (Effects will NOT appear if the slope exceeds the limit you set)
* Ground-texture-mask (Effects WILL appear ONLY upon the textures you add to the mask)

EXAMPLE:
* To apply a mask, open the Advanced Options and scroll down (enlarge the window if required)
* To add a texture mask click the Add Asset + button
* Enter the name of each texture you want the effect layer to apply to
* Save your effect layer
* Close the editing too and use the painting tools to paint your effect ont he listed texture(s).
* See [[Effect_Layer#Painting_Effect_Layers|Painting_Effect_Layers]] for how to apply the mask.

TIP:
* The accuracy (precision) of effect layers depends on [[TurfFX_Effect_Layer#Turffx-Density_Data_Binding | turffx-density]] settings.
* The higher the precision (for example float16 or float32 using 10m, 5m or 2.5m grid), the more data required and the larger your route will be.
* For texture masking, ensure you add all the textures you want a specific effect layer to appear on.
** If setting more than one mask, all criteria have to be satisfied, so if your effect is not appearing, check all your masks to see what terrain or textures are required
** To delete a mask, move the slider all the way left and click the "x" that appears on that row.

=== Other New Tools ===

====Get Effect====
The Get Effect tool is useful to find which "Effect Layer" is painted in a specific area. Once identified, you can then edit the configuration or select the Effect Layer from the dropdown list in Topology > Advanced.

# Click Edit/Add effect layers
# Click the Get Effect tool. The Preview window is automatically closed and the Effect Layers will display in the world after a few seconds
# Hover your mouse over various effect layers in the 3D world.
# As you move your mouse around the terrain, all of the effect layers (both Turffx and Clutter layers) in that area will be listed in the mouseover help dialog
# If you want to then paint with an identified effect layer, simply select it from the dropdown list in Topology > Advanced
# If you want to edit it, click the ground in that area to load the item in the Effect Layers window
# If you want to edit an item from further down the mouseover list, select the appropriate Effect Layer name from the dropdown in the Effect Layers window.

==== Save as new Preset ====
You can now save your own configurations to allow you to chose the same effect configuration in a different route.

Note that you will still need to create and name a new Effect Layer in the new route.

# Click Topology Tab -> Advanced Section -> Edit/Add effect layers to open the Effect Layers window.
# Choose a Preset from the dropdown list in the Effect Layers window.
# Click the Advanced Toggle to expand the window
# Adjust the various configurable values to modify the Preset
# View the changes in the Preview window
# When happy with the results, click the Save icon above the Preview window
# The Save dialog opens and you can either save as the same name to overwrite that Preset, or change the name to create a new Preset asset.

TIP:
* When painting or filling, if you're wondering why something isn't applying to an area, check your mask settings for that effect layer.

=== Bulk Editing Effect Layers ===

You can now also use the "Bulk Edit" tool to rapidly update a route from older versions of Trainz to use the TurfFX layers. This will place an effect layer ON TOP of an existing ground texture.

[[File:2020-01-24_125216.png|600px]]

# To access the Topology -> Advanced Section -> [ Select an Effect Layer you have created for this route ] -> Click on the "Bulk fill effect layer" icon.
# The "Bulk Asset Update/Replace" window appears.
# In “Assets to update” list, use the Picker to select one or more existing ground textures that you want to apply the effect layer to (or drag a texture from the Paint tab).
# In “Asset to update with” select the Effect layer to use by dragging from the Topology Advanced tab Effect layer dropdown list.
# To change the "median" density or height variation use the “Autofill density/height” slider. Which aspect is adjusted depends upon which “TurfFX” option you have selected under the Topology -> Advanced Section -> TurfFX drop down.
# (Optional) To randomise fill density click the checkbox and adjust the slider to either create a more uniform fill (0%) to a random fill (100%).
# (Optional) To further customise where the effects are painted, click the "Skip areas with" checkbox then choose either "Data for this binding" and "Data for effect layers of this type" from the dropdown. This will skip any effect layer vertices which already have effect layer data.
# Click "Begin" to bulk paint the effect layer on your configuration.

TIPS:
* Data for this binding means "any grid that has the selected effect layer on it".
* Data for effect layers of this type means "any grid that has the selected effect layer type (i.e. turf or clutter)"
* If you have applied any of the new "masking" options (Avoid-water, Altitude-range, Gradient-range, Ground-texture-mask) to the effect layer you are using, then the results you see in the world will depend on each of the configured settings
** i.e. If you're wondering why something isn't applying to an area, check your mask settings.
* Bulk Edit adds the effect layer ON TOP of the ground texture. It does not replace the ground texture. To replace a texture, drag another texture into the “Asset to update with” box.
* Use a [[TurfFX_Effect_Layer#Turffx-Density_Data_Binding | turffx-density]] higher than Int1 to have a greater range of density (precision).

== Bulk Paint Under Splines (2020)==
With the latest Trainz Plus update (Q1 2020), there is also a new tool designed to quickly apply ballast under your track. Of course you can also apply any other texture under a spline such as grass along a roadside, or fence line.

# From the Tools Menu Select "Bulk Asset Update/Replace".
# In “Assets to update” list, use the Picker to select one or more existing splines, or drag more splines from the Track list.
# In “Asset to update with” select the ground texture you want to use as fill.
# Under the Paint Tab -> Radius, change the radius to the width you wish to paint. (The smallest radius will give a 10m wide texture).
# Click "Begin" to bulk paint the ground texture under the spline chosen.

=Example Usage=

== Short Grass ==
Watch the video tutorial on Short Grass [[https://youtu.be/AgaaPBjHZyA HERE]]

[[File:tfx_short.jpg|1000px]]

[[File:tfx_short_info.jpg|493px]]

== Medium Grass ==
Watch the video tutorial on Medium Grass [[https://youtu.be/5TTwidjCuuQ HERE]]

== Long Grass ==
Watch the video tutorial on Long Grass [[https://youtu.be/qoH5OfcgfjU HERE]]

[[File:tfx_long.jpg|1000px]]

[[File:tfx_long_info.jpg|493px]]

== Long Grass + Long Seed Grass ==
Watch the video tutorial on Long Seed Grass [[https://youtu.be/l04As0QFFPQ HERE]]

[[File:tfx_long_seed.jpg|1000px]]

[[File:tfx_long_info.jpg|493px]] [[File:tfx_long_seed_info.jpg|493px]]

== Turf ==
[[File:tfx_turf.jpg|1000px]]

[[File:tfx_turf_info.jpg|493px]]

== Cut Turf ==
[[File:tfx_turf_cut.jpg|1000px]]

[[File:tfx_turf_cut_info.jpg|493px]]

== Other ==
[[File:TurfFX-Example0.jpg|1000px]]

[[File:TurfFX-Example1.jpg|1000px]]

=Clutter Effect Layer=

For help on editing and using the [[Help:Effect_Layer_Dialog|Clutter Effect layer]], click the link.

=Hardware Limitations=
TurfFX is developed by NVIDIA and is designed to takes advantage of high-end GPU's with substantial amounts of VRAM.

1. TurfFX is currently supported only for Windows.

2. Whereas Trainz will typically run (albeit slowly, or at reduced settings) on below-spec computers, TurfFX will need to be disabled entirely if the GPU is insufficient. We expect the minimum of a GeForce GTX 750 to get reasonable performance.

3. With TurfFX disabled, the Effect Layers are ignored entirely, and there is no performance penalty for those objects that are disabled.

=TurfFx Asset Creation=
For detailed information on creating new grass types, crops, weeds etc, please visit [[Effect_Layer_Assets]]

=See Also=
[[Help:Effect_Layer_Dialog]]<br>
[[Clutter_Effect_Layer]]

Back to [[Effect_Layer]]<br>
Back to [[Help:TRS19]]

[[Category:Content creation]]
[[Category:TRS19]]
[[Category:Help]]

Help:TurfFX Effect Layer

2020-02-13T16:33:58Z

Zikchil: /* Adding Effect Layers */

The TurfFX Effect Layer is an [[Effect Layer]] type which is used to render grass (and similar foliage). As with all effect layers, turf is painted onto the terrain and automatically generates appropriate geometry for the area surrounding the camera. As compared to the [[Clutter Effect Layer]], TurfFX offers less flexibility but substantial improvements to performance which in turn allows for greater density at greater draw distances and effective wind-synchronised animation.

=Turffx Overview=

A TurfFx asset is made up of individual polygon blades with many options to configure each blade in your Turf Effect Layer and within the asset itself. The individual asset creation process is explained in [[Effect_Layer_Assets]].

==Trainz - Content Creation - #36 - Turf Effects (part 1)==
[https://youtu.be/0zTqYRMIqCs Video]

This first tutorial on Turf Effects explains how to get up and running with painting some grass around your route. The next tutorials on turf will dive into detailed information on all the below parameters.

==Trainz - Content Creation - #37 - Turf Effects (part 2) - Parameters Explained==
[https://youtu.be/4Yc7epaBoDc Video]

This second tutorial on Turf Effects explains in detail all the parameters that come with a Turf Effect Layer.

== Creating and Editing Turffx Layers in Surveyor==

[[File:turfeffectlayeredit.jpg]]

NOTE: To return to ground editing mode you select "Ground" option in the dropdown list in the above image

=== Effect Layer Window ===

The Effect Layers window allows you to edit your effect properties. The UI in this window will change based on what effect you choose (clutter, turf, something else).

We've included some defaults to get you started with TurfFX, and suggest you experiment with each control to customise your effect.

[[file:turf_defaults.jpg]]

==== Select ====

This allows you to select any existing effect layers to view and edit their parameters.

[[File:turfeffectlayerselection.jpg]]

==== Delete ====

This button will delete the currently selected effect layer.

[[File:effectlayerwindow1b.jpg]]

=== Add ===

This button will allow you to create a new effect layer.

[[File:effectlayerwindow1c.jpg]]

==== Name ====

Enter a name for your effect layer.

[[File:turfeffectlayername.jpg]]

==== Turffx-Asset ====

Select a "Turf" asset you want to use in your turffx layer from the dropdown list. Once selected and named, you can customise how this particular layer will be configured wherever it is painted throughout the route.

Note that if you want short grass and long grass, you need to create two different TurfFX layers, or use the Turffx-Height-Scale data binding.

[[File:turfeffectlayerasset.jpg]]

==== Turffx-Density Data Binding ====

The "turffx-density" options and associated "default" value control the [[Effect Layer Data Binding]] (read this link for details) which controls the density of this turffx layer across the route. Density ranges from 0.0 (no turf present) to 1.0 (maximum density).

[[File:turfeffectlayerdensity.jpg]]

[[File:turfeffectlayerdensitydefaultvalue.jpg]]

[[file:turfdensity1.jpg]]

[[file:turfdensity2.jpg]]

[[file:turfdensity3.jpg]]

NOTE: The turffx-density parameter (int1, int2, int4 ...etc) determines how accurate your density will be when painting with the height up/down and sensitivity radius in the topology tab. For example, int1 will give you 1 click while painting to get 100% density (off or on). Int4 will give you 1 click for 1/3rd density, 2 clicks for 2/3rds density, 3 clicks for 3/3rds density. Obviously the more accuracy you need the more data will need to be stored so use the appropriate data binding for the effect you require.

==== Turffx-Height-Scale Data Binding ====

The "turffx-height-scale" options and associated "constant" value control the [[Effect Layer Data Binding]] (read this link for details) which controls the height of this turffx layer across the route. Height ranges from 0.0 (no turf present) to 1.0 (maximum height).

[[File:2018-12-18 105752.png]]

NOTE: The turffx-height-scale parameter (int1, int2, int4 ...etc) determines how accurate your height scale data will be when painting with the height up/down and sensitivity radius in the topology tab. For example, int1 will give you 1 click while painting to get 100% height (i.e. the height is either off or on). Int4 will give you 1 click for 1/3rd height, 2 clicks for 2/3rds height, 3 clicks for full height. Obviously the more accuracy you need the more data will need to be stored so use the appropriate data binding for the effect you require.

==== Geometry-Scale ====

This changes the height of your blade geometry in meters. (So unless you want 1000m high effects, we suggest using low numbers). ;)

[[File:turfeffectlayergeometryscale.jpg]]

==== Blade-Width ====

This changes the width of your blade geometry in meters.

[[File:turfeffectlayerbladewidth.jpg]]

==== Blade-Width-Noise ====

This adds random variation to the width of your blade geometry.

[[File:turfeffectlayerbladewidthnoise.jpg]]

==== Blade-Height-Noise ====

This adds random variation to the height of your blade geometry.

[[File:turfeffectlayerbladeheight.jpg]]

==== Width-Scale-Near ====

This defines the shape of your blade geometry up close to the camera.

[[File:turfeffectlayerwidthscalenear.jpg]]

==== Width-Scale-Far ====

This defines the shape of your blade geometry in the distance.

[[File:turfeffectlayerwidthscalefar.jpg]]

[[file:turfshape.jpg]]

==== Bending-Scale ====

Defines how much your blade geometry will bend in the wind. (bending strength for wind animation)

[[File:turfeffectlayerbendingscale.jpg]]

==== Dispersal ====

Dispersal controls the radius around a seed point to place individual grass blades.

[[File:turfeffectlayerdispersal.jpg]]

[[file:turftdispersal.jpg]]

==== Bunching ====

Bunching controls radial alignment of individual grass blades around the seed point. Bunching equal to one (1) produces maximally aligned distribution of grass blades, while zero (0) would result in completely random distribution.

[[File:turfeffectlayerbunching.jpg]]

[[file:turftbunching.jpg]]

==== Expansion-constant ====

: This affects how many grass blades will be at each point in the grid. Tweaking this number will change the density.
: Expansion = "expansion-constant" + "expansion-multiplier" * "value0"

: Try a starting value of 0.3.

==== Expansion-multiplier ====

: This affects how many grass blades will be at each point in the grid. Tweaking this number will change the density.
: Expansion = "expansion-constant" + "expansion-multiplier" * "value0"
: Try a starting value of 0.3

==== Number-of-seeds-multiplier ====

: This affects how many new points in each grid to sprout grass blades. Tweaking this number will change the density.
: Number of Seeds = "number-of-seeds-multiplier" * "value0"
: Try a starting value of 0.3

== Painting Turffx ==

=== Using Height Up and Down Tool===

Effect Layers are selected in the Advanced Topology Tab. When you change from Ground to any of the Effect Layers you have created, the Height Up, Height Down and Radius tools are used much like the tools in the Paint Tab.

[[File:turfeffectlayerpainting.jpg]]

=== Using Area Fill Tool===
You can also select an area and fill the area with your selected Effect Layer Binding. Set the Effect Fill Density slider when using the Fill tool to adjust the density of your effect layer.

=== Painting Tips ===
* Effect Layers are data intensive, and so you need to work out where you require precision (e.g. in highly visible areas) and where you can use much less precision (e.g. away from the track areas)
* Using 2.5m precision everywhere will consume your scene budget very quickly.
* Using the turffx-height-scale tool will raise or lower existing effect layers only. (i.e. you need to paint some density prior to adjusting the height)
* Experiment with different values such as using 0.001 for dispersal to get that "clumpy" look (then try 0.05, 0.5 etc for different looks)
* TurfFX is currently not supported during route merge.

== New TurfFX Tools (2020) ==

These new tools will be delivered as part of the Trainz Plus update for Q1 2020 and provide a range of new options to make your task of adding effect layers and using them, easier and more flexible.

=== Adding Effect Layers ===
You can now choose from a range of Preset options and edit those options as much as you like.

To access these options, go to Topology Tab -> Advanced Section -> Edit/Add effect layers.

If there are no Effect layers already used in the route, you'll be prompted to create a new one.

Add a name and chose either Turffx or Clutter.<br>
TIP: You can save your TurfFX\Clutter settings as a CDP.

[[File:2020-01-24_105930.png|900px]]

==== Option 1: Using a preset ====
# Select an Effect Preset using either the arrow keys or dropdown list.
# (Optional) Toggle the Advanced options so that you can edit the settings as required.
# Press the check (tick) button to close the Effect Layers window.
Note: Turf Effects can only render in one viewport. This means if you have the Effect Layers preview window showing the turf will be rendered in that window and not in your route.
When closing the Effect Layers window any turffx already painted in your route will begin rendering again after a short delay (~5 seconds).

==== Option 2: Using a preset and editing it ====
# Select an Effect Preset.
# Toggle Advanced Options.
# Edit the Advanced Options.
# Press the check (tick) button to close the Effect Layers window.
Note: Turf Effects can only render in one viewport. This means if you have the Effect Layers preview window showing the turf will be rendered in that window and not in your route.
When closing the Effect Layers window any turffx already painted in your route will begin rendering again after a short delay (~5 seconds).

====Presets versus Named Effect Layers====
It is important to note the difference between Presets and Effect Layers.

Presets are assets. This means they can be saved, uploaded to the DLS, or shared via .cdp. However, you cannot paint using a "Preset" directly.

# To paint, you need to create an "Effect Layer" (which can be made by selecting a Preset).
# Effect Layers are created per route.
# Click the + icon to create a new Effect Layer and give it a name (which can be the same as the Preset name if you like).
# Click the Tick to save the Effect Layer.
# This named Effect Layer is then available in the dropdown list in the Topology > Advanced tab.

NOTE: If you click the Save icon, you will create a new Preset. Of course you can do both, so that when you start another route, you have the Preset available to select when you create a new Effect Layer.

=== Masking Options ===
There are new options in the Advanced Section that determine whether effect layers will or won't be painted in various areas. These options are:
* Avoid-water (Effects will NOT appear under a water layer)
* Altitude-range (Effects will NOT appear outside the max/min altitude set)
* Gradient-range (Effects will NOT appear if the slope exceeds the limit you set)
* Ground-texture-mask (Effects WILL appear ONLY upon the textures you add to the mask)

EXAMPLE:
* To apply a mask, open the Advanced Options and scroll down (enlarge the window if required)
* To add a texture mask click the Add Asset + button
* Enter the name of each texture you want the effect layer to apply to
* Save your effect layer
* Close the editing too and use the painting tools to paint your effect ont he listed texture(s).
* See [[Effect_Layer#Painting_Effect_Layers|Painting_Effect_Layers]] for how to apply the mask.

TIP:
* The accuracy (precision) of effect layers depends on [[TurfFX_Effect_Layer#Turffx-Density_Data_Binding | turffx-density]] settings.
* The higher the precision (for example float16 or float32 using 10m, 5m or 2.5m grid), the more data required and the larger your route will be.
* For texture masking, ensure you add all the textures you want a specific effect layer to appear on.
* If setting more than one mask, all criteria have to be satisfied, so if your effect is not appearing, check all your masks to see what terrain or textures are required

=== Other New Tools ===

====Get Effect====
The Get Effect tool is useful to find which "Effect Layer" is painted in a specific area. Once identified, you can then edit the configuration or select the Effect Layer from the dropdown list in Topology > Advanced.

# Click Edit/Add effect layers
# Click the Get Effect tool. The Preview window is automatically closed and the Effect Layers will display in the world after a few seconds
# Hover your mouse over various effect layers in the 3D world.
# As you move your mouse around the terrain, all of the effect layers (both Turffx and Clutter layers) in that area will be listed in the mouseover help dialog
# If you want to then paint with an identified effect layer, simply select it from the dropdown list in Topology > Advanced
# If you want to edit it, click the ground in that area to load the item in the Effect Layers window
# If you want to edit an item from further down the mouseover list, select the appropriate Effect Layer name from the dropdown in the Effect Layers window.

==== Save as new Preset ====
You can now save your own configurations to allow you to chose the same effect configuration in a different route.

Note that you will still need to create and name a new Effect Layer in the new route.

# Click Topology Tab -> Advanced Section -> Edit/Add effect layers to open the Effect Layers window.
# Choose a Preset from the dropdown list in the Effect Layers window.
# Click the Advanced Toggle to expand the window
# Adjust the various configurable values to modify the Preset
# View the changes in the Preview window
# When happy with the results, click the Save icon above the Preview window
# The Save dialog opens and you can either save as the same name to overwrite that Preset, or change the name to create a new Preset asset.

TIP:
* When painting or filling, if you're wondering why something isn't applying to an area, check your mask settings for that effect layer.

=== Bulk Editing Effect Layers ===

You can now also use the "Bulk Edit" tool to rapidly update a route from older versions of Trainz to use the TurfFX layers. This will place an effect layer ON TOP of an existing ground texture.

[[File:2020-01-24_125216.png|600px]]

# To access the Topology -> Advanced Section -> [ Select an Effect Layer you have created for this route ] -> Click on the "Bulk fill effect layer" icon.
# The "Bulk Asset Update/Replace" window appears.
# In “Assets to update” list, use the Picker to select one or more existing ground textures that you want to apply the effect layer to (or drag a texture from the Paint tab).
# In “Asset to update with” select the Effect layer to use by dragging from the Topology Advanced tab Effect layer dropdown list.
# To change the "median" density or height variation use the “Autofill density/height” slider. Which aspect is adjusted depends upon which “TurfFX” option you have selected under the Topology -> Advanced Section -> TurfFX drop down.
# (Optional) To randomise fill density click the checkbox and adjust the slider to either create a more uniform fill (0%) to a random fill (100%).
# (Optional) To further customise where the effects are painted, click the "Skip areas with" checkbox then choose either "Data for this binding" and "Data for effect layers of this type" from the dropdown. This will skip any effect layer vertices which already have effect layer data.
# Click "Begin" to bulk paint the effect layer on your configuration.

TIPS:
* Data for this binding means "any grid that has the selected effect layer on it".
* Data for effect layers of this type means "any grid that has the selected effect layer type (i.e. turf or clutter)"
* If you have applied any of the new "masking" options (Avoid-water, Altitude-range, Gradient-range, Ground-texture-mask) to the effect layer you are using, then the results you see in the world will depend on each of the configured settings
** i.e. If you're wondering why something isn't applying to an area, check your mask settings.
* Bulk Edit adds the effect layer ON TOP of the ground texture. It does not replace the ground texture. To replace a texture, drag another texture into the “Asset to update with” box.
* Use a [[TurfFX_Effect_Layer#Turffx-Density_Data_Binding | turffx-density]] higher than Int1 to have a greater range of density (precision).

== Bulk Paint Under Splines (2020)==
With the latest Trainz Plus update (Q1 2020), there is also a new tool designed to quickly apply ballast under your track. Of course you can also apply any other texture under a spline such as grass along a roadside, or fence line.

# From the Tools Menu Select "Bulk Asset Update/Replace".
# In “Assets to update” list, use the Picker to select one or more existing splines, or drag more splines from the Track list.
# In “Asset to update with” select the ground texture you want to use as fill.
# Under the Paint Tab -> Radius, change the radius to the width you wish to paint. (The smallest radius will give a 10m wide texture).
# Click "Begin" to bulk paint the ground texture under the spline chosen.

=Example Usage=

== Short Grass ==
Watch the video tutorial on Short Grass [[https://youtu.be/AgaaPBjHZyA HERE]]

[[File:tfx_short.jpg|1000px]]

[[File:tfx_short_info.jpg|493px]]

== Medium Grass ==
Watch the video tutorial on Medium Grass [[https://youtu.be/5TTwidjCuuQ HERE]]

== Long Grass ==
Watch the video tutorial on Long Grass [[https://youtu.be/qoH5OfcgfjU HERE]]

[[File:tfx_long.jpg|1000px]]

[[File:tfx_long_info.jpg|493px]]

== Long Grass + Long Seed Grass ==
Watch the video tutorial on Long Seed Grass [[https://youtu.be/l04As0QFFPQ HERE]]

[[File:tfx_long_seed.jpg|1000px]]

[[File:tfx_long_info.jpg|493px]] [[File:tfx_long_seed_info.jpg|493px]]

== Turf ==
[[File:tfx_turf.jpg|1000px]]

[[File:tfx_turf_info.jpg|493px]]

== Cut Turf ==
[[File:tfx_turf_cut.jpg|1000px]]

[[File:tfx_turf_cut_info.jpg|493px]]

== Other ==
[[File:TurfFX-Example0.jpg|1000px]]

[[File:TurfFX-Example1.jpg|1000px]]

=Clutter Effect Layer=

For help on editing and using the [[Help:Effect_Layer_Dialog|Clutter Effect layer]], click the link.

=Hardware Limitations=
TurfFX is developed by NVIDIA and is designed to takes advantage of high-end GPU's with substantial amounts of VRAM.

1. TurfFX is currently supported only for Windows.

2. Whereas Trainz will typically run (albeit slowly, or at reduced settings) on below-spec computers, TurfFX will need to be disabled entirely if the GPU is insufficient. We expect the minimum of a GeForce GTX 750 to get reasonable performance.

3. With TurfFX disabled, the Effect Layers are ignored entirely, and there is no performance penalty for those objects that are disabled.

=TurfFx Asset Creation=
For detailed information on creating new grass types, crops, weeds etc, please visit [[Effect_Layer_Assets]]

=See Also=
[[Help:Effect_Layer_Dialog]]<br>
[[Clutter_Effect_Layer]]

Back to [[Effect_Layer]]<br>
Back to [[Help:TRS19]]

[[Category:Content creation]]
[[Category:TRS19]]
[[Category:Help]]

Help:TurfFX Effect Layer

2020-02-13T00:19:36Z

Zikchil: /* Bulk Editing Effect Layers */

The TurfFX Effect Layer is an [[Effect Layer]] type which is used to render grass (and similar foliage). As with all effect layers, turf is painted onto the terrain and automatically generates appropriate geometry for the area surrounding the camera. As compared to the [[Clutter Effect Layer]], TurfFX offers less flexibility but substantial improvements to performance which in turn allows for greater density at greater draw distances and effective wind-synchronised animation.

=Turffx Overview=

A TurfFx asset is made up of individual polygon blades with many options to configure each blade in your Turf Effect Layer and within the asset itself. The individual asset creation process is explained in [[Effect_Layer_Assets]].

==Trainz - Content Creation - #36 - Turf Effects (part 1)==
[https://youtu.be/0zTqYRMIqCs Video]

This first tutorial on Turf Effects explains how to get up and running with painting some grass around your route. The next tutorials on turf will dive into detailed information on all the below parameters.

==Trainz - Content Creation - #37 - Turf Effects (part 2) - Parameters Explained==
[https://youtu.be/4Yc7epaBoDc Video]

This second tutorial on Turf Effects explains in detail all the parameters that come with a Turf Effect Layer.

== Creating and Editing Turffx Layers in Surveyor==

[[File:turfeffectlayeredit.jpg]]

NOTE: To return to ground editing mode you select "Ground" option in the dropdown list in the above image

=== Effect Layer Window ===

The Effect Layers window allows you to edit your effect properties. The UI in this window will change based on what effect you choose (clutter, turf, something else).

We've included some defaults to get you started with TurfFX, and suggest you experiment with each control to customise your effect.

[[file:turf_defaults.jpg]]

==== Select ====

This allows you to select any existing effect layers to view and edit their parameters.

[[File:turfeffectlayerselection.jpg]]

==== Delete ====

This button will delete the currently selected effect layer.

[[File:effectlayerwindow1b.jpg]]

=== Add ===

This button will allow you to create a new effect layer.

[[File:effectlayerwindow1c.jpg]]

==== Name ====

Enter a name for your effect layer.

[[File:turfeffectlayername.jpg]]

==== Turffx-Asset ====

Select a "Turf" asset you want to use in your turffx layer from the dropdown list. Once selected and named, you can customise how this particular layer will be configured wherever it is painted throughout the route.

Note that if you want short grass and long grass, you need to create two different TurfFX layers, or use the Turffx-Height-Scale data binding.

[[File:turfeffectlayerasset.jpg]]

==== Turffx-Density Data Binding ====

The "turffx-density" options and associated "default" value control the [[Effect Layer Data Binding]] (read this link for details) which controls the density of this turffx layer across the route. Density ranges from 0.0 (no turf present) to 1.0 (maximum density).

[[File:turfeffectlayerdensity.jpg]]

[[File:turfeffectlayerdensitydefaultvalue.jpg]]

[[file:turfdensity1.jpg]]

[[file:turfdensity2.jpg]]

[[file:turfdensity3.jpg]]

NOTE: The turffx-density parameter (int1, int2, int4 ...etc) determines how accurate your density will be when painting with the height up/down and sensitivity radius in the topology tab. For example, int1 will give you 1 click while painting to get 100% density (off or on). Int4 will give you 1 click for 1/3rd density, 2 clicks for 2/3rds density, 3 clicks for 3/3rds density. Obviously the more accuracy you need the more data will need to be stored so use the appropriate data binding for the effect you require.

==== Turffx-Height-Scale Data Binding ====

The "turffx-height-scale" options and associated "constant" value control the [[Effect Layer Data Binding]] (read this link for details) which controls the height of this turffx layer across the route. Height ranges from 0.0 (no turf present) to 1.0 (maximum height).

[[File:2018-12-18 105752.png]]

NOTE: The turffx-height-scale parameter (int1, int2, int4 ...etc) determines how accurate your height scale data will be when painting with the height up/down and sensitivity radius in the topology tab. For example, int1 will give you 1 click while painting to get 100% height (i.e. the height is either off or on). Int4 will give you 1 click for 1/3rd height, 2 clicks for 2/3rds height, 3 clicks for full height. Obviously the more accuracy you need the more data will need to be stored so use the appropriate data binding for the effect you require.

==== Geometry-Scale ====

This changes the height of your blade geometry in meters.

[[File:turfeffectlayergeometryscale.jpg]]

==== Blade-Width ====

This changes the width of your blade geometry in meters.

[[File:turfeffectlayerbladewidth.jpg]]

==== Blade-Width-Noise ====

This adds random variation to the width of your blade geometry.

[[File:turfeffectlayerbladewidthnoise.jpg]]

==== Blade-Height-Noise ====

This adds random variation to the height of your blade geometry.

[[File:turfeffectlayerbladeheight.jpg]]

==== Width-Scale-Near ====

This defines the shape of your blade geometry up close to the camera.

[[File:turfeffectlayerwidthscalenear.jpg]]

==== Width-Scale-Far ====

This defines the shape of your blade geometry in the distance.

[[File:turfeffectlayerwidthscalefar.jpg]]

[[file:turfshape.jpg]]

==== Bending-Scale ====

Defines how much your blade geometry will bend in the wind. (bending strength for wind animation)

[[File:turfeffectlayerbendingscale.jpg]]

==== Dispersal ====

Dispersal controls the radius around a seed point to place individual grass blades.

[[File:turfeffectlayerdispersal.jpg]]

[[file:turftdispersal.jpg]]

==== Bunching ====

Bunching controls radial alignment of individual grass blades around the seed point. Bunching equal to one (1) produces maximally aligned distribution of grass blades, while zero (0) would result in completely random distribution.

[[File:turfeffectlayerbunching.jpg]]

[[file:turftbunching.jpg]]

==== Expansion-constant ====

: This affects how many grass blades will be at each point in the grid. Tweaking this number will change the density.
: Expansion = "expansion-constant" + "expansion-multiplier" * "value0"

: Try a starting value of 0.3.

==== Expansion-multiplier ====

: This affects how many grass blades will be at each point in the grid. Tweaking this number will change the density.
: Expansion = "expansion-constant" + "expansion-multiplier" * "value0"
: Try a starting value of 0.3

==== Number-of-seeds-multiplier ====

: This affects how many new points in each grid to sprout grass blades. Tweaking this number will change the density.
: Number of Seeds = "number-of-seeds-multiplier" * "value0"
: Try a starting value of 0.3

== Painting Turffx ==

=== Using Height Up and Down Tool===

Effect Layers are selected in the Advanced Topology Tab. When you change from Ground to any of the Effect Layers you have created, the Height Up, Height Down and Radius tools are used much like the tools in the Paint Tab.

[[File:turfeffectlayerpainting.jpg]]

=== Using Area Fill Tool===
You can also select an area and fill the area with your selected Effect Layer Binding. Set the Effect Fill Density slider when using the Fill tool to adjust the density of your effect layer.

=== Painting Tips ===
* Effect Layers are data intensive, and so you need to work out where you require precision (e.g. in highly visible areas) and where you can use much less precision (e.g. away from the track areas)
* Using 2.5m precision everywhere will consume your scene budget very quickly.
* Using the turffx-height-scale tool will raise or lower existing effect layers only. (i.e. you need to paint some density prior to adjusting the height)
* Experiment with different values such as using 0.001 for dispersal to get that "clumpy" look (then try 0.05, 0.5 etc for different looks)
* TurfFX is currently not supported during route merge.

== New TurfFX Tools (2020) ==

These new tools will be delivered as part of the Trainz Plus update for Q1 2020 and provide a range of new options to make your task of adding effect layers and using them, easier and more flexible.

=== Adding Effect Layers ===
You can now choose from a range of Preset options and edit those options as much as you like.

To access these options, go to Topology Tab -> Advanced Section -> Edit/Add effect layers.

If there are no Effect layers already used in the route, you'll be prompted to create a new one.

Add a name and chose either Turffx or Clutter.

[[File:2020-01-24_105930.png|900px]]

==== Option 1: Using a preset ====
# Select an Effect Preset using either the arrow keys or dropdown list.
# (Optional) Toggle the Advanced options so that you can edit the settings as required.
# Press the check (tick) button to close the Effect Layers window.
Note: Turf Effects can only render in one viewport. This means if you have the Effect Layers preview window showing the turf will be rendered in that window and not in your route.
When closing the Effect Layers window any turffx already painted in your route will begin rendering again after a short delay (~5 seconds).

==== Option 2: Using a preset and editing it ====
# Select an Effect Preset.
# Toggle Advanced Options.
# Edit the Advanced Options.
# Press the check (tick) button to close the Effect Layers window.
Note: Turf Effects can only render in one viewport. This means if you have the Effect Layers preview window showing the turf will be rendered in that window and not in your route.
When closing the Effect Layers window any turffx already painted in your route will begin rendering again after a short delay (~5 seconds).

====Presets versus Named Effect Layers====
It is important to note the difference between Presets and Effect Layers.

Presets are assets. This means they can be saved, uploaded to the DLS, or shared via .cdp. However, you cannot paint using a "Preset" directly.

# To paint, you need to create an "Effect Layer" (which can be made by selecting a Preset).
# Effect Layers are created per route.
# Click the + icon to create a new Effect Layer and give it a name (which can be the same as the Preset name if you like).
# Click the Tick to save the Effect Layer.
# This named Effect Layer is then available in the dropdown list in the Topology > Advanced tab.

NOTE: If you click the Save icon, you will create a new Preset. Of course you can do both, so that when you start another route, you have the Preset available to select when you create a new Effect Layer.

=== Masking Options ===
There are new options in the Advanced Section that determine whether effect layers will or won't be painted in various areas. These options are:
* Avoid-water (Effects will NOT appear under a water layer)
* Altitude-range (Effects will NOT appear outside the max/min altitude set)
* Gradient-range (Effects will NOT appear if the slope exceeds the limit you set)
* Ground-texture-mask (Effects WILL appear ONLY upon the textures you add to the mask)

EXAMPLE:
* To apply a mask, open the Advanced Options and scroll down (enlarge the window if required)
* To add a texture mask click the Add Asset + button
* Enter the name of each texture you want the effect layer to apply to
* Save your effect layer
* Close the editing too and use the painting tools to paint your effect ont he listed texture(s).
* See [[Effect_Layer#Painting_Effect_Layers|Painting_Effect_Layers]] for how to apply the mask.

TIP:
* The accuracy (precision) of effect layers depends on [[TurfFX_Effect_Layer#Turffx-Density_Data_Binding | turffx-density]] settings.
* The higher the precision (for example float16 or float32 using 10m, 5m or 2.5m grid), the more data required and the larger your route will be.
* Ensure you add all the textures you want a specific effect layer to appear on.

=== Other New Tools ===

====Get Effect====
The Get Effect tool is useful to find which "Effect Layer" is painted in a specific area. Once identified, you can then edit the configuration or select the Effect Layer from the dropdown list in Topology > Advanced.

# Click Edit/Add effect layers
# Click the Get Effect tool. The Preview window is automatically closed and the Effect Layers will display in the world after a few seconds
# Hover your mouse over various effect layers in the 3D world.
# As you move your mouse around the terrain, all of the effect layers (both Turffx and Clutter layers) in that area will be listed in the mouseover help dialog
# If you want to then paint with an identified effect layer, simply select it from the dropdown list in Topology > Advanced
# If you want to edit it, click the ground in that area to load the item in the Effect Layers window
# If you want to edit an item from further down the mouseover list, select the appropriate Effect Layer name from the dropdown in the Effect Layers window.

==== Save as new Preset ====
You can now save your own configurations to allow you to chose the same effect configuration in a different route.

Note that you will still need to create and name a new Effect Layer in the new route.

# Click Topology Tab -> Advanced Section -> Edit/Add effect layers to open the Effect Layers window.
# Choose a Preset from the dropdown list in the Effect Layers window.
# Click the Advanced Toggle to expand the window
# Adjust the various configurable values to modify the Preset
# View the changes in the Preview window
# When happy with the results, click the Save icon above the Preview window
# The Save dialog opens and you can either save as the same name to overwrite that Preset, or change the name to create a new Preset asset.

TIP:
* When painting or filling, if you're wondering why something isn't applying to an area, check your mask settings for that effect layer.

=== Bulk Editing Effect Layers ===

You can now also use the "Bulk Edit" tool to rapidly update a route from older versions of Trainz to use the TurfFX layers. This will place an effect layer ON TOP of an existing ground texture.

[[File:2020-01-24_125216.png|600px]]

# To access the Topology -> Advanced Section -> [ Select an Effect Layer you have created for this route ] -> Click on the "Bulk fill effect layer" icon.
# The "Bulk Asset Update/Replace" window appears.
# In “Assets to update” list, use the Picker to select one or more existing ground textures that you want to apply the effect layer to (or drag a texture from the Paint tab).
# In “Asset to update with” select the Effect layer to use by dragging from the Topology Advanced tab Effect layer dropdown list.
# To change the "median" density or height variation use the “Autofill density/height” slider. Which aspect is adjusted depends upon which “TurfFX” option you have selected under the Topology -> Advanced Section -> TurfFX drop down.
# (Optional) To randomise fill density click the checkbox and adjust the slider to either create a more uniform fill (0%) to a random fill (100%).
# (Optional) To further customise where the effects are painted, click the "Skip areas with" checkbox then choose either "Data for this binding" and "Data for effect layers of this type" from the dropdown. This will skip any effect layer vertices which already have effect layer data.
# Click "Begin" to bulk paint the effect layer on your configuration.

TIPS:
* Data for this binding means "any grid that has the selected effect layer on it".
* Data for effect layers of this type means "any grid that has the selected effect layer type (i.e. turf or clutter)"
* If you have applied any of the new "masking" options (Avoid-water, Altitude-range, Gradient-range, Ground-texture-mask) to the effect layer you are using, then the results you see in the world will depend on each of the configured settings
** i.e. If you're wondering why something isn't applying to an area, check your mask settings.
* Bulk Edit adds the effect layer ON TOP of the ground texture. It does not replace the ground texture. To replace a texture, drag another texture into the “Asset to update with” box.
* Use a [[TurfFX_Effect_Layer#Turffx-Density_Data_Binding | turffx-density]] higher than Int1 to have a greater range of density (precision).

== Bulk Paint Under Splines (2020)==
With the latest Trainz Plus update (Q1 2020), there is also a new tool designed to quickly apply ballast under your track. Of course you can also apply any other texture under a spline such as grass along a roadside, or fence line.

# From the Tools Menu Select "Bulk Asset Update/Replace".
# In “Assets to update” list, use the Picker to select one or more existing splines, or drag more splines from the Track list.
# In “Asset to update with” select the ground texture you want to use as fill.
# Under the Paint Tab -> Radius, change the radius to the width you wish to paint. (The smallest radius will give a 10m wide texture).
# Click "Begin" to bulk paint the ground texture under the spline chosen.

=Example Usage=

== Short Grass ==
Watch the video tutorial on Short Grass [[https://youtu.be/AgaaPBjHZyA HERE]]

[[File:tfx_short.jpg|1000px]]

[[File:tfx_short_info.jpg|493px]]

== Medium Grass ==
Watch the video tutorial on Medium Grass [[https://youtu.be/5TTwidjCuuQ HERE]]

== Long Grass ==
Watch the video tutorial on Long Grass [[https://youtu.be/qoH5OfcgfjU HERE]]

[[File:tfx_long.jpg|1000px]]

[[File:tfx_long_info.jpg|493px]]

== Long Grass + Long Seed Grass ==
Watch the video tutorial on Long Seed Grass [[https://youtu.be/l04As0QFFPQ HERE]]

[[File:tfx_long_seed.jpg|1000px]]

[[File:tfx_long_info.jpg|493px]] [[File:tfx_long_seed_info.jpg|493px]]

== Turf ==
[[File:tfx_turf.jpg|1000px]]

[[File:tfx_turf_info.jpg|493px]]

== Cut Turf ==
[[File:tfx_turf_cut.jpg|1000px]]

[[File:tfx_turf_cut_info.jpg|493px]]

== Other ==
[[File:TurfFX-Example0.jpg|1000px]]

[[File:TurfFX-Example1.jpg|1000px]]

=Clutter Effect Layer=

For help on editing and using the [[Help:Effect_Layer_Dialog|Clutter Effect layer]], click the link.

=Hardware Limitations=
TurfFX is developed by NVIDIA and is designed to takes advantage of high-end GPU's with substantial amounts of VRAM.

1. TurfFX is currently supported only for Windows.

2. Whereas Trainz will typically run (albeit slowly, or at reduced settings) on below-spec computers, TurfFX will need to be disabled entirely if the GPU is insufficient. We expect the minimum of a GeForce GTX 750 to get reasonable performance.

3. With TurfFX disabled, the Effect Layers are ignored entirely, and there is no performance penalty for those objects that are disabled.

=TurfFx Asset Creation=
For detailed information on creating new grass types, crops, weeds etc, please visit [[Effect_Layer_Assets]]

=See Also=
[[Help:Effect_Layer_Dialog]]<br>
[[Clutter_Effect_Layer]]

Back to [[Effect_Layer]]<br>
Back to [[Help:TRS19]]

[[Category:Content creation]]
[[Category:TRS19]]
[[Category:Help]]

Help:TurfFX Effect Layer

2020-02-12T23:58:53Z

Zikchil: /* Masking Options */

The TurfFX Effect Layer is an [[Effect Layer]] type which is used to render grass (and similar foliage). As with all effect layers, turf is painted onto the terrain and automatically generates appropriate geometry for the area surrounding the camera. As compared to the [[Clutter Effect Layer]], TurfFX offers less flexibility but substantial improvements to performance which in turn allows for greater density at greater draw distances and effective wind-synchronised animation.

=Turffx Overview=

A TurfFx asset is made up of individual polygon blades with many options to configure each blade in your Turf Effect Layer and within the asset itself. The individual asset creation process is explained in [[Effect_Layer_Assets]].

==Trainz - Content Creation - #36 - Turf Effects (part 1)==
[https://youtu.be/0zTqYRMIqCs Video]

This first tutorial on Turf Effects explains how to get up and running with painting some grass around your route. The next tutorials on turf will dive into detailed information on all the below parameters.

==Trainz - Content Creation - #37 - Turf Effects (part 2) - Parameters Explained==
[https://youtu.be/4Yc7epaBoDc Video]

This second tutorial on Turf Effects explains in detail all the parameters that come with a Turf Effect Layer.

== Creating and Editing Turffx Layers in Surveyor==

[[File:turfeffectlayeredit.jpg]]

NOTE: To return to ground editing mode you select "Ground" option in the dropdown list in the above image

=== Effect Layer Window ===

The Effect Layers window allows you to edit your effect properties. The UI in this window will change based on what effect you choose (clutter, turf, something else).

We've included some defaults to get you started with TurfFX, and suggest you experiment with each control to customise your effect.

[[file:turf_defaults.jpg]]

==== Select ====

This allows you to select any existing effect layers to view and edit their parameters.

[[File:turfeffectlayerselection.jpg]]

==== Delete ====

This button will delete the currently selected effect layer.

[[File:effectlayerwindow1b.jpg]]

=== Add ===

This button will allow you to create a new effect layer.

[[File:effectlayerwindow1c.jpg]]

==== Name ====

Enter a name for your effect layer.

[[File:turfeffectlayername.jpg]]

==== Turffx-Asset ====

Select a "Turf" asset you want to use in your turffx layer from the dropdown list. Once selected and named, you can customise how this particular layer will be configured wherever it is painted throughout the route.

Note that if you want short grass and long grass, you need to create two different TurfFX layers, or use the Turffx-Height-Scale data binding.

[[File:turfeffectlayerasset.jpg]]

==== Turffx-Density Data Binding ====

The "turffx-density" options and associated "default" value control the [[Effect Layer Data Binding]] (read this link for details) which controls the density of this turffx layer across the route. Density ranges from 0.0 (no turf present) to 1.0 (maximum density).

[[File:turfeffectlayerdensity.jpg]]

[[File:turfeffectlayerdensitydefaultvalue.jpg]]

[[file:turfdensity1.jpg]]

[[file:turfdensity2.jpg]]

[[file:turfdensity3.jpg]]

NOTE: The turffx-density parameter (int1, int2, int4 ...etc) determines how accurate your density will be when painting with the height up/down and sensitivity radius in the topology tab. For example, int1 will give you 1 click while painting to get 100% density (off or on). Int4 will give you 1 click for 1/3rd density, 2 clicks for 2/3rds density, 3 clicks for 3/3rds density. Obviously the more accuracy you need the more data will need to be stored so use the appropriate data binding for the effect you require.

==== Turffx-Height-Scale Data Binding ====

The "turffx-height-scale" options and associated "constant" value control the [[Effect Layer Data Binding]] (read this link for details) which controls the height of this turffx layer across the route. Height ranges from 0.0 (no turf present) to 1.0 (maximum height).

[[File:2018-12-18 105752.png]]

NOTE: The turffx-height-scale parameter (int1, int2, int4 ...etc) determines how accurate your height scale data will be when painting with the height up/down and sensitivity radius in the topology tab. For example, int1 will give you 1 click while painting to get 100% height (i.e. the height is either off or on). Int4 will give you 1 click for 1/3rd height, 2 clicks for 2/3rds height, 3 clicks for full height. Obviously the more accuracy you need the more data will need to be stored so use the appropriate data binding for the effect you require.

==== Geometry-Scale ====

This changes the height of your blade geometry in meters.

[[File:turfeffectlayergeometryscale.jpg]]

==== Blade-Width ====

This changes the width of your blade geometry in meters.

[[File:turfeffectlayerbladewidth.jpg]]

==== Blade-Width-Noise ====

This adds random variation to the width of your blade geometry.

[[File:turfeffectlayerbladewidthnoise.jpg]]

==== Blade-Height-Noise ====

This adds random variation to the height of your blade geometry.

[[File:turfeffectlayerbladeheight.jpg]]

==== Width-Scale-Near ====

This defines the shape of your blade geometry up close to the camera.

[[File:turfeffectlayerwidthscalenear.jpg]]

==== Width-Scale-Far ====

This defines the shape of your blade geometry in the distance.

[[File:turfeffectlayerwidthscalefar.jpg]]

[[file:turfshape.jpg]]

==== Bending-Scale ====

Defines how much your blade geometry will bend in the wind. (bending strength for wind animation)

[[File:turfeffectlayerbendingscale.jpg]]

==== Dispersal ====

Dispersal controls the radius around a seed point to place individual grass blades.

[[File:turfeffectlayerdispersal.jpg]]

[[file:turftdispersal.jpg]]

==== Bunching ====

Bunching controls radial alignment of individual grass blades around the seed point. Bunching equal to one (1) produces maximally aligned distribution of grass blades, while zero (0) would result in completely random distribution.

[[File:turfeffectlayerbunching.jpg]]

[[file:turftbunching.jpg]]

==== Expansion-constant ====

: This affects how many grass blades will be at each point in the grid. Tweaking this number will change the density.
: Expansion = "expansion-constant" + "expansion-multiplier" * "value0"

: Try a starting value of 0.3.

==== Expansion-multiplier ====

: This affects how many grass blades will be at each point in the grid. Tweaking this number will change the density.
: Expansion = "expansion-constant" + "expansion-multiplier" * "value0"
: Try a starting value of 0.3

==== Number-of-seeds-multiplier ====

: This affects how many new points in each grid to sprout grass blades. Tweaking this number will change the density.
: Number of Seeds = "number-of-seeds-multiplier" * "value0"
: Try a starting value of 0.3

== Painting Turffx ==

=== Using Height Up and Down Tool===

Effect Layers are selected in the Advanced Topology Tab. When you change from Ground to any of the Effect Layers you have created, the Height Up, Height Down and Radius tools are used much like the tools in the Paint Tab.

[[File:turfeffectlayerpainting.jpg]]

=== Using Area Fill Tool===
You can also select an area and fill the area with your selected Effect Layer Binding. Set the Effect Fill Density slider when using the Fill tool to adjust the density of your effect layer.

=== Painting Tips ===
* Effect Layers are data intensive, and so you need to work out where you require precision (e.g. in highly visible areas) and where you can use much less precision (e.g. away from the track areas)
* Using 2.5m precision everywhere will consume your scene budget very quickly.
* Using the turffx-height-scale tool will raise or lower existing effect layers only. (i.e. you need to paint some density prior to adjusting the height)
* Experiment with different values such as using 0.001 for dispersal to get that "clumpy" look (then try 0.05, 0.5 etc for different looks)
* TurfFX is currently not supported during route merge.

== New TurfFX Tools (2020) ==

These new tools will be delivered as part of the Trainz Plus update for Q1 2020 and provide a range of new options to make your task of adding effect layers and using them, easier and more flexible.

=== Adding Effect Layers ===
You can now choose from a range of Preset options and edit those options as much as you like.

To access these options, go to Topology Tab -> Advanced Section -> Edit/Add effect layers.

If there are no Effect layers already used in the route, you'll be prompted to create a new one.

Add a name and chose either Turffx or Clutter.

[[File:2020-01-24_105930.png|900px]]

==== Option 1: Using a preset ====
# Select an Effect Preset using either the arrow keys or dropdown list.
# (Optional) Toggle the Advanced options so that you can edit the settings as required.
# Press the check (tick) button to close the Effect Layers window.
Note: Turf Effects can only render in one viewport. This means if you have the Effect Layers preview window showing the turf will be rendered in that window and not in your route.
When closing the Effect Layers window any turffx already painted in your route will begin rendering again after a short delay (~5 seconds).

==== Option 2: Using a preset and editing it ====
# Select an Effect Preset.
# Toggle Advanced Options.
# Edit the Advanced Options.
# Press the check (tick) button to close the Effect Layers window.
Note: Turf Effects can only render in one viewport. This means if you have the Effect Layers preview window showing the turf will be rendered in that window and not in your route.
When closing the Effect Layers window any turffx already painted in your route will begin rendering again after a short delay (~5 seconds).

====Presets versus Named Effect Layers====
It is important to note the difference between Presets and Effect Layers.

Presets are assets. This means they can be saved, uploaded to the DLS, or shared via .cdp. However, you cannot paint using a "Preset" directly.

# To paint, you need to create an "Effect Layer" (which can be made by selecting a Preset).
# Effect Layers are created per route.
# Click the + icon to create a new Effect Layer and give it a name (which can be the same as the Preset name if you like).
# Click the Tick to save the Effect Layer.
# This named Effect Layer is then available in the dropdown list in the Topology > Advanced tab.

NOTE: If you click the Save icon, you will create a new Preset. Of course you can do both, so that when you start another route, you have the Preset available to select when you create a new Effect Layer.

=== Masking Options ===
There are new options in the Advanced Section that determine whether effect layers will or won't be painted in various areas. These options are:
* Avoid-water (Effects will NOT appear under a water layer)
* Altitude-range (Effects will NOT appear outside the max/min altitude set)
* Gradient-range (Effects will NOT appear if the slope exceeds the limit you set)
* Ground-texture-mask (Effects WILL appear ONLY upon the textures you add to the mask)
** See section "Painting Turffx - Using Height Up and Down Tool" for how to apply the mask.

TIP:
* The accuracy (precision) of effect layers depends on [[TurfFX_Effect_Layer#Turffx-Density_Data_Binding | turffx-density]] settings.
** The higher the precision (for example float16 or float32 using 10m, 5m or 2.5m grid), the more data required and the larger your route will be.
* Ensure you add all the textures you want a specific effect layer to appear on.

=== Other New Tools ===

====Get Effect====
The Get Effect tool is useful to find which "Effect Layer" is painted in a specific area. Once identified, you can then edit the configuration or select the Effect Layer from the dropdown list in Topology > Advanced.

# Click Edit/Add effect layers
# Click the Get Effect tool. The Preview window is automatically closed and the Effect Layers will display in the world after a few seconds
# Hover your mouse over various effect layers in the 3D world.
# As you move your mouse around the terrain, all of the effect layers (both Turffx and Clutter layers) in that area will be listed in the mouseover help dialog
# If you want to then paint with an identified effect layer, simply select it from the dropdown list in Topology > Advanced
# If you want to edit it, click the ground in that area to load the item in the Effect Layers window
# If you want to edit an item from further down the mouseover list, select the appropriate Effect Layer name from the dropdown in the Effect Layers window.

==== Save as new Preset ====
You can now save your own configurations to allow you to chose the same effect configuration in a different route.

Note that you will still need to create and name a new Effect Layer in the new route.

# Click Topology Tab -> Advanced Section -> Edit/Add effect layers to open the Effect Layers window.
# Choose a Preset from the dropdown list in the Effect Layers window.
# Click the Advanced Toggle to expand the window
# Adjust the various configurable values to modify the Preset
# View the changes in the Preview window
# When happy with the results, click the Save icon above the Preview window
# The Save dialog opens and you can either save as the same name to overwrite that Preset, or change the name to create a new Preset asset.

TIP:
* When painting or filling, if you're wondering why something isn't applying to an area, check your mask settings for that effect layer.

=== Bulk Editing Effect Layers ===

You can now also use the "Bulk Edit" tool to rapidly update a route from older versions of Trainz to use the TurfFX layers. This will place an effect layer ON TOP of an existing ground texture.

[[File:2020-01-24_125216.png|600px]]

# To access the Topology -> Advanced Section -> [ Select an Effect Layer you have created for this route ] -> Click on the "Bulk fill effect layer" icon.
# The "Bulk Asset Update/Replace" window appears.
# In “Assets to update” list, use the Picker to select one or more existing ground textures that you want to apply the effect layer to (or drag a texture from the Paint tab).
# In “Asset to update with” select the Effect layer to use by dragging from the Topology Advanced tab Effect layer dropdown list.
# To change the "median" density or height variation use the “Autofill density/height” slider. Which aspect is adjusted depends upon which “TurfFX” option you have selected under the Topology -> Advanced Section -> TurfFX drop down.
# (Optional) To randomise fill density click the checkbox and adjust the slider to either create a more uniform fill (0%) to a random fill (100%).
# (Optional) To further customise where the effects are painted, click the "Skip areas with" checkbox then choose either "Data for this binding" and "Data for effect layers of this type" from the dropdown. This will skip any effect layer vertices which already have effect layer data.
# Click "Begin" to bulk paint the effect layer on your configuration.

TIPS:
* Data for this binding means "any grid that has the selected effect layer on it".
* Data for effect layers of this type means "any grid that has the selected effect layer type (i.e. turf or clutter)"
* If you have applied any of the new "masking" options (Avoid-water, Altitude-range, Gradient-range, Ground-texture-mask) to the effect layer you are using, then the results you see in the world will depend on each of the configured settings
i.e. If you're wondering why something isn't applying to an area, check your mask settings.
* Bulk Edit adds the effect layer ON TOP of the ground texture. It does not replace the ground texture. To replace a texture, drag another texture into the “Asset to update with” box.
* Use a [[TurfFX_Effect_Layer#Turffx-Density_Data_Binding | turffx-density]] higher than Int1 to have a greater range of density (precision).

== Bulk Paint Under Splines (2020)==
With the latest Trainz Plus update (Q1 2020), there is also a new tool designed to quickly apply ballast under your track. Of course you can also apply any other texture under a spline such as grass along a roadside, or fence line.

# From the Tools Menu Select "Bulk Asset Update/Replace".
# In “Assets to update” list, use the Picker to select one or more existing splines, or drag more splines from the Track list.
# In “Asset to update with” select the ground texture you want to use as fill.
# Under the Paint Tab -> Radius, change the radius to the width you wish to paint. (The smallest radius will give a 10m wide texture).
# Click "Begin" to bulk paint the ground texture under the spline chosen.

=Example Usage=

== Short Grass ==
Watch the video tutorial on Short Grass [[https://youtu.be/AgaaPBjHZyA HERE]]

[[File:tfx_short.jpg|1000px]]

[[File:tfx_short_info.jpg|493px]]

== Medium Grass ==
Watch the video tutorial on Medium Grass [[https://youtu.be/5TTwidjCuuQ HERE]]

== Long Grass ==
Watch the video tutorial on Long Grass [[https://youtu.be/qoH5OfcgfjU HERE]]

[[File:tfx_long.jpg|1000px]]

[[File:tfx_long_info.jpg|493px]]

== Long Grass + Long Seed Grass ==
Watch the video tutorial on Long Seed Grass [[https://youtu.be/l04As0QFFPQ HERE]]

[[File:tfx_long_seed.jpg|1000px]]

[[File:tfx_long_info.jpg|493px]] [[File:tfx_long_seed_info.jpg|493px]]

== Turf ==
[[File:tfx_turf.jpg|1000px]]

[[File:tfx_turf_info.jpg|493px]]

== Cut Turf ==
[[File:tfx_turf_cut.jpg|1000px]]

[[File:tfx_turf_cut_info.jpg|493px]]

== Other ==
[[File:TurfFX-Example0.jpg|1000px]]

[[File:TurfFX-Example1.jpg|1000px]]

=Clutter Effect Layer=

For help on editing and using the [[Help:Effect_Layer_Dialog|Clutter Effect layer]], click the link.

=Hardware Limitations=
TurfFX is developed by NVIDIA and is designed to takes advantage of high-end GPU's with substantial amounts of VRAM.

1. TurfFX is currently supported only for Windows.

2. Whereas Trainz will typically run (albeit slowly, or at reduced settings) on below-spec computers, TurfFX will need to be disabled entirely if the GPU is insufficient. We expect the minimum of a GeForce GTX 750 to get reasonable performance.

3. With TurfFX disabled, the Effect Layers are ignored entirely, and there is no performance penalty for those objects that are disabled.

=TurfFx Asset Creation=
For detailed information on creating new grass types, crops, weeds etc, please visit [[Effect_Layer_Assets]]

=See Also=
[[Help:Effect_Layer_Dialog]]<br>
[[Clutter_Effect_Layer]]

Back to [[Effect_Layer]]<br>
Back to [[Help:TRS19]]

[[Category:Content creation]]
[[Category:TRS19]]
[[Category:Help]]

Effect Layer

2020-02-12T17:21:26Z

Zikchil: /* Effect Layer Types */

Effect layers are a new [[TRS19]] feature which offer the ability to use Surveyor to paint various effects beyond the traditional ground height and ground texture. Each effect layer typically offers a number of configuration options, including a configurable data density so that route creators can tune the outcome to their specific requirements, dedicating performance to areas which are important to their route while lowering detail and/or flexibility in other less-important areas in order to maintain high overall performance.

= Effect Layers UI =
Effect Layers are configured per route. A new "Edit Effect Layers" menu item in the Surveyor main menu pops up an editing dialog which allows the route builder to add, remove, and edit effect layers. An effect layer type is selected when adding a new effect layer, and the type-specific properties for that layer may be adjusted repeatedly until the desired result is achieved. Effect layers are also named, for user convenience.

Most properties of the effect layer are configured on a route-wide basis, however some special properties may be configured to change across the route, using data bindings.

= Configuring Effect Layer Data Bindings =
Specific effect layer properties support data binding. This allows the route builder to paint (eg. using the ground height tools) the property onto the terrain, rather than setting it to a single value route-wide. For many effect types, this is used to configure the intensity of the effect at various locations on the route, although other properties and data types are also configurable in this manner.

There is a limited amount of data reserved in the route for effect layer data bindings. It is up to the route builder to determine how best to use the available data space to best effect. Each property which supports data binding may be configured with a set resolution (higher resolutions consume more data) and precision (higher precision consumes more data). The route builder determines which effect layer need the most precise control, and dedicates the majority of the available data space to those layers.

Adjusting data bindings is a computationally expensive operation. On a large route, this process can take a number of seconds. An uninterruptible progress indication will show during this process. It is not possible to "undo" a change to a data binding, so the route builder should save changes before editing bindings in an existing route.

= Painting Effect Layers =
Once an effect layer data binding has been configured, the route builder may begin painting in the effect layer. Surveyor's "Topology - Advanced" tab offers a new "Effect Layer" picker which allows the route builder to select either "Ground" or one of the effect layer data bindings. A button is also present in this location to quick-open the relevant Effect Layer properties. After selecting the target data binding, the route builder may use the topology tools (height up, height down, etc.) to manipulate the bound data.

As the Surveyor brush size is variable, it is possible to configure a brush which is finer than the precision of the effect layer data binding. This makes it possible to move the brush to a location where painting will have no effect (since it lies between the bound locations, rather than overlapping one or more). In this scenario, the brush will turn red to indicate that painting will have no effect. The route builder must either increase the brush size, or move the brush to a location which overlaps one of the bound locations. Alternatively, the player can consider adjusting the data bindings to have a higher resolution, at the expense of increased data usage.

= Effect Layer Types =
The current effect layer types are supported:

* [[Clutter Effect Layer]] - for ground clutter such as rocks and foliage.
* [[TurfFX Effect Layer]] - for various types of grass and grass-like flora.

Return to [[Help:Effect_Layer_Dialog|Effect Layer Home]]

[[Category:Modeling]]
[[Category:Content creation]]
[[Category:TRS19]]

Effect Layer

2020-02-12T17:20:45Z

Zikchil: /* Effect Layer Types */

Effect layers are a new [[TRS19]] feature which offer the ability to use Surveyor to paint various effects beyond the traditional ground height and ground texture. Each effect layer typically offers a number of configuration options, including a configurable data density so that route creators can tune the outcome to their specific requirements, dedicating performance to areas which are important to their route while lowering detail and/or flexibility in other less-important areas in order to maintain high overall performance.

= Effect Layers UI =
Effect Layers are configured per route. A new "Edit Effect Layers" menu item in the Surveyor main menu pops up an editing dialog which allows the route builder to add, remove, and edit effect layers. An effect layer type is selected when adding a new effect layer, and the type-specific properties for that layer may be adjusted repeatedly until the desired result is achieved. Effect layers are also named, for user convenience.

Most properties of the effect layer are configured on a route-wide basis, however some special properties may be configured to change across the route, using data bindings.

= Configuring Effect Layer Data Bindings =
Specific effect layer properties support data binding. This allows the route builder to paint (eg. using the ground height tools) the property onto the terrain, rather than setting it to a single value route-wide. For many effect types, this is used to configure the intensity of the effect at various locations on the route, although other properties and data types are also configurable in this manner.

There is a limited amount of data reserved in the route for effect layer data bindings. It is up to the route builder to determine how best to use the available data space to best effect. Each property which supports data binding may be configured with a set resolution (higher resolutions consume more data) and precision (higher precision consumes more data). The route builder determines which effect layer need the most precise control, and dedicates the majority of the available data space to those layers.

Adjusting data bindings is a computationally expensive operation. On a large route, this process can take a number of seconds. An uninterruptible progress indication will show during this process. It is not possible to "undo" a change to a data binding, so the route builder should save changes before editing bindings in an existing route.

= Painting Effect Layers =
Once an effect layer data binding has been configured, the route builder may begin painting in the effect layer. Surveyor's "Topology - Advanced" tab offers a new "Effect Layer" picker which allows the route builder to select either "Ground" or one of the effect layer data bindings. A button is also present in this location to quick-open the relevant Effect Layer properties. After selecting the target data binding, the route builder may use the topology tools (height up, height down, etc.) to manipulate the bound data.

As the Surveyor brush size is variable, it is possible to configure a brush which is finer than the precision of the effect layer data binding. This makes it possible to move the brush to a location where painting will have no effect (since it lies between the bound locations, rather than overlapping one or more). In this scenario, the brush will turn red to indicate that painting will have no effect. The route builder must either increase the brush size, or move the brush to a location which overlaps one of the bound locations. Alternatively, the player can consider adjusting the data bindings to have a higher resolution, at the expense of increased data usage.

= Effect Layer Types =
The current effect layer types are supported:

* [[Clutter Effect Layer]] - for ground clutter such as rocks and foliage.
* [[TurfFX Effect Layer]] - for various types of grass and grass-like flora.
* Return to [[Help:Effect_Layer_Dialog|Effect Layer Home]]

[[Category:Modeling]]
[[Category:Content creation]]
[[Category:TRS19]]

Help:TRS19 Trainz Settings

2020-01-28T22:45:50Z

Zikchil: /* Compatibility Mode */

The Trainz Settings window provides access to a range of settings for Trainz, including performance settings, the location of your LocalData folder, and more.

== General Tab==
The General Tab provides access to screen resolution and other general options of Trainz.

[[File:2018-06-13 122616.png|270px]]

===Display Selection===
The Display Selection box provides an option for you to select which display (screen) to use. If you only have one display, then only one option will be available.

===Full Screen===
The Full Screen option allows you to force Trainz to run in Full Screen mode with no borders. This will run at the [[#Display Resolution|Display Resolution]] selected. You can also toggle full screen whilst running Trainz by pressing ALT + Enter on your keyboard.

When not in full screen, Trainz will run in a window which you can adjust by dragging the edges or corners to the size you want. This will automatically adjust the resolution to match.

===Display Resolution===
The Display Resolution option can only be changed when the [[#Full Screen|Full Screen]] option is enabled.

This option allows you to set the display resolution of Trainz when running in full screen mode, including when toggled with the ALT + Enter keyboard command.

===Vertical Sync===
The Vertical Sync option is used to help with smoothness when running Trainz, particularly at lower frame rates.

====Full====
At full, whenever the frame rate drops below 60frames per second (FPS) there will be a 'skip' in smoothness. If the frame rate is consistently below 60 then there will be regular skipping of frames. If you see frame rates above 60FPS, but still inconsistent then this option will help make Trainz run smoother.

====Half====
The default setting is Half. This forces the maximum number of frames to be 30FPS at all times. This allows a much smoother frame rate if your computer runs below 60FPS and above 30FPS. If you see frame rates below 30FPS then you may still see skips.

====None====
Setting Vertical Sync to 'None' will turn Vertical Sync off completely. In this case there will be no capping of the framerate, and as such it may vary a lot which may cause stuttering. On very high performance hardware you may wish to try running with Vertical Sync off.

===Language===
This options allows you to change the language that TRS2019 displays.

===Compatibility Mode===
This option allows you to select <b><i>compatibility mode for <u>scripts</u> in Trainz</i></b>. This currently defaults to 'Maximize Compatibility' and may remain unless you're developing scripts for routes and sessions made in TRS2019. Additionally developers may wish to try running in 'stream objects' or 'maximize performance' mods to test for script performance changes.

* Running one of the other options may cause older scripts to not function.
* This developer tool should not be interpreted to be a performance tool similar to a GFX card setting for "best quality \ best performance".

===Manage content as thumbnails===
This option allows you to set Trainz Content to display all content as thumbnails, rather than as a list.

===Enable game controller support===
This option enables support for game controllers, such as the Rail Driver controller. See the [[Help:TANE_Raildriver|Rail Driver]] page for further information on setting up a RailDriver controller with Trainz.

== Install Tab ==
The install tab provides access to change the LocalData folder, and to check for updates for Trainz.

[[File:2018-06-13 122628.png|270px]]

===Local Data folder===
Your LocalData folder contains all of your downloaded/installed content, as well as your settings for Trainz. This will default to the AppData on C:\ drive (for Windows), or the Library directory on the main drive (OSx/Mac). If you have limited space on your main drive then it may be ideal to move it to another drive.

You can specify an alternate location for storing content by pressing the '...' button. To avoid dataloss if you have already created or downloaded content, please see [[Help:Moving_Content|Moving Content]] for information on moving your existing LocalData.

===Check for Trainz updates...===
This option will check for any available updates for Trainz.

===Change Trainz update stream===
This option will allow you to change the update stream for Trainz, such as to access a public beta test.

==Performance Tab==
The Performance tab provides many options that adjust the graphics in Trainz, which in turn allow you to tune the look and performance of Trainz. Please note, many of these options require you to restart Trainz (close all windows, including the launcher window, then re-open Trainz) to take effect. The higher the setting, the greater the detail but also the greater the impact it will have on performance, depending on your hardware. These settings are also adjusted by the [[Help:Performance_Configurator|Performance Configurator]].

[[File:2018-06-13 122553.png|270px]]

Please see the [[Help:Video_Settings|Video Settings]] page for information on each of these settings, and how to tune these settings for different hardware configurations.

== Internet Tab==
The Internet Tab allows you to view and set your MyTrainz account details, and view your First Class Ticket status.

[[File:2018-06-13 122607.png|270px]]

===MyTrainz account===
Your MyTrainz account is the account registered on the Trainz Store, Trainz Portal, or Auran.com websites. If you do not yet have one, then click on the Create Account button to create a new account.

This account provides access to all of the online features in Trainz, including the Download Station!

Once created, enter your username and password into the boxes provided and then press enter to allow Trainz to log in. Please Note, your username and password are case sensitive. For Trainz Store purchases, Trainz will be automatically registered to the username it was purchased through.

For Steam and Mac AppStore purchases, Trainz is registered to your account when it first logs into the first MyTrainz account entered into the settings.

You can only register Trainz to one MyTrainz account. Your registration is not transferable to another account.

===First Class Ticket Status===
Your First Class Ticket status is shown here. First Class Tickets provide access to the First Class server on the Download Station to download new content for Trainz at faster speeds, without any daily download limits and provides priority download access over the free server. You only need one First Class Ticket per account, it will then be available to all versions registered to that account.

==Dev Tab==
The Dev tab provides a range of displays and settings intended for content developers.

[[File:2018-06-13 122612.png|270px]]

===UserID===
This is the UserID number for your account. This number is the first number used in the asset id/kuid number of any content that you create.

===Daily backups to keep===
When content is removed by Trainz, either by you or during part of a database update or rebuild (ie the content is damaged, or there is another item with the same AssetID installed), it will be moved to the Backups folder of your LocalData.

This option allows you to set how many days worth of backups will be kept. Currently defaults to 1. Please note, these backups may not always be usable, and are intended for advanced users only. We recommend keeping manual backups of content yourself. See [[Help:Backing_Up_Content|Backing Up Content]] for instructions on this.

===Time Scaling===
This allows you to speed up Trainz, such as to allow you to run through sessions much quicker to allow you to debug a session easily.

===Debug render===
TBC

===Enable advanced debug tools===
This option allows you to enable advanced debug tools, such as script debug tools and Post Processing tools.

===Show Script Exception Notifications===
This allows you to enable the script exception notifications in Trainz. These indicate issues/errors with scripts in Trainz, and are useful for debugging scripted functions (ie driver commands, custom scripts for trains, etc) that may not be working as expected.

Script exceptions will appear in Trainz as a red 'bug' icon at the bottom right. Click on this to view the script exceptions that have appeared up to that point in the session. If none have appeared, the red bug icon will not appear.

===Log script output===
This will allow the script output to be placed into the Logs. You can view the logs by clicking on 'Developer', then click on 'Show Logs'. You may wish to 'Clear Logs' first to start with a clean display.

===Log script message handling===
This option will allow the logging of script message handling in Trainz.

Return to [[TRS19 | TRS19 Home Page]] - [[Help:TRS19_Launcher|TRS2019 Launcher]] - [[Help:TRS19|TRS19 Help]]
[[Category:TRS19]][[Category:Help]]

Help:TurfFX Effect Layer

2020-01-28T17:02:59Z

Zikchil: /* Painting Tips */

The TurfFX Effect Layer is an [[Effect Layer]] type which is used to render grass (and similar foliage). As with all effect layers, turf is painted onto the terrain and automatically generates appropriate geometry for the area surrounding the camera. As compared to the [[Clutter Effect Layer]], TurfFX offers less flexibility but substantial improvements to performance which in turn allows for greater density at greater draw distances and effective wind-synchronised animation.

=Turffx Overview=

A TurfFx asset is made up of individual polygon blades with many options to configure each blade in your Turf Effect Layer and within the asset itself. The individual asset creation process is explained in [[Effect_Layer_Assets]].

==Trainz - Content Creation - #36 - Turf Effects (part 1)==
[https://youtu.be/0zTqYRMIqCs Video]

This first tutorial on Turf Effects explains how to get up and running with painting some grass around your route. The next tutorials on turf will dive into detailed information on all the below parameters.

==Trainz - Content Creation - #37 - Turf Effects (part 2) - Parameters Explained==
[https://youtu.be/4Yc7epaBoDc Video]

This second tutorial on Turf Effects explains in detail all the parameters that come with a Turf Effect Layer.

== Creating and Editing Turffx Layers in Surveyor==

[[File:turfeffectlayeredit.jpg]]

NOTE: To return to ground editing mode you select "Ground" option in the dropdown list in the above image

=== Effect Layer Window ===

The Effect Layers window allows you to edit your effect properties. The UI in this window will change based on what effect you choose (clutter, turf, something else).

We've included some defaults to get you started with TurfFX, and suggest you experiment with each control to customise your effect.

[[file:turf_defaults.jpg]]

==== Select ====

This allows you to select any existing effect layers to view and edit their parameters.

[[File:turfeffectlayerselection.jpg]]

==== Delete ====

This button will delete the currently selected effect layer.

[[File:effectlayerwindow1b.jpg]]

=== Add ===

This button will allow you to create a new effect layer.

[[File:effectlayerwindow1c.jpg]]

==== Name ====

Enter a name for your effect layer.

[[File:turfeffectlayername.jpg]]

==== Turffx-Asset ====

Select a "Turf" asset you want to use in your turffx layer from the dropdown list. Once selected and named, you can customise how this particular layer will be configured wherever it is painted throughout the route.

Note that if you want short grass and long grass, you need to create two different TurfFX layers, or use the Turffx-Height-Scale data binding.

[[File:turfeffectlayerasset.jpg]]

==== Turffx-Density Data Binding ====

The "turffx-density" options and associated "default" value control the [[Effect Layer Data Binding]] (read this link for details) which controls the density of this turffx layer across the route. Density ranges from 0.0 (no turf present) to 1.0 (maximum density).

[[File:turfeffectlayerdensity.jpg]]

[[File:turfeffectlayerdensitydefaultvalue.jpg]]

[[file:turfdensity1.jpg]]

[[file:turfdensity2.jpg]]

[[file:turfdensity3.jpg]]

NOTE: The turffx-density parameter (int1, int2, int4 ...etc) determines how accurate your density will be when painting with the height up/down and sensitivity radius in the topology tab. For example, int1 will give you 1 click while painting to get 100% density (off or on). Int4 will give you 1 click for 1/3rd density, 2 clicks for 2/3rds density, 3 clicks for 3/3rds density. Obviously the more accuracy you need the more data will need to be stored so use the appropriate data binding for the effect you require.

==== Turffx-Height-Scale Data Binding ====

The "turffx-height-scale" options and associated "constant" value control the [[Effect Layer Data Binding]] (read this link for details) which controls the height of this turffx layer across the route. Height ranges from 0.0 (no turf present) to 1.0 (maximum height).

[[File:2018-12-18 105752.png]]

NOTE: The turffx-height-scale parameter (int1, int2, int4 ...etc) determines how accurate your height scale data will be when painting with the height up/down and sensitivity radius in the topology tab. For example, int1 will give you 1 click while painting to get 100% height (i.e. the height is either off or on). Int4 will give you 1 click for 1/3rd height, 2 clicks for 2/3rds height, 3 clicks for full height. Obviously the more accuracy you need the more data will need to be stored so use the appropriate data binding for the effect you require.

==== Geometry-Scale ====

This changes the height of your blade geometry in meters.

[[File:turfeffectlayergeometryscale.jpg]]

==== Blade-Width ====

This changes the width of your blade geometry in meters.

[[File:turfeffectlayerbladewidth.jpg]]

==== Blade-Width-Noise ====

This adds random variation to the width of your blade geometry.

[[File:turfeffectlayerbladewidthnoise.jpg]]

==== Blade-Height-Noise ====

This adds random variation to the height of your blade geometry.

[[File:turfeffectlayerbladeheight.jpg]]

==== Width-Scale-Near ====

This defines the shape of your blade geometry up close to the camera.

[[File:turfeffectlayerwidthscalenear.jpg]]

==== Width-Scale-Far ====

This defines the shape of your blade geometry in the distance.

[[File:turfeffectlayerwidthscalefar.jpg]]

[[file:turfshape.jpg]]

==== Bending-Scale ====

Defines how much your blade geometry will bend in the wind. (bending strength for wind animation)

[[File:turfeffectlayerbendingscale.jpg]]

==== Dispersal ====

Dispersal controls the radius around a seed point to place individual grass blades.

[[File:turfeffectlayerdispersal.jpg]]

[[file:turftdispersal.jpg]]

==== Bunching ====

Bunching controls radial alignment of individual grass blades around the seed point. Bunching equal to one (1) produces maximally aligned distribution of grass blades, while zero (0) would result in completely random distribution.

[[File:turfeffectlayerbunching.jpg]]

[[file:turftbunching.jpg]]

==== Expansion-constant ====

: This affects how many grass blades will be at each point in the grid. Tweaking this number will change the density.
: Expansion = "expansion-constant" + "expansion-multiplier" * "value0"

: Try a starting value of 0.3.

==== Expansion-multiplier ====

: This affects how many grass blades will be at each point in the grid. Tweaking this number will change the density.
: Expansion = "expansion-constant" + "expansion-multiplier" * "value0"
: Try a starting value of 0.3

==== Number-of-seeds-multiplier ====

: This affects how many new points in each grid to sprout grass blades. Tweaking this number will change the density.
: Number of Seeds = "number-of-seeds-multiplier" * "value0"
: Try a starting value of 0.3

== Painting Turffx ==

=== Using Height Up and Down Tool===

Effect Layers are selected in the Advanced Topology Tab. When you change from Ground to any of the Effect Layers you have created, the Height Up, Height Down and Radius tools are used much like the tools in the Paint Tab.

[[File:turfeffectlayerpainting.jpg]]

=== Using Area Fill Tool===
You can also select an area and fill the area with your selected Effect Layer Binding. Set the Effect Fill Density slider when using the Fill tool to adjust the density of your effect layer.

=== Painting Tips ===
* Effect Layers are data intensive, and so you need to work out where you require precision (e.g. in highly visible areas) and where you can use much less precision (e.g. away from the track areas)
* Using 2.5m precision everywhere will consume your scene budget very quickly.
* Using the turffx-height-scale tool will raise or lower existing effect layers only. (i.e. you need to paint some density prior to adjusting the height)
* Experiment with different values such as using 0.001 for dispersal to get that "clumpy" look (then try 0.05, 0.5 etc for different looks)
* TurfFX is currently not supported during route merge.

== New TurfFX Tools (2020) ==

These new tools will be delivered as part of the Trainz Plus update for Q1 2020 and provide a range of new options to make your task of adding effect layers and using them, easier and more flexible.

=== Adding Effect Layers ===
You can now choose from a range of Preset options and edit those options as much as you like.

To access these options, go to Topology Tab -> Advanced Section -> Edit/Add effect layers.

If there are no Effect layers already used in the route, you'll be prompted to create a new one.

Add a name and chose either Turffx or Clutter.

[[File:2020-01-24_105930.png|900px]]

==== Option 1: Using a preset ====
# Select an Effect Preset using either the arrow keys or dropdown list.
# (Optional) Toggle the Advanced options so that you can edit the settings as required.
# Press the check (tick) button to close the Effect Layers window.
Note: Turf Effects can only render in one viewport. This means if you have the Effect Layers preview window showing the turf will be rendered in that window and not in your route.
When closing the Effect Layers window any turffx already painted in your route will begin rendering again after a short delay (~5 seconds).

==== Option 2: Using a preset and editing it ====
# Select an Effect Preset.
# Toggle Advanced Options.
# Edit the Advanced Options.
# Press the check (tick) button to close the Effect Layers window.
Note: Turf Effects can only render in one viewport. This means if you have the Effect Layers preview window showing the turf will be rendered in that window and not in your route.
When closing the Effect Layers window any turffx already painted in your route will begin rendering again after a short delay (~5 seconds).

====Presets versus Named Effect Layers====
It is important to note the difference between Presets and Effect Layers.

Presets are assets. This means they can be saved, uploaded to the DLS, or shared via .cdp. However, you cannot paint using a "Preset" directly.

# To paint, you need to create an "Effect Layer" (which can be made by selecting a Preset).
# Effect Layers are created per route.
# Click the + icon to create a new Effect Layer and give it a name (which can be the same as the Preset name if you like).
# Click the Tick to save the Effect Layer.
# This named Effect Layer is then available in the dropdown list in the Topology > Advanced tab.

NOTE: If you click the Save icon, you will create a new Preset. Of course you can do both, so that when you start another route, you have the Preset available to select when you create a new Effect Layer.

=== Masking Options ===
There are new options in the Advanced Section that determine whether effect layers will or won't be painted in various areas. These options are:
* Avoid-water (Effects will NOT appear under a water layer)
* Altitude-range (Effects will NOT appear outside the max/min altitude set)
* Gradient-range (Effects will NOT appear if the slope exceeds the limit you set)
* Ground-texture-mask (Effects WILL appear ONLY upon the textures you add to the mask)

TIP:
* The accuracy (precision) of effect layers depends on [[TurfFX_Effect_Layer#Turffx-Density_Data_Binding | turffx-density]] settings. The higher the precision (for example float16 or float32 using 10m, 5m or 2.5m grid), the more data required and the larger your route will be.
* Ensure you add all the textures you want a specific effect layer to appear on.

=== Other New Tools ===

====Get Effect====
The Get Effect tool is useful to find which "Effect Layer" is painted in a specific area. Once identified, you can then edit the configuration or select the Effect Layer from the dropdown list in Topology > Advanced.

# Click Edit/Add effect layers
# Click the Get Effect tool. The Preview window is automatically closed and the Effect Layers will display in the world after a few seconds
# Hover your mouse over various effect layers in the 3D world.
# As you move your mouse around the terrain, all of the effect layers (both Turffx and Clutter layers) in that area will be listed in the mouseover help dialog
# If you want to then paint with an identified effect layer, simply select it from the dropdown list in Topology > Advanced
# If you want to edit it, click the ground in that area to load the item in the Effect Layers window
# If you want to edit an item from further down the mouseover list, select the appropriate Effect Layer name from the dropdown in the Effect Layers window.

==== Save as new Preset ====
You can now save your own configurations to allow you to chose the same effect configuration in a different route.

Note that you will still need to create and name a new Effect Layer in the new route.

# Click Topology Tab -> Advanced Section -> Edit/Add effect layers to open the Effect Layers window.
# Choose a Preset from the dropdown list in the Effect Layers window.
# Click the Advanced Toggle to expand the window
# Adjust the various configurable values to modify the Preset
# View the changes in the Preview window
# When happy with the results, click the Save icon above the Preview window
# The Save dialog opens and you can either save as the same name to overwrite that Preset, or change the name to create a new Preset asset.

TIP:
* When painting or filling, if you're wondering why something isn't applying to an area, check your mask settings for that effect layer.

=== Bulk Editing Effect Layers ===

You can now also use the "Bulk Edit" tool to rapidly update a route from older versions of Trainz to use the TurfFX layers. This will place an effect layer ON TOP of an existing ground texture.

[[File:2020-01-24_125216.png|600px]]

# To access the Topology -> Advanced Section -> [ Select an Effect Layer you have created for this route ] -> Click on the "Bulk fill effect layer" icon.
# The "Bulk Asset Update/Replace" window appears.
# In “Assets to update” list, use the Picker to select one or more existing ground textures that you want to apply the effect layer to (or drag a texture from the Paint tab).
# In “Asset to update with” select the Effect layer to use by dragging from the Topology Advanced tab Effect layer dropdown list.
# To change the "median" density or height variation use the “Autofill density/height” slider. Which aspect is adjusted depends upon which “TurfFX” option you have selected under the Topology -> Advanced Section -> TurfFX drop down.
# (Optional) To randomise fill density click the checkbox and adjust the slider to either create a more uniform fill (0%) to a random fill (100%).
# (Optional) To further customise where the effects are painted, click the "Skip areas with" checkbox then choose either "Data for this binding" and "Data for effect layers of this type" from the dropdown. This will skip any effect layer vertices which already have effect layer data.
# Click "Begin" to bulk paint the effect layer on your configuration.

TIPS:
* Data for this binding means "any grid that has the selected effect layer on it".
* Data for effect layers of this type means "any grid that has the selected effect layer type (i.e. turf or clutter)"
* If you have applied any of the new "masking" options (Avoid-water, Altitude-range, Gradient-range, Ground-texture-mask) to the effect layer you are using, then the results you see in the world will depend on each of the configured settings
i.e. If you're wondering why something isn't applying to an area, check your mask settings.
* Bulk Edit adds the effect layer ON TOP of the ground texture. It does not replace the ground texture. To replace a texture, drag another texture into the “Asset to update with” box.
* Use a [[TurfFX_Effect_Layer#Turffx-Density_Data_Binding | turffx-density]] higher than Int1 to have a greater range of density (precision).

== Bulk Paint Under Splines (2020)==
With the latest Trainz Plus update (Q1 2020), there is also a new tool designed to quickly apply ballast under your track. Of course you can also apply any other texture under a spline such as grass along a roadside, or fence line.

# From the Tools Menu Select "Bulk Asset Update/Replace".
# In “Assets to update” list, use the Picker to select one or more existing splines, or drag more splines from the Track list.
# In “Asset to update with” select the ground texture you want to use as fill.
# Under the Paint Tab -> Radius, change the radius to the width you wish to paint. (The smallest radius will give a 10m wide texture).
# Click "Begin" to bulk paint the ground texture under the spline chosen.

=Example Usage=

== Short Grass ==
Watch the video tutorial on Short Grass [[https://youtu.be/AgaaPBjHZyA HERE]]

[[File:tfx_short.jpg|1000px]]

[[File:tfx_short_info.jpg|493px]]

== Medium Grass ==
Watch the video tutorial on Medium Grass [[https://youtu.be/5TTwidjCuuQ HERE]]

== Long Grass ==
Watch the video tutorial on Long Grass [[https://youtu.be/qoH5OfcgfjU HERE]]

[[File:tfx_long.jpg|1000px]]

[[File:tfx_long_info.jpg|493px]]

== Long Grass + Long Seed Grass ==
Watch the video tutorial on Long Seed Grass [[https://youtu.be/l04As0QFFPQ HERE]]

[[File:tfx_long_seed.jpg|1000px]]

[[File:tfx_long_info.jpg|493px]] [[File:tfx_long_seed_info.jpg|493px]]

== Turf ==
[[File:tfx_turf.jpg|1000px]]

[[File:tfx_turf_info.jpg|493px]]

== Cut Turf ==
[[File:tfx_turf_cut.jpg|1000px]]

[[File:tfx_turf_cut_info.jpg|493px]]

== Other ==
[[File:TurfFX-Example0.jpg|1000px]]

[[File:TurfFX-Example1.jpg|1000px]]

=Clutter Effect Layer=

For help on editing and using the [[Help:Effect_Layer_Dialog|Clutter Effect layer]], click the link.

=Hardware Limitations=
TurfFX is developed by NVIDIA and is designed to takes advantage of high-end GPU's with substantial amounts of VRAM.

1. TurfFX is currently supported only for Windows.

2. Whereas Trainz will typically run (albeit slowly, or at reduced settings) on below-spec computers, TurfFX will need to be disabled entirely if the GPU is insufficient. We expect the minimum of a GeForce GTX 750 to get reasonable performance.

3. With TurfFX disabled, the Effect Layers are ignored entirely, and there is no performance penalty for those objects that are disabled.

=TurfFx Asset Creation=
For detailed information on creating new grass types, crops, weeds etc, please visit [[Effect_Layer_Assets]]

=See Also=
[[Help:Effect_Layer_Dialog]]<br>
[[Clutter_Effect_Layer]]

Back to [[Effect_Layer]]<br>
Back to [[Help:TRS19]]

[[Category:Content creation]]
[[Category:TRS19]]
[[Category:Help]]

Help:Effect Layer Dialog

2020-01-28T16:56:05Z

Zikchil: /* Tips */

This page outlines how to create and paint your own Clutter Effect layers in Surveyor.

For Help on creating and painting [[Help:TurfFX_Effect_Layer|Turffx layers]], click the link.

== Creating and Editing Clutter Layers ==

[[File:effectlayertopology1.jpg]]

=== Effect Layer Window ===

The Effect Layers window allows you to edit your effect properties. The UI in this window will change based on which effect you choose (clutter, turf, something else).

[[File:effectlayerwindow1.jpg]]

==== Select ====

This allows you to select any existing effect layers to view and edit their parameters.

[[File:effectlayerwindow1a.jpg]]

==== Delete ====

This button will delete the currently selected effect layer.

[[File:effectlayerwindow1b.jpg]]

==== Add ====

This button will allow you to create a new effect layer.

[[File:effectlayerwindow1c.jpg]]

==== Name ====

Enter a name for your effect layer.

[[File:effectlayerwindow1d.jpg]]

==== Clutter-Density Data Binding ====

The "clutter-density" options and associated "constant" value control the [[Effect Layer Data Binding]] (read this link for details) which controls the density of this clutter layer across the route. Density ranges from 0.0 (no clutter present) to 1.0 (maximum density).

[[File:effectlayerwindow1e.jpg]]

[[File:effectlayerwindow1f.jpg]]

==== Spacing ====

Determines the spacing in meters between each clutter asset. The smaller the spacing the closer your clutter assets will be to one another (but most likely, the smaller the spacing the worse your performance will be).

[[File:effectlayerwindow1g.jpg]]

==== Random-Rotation ====

If true, randomly rotates every clutter asset in the effect layer. False will rotate each clutter asset to face the same direction.

[[File:effectlayerwindow1h.jpg]]

==== Draw-Distance ====

How far away the clutter layer will render out to in meters. The smaller you can make this the better your performance will be. If you don't need the default 300 meters and clutter looks fine at 100 meters then do it.

[[File:effectlayerwindow1i.jpg]]

==== Mesh-Assets ====

This is where you select one or more assets to be randomly generated for your clutter layer.

* Click the "Add Asset" button to add a new asset row.
* Click in the text box to list the clutter assets
* Select an asset you want to use in your clutter layer from the dropdown list.
* Adjust the slider next to each asset to determine how frequently to spawn this particular asset.
* Move the slider all the way to the right to give a very high spawn frequency.
* Move the slider all the way to the left stop it from spawning altogether (0 spawn frequency).
* When the slider is all the way to the left you get a delete button. Click that to remove this asset row.

[[File:effectlayerwindow1j.jpg]]

== Painting Clutter ==

[[File:paintingeffectlayers1.jpg]]

==Tips==
* When you click once to paint an area, you apply the minimum density of clutter
* Clicking more times on the same location will increase the denisty up to a maximum point (defined in the settings for that effect layer)
* Holding the left mouse button will paint at the highest density.
* Creating higher density clutter layers will reduce performance.
* To avoid major performance degradation, the engine also begins culling clutter in the distance if there is too much in the scene at one time.
* Try different combinations of plant and/or rocks to work out which items work best together
* Adjust the density sliders to adjust the % of each item that appears in your effect layer.
* Currently each effect layer you create is per route only.
* TurfFX is currently not supported in route merge.

==Turffx Layers==
For Help on creating and painting [[Help:TurfFX_Effect_Layer|Turffx layers]], click the link.

[[File:TurfFX-Example0.jpg|800px]]

== See Also ==
[[Help:TurfFX_Effect_Layer]]

For specific guidance to make your own clutter assets see: [[Clutter_Effect_Layer]]
For specific guidance to make your own TurfFX assets see: [[Effect_Layer_Assets]]

Return to [[Help:TRS19|TRS19 Help Page]]
[[Category:TRS19]]

TrainzUtil

2020-01-24T17:18:10Z

Zikchil: /* Usage */

[[TrainzUtil]] is a command line [[Content Management]] tool.

=Functionality=

[[TrainzUtil]] is capable of performing some content management tasks including:
* Installation, removal and editing of custom content.
* Limited searching of local content.
* Packaging local content for distribution.
[[TrainzUtil]] provides a small subset of the available content management functions, for most operations [[Content Manager]] should be used.

=Usage=

[[TrainzUtil]] is a command line utility and cannot be started from the [[Help:TRS19 Launcher|Trainz Launcher]].
*To start [[TrainzUtil]] open a command prompt and navigate to your Trainz "bin" directory (e.g. C:\Program Files\Auran\TS2010\Bin or D:N3V Games\Trainz A New Era etc).
*You can then launch [[TrainzUtil]] with command arguments as below.<br>
*In TRS19, you can enable trainzutil by clicking Trainz Settings > Dev > Enable Advanced debug commands, then restarting the game.
*You can then run the trainzutil commands from Launcher > Developer > Run trainzutil command.

NOTE: Due to the Windows command prompt treating the '<' and '>' characters as pipe operators, be sure to include quotes around any KUID parameters. For example:

trainzutil delete "<kuid:87854:982511580>"

* TrainzUtil help
:''Display TrainzUtil help text.'' (''...start here to see all current command line entries available'')
* TrainzUtil version
:''Display the TrainzUtil build version.''
* TrainzUtil echo <TEXT>
:''Echo the supplied text.''
* TrainzUtil time
:''Echoes the current time in RFC 822 format.''
* TrainzUtil setlanguage <langCode>
:''Set the Trainz language to the language code supplied (eg. US, FR, RU, etc).''
* TrainzUtil installCDP <PATH>
:''Install an asset from a CDP file.''
* TrainzUtil installfrompath <PATH>
:''Install an asset from a directory.''
* TrainzUtil installfromdls <KUID>
:''Install an asset from the Auran Download Station.''
* TrainzUtil edit <KUID>
:''Open an asset for editing.''
* TrainzUtil generateKUID
:''Generate a new KUID number in the local user's KUID range.''
* TrainzUtil createCDP <OUTPUT PATH> <KUID1> <KUID2> ... <KUIDX>
:''Export assets to a CDP file.''
* TrainzUtil repairdatabase
:''Repairs the Trainz Asset Database.''
* TrainzUtil repairdatabase extended
:''Forces DLC packages to be reinstalled and fully repairs database corruption. [https://support.trainzportal.com/index.php?/Knowledgebase/Article/View/36/8/extended-database-repair:Full Details here]''
* TrainzUtil printconfig <KUID>
:''Print the contents of an assets config file to the console.''
* TrainzUtil backupkeywords
:''Backup all the keywords of your assets.''
* TrainzUtil importkeywords
:''Import keywords into the Trainz Asset Database.''
* TrainzUtil add-keyword <keyword> <KUID> [..]
:''Add a keyword to the specified assets.''
* TrainzUtil remove-keyword <keyword> <KUID> [..]
:''Remove a keyword from the specified assets.''
* TrainzUtil search-by-keyword <keyword>
:''Returns a list of all assets with the specified keyword.''
* TrainzUtil commit <KUID>
:''Commit any edits that have been made to the specified asset.''
* TrainzUtil revert <KUID>
:''Discard any edits that have been made to the specified asset.''
* TrainzUtil delete <KUID>
:''Delete the specified asset from disk.''
* TrainzUtil list <KUID> [..]
:''Parses the specified kuid list into the results.''
* TrainzUtil list-latest-versions <KUID>
:''Get the latest known version of an asset. Multiple KUIDs may be specified as multiple arguments.''
* TrainzUtil list-dependencies <KUID>
:''Get an assets direct dependencies.''
* TrainzUtil list-dependants <KUID>
:''Get an assets direct dependants.''
* TrainzUtil authors
:''List of all the authorIDs that have content in the game.''
* TrainzUtil searchbycategory [-a] <CategoryList>
:''List all the local assets with a category set in this format, "CMP;MESH|BD;-ACTV|VE|SCEN". Use the -a parameter if you want to search the [[Download Station]] as well.''
* TrainzUtil filterbystatus <status> <KUID>
:''List all assets from the specified list which match the specified status flags.''
* TrainzUtil importconsists <PATH>
:''Import an old style Surveyor consist list, creating consist assets for any unknown entries.''
* TrainzUtil setnextcontentid <int>
:''Provides a 'next content ID' hint for the KUID generator.''
* TrainzUtil status <KUID>
:''Print the status of the specified asset.''
:''This will output + <KUID> : <Flags> : <category> : <username> where flags are a series of letters with case indicating boolean state. (capital letters are flagged true and lowercase are flagged false.)''
:*''Aa - The asset is archived.''
:*''Bb - The asset is builtin or packaged content.''
:*''Cc - The asset is in the base content set.''
:*''Dd - The asset is on the download station.''
:*''Ee - The asset is open for edit.''
:*''Ff - The asset is faulty.''
:*''Ii - The asset is installed locally.''
:*''Ll - The asset is locally modified.''
:*''Mm - The asset has missing dependencies.''
:*''Oo - The asset is obsolete.''
:*''Pp - The asset is listed in the DLS index as payware DLC.''
:*''Uu - The asset has an update available.''
:*''Xx - The asset is authorised for use in this Trainz installation.''
* TrainzUtil validate <KUID>
:''Perform validation and display any errors or warnings relating to this asset.''
* TrainzUtil compile <PATH>
:''Compile a script file.''
:*''<-d> Display gamescript documentation.''
:*''<-s> Silent mode.''
:*''<-bPATH> Specify a file path for the compile log.''
:*''<-pPATH> Specify the output directory.''
:*''<-oPATH> Specify the output library filename.''
:*''<PATH> Input source file.''
:*''<-iPATH> Additional include path.''
* TrainzUtil convert-config <PATH>
:''Converts a config.txt file to config.chump or vice versa.''
* TrainzUtil open-in-driver [-wait] <KUID>
:''Open the specified route or session asset in Driver. Optionally wait until the module is exited.''
* TrainzUtil open-in-surveyor [-wait] <KUID>
:''Open the specified route or session asset in Surveyor. Optionally wait until the module is exited.''
* TrainzUtil open-in-preview [-wait] <KUID>
:''Open the specified route or session asset in the asset preview tool. Optionally wait until the module is exited.''
* TrainzUtil encrypt <PATH>
:''Encrypt a script file (gs --> gse).''
* TrainzUtil export-package <device-type> <package-name> <package-build-number> [<dependency-package-name> ...] <kuid>
:''Export assets to a device package. Multiple KUIDs may be specified as multiple arguments.''
* TrainzUtil update-package <package-name>
:''Update prebuilt data within a package.''
* TrainzUtil install-package <PATH>
:''Install a package from the specified path.''
* TrainzUtil clean-package [-a] <package-name>
:''Remove the local build's prebuilt data from within a package. Use the -a parameter if you want to strip all prebuilt data.''
* TrainzUtil uninstall-package <package-name>
:''Uninstall the specified package.''
* TrainzUtil list-package-assets <package-name>
:''List the assets available in the specified package.''
* TrainzUtil prebuild [--force] [--nofail] [--clear] [<KUID> ..]
:''Precache all installed content.''
* TrainzUtil downloadcontentlistings
:''Fully download the latest content listings.''
* TrainzUtil listbuilds <PATH>
:''Print the list of installed build numbers to a file.''
* TrainzUtil quit
:''Requests the GUI to close.''
* TrainzUtil async <command..>
:''Begins running the specified command asynchronously.''
* TrainzUtil sync
:''Waits for all async commands to complete.''
* TrainzUtil wait <seconds>
:''Pause for the specified number of seconds.''
* TrainzUtil @<file.txt>
:''Batch-execute a series of commands from the specified text file (every argument must be between double quotes). Every line of that text file will be processed like a separate call to TrainzUtil''
* set <variable> <command..>
:''Used in a batch file, runs the specified command and overwrites the named variable with the result.''
* append <variable> <command..>
:''Used in a batch file, runs the specified command and appends the result into the named variable.''
* iferr <variable> <command..>
:''Used in a batch file, runs the specified command only if the named variable contains one or more errors.''
* iferrflag <command..>
:''Used in a batch file, runs the specified command only if an error has occurred in the batch file execution up to this point.''
* ifnone <variable> <command..>
:''Used in a batch file, runs the specified command only if the named variable contains no assets.''
* ifhas <variable> <command..>
:''Used in a batch file, runs the specified command only if the named variable contains one or more assets.''
* print <variable>
:''Used in a batch file, prints the content of the named variable.''
* printerrors <variable>
:''Used in a batch file, prints any errors contained in the named variable.''
* abort <TEXT>
:''Used in a batch files, aborts processing of the batch file immediately without raising any further errors. If arguments are present, they are logged as a single error string.''
* $(<variable>)
:''Used as a command parameter in a batch file, replaced with the KUID(s) from the specified variable.''

=Notes=
Due to the Windows command prompt treating the '<' and '>' characters as pipe operators, be sure to include quotes around any KUID parameters. For example:

trainzutil delete "<kuid:87854:982511580>"

[[Content Creation]]

Help:TurfFX Effect Layer

2020-01-23T23:52:57Z

Zikchil: /* See Also */

The TurfFX Effect Layer is an [[Effect Layer]] type which is used to render grass (and similar foliage). As with all effect layers, turf is painted onto the terrain and automatically generates appropriate geometry for the area surrounding the camera. As compared to the [[Clutter Effect Layer]], TurfFX offers less flexibility but substantial improvements to performance which in turn allows for greater density at greater draw distances and effective wind-synchronised animation.

=Overview=

A TurfFx asset is made up of individual polygon blades with many options to configure each blade in your Turf Effect Layer and within the asset itself. The individual asset creation process is explained in [[Effect_Layer_Assets]].

==Trainz - Content Creation - #36 - Turf Effects (part 1)==
[https://youtu.be/0zTqYRMIqCs Video]

This first tutorial on Turf Effects explains how to get up and running with painting some grass around your route. The next tutorials on turf will dive into detailed information on all the below parameters.

==Trainz - Content Creation - #37 - Turf Effects (part 2) - Parameters Explained==
[https://youtu.be/4Yc7epaBoDc Video]

This second tutorial on Turf Effects explains in detail all the parameters that come with a Turf Effect Layer.

== Creating and Editing Turffx Layers in Surveyor==

[[File:turfeffectlayeredit.jpg]]

NOTE: To return to ground editing mode you select "Ground" option in the dropdown list in the above image

=== Effect Layer Window ===

The Effect Layers window allows you to edit your effect properties. The UI in this window will change based on what effect you choose (clutter, turf, something else).

We've included some defaults to get you started with TurfFX, and suggest you experiment with each control to customise your effect.

[[file:turf_defaults.jpg]]

==== Select ====

This allows you to select any existing effect layers to view and edit their parameters.

[[File:turfeffectlayerselection.jpg]]

==== Delete ====

This button will delete the currently selected effect layer.

[[File:effectlayerwindow1b.jpg]]

=== Add ===

This button will allow you to create a new effect layer.

[[File:effectlayerwindow1c.jpg]]

==== Name ====

Enter a name for your effect layer.

[[File:turfeffectlayername.jpg]]

==== Turffx-Asset ====

Select a "Turf" asset you want to use in your turffx layer from the dropdown list. Once selected and named, you can customise how this particular layer will be configured wherever it is painted throughout the route.

Note that if you want short grass and long grass, you need to create two different TurfFX layers.

[[File:turfeffectlayerasset.jpg]]

==== Turffx-Density Data Binding ====

The "turffx-density" options and associated "default" value control the [[Effect Layer Data Binding]] (read this link for details) which controls the density of this turffx layer across the route. Density ranges from 0.0 (no turf present) to 1.0 (maximum density).

[[File:turfeffectlayerdensity.jpg]]

[[File:turfeffectlayerdensitydefaultvalue.jpg]]

[[file:turfdensity1.jpg]]

[[file:turfdensity2.jpg]]

[[file:turfdensity3.jpg]]

NOTE: The turffx-density parameter (int1, int2, int4 ...etc) determines how accurate your density will be when painting with the height up/down and sensitivity radius in the topology tab. For example, int1 will give you 1 click while painting to get 100% density (off or on). Int4 will give you 1 click for 1/3rd density, 2 clicks for 2/3rds density, 3 clicks for 3/3rds density. Obviously the more accuracy you need the more data will need to be stored so use the appropriate data binding for the effect you require.

==== Turffx-Height-Scale Data Binding ====

The "turffx-height-scale" options and associated "constant" value control the [[Effect Layer Data Binding]] (read this link for details) which controls the height of this turffx layer across the route. Height ranges from 0.0 (no turf present) to 1.0 (maximum height).

[[File:2018-12-18 105752.png]]

==== Geometry-Scale ====

This changes the height of your blade geometry in meters.

[[File:turfeffectlayergeometryscale.jpg]]

==== Blade-Width ====

This changes the width of your blade geometry in meters.

[[File:turfeffectlayerbladewidth.jpg]]

==== Blade-Width-Noise ====

This adds random variation to the width of your blade geometry.

[[File:turfeffectlayerbladewidthnoise.jpg]]

==== Blade-Height-Noise ====

This adds random variation to the height of your blade geometry.

[[File:turfeffectlayerbladeheight.jpg]]

==== Width-Scale-Near ====

This defines the shape of your blade geometry up close to the camera.

[[File:turfeffectlayerwidthscalenear.jpg]]

==== Width-Scale-Far ====

This defines the shape of your blade geometry in the distance.

[[File:turfeffectlayerwidthscalefar.jpg]]

[[file:turfshape.jpg]]

==== Bending-Scale ====

Defines how much your blade geometry will bend in the wind. (bending strength for wind animation)

[[File:turfeffectlayerbendingscale.jpg]]

==== Dispersal ====

Dispersal controls the radius around a seed point to place individual grass blades.

[[File:turfeffectlayerdispersal.jpg]]

[[file:turftdispersal.jpg]]

==== Bunching ====

Bunching controls radial alignment of individual grass blades around the seed point. Bunching equal to one (1) produces maximally aligned distribution of grass blades, while zero (0) would result in completely random distribution.

[[File:turfeffectlayerbunching.jpg]]

[[file:turftbunching.jpg]]

==== Expansion-constant ====

: This affects how many grass blades will be at each point in the grid. Tweaking this number will change the density.
: Expansion = "expansion-constant" + "expansion-multiplier" * "value0"

: Try a starting value of 0.3.

==== Expansion-multiplier ====

: This affects how many grass blades will be at each point in the grid. Tweaking this number will change the density.
: Expansion = "expansion-constant" + "expansion-multiplier" * "value0"
: Try a starting value of 0.3

==== Number-of-seeds-multiplier ====

: This affects how many new points in each grid to sprout grass blades. Tweaking this number will change the density.
: Number of Seeds = "number-of-seeds-multiplier" * "value0"
: Try a starting value of 0.3

== Painting Turffx ==

=== Using Height Up and Down Tool===

Effect Layers are selected in the Advanced Topology Tab. When you change from Ground to any of the Effect Layers you have created, the Height Up, Height Down and Radius tools are used much like the tools in the Paint Tab.

[[File:turfeffectlayerpainting.jpg]]

=== Using Area Fill Tool===
You can also select an area and fill the area with your selected Effect Layer Binding. Set the Effect Fill Density slider when using the Fill tool to adjust the density of your effect layer.

=== Painting Tips ===
* Effect Layers are data intensive, and so you need to work out where you require precision (e.g. in highly visible areas) and where you can use much less precision (e.g. away from the track areas)
* Using 2.5m precision everywhere will consume your scene budget very quickly.
* Using the turffx-height-scale tool will raise or lower existing effect layers only. (i.e. you need to paint some density prior to adjusting the height)
* Experiment with different values such as using 0.001 for dispersal to get that "clumpy" look (then try 0.05, 0.5 etc for different looks)

== New TurfFX Tools (2020) ==

These new tools will be delivered as part of the Trainz Plus update for Q1 2020 and provide a range of new options to make your task of adding effect layers easier and more flexible.

=== Adding Effect Layers ===
You can now choose from a range of Preset options and edit those options as much as you like.

To access these options, go to Topology Tab -> Advanced Section -> Edit/Add effect layers.

The default selection is TurfFX, or you can change to Clutter if required.

==== Option 1: Using a preset ====
* Select an Effect Preset using either the arrow keys or dropdown list.
* This opens the Advanced options so that you can edit the settings as required.
* Press the check (tick) button to close the Effect Layers window.
Note: Turf Effects can only render in one viewport. This means if you have the Effect Layers preview window showing the turf will be rendered in that window and not in your route. When closing the Effect Layers window the turf will begin rendering in your route after about 3 - 5 seconds.

==== Option 2: Using a preset and editing it ====
* Select an Effect Preset.
* Toggle Advanced Options.
* Edit the Advanced Options.
* Press the check (tick) button to close the Effect Layers window.
Note: Turf Effects can only render in one viewport. This means if you have the Effect Layers preview window showing the turf will be rendered in that window and not in your route. When closing the Effect Layers window the turf will begin rendering in your route after about 3 - 5 seconds.

==== Masking Option===
There are new options in the Advanced Section that determine whether effect layers will or won't be painted in various areas. These options are:
* Avoid-water (Effects will NOT appear under a water layer)
* Altitude-range (Effects will NOT appear outside the max/min altitude set)
* Gradient-range (Effects will NOT appear if the slope exceeds the limit you set)
* Ground-texture-mask (Effects WILL appear ONLY upon the textures you add to the mask)

TIP:
The accuracy (precision) of effect layers depends on turf-density settings. The higher the precision, the more data required.

=== Bulk Editing Effect Layers===

You can now also "Bulk Edit" to rapidly update a route from older versions of Trainz to use the TurfFX layers.

To access the Topology -> Advanced Section -> [ Select an Effect Layer you have created for this route ] -> Click on "Bulk fill effect layer"

The "Bulk Asset Update/Replace" window appears.

In “Assets to update” list, use the Picker to select one or more existing ground textures that you want to apply the effect layer to.

In “Asset to update with” select the Effect layer to use by dragging from the Topology tab Effect layer dropdown list.

“Autofill density/height” is used to create density or height variation (depending on which “TurfFX” option you have selected under the Topology -> Advanced Section -> TurfFX drop down). This is where you might need more turffx-density higher than Int1 to see better results to increase precision.

There are two configurable options to choose as well:
* "Randomise fill density by xx%" - A checkbox and slider that changes from a uniform fill to a random fill, where the slider sets the amount of randomisation and the main density slider (beneath the "replace with" asset) sets the median. Ranges from 0% to 100%.
* "Skip areas with" - A dropdown menu that causes the tool to skip any effect layer vertices which already have effect layer data. Has two options, "Data for this binding" and "Data for effect layers of this type".

Click "Begin" to bulk paint the effect layer on your configuration.

TIP:
If you have applied any of the new "masking" options (Avoid-water, Altitude-range, Gradient-range, Ground-texture-mask) in your effect layer creation then this could be overriding the results you are seeing.

== Bulk Paint Under Splines ==
While not related to Turffx, there is also a new tool designed to quickly apply ballast under your track. Of course you can also apply any other texture under a spline such as grass along a roadside, or fenceline.

From the Tools Menu Select "Bulk Asset Update/Replace".

In “Assets to update” list, use the Picker to select one or more existing splines, or drag more splines from the Track list.

In “Asset to update with” select the ground texture you want to use as fill.

Under the Paint Tab -> Radius, change the radius to the width your wish to paint. (The smallest radius will give a 10m wide texture).

Click "Begin" to bulk paint the effect layer on your configuration.

=Example Usage=

== Short Grass ==
Watch the video tutorial on Short Grass [[https://youtu.be/AgaaPBjHZyA HERE]]

[[File:tfx_short.jpg|1000px]]

[[File:tfx_short_info.jpg|493px]]

== Medium Grass ==
Watch the video tutorial on Medium Grass [[https://youtu.be/5TTwidjCuuQ HERE]]

== Long Grass ==
Watch the video tutorial on Long Grass [[https://youtu.be/qoH5OfcgfjU HERE]]

[[File:tfx_long.jpg|1000px]]

[[File:tfx_long_info.jpg|493px]]

== Long Grass + Long Seed Grass ==
Watch the video tutorial on Long Seed Grass [[https://youtu.be/l04As0QFFPQ HERE]]

[[File:tfx_long_seed.jpg|1000px]]

[[File:tfx_long_info.jpg|493px]] [[File:tfx_long_seed_info.jpg|493px]]

== Turf ==
[[File:tfx_turf.jpg|1000px]]

[[File:tfx_turf_info.jpg|493px]]

== Cut Turf ==
[[File:tfx_turf_cut.jpg|1000px]]

[[File:tfx_turf_cut_info.jpg|493px]]

== Other ==
[[File:TurfFX-Example0.jpg|1000px]]

[[File:TurfFX-Example1.jpg|1000px]]

=Surveyor Bulk Editing Tools=

In future updates we plan on expanding the TurfFX tools to enable global updates such as adding a TurfFX layer to an existing ground texture. These tools, when introduced, will greatly speed up the conversion process from older routes.

=Hardware Limitations=
TurfFX is developed by NVIDIA and is designed to takes advantage of high-end GPU's with substantial amounts of VRAM.

1. TurfFX is currently supported only for Windows.

2. Whereas Trainz will typically run (albeit slowly, or at reduced settings) on below-spec computers, TurfFX will need to be disabled entirely if the GPU is insufficient. We expect the minimum of a GeForce GTX 750 to get reasonable performance.

3. With TurfFX disabled, the Effect Layers are ignored entirely, and there is no performance penalty for those objects that are disabled.

=TurfFx Asset Creation=
For detailed information on creating new grass types, crops, weeds etc, please visit [[Effect_Layer_Assets]]

=See Also=
[[Help:Effect_Layer_Dialog]]<br>
[[Clutter_Effect_Layer]]

Back to [[Effect_Layer]]<br>
Back to [[Help:TRS19]]

[[Category:Content creation]]
[[Category:TRS19]]
[[Category:Help]]

Help:TurfFX Effect Layer

2020-01-23T21:55:34Z

Zikchil: /* Effect Layer Window */

The TurfFX Effect Layer is an [[Effect Layer]] type which is used to render grass (and similar foliage). As with all effect layers, turf is painted onto the terrain and automatically generates appropriate geometry for the area surrounding the camera. As compared to the [[Clutter Effect Layer]], TurfFX offers less flexibility but substantial improvements to performance which in turn allows for greater density at greater draw distances and effective wind-synchronised animation.

=Overview=

A TurfFx asset is made up of individual polygon blades with many options to configure each blade in your Turf Effect Layer and within the asset itself. The individual asset creation process is explained in [[Effect_Layer_Assets]].

==Trainz - Content Creation - #36 - Turf Effects (part 1)==
[https://youtu.be/0zTqYRMIqCs Video]

This first tutorial on Turf Effects explains how to get up and running with painting some grass around your route. The next tutorials on turf will dive into detailed information on all the below parameters.

==Trainz - Content Creation - #37 - Turf Effects (part 2) - Parameters Explained==
[https://youtu.be/4Yc7epaBoDc Video]

This second tutorial on Turf Effects explains in detail all the parameters that come with a Turf Effect Layer.

== Creating and Editing Turffx Layers in Surveyor==

[[File:turfeffectlayeredit.jpg]]

NOTE: To return to ground editing mode you select "Ground" option in the dropdown list in the above image

=== Effect Layer Window ===

The Effect Layers window allows you to edit your effect properties. The UI in this window will change based on what effect you choose (clutter, turf, something else).

We've included some defaults to get you started with TurfFX, and suggest you experiment with each control to customise your effect.

[[file:turf_defaults.jpg]]

==== Select ====

This allows you to select any existing effect layers to view and edit their parameters.

[[File:turfeffectlayerselection.jpg]]

==== Delete ====

This button will delete the currently selected effect layer.

[[File:effectlayerwindow1b.jpg]]

=== Add ===

This button will allow you to create a new effect layer.

[[File:effectlayerwindow1c.jpg]]

==== Name ====

Enter a name for your effect layer.

[[File:turfeffectlayername.jpg]]

==== Turffx-Asset ====

Select a "Turf" asset you want to use in your turffx layer from the dropdown list. Once selected and named, you can customise how this particular layer will be configured wherever it is painted throughout the route.

Note that if you want short grass and long grass, you need to create two different TurfFX layers.

[[File:turfeffectlayerasset.jpg]]

==== Turffx-Density Data Binding ====

The "turffx-density" options and associated "default" value control the [[Effect Layer Data Binding]] (read this link for details) which controls the density of this turffx layer across the route. Density ranges from 0.0 (no turf present) to 1.0 (maximum density).

[[File:turfeffectlayerdensity.jpg]]

[[File:turfeffectlayerdensitydefaultvalue.jpg]]

[[file:turfdensity1.jpg]]

[[file:turfdensity2.jpg]]

[[file:turfdensity3.jpg]]

NOTE: The turffx-density parameter (int1, int2, int4 ...etc) determines how accurate your density will be when painting with the height up/down and sensitivity radius in the topology tab. For example, int1 will give you 1 click while painting to get 100% density (off or on). Int4 will give you 1 click for 1/3rd density, 2 clicks for 2/3rds density, 3 clicks for 3/3rds density. Obviously the more accuracy you need the more data will need to be stored so use the appropriate data binding for the effect you require.

==== Turffx-Height-Scale Data Binding ====

The "turffx-height-scale" options and associated "constant" value control the [[Effect Layer Data Binding]] (read this link for details) which controls the height of this turffx layer across the route. Height ranges from 0.0 (no turf present) to 1.0 (maximum height).

[[File:2018-12-18 105752.png]]

==== Geometry-Scale ====

This changes the height of your blade geometry in meters.

[[File:turfeffectlayergeometryscale.jpg]]

==== Blade-Width ====

This changes the width of your blade geometry in meters.

[[File:turfeffectlayerbladewidth.jpg]]

==== Blade-Width-Noise ====

This adds random variation to the width of your blade geometry.

[[File:turfeffectlayerbladewidthnoise.jpg]]

==== Blade-Height-Noise ====

This adds random variation to the height of your blade geometry.

[[File:turfeffectlayerbladeheight.jpg]]

==== Width-Scale-Near ====

This defines the shape of your blade geometry up close to the camera.

[[File:turfeffectlayerwidthscalenear.jpg]]

==== Width-Scale-Far ====

This defines the shape of your blade geometry in the distance.

[[File:turfeffectlayerwidthscalefar.jpg]]

[[file:turfshape.jpg]]

==== Bending-Scale ====

Defines how much your blade geometry will bend in the wind. (bending strength for wind animation)

[[File:turfeffectlayerbendingscale.jpg]]

==== Dispersal ====

Dispersal controls the radius around a seed point to place individual grass blades.

[[File:turfeffectlayerdispersal.jpg]]

[[file:turftdispersal.jpg]]

==== Bunching ====

Bunching controls radial alignment of individual grass blades around the seed point. Bunching equal to one (1) produces maximally aligned distribution of grass blades, while zero (0) would result in completely random distribution.

[[File:turfeffectlayerbunching.jpg]]

[[file:turftbunching.jpg]]

==== Expansion-constant ====

: This affects how many grass blades will be at each point in the grid. Tweaking this number will change the density.
: Expansion = "expansion-constant" + "expansion-multiplier" * "value0"

: Try a starting value of 0.3.

==== Expansion-multiplier ====

: This affects how many grass blades will be at each point in the grid. Tweaking this number will change the density.
: Expansion = "expansion-constant" + "expansion-multiplier" * "value0"
: Try a starting value of 0.3

==== Number-of-seeds-multiplier ====

: This affects how many new points in each grid to sprout grass blades. Tweaking this number will change the density.
: Number of Seeds = "number-of-seeds-multiplier" * "value0"
: Try a starting value of 0.3

== Painting Turffx ==

=== Using Height Up and Down Tool===

Effect Layers are selected in the Advanced Topology Tab. When you change from Ground to any of the Effect Layers you have created, the Height Up, Height Down and Radius tools are used much like the tools in the Paint Tab.

[[File:turfeffectlayerpainting.jpg]]

=== Using Area Fill Tool===
You can also select an area and fill the area with your selected Effect Layer Binding. Set the Effect Fill Density slider when using the Fill tool to adjust the density of your effect layer.

=== Painting Tips ===
* Effect Layers are data intensive, and so you need to work out where you require precision (e.g. in highly visible areas) and where you can use much less precision (e.g. away from the track areas)
* Using 2.5m precision everywhere will consume your scene budget very quickly.
* Using the turffx-height-scale tool will raise or lower existing effect layers only. (i.e. you need to paint some density prior to adjusting the height)
* Experiment with different values such as using 0.001 for dispersal to get that "clumpy" look (then try 0.05, 0.5 etc for different looks)

== New TurfFX Tools (2020) ==

These new tools will be delivered as part of the Trainz Plus update for Q1 2020 and provide a range of new options to make your task of adding effect layers easier and more flexible.

=== Adding Effect Layers ===
You can now choose from a range of Preset options and edit those options as much as you like.

To access these options, go to Topology Tab -> Advanced Section -> Edit/Add effect layers.

The default selection is TurfFX, or you can change to Clutter if required.

==== Option 1: Using a preset ====
* Select an Effect Preset using either the arrow keys or dropdown list.
* This opens the Advanced options so that you can edit the settings as required.
* Press the check (tick) button to close the Effect Layers window.
Note: Turf Effects can only render in one viewport. This means if you have the Effect Layers preview window showing the turf will be rendered in that window and not in your route. When closing the Effect Layers window the turf will begin rendering in your route after about 3 - 5 seconds.

==== Option 2: Using a preset and editing it ====
* Select an Effect Preset.
* Toggle Advanced Options.
* Edit the Advanced Options.
* Press the check (tick) button to close the Effect Layers window.
Note: Turf Effects can only render in one viewport. This means if you have the Effect Layers preview window showing the turf will be rendered in that window and not in your route. When closing the Effect Layers window the turf will begin rendering in your route after about 3 - 5 seconds.

==== Masking Option===
There are new options in the Advanced Section that determine whether effect layers will or won't be painted in various areas. These options are:
* Avoid-water (Effects will NOT appear under a water layer)
* Altitude-range (Effects will NOT appear outside the max/min altitude set)
* Gradient-range (Effects will NOT appear if the slope exceeds the limit you set)
* Ground-texture-mask (Effects WILL appear ONLY upon the textures you add to the mask)

TIP:
The accuracy (precision) of effect layers depends on turf-density settings. The higher the precision, the more data required.

=== Bulk Editing Effect Layers===

You can now also "Bulk Edit" to rapidly update a route from older versions of Trainz to use the TurfFX layers.

To access the Topology -> Advanced Section -> [ Select an Effect Layer you have created for this route ] -> Click on "Bulk fill effect layer"

The "Bulk Asset Update/Replace" window appears.

In “Assets to update” list, use the Picker to select one or more existing ground textures that you want to apply the effect layer to.

In “Asset to update with” select the Effect layer to use by dragging from the Topology tab Effect layer dropdown list.

“Autofill density/height” is used to create density or height variation (depending on which “TurfFX” option you have selected under the Topology -> Advanced Section -> TurfFX drop down). This is where you might need more turffx-density higher than Int1 to see better results to increase precision.

There are two configurable options to choose as well:
* "Randomise fill density by xx%" - A checkbox and slider that changes from a uniform fill to a random fill, where the slider sets the amount of randomisation and the main density slider (beneath the "replace with" asset) sets the median. Ranges from 0% to 100%.
* "Skip areas with" - A dropdown menu that causes the tool to skip any effect layer vertices which already have effect layer data. Has two options, "Data for this binding" and "Data for effect layers of this type".

Click "Begin" to bulk paint the effect layer on your configuration.

TIP:
If you have applied any of the new "masking" options (Avoid-water, Altitude-range, Gradient-range, Ground-texture-mask) in your effect layer creation then this could be overriding the results you are seeing.

== Bulk Paint Under Splines ==
While not related to Turffx, there is also a new tool designed to quickly apply ballast under your track. Of course you can also apply any other texture under a spline such as grass along a roadside, or fenceline.

From the Tools Menu Select "Bulk Asset Update/Replace".

In “Assets to update” list, use the Picker to select one or more existing splines, or drag more splines from the Track list.

In “Asset to update with” select the ground texture you want to use as fill.

Under the Paint Tab -> Radius, change the radius to the width your wish to paint. (The smallest radius will give a 10m wide texture).

Click "Begin" to bulk paint the effect layer on your configuration.

=Example Usage=

== Short Grass ==
Watch the video tutorial on Short Grass [[https://youtu.be/AgaaPBjHZyA HERE]]

[[File:tfx_short.jpg|1000px]]

[[File:tfx_short_info.jpg|493px]]

== Medium Grass ==
Watch the video tutorial on Medium Grass [[https://youtu.be/5TTwidjCuuQ HERE]]

== Long Grass ==
Watch the video tutorial on Long Grass [[https://youtu.be/qoH5OfcgfjU HERE]]

[[File:tfx_long.jpg|1000px]]

[[File:tfx_long_info.jpg|493px]]

== Long Grass + Long Seed Grass ==
Watch the video tutorial on Long Seed Grass [[https://youtu.be/l04As0QFFPQ HERE]]

[[File:tfx_long_seed.jpg|1000px]]

[[File:tfx_long_info.jpg|493px]] [[File:tfx_long_seed_info.jpg|493px]]

== Turf ==
[[File:tfx_turf.jpg|1000px]]

[[File:tfx_turf_info.jpg|493px]]

== Cut Turf ==
[[File:tfx_turf_cut.jpg|1000px]]

[[File:tfx_turf_cut_info.jpg|493px]]

== Other ==
[[File:TurfFX-Example0.jpg|1000px]]

[[File:TurfFX-Example1.jpg|1000px]]

=Surveyor Bulk Editing Tools=

In future updates we plan on expanding the TurfFX tools to enable global updates such as adding a TurfFX layer to an existing ground texture. These tools, when introduced, will greatly speed up the conversion process from older routes.

=Hardware Limitations=
TurfFX is developed by NVIDIA and is designed to takes advantage of high-end GPU's with substantial amounts of VRAM.

1. TurfFX is currently supported only for Windows.

2. Whereas Trainz will typically run (albeit slowly, or at reduced settings) on below-spec computers, TurfFX will need to be disabled entirely if the GPU is insufficient. We expect the minimum of a GeForce GTX 750 to get reasonable performance.

3. With TurfFX disabled, the Effect Layers are ignored entirely, and there is no performance penalty for those objects that are disabled.

=TurfFx Asset Creation=
For detailed information on creating new grass types, crops, weeds etc, please visit [[Effect_Layer_Assets]]

=See Also=
[[Help:Effect_Layer_Dialog]]
[[Clutter_Effect_Layer]]

Back to [[Effect_Layer]]
Back to [[Help:TRS19]]

[[Category:Content creation]]
[[Category:TRS19]]
[[Category:Help]]

Help:TurfFX Effect Layer

2020-01-23T21:36:23Z

Zikchil: /* New Turffx Tools (2020) */

The TurfFX Effect Layer is an [[Effect Layer]] type which is used to render grass (and similar foliage). As with all effect layers, turf is painted onto the terrain and automatically generates appropriate geometry for the area surrounding the camera. As compared to the [[Clutter Effect Layer]], TurfFX offers less flexibility but substantial improvements to performance which in turn allows for greater density at greater draw distances and effective wind-synchronised animation.

=Overview=

A TurfFx asset is made up of individual polygon blades with many options to configure each blade in your Turf Effect Layer and within the asset itself. The individual asset creation process is explained in [[Effect_Layer_Assets]].

==Trainz - Content Creation - #36 - Turf Effects (part 1)==
[https://youtu.be/0zTqYRMIqCs Video]

This first tutorial on Turf Effects explains how to get up and running with painting some grass around your route. The next tutorials on turf will dive into detailed information on all the below parameters.

==Trainz - Content Creation - #37 - Turf Effects (part 2) - Parameters Explained==
[https://youtu.be/4Yc7epaBoDc Video]

This second tutorial on Turf Effects explains in detail all the parameters that come with a Turf Effect Layer.

== Creating and Editing Turffx Layers in Surveyor==

[[File:turfeffectlayeredit.jpg]]

NOTE: To return to ground editing mode you select "Ground" option in the dropdown list in the above image

=== Effect Layer Window ===

The Effect Layers window allows you to edit your effect properties. The UI in this window will change based on what effect you choose (clutter, turf, something else).

We've included some defaults to get you started with TurFX, and suggest you experiment with each control to customise your effect.

[[file:turf_defaults.jpg]]

==== Select ====

This allows you to select any existing effect layers to view and edit their parameters.

[[File:turfeffectlayerselection.jpg]]

==== Delete ====

This button will delete the currently selected effect layer.

[[File:effectlayerwindow1b.jpg]]

=== Add ===

This button will allow you to create a new effect layer.

[[File:effectlayerwindow1c.jpg]]

==== Name ====

Enter a name for your effect layer.

[[File:turfeffectlayername.jpg]]

==== Turffx-Asset ====

Select a "Turf" asset you want to use in your turffx layer from the dropdown list. Once selected and named, you can customise how this particular layer will be configured wherever it is painted throughout the route.

Note that if you want short grass and long grass, you need to create two different TurfFX layers.

[[File:turfeffectlayerasset.jpg]]

==== Turffx-Density Data Binding ====

The "turffx-density" options and associated "default" value control the [[Effect Layer Data Binding]] (read this link for details) which controls the density of this turffx layer across the route. Density ranges from 0.0 (no turf present) to 1.0 (maximum density).

[[File:turfeffectlayerdensity.jpg]]

[[File:turfeffectlayerdensitydefaultvalue.jpg]]

[[file:turfdensity1.jpg]]

[[file:turfdensity2.jpg]]

[[file:turfdensity3.jpg]]

NOTE: The turffx-density parameter (int1, int2, int4 ...etc) determines how accurate your density will be when painting with the height up/down and sensitivity radius in the topology tab. For example, int1 will give you 1 click while painting to get 100% density (off or on). Int4 will give you 1 click for 1/3rd density, 2 clicks for 2/3rds density, 3 clicks for 3/3rds density. Obviously the more accuracy you need the more data will need to be stored so use the appropriate data binding for the effect you require.

==== Turffx-Height-Scale Data Binding ====

The "turffx-height-scale" options and associated "constant" value control the [[Effect Layer Data Binding]] (read this link for details) which controls the height of this turffx layer across the route. Height ranges from 0.0 (no turf present) to 1.0 (maximum height).

[[File:2018-12-18 105752.png]]

==== Geometry-Scale ====

This changes the height of your blade geometry in meters.

[[File:turfeffectlayergeometryscale.jpg]]

==== Blade-Width ====

This changes the width of your blade geometry in meters.

[[File:turfeffectlayerbladewidth.jpg]]

==== Blade-Width-Noise ====

This adds random variation to the width of your blade geometry.

[[File:turfeffectlayerbladewidthnoise.jpg]]

==== Blade-Height-Noise ====

This adds random variation to the height of your blade geometry.

[[File:turfeffectlayerbladeheight.jpg]]

==== Width-Scale-Near ====

This defines the shape of your blade geometry up close to the camera.

[[File:turfeffectlayerwidthscalenear.jpg]]

==== Width-Scale-Far ====

This defines the shape of your blade geometry in the distance.

[[File:turfeffectlayerwidthscalefar.jpg]]

[[file:turfshape.jpg]]

==== Bending-Scale ====

Defines how much your blade geometry will bend in the wind. (bending strength for wind animation)

[[File:turfeffectlayerbendingscale.jpg]]

==== Dispersal ====

Dispersal controls the radius around a seed point to place individual grass blades.

[[File:turfeffectlayerdispersal.jpg]]

[[file:turftdispersal.jpg]]

==== Bunching ====

Bunching controls radial alignment of individual grass blades around the seed point. Bunching equal to one (1) produces maximally aligned distribution of grass blades, while zero (0) would result in completely random distribution.

[[File:turfeffectlayerbunching.jpg]]

[[file:turftbunching.jpg]]

==== Expansion-constant ====

: This affects how many grass blades will be at each point in the grid. Tweaking this number will change the density.
: Expansion = "expansion-constant" + "expansion-multiplier" * "value0"

: Try a starting value of 0.3.

==== Expansion-multiplier ====

: This affects how many grass blades will be at each point in the grid. Tweaking this number will change the density.
: Expansion = "expansion-constant" + "expansion-multiplier" * "value0"
: Try a starting value of 0.3

==== Number-of-seeds-multiplier ====

: This affects how many new points in each grid to sprout grass blades. Tweaking this number will change the density.
: Number of Seeds = "number-of-seeds-multiplier" * "value0"
: Try a starting value of 0.3

== Painting Turffx ==

=== Using Height Up and Down Tool===

Effect Layers are selected in the Advanced Topology Tab. When you change from Ground to any of the Effect Layers you have created, the Height Up, Height Down and Radius tools are used much like the tools in the Paint Tab.

[[File:turfeffectlayerpainting.jpg]]

=== Using Area Fill Tool===
You can also select an area and fill the area with your selected Effect Layer Binding. Set the Effect Fill Density slider when using the Fill tool to adjust the density of your effect layer.

=== Painting Tips ===
* Effect Layers are data intensive, and so you need to work out where you require precision (e.g. in highly visible areas) and where you can use much less precision (e.g. away from the track areas)
* Using 2.5m precision everywhere will consume your scene budget very quickly.
* Using the turffx-height-scale tool will raise or lower existing effect layers only. (i.e. you need to paint some density prior to adjusting the height)
* Experiment with different values such as using 0.001 for dispersal to get that "clumpy" look (then try 0.05, 0.5 etc for different looks)

== New TurfFX Tools (2020) ==

These new tools will be delivered as part of the Trainz Plus update for Q1 2020 and provide a range of new options to make your task of adding effect layers easier and more flexible.

=== Adding Effect Layers ===
You can now choose from a range of Preset options and edit those options as much as you like.

To access these options, go to Topology Tab -> Advanced Section -> Edit/Add effect layers.

The default selection is TurfFX, or you can change to Clutter if required.

==== Option 1: Using a preset ====
* Select an Effect Preset using either the arrow keys or dropdown list.
* This opens the Advanced options so that you can edit the settings as required.
* Press the check (tick) button to close the Effect Layers window.
Note: Turf Effects can only render in one viewport. This means if you have the Effect Layers preview window showing the turf will be rendered in that window and not in your route. When closing the Effect Layers window the turf will begin rendering in your route after about 3 - 5 seconds.

==== Option 2: Using a preset and editing it ====
* Select an Effect Preset.
* Toggle Advanced Options.
* Edit the Advanced Options.
* Press the check (tick) button to close the Effect Layers window.
Note: Turf Effects can only render in one viewport. This means if you have the Effect Layers preview window showing the turf will be rendered in that window and not in your route. When closing the Effect Layers window the turf will begin rendering in your route after about 3 - 5 seconds.

==== Masking Option===
There are new options in the Advanced Section that determine whether effect layers will or won't be painted in various areas. These options are:
* Avoid-water (Effects will NOT appear under a water layer)
* Altitude-range (Effects will NOT appear outside the max/min altitude set)
* Gradient-range (Effects will NOT appear if the slope exceeds the limit you set)
* Ground-texture-mask (Effects WILL appear ONLY upon the textures you add to the mask)

TIP:
The accuracy (precision) of effect layers depends on turf-density settings. The higher the precision, the more data required.

=== Bulk Editing Effect Layers===

You can now also "Bulk Edit" to rapidly update a route from older versions of Trainz to use the TurfFX layers.

To access the Topology -> Advanced Section -> [ Select an Effect Layer you have created for this route ] -> Click on "Bulk fill effect layer"

The "Bulk Asset Update/Replace" window appears.

In “Assets to update” list, use the Picker to select one or more existing ground textures that you want to apply the effect layer to.

In “Asset to update with” select the Effect layer to use by dragging from the Topology tab Effect layer dropdown list.

“Autofill density/height” is used to create density or height variation (depending on which “TurfFX” option you have selected under the Topology -> Advanced Section -> TurfFX drop down). This is where you might need more turffx-density higher than Int1 to see better results to increase precision.

There are two configurable options to choose as well:
* "Randomise fill density by xx%" - A checkbox and slider that changes from a uniform fill to a random fill, where the slider sets the amount of randomisation and the main density slider (beneath the "replace with" asset) sets the median. Ranges from 0% to 100%.
* "Skip areas with" - A dropdown menu that causes the tool to skip any effect layer vertices which already have effect layer data. Has two options, "Data for this binding" and "Data for effect layers of this type".

Click "Begin" to bulk paint the effect layer on your configuration.

TIP:
If you have applied any of the new "masking" options (Avoid-water, Altitude-range, Gradient-range, Ground-texture-mask) in your effect layer creation then this could be overriding the results you are seeing.

== Bulk Paint Under Splines ==
While not related to Turffx, there is also a new tool designed to quickly apply ballast under your track. Of course you can also apply any other texture under a spline such as grass along a roadside, or fenceline.

From the Tools Menu Select "Bulk Asset Update/Replace".

In “Assets to update” list, use the Picker to select one or more existing splines, or drag more splines from the Track list.

In “Asset to update with” select the ground texture you want to use as fill.

Under the Paint Tab -> Radius, change the radius to the width your wish to paint. (The smallest radius will give a 10m wide texture).

Click "Begin" to bulk paint the effect layer on your configuration.

=Example Usage=

== Short Grass ==
Watch the video tutorial on Short Grass [[https://youtu.be/AgaaPBjHZyA HERE]]

[[File:tfx_short.jpg|1000px]]

[[File:tfx_short_info.jpg|493px]]

== Medium Grass ==
Watch the video tutorial on Medium Grass [[https://youtu.be/5TTwidjCuuQ HERE]]

== Long Grass ==
Watch the video tutorial on Long Grass [[https://youtu.be/qoH5OfcgfjU HERE]]

[[File:tfx_long.jpg|1000px]]

[[File:tfx_long_info.jpg|493px]]

== Long Grass + Long Seed Grass ==
Watch the video tutorial on Long Seed Grass [[https://youtu.be/l04As0QFFPQ HERE]]

[[File:tfx_long_seed.jpg|1000px]]

[[File:tfx_long_info.jpg|493px]] [[File:tfx_long_seed_info.jpg|493px]]

== Turf ==
[[File:tfx_turf.jpg|1000px]]

[[File:tfx_turf_info.jpg|493px]]

== Cut Turf ==
[[File:tfx_turf_cut.jpg|1000px]]

[[File:tfx_turf_cut_info.jpg|493px]]

== Other ==
[[File:TurfFX-Example0.jpg|1000px]]

[[File:TurfFX-Example1.jpg|1000px]]

=Surveyor Bulk Editing Tools=

In future updates we plan on expanding the TurfFX tools to enable global updates such as adding a TurfFX layer to an existing ground texture. These tools, when introduced, will greatly speed up the conversion process from older routes.

=Hardware Limitations=
TurfFX is developed by NVIDIA and is designed to takes advantage of high-end GPU's with substantial amounts of VRAM.

1. TurfFX is currently supported only for Windows.

2. Whereas Trainz will typically run (albeit slowly, or at reduced settings) on below-spec computers, TurfFX will need to be disabled entirely if the GPU is insufficient. We expect the minimum of a GeForce GTX 750 to get reasonable performance.

3. With TurfFX disabled, the Effect Layers are ignored entirely, and there is no performance penalty for those objects that are disabled.

=TurfFx Asset Creation=
For detailed information on creating new grass types, crops, weeds etc, please visit [[Effect_Layer_Assets]]

=See Also=
[[Help:Effect_Layer_Dialog]]
[[Clutter_Effect_Layer]]

Back to [[Effect_Layer]]
Back to [[Help:TRS19]]

[[Category:Content creation]]
[[Category:TRS19]]
[[Category:Help]]

Help:Importing Content

2020-01-22T15:10:18Z

Zikchil:

==Recommended Methods of Transferring Content==
There are several different methods that can be used to transfer content between different installations/versions of Trainz. Some are more suitable for smaller amounts of content, whilst others are suited to large amounts of content.

Use the Status column to avoid content marked as ‘payware’, ‘built-in’, or ‘installed from DLS’.

<div style="background-color: #ff9797;border-style: dotted; width:800px; overflow:auto; ">
* DO NOT attempt to transfer content marked as ‘payware’ or ‘built-in’ manually as it will not include the textures and will show as faulty.<br>
* This content is downloaded via in-game Asset Download window. <br>
</div>

It is also recommended that content marked as ‘installed from DLS’ be downloaded again, see section [[#Content from the Download Station|Content From Download Station]].

===Using Columns in Content Manager===
<span class="mw-customtoggle-myDivision-usingcolumns">'''+ Click to show/hide Using Columns in Content Manager'''</span>

<div class="mw-collapsible mw-collapsed" style="overflow:auto;" id="mw-customcollapsible-myDivision-usingcolumns">

:Using columns in Content Manager is very simple, and can make finding specific content much easier!

:To start with, you will need to ensure that Content Manager is not set to thumbnail mode, as this will turn off the columns. The option for this is found in the Trainz Settings.

:To add columns, simply right click on one of the column names and go to ‘insert column’, then click on the Column you wish to add’.

:To sort by a column, click on the column name. This will sort in ascending order, if you click again then it will sort in descending order.

:For transferring content, add the ‘status’ column, then click on this column to sort by status. Now locate all content marked as ‘locally modified’, as this will be mostly content you have created, or content you have edited or installed from 3rd party websites.
<span class="mw-customtoggle-myDivision-usingcolumns">'''+ Click to show/hide Using Columns in Content Manager'''</span>
</div>

==Transferring via CDP files (Easiest)==
One method you can use is to save your content to a cdp file, or cdp files, and then import this into TRS2019.
Note: '''cdp files should not be made larger than 500MB in size''', so as to ensure that the file does not become corrupted and can be imported successfully by Trainz.

This method is recommended for transferring smaller numbers of assets, or individual assets.

To save the cdp file, follow these steps:
# Open Trainz Content or Content Manager in your old installation of Trainz
# Locate and select the asset(s) you wish to transfer
# Right click and click on 'Export to CDP' (or 'Save as CDP')
# Choose a location you’ll remember to save them to, then give the cdp file a name and click on 'Save'

You can save multiple assets to the same cdp file. To do so, hold the CTRL key and left click on each asset, then follow steps 3 and 4 above.

To import the cdp files, follow these steps:

# Open TRS2019's Trainz Content (content manager) tool by clicking on 'Manage Content' on the Launcher
# Drag and drop the 'cdp' files into the Trainz Content window

The content will then be installed. You can import multiple cdp files at the same time.

==Transferring via 'Open for Edit' (Better for transferring a large amount of content)==
I. For importing large amounts of content, we recommend the following approach for importing content from your older installation of Trainz:

#Open Trainz Content or Content Manager (CM) in your previous installation of Trainz
#Locate an asset you wish to transfer
#Right click on the asset, then go to 'Open'
#*SHFT+LMB to select multiple assets.
#Click on 'Open for Editing'
#Repeat for all other assets you wish to transfer.
#*When you have opened for edit every asset you wish to transfer, right click on <i><b><u>one of the assets</u></b></i>, then go to 'open' and click on 'Show in Explorer' or 'Show in Finder'.
#*You should then see an Explorer/Finder window open showing the open asset. Go to the 'Address' bar at the top, and click on the folder called 'Editing'. This will show all of the open for edit assets.
#You may now exit this 'source' version of Trainz.
<br>
II. To import the content, follow these steps:
#Open TRS2019's Trainz Content (content manager) tool by clicking on 'Manage Content' on the launcher
#Select all of the folders within the 'Editing' folder in Explorer/Finder
#Drag and Drop these into the Trainz Content window
#*The content will then be imported into TRS2019.
#*If you plan on maintaining the original copy of Trainz, remember to go back and resolve any 'open for editing' (OFE) assets.
#*You may do this by custom filtering CM on 'OFE = true' and clicking "revert to original".
<br>
III. ''An alternative option'', once you have opened your assets for edit, is to find the location of your Local Data folder and then import directly from this using the ‘import content folder’ tool. This is done by following these steps:

#Open the launcher screen for your previous installation of Trainz
#Click on Trainz Settings
#Click on the ‘Install’ tab
#Your Local Data location will then be shown in the ‘Local Data’ path box. The last folder in the path will be named ‘build xxxxxxxxx’ (the Xs will be random letters and numbers)
#Open the launcher screen for TRS2019
#Click on Manage Content
#Click on ‘File’ at the top of the screen, then click on ‘import content folder’
#Go to the location that was shown in the install tab of your previous installation
#Click on the ‘Editing’ folder in the ‘build xxxxxxxxx’ folder
#Click on ‘Open’
#Your content will then be imported into TRS2019.

==Dependencies==
Dependencies are the assets that another asset relies on, such as all of the scenery objects used on a route, or the trains used in a session.

You can view an assets dependencies by right clicking on it, then click on ‘list dependencies’.

Alternatively, if you click on ‘list dependencies recursively’, this will display the dependencies of the selected assets dependencies. This is useful if the dependencies are likely to be ‘complex’ objects (ie trains, procedural tracks, complex scenery objects, etc). Use this option if you are not sure.

==Content from the Download Station==
It is recommended that content from the Download Station be downloaded again, rather than be transferred using the above methods. This ensures that you have the latest version of all assets from the Download Station, and will ensure that the assets remain compatible with Multiplayer.

==Further Information==

<div style="background-color: #ff9797;border-style: dotted; width:800px; overflow:auto; ">
* Do NOT attempt to transfer assets from previous versions over into TRS2019 by simply copying your LocalData folders or creating .cdps.
** The format of the LocalData folders may not be compatible with TRS2019.

* You must not set TRS19 to use the LocalData folder for Trainz: A New Era or any other version of Trainz.
** Doing so can cause Trainz to become unstable, or cease to function correctly, and may damage any content in the LocalData folder.

*Please note that the following items cannot be imported into TRS2019 directly:
** .ja files
** .tzarc files
</div>

* TRS2019 has been designed to be backwards compatible with the majority of content from previous versions of Trainz.
** ...so it is possible to import your content from TANE into TRS2019 and even from one build of TRS2019 into a new one.
* <b>Important</b> : TRS2019 requires the original textures to show correctly in-game,
** ...therefore built-in content and DLC content, which does not contain source files, cannot be imported directly (or it will become 'faulty').
* Built-in content from TS2010 and earlier (excluding routes that were new in TS2010) is available from the Download Station.
** We are in the process of preparing the TS12 and TS2010 routes for downloading.

Return to
*[[Help:TRS19|TRS19 Help Page]]
*[[Help:TRS2019_Trainz_Content|Trainz Content]]
*[[Help:Content_Manager|Content Manager]]

[[Category:TRS19]]
[[Category: Help]]

Help:TRS19 Driver UI

2019-12-30T17:32:05Z

Zikchil: /* Driver UI Underlay Toggle */

TRS19 introduces a new Driver UI (User Interface). Many of the functions will be familiar to Trainz users, although there are several new systems introduced.

==General Driver UI Buttons==
At the bottom right corner of the Driver UI are a set of buttons that will appear in your Driver sessions.

[[File:Driver-ui-general-buttons.JPG]]

===Driver UI Buttons Panel===
[[File:Driver-ui-control-buttons-toggle.JPG|Driver UI Buttons Panel]]
The Buttons Panel provides a selection of buttons for driving your train. Different buttons will be available to use depending on the train you are driving; these buttons are available in all UI modes.

See [[Help:TRS19_Driver_Buttons_Panel|Driver UI Buttons Panel]] for further information.

===Driver UI Mode===
[[File:Driver-ui-hud-mode-buttons.JPG|Driver UI Mode]]

The Driver UI Mode buttons allow you to select if you are driving with [[#Simple Controls|Simple Controls]] or [[#Realistic Controls|Realistic Controls]], and to access the [[#Command Bar|AI Command Bar]].

===Driver UI Underlay Toggle===
[[File:Driver-ui-interface-underlay-button.JPG|Driver UI Underlay Toggle]]
The Driver UI Underlay Toggle will turn a shaded underlay for the new Driver UI on or off. This may help provide some extra contrast to the UI in some situations.<br>
Note: This has been moved to Display Menu > Interface Underlay

== Track Profile==
The new Track Profile feature provides a brand new way to view the track ahead of you, showing you the grades ahead along with a variety of track features.

The features shown on the track profile can be customised by right-clicking on the track, and then selecting the features you would like to see.

You can also zoom in and out to show more, or less, of the track depending on the speed you're travelling at or the density of trackside objects ahead of you.

[[File:2018-06-12_174722.png]]

See the [[Help:TRS19_Driver_Track_Profile|Track Profile]] page for further information on using the Track Profile portion of the Driver UI.

==Simple Controls==
The Simple Controls HUD allows you to drive your train in Simple Controls mode (formerly DCC Mode).

[[File:2018-06-12_173733.png]]

<div style="background-color: #ddf5eb;border-style: dotted; width:800px; overflow:auto; ">
TIP: For more accurate control, left-click and drag your mouse cursor up a few cm away from the dial.
</div>

See the [[Help:TRS19_Driver_Controls_Dcc|Simple Controls]] page for further information.

==Realistic Controls==
The Realistic Controls HUD allows you to drive your train in Realistic Controls mode (formerly CAB Mode).

There are two different versions of the Realistic Controls HUD, one for Steam locomotives and the other for Diesel and Electric locomotives.

=== Realistic Steam Controls ===
The Steam Locomotive mode of the Realistic Controls HUD provides you with all of the important controls for steam locomotives, as well as a range of readouts for the locomotive's current state.

[[File:2018-06-12_173803.png]]

See the [[Help:TRS19_Driver_Controls_Steam|Steam Controls]] page for further information.

=== Realistic Diesel Controls ===
The Diesel Locomotive mode of the Realistic Controls HUD provides you with all of the important controls for diesel and electric locomotives, and includes a range of readouts for the locomotive's current state.

[[File:2018-06-12_174441.png]]

See the [[Help:TRS19_Driver_Controls_Diesel|Diesel and Electric Controls]] page for further information.

==Command Bar==
The Driver Command Bar mode of the Driver UI provides access to add, modify, or remove Driver Commands from Trainz.

[[File:2018-06-12_173901.png]]

See the [[Help:Driver_CommandBar|Driver Command Bar]] page for further information.

==Driver Menu Bar==
The Driver Menu Bar provides access to a range of options relating to the operation, and conditions, of the session.

See [[Help:MenuBar|Driver Menu Bar]] for further information on the Driver Menu Bar.

Some important menus are also outlined below.

===Driver System Menu===
:The Driver System Menu provides access to several options, such as the settings and save game options

[[File:2018-06-12_170221.png]]

:See the [[Help:Driver_Main_Menu|Driver System Menu]] menu page for further information.

===Driver Tools Menu===
:The Driver Tools Menu provides access to a selection of tools for Driver Mode, including Pause, Find Object, and more.

[[File:2018-06-12_171709.png]]

:See the [[Help:Driver_MenuTools|Driver Tools Menu]] page for further information

===Driver Window Menu===
:The Driver Window Menu provides access to the various interface elements that open up in a new window.

[[File:2018-08-27 101617.png]]

:See the [[Help:Driver_Window_Menu|Driver Window Menu]] page for further information

==Other Topics==
[[File:area-menus.png |link=Help:TRS2019 Menus]] [[File:area-driving.png |link=Help:TRS2019 Driver]] [[File:area-building.png |link=Help:TRS2019 Surveyor]] [[File:area-dlc.png|link=Help:TRS2019 Trainz Content]]

[[File:go_back.png |link=Help:TRS19]]
Go back to: [[Help:TRS19|TRS19 Help]]

[[Category:TRS19]]
[[Category: Help]]

Help:Importing Content

2019-10-03T13:52:36Z

Zikchil: /* Transferring via 'Open for Edit' (Better for transferring a large amount of content) */

TRS2019 has been designed to be backwards compatible with the majority of content from previous versions of Trainz so it is possible to import your content from TANE into TRS2019 (and even from one build of TRS2019 into a new one).

It is important to know that TRS2019 requires the original textures to show correctly in-game, and therefore built-in content and DLC content, which does not contain source files, cannot be imported directly (or it will become 'faulty'). All DLC packs are expected to become available for TRS2019 via the Asset Download tool after TRS2019 is fully released (may not be available during Early Access).

Built-in content from TS2010 and earlier (excluding routes that were new in TS2010) is available from the Download Station.

We are in the process of preparing the TS12 and TS2010 routes for downloading.

==Recommended Methods of Transferring Content==
There are several different methods that can be used to transfer content between different installations/versions of Trainz. Some are more suitable for smaller amounts of content, whilst others are suited to large amounts of content.

Use the Status column to avoid content marked as ‘payware’, ‘built-in’, or ‘installed from DLS’.

<div style="background-color: #ff9797;border-style: dotted; width:800px; overflow:auto; ">
DO NOT attempt to transfer content marked as ‘payware’ or ‘built-in’ manually as it will not include the textures and will show as faulty.<br>
This content is downloaded via in-game Asset Download window. <br>
</div>

It is also recommended that content marked as ‘installed from DLS’ be downloaded again, see section [[#Content from the Download Station|Content From Download Station]].

===Using Columns in Content Manager===
<span class="mw-customtoggle-myDivision-usingcolumns">'''+ Click to show/hide Using Columns in Content Manager'''</span>

<div class="mw-collapsible mw-collapsed" style="overflow:auto;" id="mw-customcollapsible-myDivision-usingcolumns">

:Using columns in Content Manager is very simple, and can make finding specific content much easier!

:To start with, you will need to ensure that Content Manager is not set to thumbnail mode, as this will turn off the columns. The option for this is found in the Trainz Settings.

:To add columns, simply right click on one of the column names and go to ‘insert column’, then click on the Column you wish to add’.

:To sort by a column, click on the column name. This will sort in ascending order, if you click again then it will sort in descending order.

:For transferring content, add the ‘status’ column, then click on this column to sort by status. Now locate all content marked as ‘locally modified’, as this will be mostly content you have created, or content you have edited or installed from 3rd party websites.
<span class="mw-customtoggle-myDivision-usingcolumns">'''+ Click to show/hide Using Columns in Content Manager'''</span>
</div>

==Transferring via CDP files (Easiest)==
One method you can use is to save your content to a cdp file, or cdp files, and then import this into TRS2019. Note: cdp files should not be made larger than 500MB in size, so as to ensure that the file does not become corrupted and can be imported successfully by Trainz.

This method is recommended for transferring smaller numbers of assets, or individual assets.

To save the cdp file, follow these steps:
# Open Trainz Content or Content Manager in your old installation of Trainz
# Locate and select the asset(s) you wish to transfer
# Right click and click on 'Export to CDP' (or 'Save as CDP')
# Choose a location you’ll remember to save them to, then give the cdp file a name and click on 'Save'

You can save multiple assets to the same cdp file. To do so, hold the CTRL key and left click on each asset, then follow steps 3 and 4 above.

To import the cdp files, follow these steps:

# Open TRS2019's Trainz Content (content manager) tool by clicking on 'Manage Content' on the Launcher
# Drag and drop the 'cdp' files into the Trainz Content window

The content will then be installed. You can import multiple cdp files at the same time.

==Transferring via 'Open for Edit' (Better for transferring a large amount of content)==
I. For importing large amounts of content, we recommend the following approach for importing content from your older installation of Trainz:

#Open Trainz Content or Content Manager (CM) in your previous installation of Trainz
#Locate an asset you wish to transfer
#Right click on the asset, then go to 'Open'
#*SHFT+LMB to select multiple assets.
#Click on 'Open for Editing'
#Repeat for all other assets you wish to transfer.
#*When you have opened for edit every asset you wish to transfer, right click on <i><b><u>one of the assets</u></b></i>, then go to 'open' and click on 'Show in Explorer' or 'Show in Finder'.
#*You should then see an Explorer/Finder window open showing the open asset. Go to the 'Address' bar at the top, and click on the folder called 'Editing'. This will show all of the open for edit assets.
#You may now exit this 'source' version of Trainz.
<br>
II. To import the content, follow these steps:
#Open TRS2019's Trainz Content (content manager) tool by clicking on 'Manage Content' on the launcher
#Select all of the folders within the 'Editing' folder in Explorer/Finder
#Drag and Drop these into the Trainz Content window
#*The content will then be imported into TRS2019.
#*If you plan on maintaining the original copy of Trainz, remember to go back and resolve any 'open for editing' (OFE) assets.
#*You may do this by custom filtering CM on 'OFE = true' and clicking "revert to original".
<br>
III. ''An alternative option'', once you have opened your assets for edit, is to find the location of your Local Data folder and then import directly from this using the ‘import content folder’ tool. This is done by following these steps:

#Open the launcher screen for your previous installation of Trainz
#Click on Trainz Settings
#Click on the ‘Install’ tab
#Your Local Data location will then be shown in the ‘Local Data’ path box. The last folder in the path will be named ‘build xxxxxxxxx’ (the Xs will be random letters and numbers)
#Open the launcher screen for TRS2019
#Click on Manage Content
#Click on ‘File’ at the top of the screen, then click on ‘import content folder’
#Go to the location that was shown in the install tab of your previous installation
#Click on the ‘Editing’ folder in the ‘build xxxxxxxxx’ folder
#Click on ‘Open’
#Your content will then be imported into TRS2019.

==Dependencies==
Dependencies are the assets that another asset relies on, such as all of the scenery objects used on a route, or the trains used in a session.

You can view an assets dependencies by right clicking on it, then click on ‘list dependencies’.

Alternatively, if you click on ‘list dependencies recursively’, this will display the dependencies of the selected assets dependencies. This is useful if the dependencies are likely to be ‘complex’ objects (ie trains, procedural tracks, complex scenery objects, etc). Use this option if you are not sure.

==Content from the Download Station==
It is recommended that content from the Download Station be downloaded again, rather than be transferred using the above methods. This ensures that you have the latest version of all assets from the Download Station, and will ensure that the assets remain compatible with Multiplayer.

==Further Information==

<div style="background-color: #ff9797;border-style: dotted; width:800px; overflow:auto; ">
Do NOT attempt to transfer assets from previous versions over into TRS2019 by simply copying your LocalData folders or creating .cdps. The format of the LocalData folders may not be compatible with TRS2019.

You must not set TRS19 to use the LocalData folder for Trainz: A New Era or any other version of Trainz. Doing so can cause Trainz to become unstable, or cease to function correctly, and may damage any content in the LocalData folder.

Please note that the following items cannot be imported into TRS2019 directly:

* .ja files
* .tzarc files
</div>

Return to
*[[Help:TRS19|TRS19 Help Page]]
*[[Help:TRS2019_Trainz_Content|Trainz Content]]
*[[Help:Content_Manager|Content Manager]]

[[Category:TRS19]]
[[Category: Help]]

Help:Importing Content

2019-10-01T18:30:34Z

Zikchil: /* Transferring via 'Open for Edit' (Better for transferring a large amount of content) */

TRS2019 has been designed to be backwards compatible with the majority of content from previous versions of Trainz so it is possible to import your content from TANE into TRS2019 (and even from one build of TRS2019 into a new one).

It is important to know that TRS2019 requires the original textures to show correctly in-game, and therefore built-in content and DLC content, which does not contain source files, cannot be imported directly (or it will become 'faulty'). All DLC packs are expected to become available for TRS2019 via the Asset Download tool after TRS2019 is fully released (may not be available during Early Access).

Built-in content from TS2010 and earlier (excluding routes that were new in TS2010) is available from the Download Station.

We are in the process of preparing the TS12 and TS2010 routes for downloading.

==Recommended Methods of Transferring Content==
There are several different methods that can be used to transfer content between different installations/versions of Trainz. Some are more suitable for smaller amounts of content, whilst others are suited to large amounts of content.

Use the Status column to avoid content marked as ‘payware’, ‘built-in’, or ‘installed from DLS’.

<div style="background-color: #ff9797;border-style: dotted; width:800px; overflow:auto; ">
DO NOT attempt to transfer content marked as ‘payware’ or ‘built-in’ manually as it will not include the textures and will show as faulty.<br>
This content is downloaded via in-game Asset Download window. <br>
</div>

It is also recommended that content marked as ‘installed from DLS’ be downloaded again, see section [[#Content from the Download Station|Content From Download Station]].

===Using Columns in Content Manager===
<span class="mw-customtoggle-myDivision-usingcolumns">'''+ Click to show/hide Using Columns in Content Manager'''</span>

<div class="mw-collapsible mw-collapsed" style="overflow:auto;" id="mw-customcollapsible-myDivision-usingcolumns">

:Using columns in Content Manager is very simple, and can make finding specific content much easier!

:To start with, you will need to ensure that Content Manager is not set to thumbnail mode, as this will turn off the columns. The option for this is found in the Trainz Settings.

:To add columns, simply right click on one of the column names and go to ‘insert column’, then click on the Column you wish to add’.

:To sort by a column, click on the column name. This will sort in ascending order, if you click again then it will sort in descending order.

:For transferring content, add the ‘status’ column, then click on this column to sort by status. Now locate all content marked as ‘locally modified’, as this will be mostly content you have created, or content you have edited or installed from 3rd party websites.
<span class="mw-customtoggle-myDivision-usingcolumns">'''+ Click to show/hide Using Columns in Content Manager'''</span>
</div>

==Transferring via CDP files (Easiest)==
One method you can use is to save your content to a cdp file, or cdp files, and then import this into TRS2019. Note: cdp files should not be made larger than 500MB in size, so as to ensure that the file does not become corrupted and can be imported successfully by Trainz.

This method is recommended for transferring smaller numbers of assets, or individual assets.

To save the cdp file, follow these steps:
# Open Trainz Content or Content Manager in your old installation of Trainz
# Locate and select the asset(s) you wish to transfer
# Right click and click on 'Export to CDP' (or 'Save as CDP')
# Choose a location you’ll remember to save them to, then give the cdp file a name and click on 'Save'

You can save multiple assets to the same cdp file. To do so, hold the CTRL key and left click on each asset, then follow steps 3 and 4 above.

To import the cdp files, follow these steps:

# Open TRS2019's Trainz Content (content manager) tool by clicking on 'Manage Content' on the Launcher
# Drag and drop the 'cdp' files into the Trainz Content window

The content will then be installed. You can import multiple cdp files at the same time.

==Transferring via 'Open for Edit' (Better for transferring a large amount of content)==
I. For importing large amounts of content, we recommend the following approach for importing content from your older installation of Trainz:

# Open Trainz Content or Content Manager in your previous installation of Trainz
# Locate an asset you wish to transfer
# Right click on the asset, then go to 'Open'
# Click on 'Open for Editing'
# Repeat for all other assets you wish to transfer.
*When you have opened for edit every asset you wish to transfer, right click on one of the assets, then go to 'open' and click on 'Show in Explorer' or 'Show in Finder'.
*You should then see an Explorer/Finder window open showing the open asset. Go to the 'Address' bar at the top, and click on the folder called 'Editing'. This will show all of the open for edit assets.
<br>
II. To import the content, follow these steps:
# Open TRS2019's Trainz Content (content manager) tool by clicking on 'Manage Content' on the launcher
# Select all of the folders within the 'Editing' folder in Explorer/Finder
# Drag and Drop these into the Trainz Content window
*The content will then be imported into TRS2019.
<br>
III. ''An alternative option'', once you have opened your assets for edit, is to find the location of your Local Data folder and then import directly from this using the ‘import content folder’ tool. This is done by following these steps:

# Open the launcher screen for your previous installation of Trainz
# Click on Trainz Settings
# Click on the ‘Install’ tab
# Your Local Data location will then be shown in the ‘Local Data’ path box. The last folder in the path will be named ‘build xxxxxxxxx’ (the Xs will be random letters and numbers)
# Open the launcher screen for TRS2019
# Click on Manage Content
# Click on ‘File’ at the top of the screen, then click on ‘import content folder’
# Go to the location that was shown in the install tab of your previous installation
# Click on the ‘Editing’ folder in the ‘build xxxxxxxxx’ folder
# Click on ‘Open’
# Your content will then be imported into TRS2019.

==Dependencies==
Dependencies are the assets that another asset relies on, such as all of the scenery objects used on a route, or the trains used in a session.

You can view an assets dependencies by right clicking on it, then click on ‘list dependencies’.

Alternatively, if you click on ‘list dependencies recursively’, this will display the dependencies of the selected assets dependencies. This is useful if the dependencies are likely to be ‘complex’ objects (ie trains, procedural tracks, complex scenery objects, etc). Use this option if you are not sure.

==Content from the Download Station==
It is recommended that content from the Download Station be downloaded again, rather than be transferred using the above methods. This ensures that you have the latest version of all assets from the Download Station, and will ensure that the assets remain compatible with Multiplayer.

==Further Information==

<div style="background-color: #ff9797;border-style: dotted; width:800px; overflow:auto; ">
Do NOT attempt to transfer assets from previous versions over into TRS2019 by simply copying your LocalData folders or creating .cdps. The format of the LocalData folders may not be compatible with TRS2019.

You must not set TRS19 to use the LocalData folder for Trainz: A New Era or any other version of Trainz. Doing so can cause Trainz to become unstable, or cease to function correctly, and may damage any content in the LocalData folder.

Please note that the following items cannot be imported into TRS2019 directly:

* .ja files
* .tzarc files
</div>

Return to
*[[Help:TRS19|TRS19 Help Page]]
*[[Help:TRS2019_Trainz_Content|Trainz Content]]
*[[Help:Content_Manager|Content Manager]]

[[Category:TRS19]]
[[Category: Help]]

Help:Importing Content

2019-10-01T18:30:03Z

Zikchil: /* Transferring via 'Open for Edit' (Better for transferring a large amount of content) */

TRS2019 has been designed to be backwards compatible with the majority of content from previous versions of Trainz so it is possible to import your content from TANE into TRS2019 (and even from one build of TRS2019 into a new one).

It is important to know that TRS2019 requires the original textures to show correctly in-game, and therefore built-in content and DLC content, which does not contain source files, cannot be imported directly (or it will become 'faulty'). All DLC packs are expected to become available for TRS2019 via the Asset Download tool after TRS2019 is fully released (may not be available during Early Access).

Built-in content from TS2010 and earlier (excluding routes that were new in TS2010) is available from the Download Station.

We are in the process of preparing the TS12 and TS2010 routes for downloading.

==Recommended Methods of Transferring Content==
There are several different methods that can be used to transfer content between different installations/versions of Trainz. Some are more suitable for smaller amounts of content, whilst others are suited to large amounts of content.

Use the Status column to avoid content marked as ‘payware’, ‘built-in’, or ‘installed from DLS’.

<div style="background-color: #ff9797;border-style: dotted; width:800px; overflow:auto; ">
DO NOT attempt to transfer content marked as ‘payware’ or ‘built-in’ manually as it will not include the textures and will show as faulty.<br>
This content is downloaded via in-game Asset Download window. <br>
</div>

It is also recommended that content marked as ‘installed from DLS’ be downloaded again, see section [[#Content from the Download Station|Content From Download Station]].

===Using Columns in Content Manager===
<span class="mw-customtoggle-myDivision-usingcolumns">'''+ Click to show/hide Using Columns in Content Manager'''</span>

<div class="mw-collapsible mw-collapsed" style="overflow:auto;" id="mw-customcollapsible-myDivision-usingcolumns">

:Using columns in Content Manager is very simple, and can make finding specific content much easier!

:To start with, you will need to ensure that Content Manager is not set to thumbnail mode, as this will turn off the columns. The option for this is found in the Trainz Settings.

:To add columns, simply right click on one of the column names and go to ‘insert column’, then click on the Column you wish to add’.

:To sort by a column, click on the column name. This will sort in ascending order, if you click again then it will sort in descending order.

:For transferring content, add the ‘status’ column, then click on this column to sort by status. Now locate all content marked as ‘locally modified’, as this will be mostly content you have created, or content you have edited or installed from 3rd party websites.
<span class="mw-customtoggle-myDivision-usingcolumns">'''+ Click to show/hide Using Columns in Content Manager'''</span>
</div>

==Transferring via CDP files (Easiest)==
One method you can use is to save your content to a cdp file, or cdp files, and then import this into TRS2019. Note: cdp files should not be made larger than 500MB in size, so as to ensure that the file does not become corrupted and can be imported successfully by Trainz.

This method is recommended for transferring smaller numbers of assets, or individual assets.

To save the cdp file, follow these steps:
# Open Trainz Content or Content Manager in your old installation of Trainz
# Locate and select the asset(s) you wish to transfer
# Right click and click on 'Export to CDP' (or 'Save as CDP')
# Choose a location you’ll remember to save them to, then give the cdp file a name and click on 'Save'

You can save multiple assets to the same cdp file. To do so, hold the CTRL key and left click on each asset, then follow steps 3 and 4 above.

To import the cdp files, follow these steps:

# Open TRS2019's Trainz Content (content manager) tool by clicking on 'Manage Content' on the Launcher
# Drag and drop the 'cdp' files into the Trainz Content window

The content will then be installed. You can import multiple cdp files at the same time.

==Transferring via 'Open for Edit' (Better for transferring a large amount of content)==
I. For importing large amounts of content, we recommend the following approach for importing content from your older installation of Trainz:

# Open Trainz Content or Content Manager in your previous installation of Trainz
# Locate an asset you wish to transfer
# Right click on the asset, then go to 'Open'
# Click on 'Open for Editing'
# Repeat for all other assets you wish to transfer.
*When you have opened for edit every asset you wish to transfer, right click on one of the assets, then go to 'open' and click on 'Show in Explorer' or 'Show in Finder'.
*You should then see an Explorer/Finder window open showing the open asset. Go to the 'Address' bar at the top, and click on the folder called 'Editing'. This will show all of the open for edit assets.
<br>
II. To import the content, follow these steps:
# Open TRS2019's Trainz Content (content manager) tool by clicking on 'Manage Content' on the launcher
# Select all of the folders within the 'Editing' folder in Explorer/Finder
# Drag and Drop these into the Trainz Content window
*The content will then be imported into TRS2019.
<br>
III. ''An alternative option'', once you have opened your assets for edit, is to find the location of your Local Data folder and then import directly from this using the ‘import content folder’ tool. This is done by following these steps:

# Open the launcher screen for your previous installation of Trainz
# Click on Trainz Settings
# Click on the ‘Install’ tab
# Your Local Data location will then be shown in the ‘Local Data’ path box. The last folder in the path will be named ‘build xxxxxxxxx’ (the Xs will be random letters and numbers)
# Open the launcher screen for TRS2019
# Click on Manage Content
# Click on ‘File’ at the top of the screen, then click on ‘import content folder’
# Go to the location that was shown in the install tab of your previous installation
# Click on the ‘Editing’ folder in the ‘build xxxxxxxxx’ folder
# click on ‘Open’
# Your content will then be imported into TRS2019.

==Dependencies==
Dependencies are the assets that another asset relies on, such as all of the scenery objects used on a route, or the trains used in a session.

You can view an assets dependencies by right clicking on it, then click on ‘list dependencies’.

Alternatively, if you click on ‘list dependencies recursively’, this will display the dependencies of the selected assets dependencies. This is useful if the dependencies are likely to be ‘complex’ objects (ie trains, procedural tracks, complex scenery objects, etc). Use this option if you are not sure.

==Content from the Download Station==
It is recommended that content from the Download Station be downloaded again, rather than be transferred using the above methods. This ensures that you have the latest version of all assets from the Download Station, and will ensure that the assets remain compatible with Multiplayer.

==Further Information==

<div style="background-color: #ff9797;border-style: dotted; width:800px; overflow:auto; ">
Do NOT attempt to transfer assets from previous versions over into TRS2019 by simply copying your LocalData folders or creating .cdps. The format of the LocalData folders may not be compatible with TRS2019.

You must not set TRS19 to use the LocalData folder for Trainz: A New Era or any other version of Trainz. Doing so can cause Trainz to become unstable, or cease to function correctly, and may damage any content in the LocalData folder.

Please note that the following items cannot be imported into TRS2019 directly:

* .ja files
* .tzarc files
</div>

Return to
*[[Help:TRS19|TRS19 Help Page]]
*[[Help:TRS2019_Trainz_Content|Trainz Content]]
*[[Help:Content_Manager|Content Manager]]

[[Category:TRS19]]
[[Category: Help]]

HowTo/Place Signals

2019-08-25T16:36:29Z

Zikchil:

Australian & UK signals appear on the left of the track, USA signals appear on the right. European signals vary depending on the track.

*Careful placement of signals will allow you to operate complex operations involving several moving consists without incident.
*It is important to consider that the signals are there to protect the trains from each other, and any situation where their paths may cross should be protected by a signal.

*Extended sections of single line should be relieved by sections of double track or “crossing loops” that enable trains to either pass or cross each other.
*At the entrance to a section of single line there can be two signals protecting the same block, i.e. one on each track to enable faster trains to pass slower ones.

*Keep in mind that once your train passes a signal, any following train will not be permitted to pass until your train reaches the next signal,
**...if traffic is going to be heavy, don’t place them too far apart.
*It is recommended that you place at least one signal between each junction, and more on longer sections.
*To protect AI trains from over running terminating track, a rail end marker or buffer must be used.

Note: At the time of writing, TANE signals are not capable of detecting a train crossing a block via a diamond crossing. If you wish to operate a fully automated system, diamond crossings should not be used in the path of AI trains.

==Return to Index==

[[HowToGuides|<< How To Guides]]

[[Category:How-to guides]]

How to Create a Picklist

2019-08-21T15:52:39Z

Zikchil: /* Using Surveyor */

The information in this Wiki Page applies to both '''TANE''' and '''TRS19''' and will show you how to create a '''Picklist''' in '''TRS19''' or '''TANE''' (both programs use identical methods).
* For instructions on how to '''backup''' a Picklist, see the wiki page '''[[How to Backup a Picklist]]'''
* For instructions on how to '''move''' a Picklist, see the wiki page '''[[How to Move a Picklist]]'''<br>

Both programs provide you with two different methods of creating '''Picklists''', using either '''Content Manager''' (or '''Manage Content''' from the TANE/TRS19 Launcher) or in '''Surveyor'''.<br>

='''Using Content Manager (CM)'''=

<table cellpadding="4" bgcolor=#ffffff>
<tr valign="top">
<td>[[file:Steps.PNG]]</td>
<td><font size="3">'''Step 1: Select the assets'''</font><br>
<table cellpadding="4" bgcolor=#ffffb0>
<tr valign="top">
<td>[[file:NotePad.PNG]]</td>
<td><font size="3">'''Notes:'''</font><br>
Only assets that are '''installed on your system''' can be added to a Picklist. They can be built-in, base, payware or installed from the DLS.</td>
</tr>
</table>
<table>
<tr valign="top">
<td><br>From the '''TRS19''' or '''TANE''' Launcher
#select '''Manage Content'''
#(optional step) in '''Content Manager''' select a filter or create a custom filter to show the assets you want in the Picklist
#use the left mouse button and either the '''Ctrl''' or '''Shift''' key to click on each asset that is to be added to the Picklist<br>
[[file:PickList_CM01.png]]</td>
</tr>
</table></td>
</tr>
</table>
<br>
<table cellpadding="4" bgcolor=#ffffff>
<tr valign="top">
<td>[[file:Steps.PNG]]</td>
<td><font size="3">'''Step 2: Add the assets to the Picklist'''</font><br>
<table>
<tr valign="top">
<td>
#right mouse click on ''any one'' of the highlighted assets
#select '''Add to Picklist''' from the popup menu
#select either:-
:#an existing Picklist (if any) to add the assets to that Picklist, or
:#'''New Picklist''' to create a new list<br>
[[file:PickList_CM02.png]]</td>
</tr>
</table></td>
</tr>
</table>
<br>
<table cellpadding="4" bgcolor=#ffffff>
<tr valign="top">
<td>[[file:Steps.PNG]]</td>
<td><font size="3">'''Step 3: Enter Picklist Name (for New Picklist option only)</font>
<table>
<tr valign="top">
<td>
*type a name for the new Picklist and click '''OK'''<br>
[[file:PickList_CM03.png]]</td>
</tr><br>
</table></td>
</tr>
</table>
<br>

='''Using Surveyor'''=

In '''Surveyor''' in either '''TRS19''' or '''TANE'''.

<table cellpadding="4" bgcolor=#ffffff>
<tr valign="top">
<td>[[file:Steps.PNG]]</td>
<td><font size="3">'''Step 1: Open the Picklist Window'''</font><br>
<table>
<tr valign="top">
<td><br>From the TRS19/TANE Surveyor...
*press '''Ctrl-Shift-F''' to open the full Search Filter tool (Note: pressing '''Ctrl-F''' will only open the find named asset filter tool)
<table>
<tr valign="top">
<td>[[file:PickList_Surveyor01.png]]</td>
<td>If you already have one or more Picklists then the current Picklist will be shown. An empty Picklist window indicates that no Picklist has been created.
*to switch to a different Picklist or to create a new one, click on the '''down arrow''' icon shown in the image.<br><br>
<table>
<tr valign="top">
<td>[[file:PickList_Surveyor03.png]]</td>
<td>then click either ...
*'''Change pick list >''' to select a different Picklist, or
*'''Create pick list''' to create a new one</td>
</tr>
</table><br>
If you have selected '''Create pick list''' then you will have to enter a name for the list then click the '''OK''' (tick) button.<br>
[[file:PickList_Surveyor04.png]]</td>
</tr>
</table></td>
</tr>
</table></td>
</tr>
</table>
<br>
<table cellpadding="4" bgcolor=#ffffff>
<tr valign="top">
<td>[[file:Steps.PNG]]</td>
<td><font size="3">'''Step 2: Add the assets to the Picklist'''</font><br>
<table>
<tr valign="top">
<td>
#Open the tool selection window for the types of assets to be added. For example: the Object Tool Window ('''F3''' key)
#Scroll down the selection window to an asset that is to be added to the Picklist
#'''Drag & Drop''' the asset from the selection window to the Picklist window
#*You may also toggle the "get" button state from "get object" to "get picklist" via RMB.
#*This lets you click-select items already on the map, and place them in a picklist.
#Repeat as required<br>
<table>
<tr valign="top">
<td>[[file:PickList_Surveyor02.png]]</td>
<td>
<table cellpadding="4" bgcolor=#c1e7e7>
<tr valign="top">
<td>[[file:DotPoint.JPG]]</td>
<td>'''Each asset is automatically added and saved to the Picklist when it is "dropped" into the Picklist window'''</td>
</tr>
<tr valign="top">
<td>[[file:DotPoint.JPG]]</td>
<td>'''If you drag & drop an asset into the Picklist window and it does not appear, then it usually means that the asset is already present in the list'''</td>
</tr>
<tr valign="top">
<td>[[file:DotPoint.JPG]]</td>
<td>'''To remove an asset from the Picklist simply drag it out of the Picklist window onto the Surveyor screen'''</td>
</tr>
</table><br>
Press the '''<u>ESC</u>'''ape key to close the Search Filter/Picklist Tool</td>
</tr>
</table></td>
</tr>
</table>
----
----
<br>

='''Trainz Wiki'''=
<table cellpadding="4" bgcolor=#ffffff>
<tr valign="top">
<td>[[file:TrainzWiki.png]]</td>
<td>
<font size="3">'''More Tutorials and Guides to Using Trainz'''</font><br>
*'''<span class="plainlinks">[http://online.ts2009.com/mediaWiki/index.php/HowTo How to Guides]</span>'''
*'''[[Driver Commands List]]'''
*'''[[Session Rule List with Parameters|Session Rules List (Alphabetical) with Parameters]]'''
*'''[[Session Rules By Categories With Properties|Session Rules List (Categories) With Parameters]]'''
</td>
</tr>
</table>

[[Category:How-to guides]]

Help:Moving Content

2019-08-19T21:41:30Z

Zikchil: /* Creating a New Local Data Folder */

Trainz stores additional content and user settings separately from the Trainz installation folder. A platform-specific default path is used, which can be accessed in your platform-specific file manager as described below. This folder may grow to a substantial size over time. If required, you may specify an alternate location for storing your content.

These instructions apply to TANE build 82340 and above. The same steps can be used for TRS2019, just replace 'TANE' with 'TRS2019' for folder names!

=Locating your Local Data Folder=

From the launcher of any Trainz installation, you can click the "Trainz Settings" button and then switch to the "Install" tab to see the full path to that installation's local data folder. You can navigate directly to that path using your system's file manager, however please keep in mind that the parent folders of the default location may be hidden on some systems so simply starting at the top level of your computer and working your way down may not work.

In order to navigate directly to the local data folder's default location, the following steps can be used:

==Windows==
In Windows, the local data folder is stored by default at a subfolder of "C:\Users\<username>\AppData\Local\N3V Games\TANE" (where "<username>" is the username of the logged-in Windows user account.)

You may access this location in Windows Explorer by entering the path "%appdata%\..\Local\N3V Games\TANE" into the Window Explorer address bar. At this location you will see one or more local data folders, corresponding with your various Trainz installations. The name of each folder here includes a random character string which has no meaning but simply allows for multiple installs to coexist without overwriting each other's data files.

You will also find a text file at this location named "userdata-redirect-map.txt" which lists the correlation between each Trainz installation and its local data folder. While it is possible to hand-edit this file using a program such as WordPad.exe, it is not recommended due to the potential for data loss.

==Mac OS X==
In Mac OS X, the local data folder is stored by default at a subfolder of "/Users/<username>/Library/Containers/com.n3vgames.tane" (where "<username>" is the username of the logged-in Mac OS X user account.)

You may access this location in Finder by using "Go To" (command-shift-G) and then entering the address "~/Library/Containers/com.n3vgames.tane/Data". At this location you will see one or more local data folders, corresponding with your various Trainz installations. The name of each folder here includes a random character string which has no meaning but simply allows for multiple installs to coexist without overwriting each other's data files.

You will also find a file at this location named "userdata-redirect-map.txt" which lists the correlation between each Trainz installation and its local data folder. It is typically not possible to hand-edit this file due to the way that Mac OS X encodes file paths.

=Copy\Move\Archive your Local Data Folder=

# Open "Launcher > Trainz Settings > Install tab".
#:* Note the path displayed in the "Local Data Folder" field (this is your current data directory where your user content resides).
#:* <i>Recommended...</i>
#::* Highlight and Copy this path to Notepad.
#::* Verify all other tabs contain the settings you want, including your authentication credentials.<br>
# Open Windows Explorer and navigate to the current data folder (you may paste the path from step 1 to open directly).
# Open a second instance of Windows Explorer and create a new empty folder at the desired location (e.g. D:\TANE_Content)
#:* Highlight and Copy this new path to your clipboard
#:* Paste this new path into the "Local Data Folder" field
# Close the Settings dialog
#:* ...there will be a prompt telling you about restarting, acknowledge it.
#:* ...close the Launcher
# Focus on the first instance of Windows Explorer, copy all files\folders here into the new folder (the 2nd instance of Explorer).
#:* i.e. folders like backup, cache, etc plus assets.tdx and keystore.tdx.
# Start the launcher
#:* If you're watching the new directory in Explorer you'll see some changes occur (files added).
# '''OPTIONAL''' - Access "Trainz Settings".
#:* All settings verified in step 1 should be present on all tabs.
# Click "Start Trainz"
# Application will launch as expected.
#:* If content is missing, or if a database repair commences, or you're prompted to login, you have made a mistake and will need to re-check the settings above.
<br>
'''Benefits of this process...'''
* Provides a method for you to create data directories using naming conventions easily tracked by humans (as opposed to the machine name Trainz generates for its folders)
* Allows you to move content between builds and patches without resorting to CDP export\import.
* Allows you to work independently from your "source content" making changes without risk and...,
* Point back to your old folder anytime you need a reference or to check "how it worked" before you started modifying content.
* Creates a backup of the "old" content folder and optionally archive\delete the old folder to free up space.

'''WARNING:'''
* DO NOT ever delete the C:\Users\<pc name>\AppData\Local\N3V Games\TANE folder OR the userdata-redirect-map.txt file in that folder.
:* This file is required by TANE to ensure the Local Data Folder is found.
:* If the redirect file does not exist, TANE will create a new one and create a new local data folder in the default location and you are back to your starting point.
<br>
'''TROUBLESHOOTING:'''
* If a new unused /build xxxxxxxx folder is created in the default location upon restarting, you have not followed the steps correctly - please review the steps again.
* If you are asked to enter your username again, you have not followed the steps correctly - please review the steps again.

=Creating a New Local Data Folder=

Sometimes your Local Data Folder can end up with corrupt data. In this case, the solution is to create a new folder which contains no 3rd party content. From there, you can then IMPORT your old content and work out which items may be causing issues.

# Open the Launcher > Trainz Settings > Install (tab).
#:*...see the "Local Data Folder" field, this is the path for your game data.
#:*...the default path is C:\Users\<username>\AppData\Local\N3V Games\<version>\build folder
#::*The default build folder uses an alphanumeric system generated name. The next steps are important to make sure you are looking at the correct folder if you have more than one
#Highlight the full path and use Ctrl-C to copy it.
#Open Windows Explorer and paste the path into the Explorer address dropdown (usually opens to "this PC")
#:*Key-press <Enter>.
#:*You are now in your games current data directory.
#Navigate up one directory level (you can use the little "up arrow" on the left of of the address dropdown)
#Create a new folder and give it a name
#Now double-click into this new folder (it will be empty), and copy the path just like you did in the above step #2.
#Now go back to Launcher > Trainz Settings > Install tab, paste the new path, replacing the current path, in the "Local Data Folder" field
#Close the Trainz Settings form (a message will appear saying the game needs a restart, click OK, then close the Launcher too)
#Restart the game. A few things will happen
#:*...(if TRS19), you'll see the "Trainz Performance Configuration" dialog. you can select an option or click "Skip..." on the lower right.
#:*...in Explorer you'll see the folder get populated with some new sub-folders and files.
#:*...you'll need to provide your user name\password in Trainz Settings > Internet (tab)
#Click Start Trainz and complete the database build. Now your game is pointing to a "clean data directory".

NOTES:
*This process does not copy any of your local content across, this mirrors a first time installation with built-in content only. You may hear this referred to as "baseline".
*This is applicable to TANE & TRS19 (minus the performance config), and may be used to easily swap between testing & working folders.

Return to [[Help:TRS19|TRS19 Help Page]]<br>
Additional Info: [[Help:Importing Content|Importing Content]]

[[Category:TRS19]]
[[Category: Help]]

Help:Moving Content

2019-08-02T15:56:01Z

Zikchil: /* Creating a New Local Data Folder */

Trainz stores additional content and user settings separately from the Trainz installation folder. A platform-specific default path is used, which can be accessed in your platform-specific file manager as described below. This folder may grow to a substantial size over time. If required, you may specify an alternate location for storing your content.

These instructions apply to TANE build 82340 and above. The same steps can be used for TRS2019, just replace 'TANE' with 'TRS2019' for folder names!

=Locating your Local Data Folder=

From the launcher of any Trainz installation, you can click the "Trainz Settings" button and then switch to the "Install" tab to see the full path to that installation's local data folder. You can navigate directly to that path using your system's file manager, however please keep in mind that the parent folders of the default location may be hidden on some systems so simply starting at the top level of your computer and working your way down may not work.

In order to navigate directly to the local data folder's default location, the following steps can be used:

==Windows==
In Windows, the local data folder is stored by default at a subfolder of "C:\Users\<username>\AppData\Local\N3V Games\TANE" (where "<username>" is the username of the logged-in Windows user account.)

You may access this location in Windows Explorer by entering the path "%appdata%\..\Local\N3V Games\TANE" into the Window Explorer address bar. At this location you will see one or more local data folders, corresponding with your various Trainz installations. The name of each folder here includes a random character string which has no meaning but simply allows for multiple installs to coexist without overwriting each other's data files.

You will also find a text file at this location named "userdata-redirect-map.txt" which lists the correlation between each Trainz installation and its local data folder. While it is possible to hand-edit this file using a program such as WordPad.exe, it is not recommended due to the potential for data loss.

==Mac OS X==
In Mac OS X, the local data folder is stored by default at a subfolder of "/Users/<username>/Library/Containers/com.n3vgames.tane" (where "<username>" is the username of the logged-in Mac OS X user account.)

You may access this location in Finder by using "Go To" (command-shift-G) and then entering the address "~/Library/Containers/com.n3vgames.tane/Data". At this location you will see one or more local data folders, corresponding with your various Trainz installations. The name of each folder here includes a random character string which has no meaning but simply allows for multiple installs to coexist without overwriting each other's data files.

You will also find a file at this location named "userdata-redirect-map.txt" which lists the correlation between each Trainz installation and its local data folder. It is typically not possible to hand-edit this file due to the way that Mac OS X encodes file paths.

=Copy\Move\Archive your Local Data Folder=

# Open "Launcher > Trainz Settings > Install tab".
#:* Note the path displayed in the "Local Data Folder" field (this is your current data directory where your user content resides).
#:* <i>Recommended...</i>
#::* Highlight and Copy this path to Notepad.
#::* Verify all other tabs contain the settings you want, including your authentication credentials.<br>
# Open Windows Explorer and navigate to the current data folder (you may paste the path from step 1 to open directly).
# Open a second instance of Windows Explorer and create a new empty folder at the desired location (e.g. D:\TANE_Content)
#:* Highlight and Copy this new path to your clipboard
#:* Paste this new path into the "Local Data Folder" field
# Close the Settings dialog
#:* ...there will be a prompt telling you about restarting, acknowledge it.
#:* ...close the Launcher
# Focus on the first instance of Windows Explorer, copy all files\folders here into the new folder (the 2nd instance of Explorer).
#:* i.e. folders like backup, cache, etc plus assets.tdx and keystore.tdx.
# Start the launcher
#:* If you're watching the new directory in Explorer you'll see some changes occur (files added).
# '''OPTIONAL''' - Access "Trainz Settings".
#:* All settings verified in step 1 should be present on all tabs.
# Click "Start Trainz"
# Application will launch as expected.
#:* If content is missing, or if a database repair commences, or you're prompted to login, you have made a mistake and will need to re-check the settings above.
<br>
'''Benefits of this process...'''
* Provides a method for you to create data directories using naming conventions easily tracked by humans (as opposed to the machine name Trainz generates for its folders)
* Allows you to move content between builds and patches without resorting to CDP export\import.
* Allows you to work independently from your "source content" making changes without risk and...,
* Point back to your old folder anytime you need a reference or to check "how it worked" before you started modifying content.
* Creates a backup of the "old" content folder and optionally archive\delete the old folder to free up space.

'''WARNING:'''
* DO NOT ever delete the C:\Users\<pc name>\AppData\Local\N3V Games\TANE folder OR the userdata-redirect-map.txt file in that folder.
:* This file is required by TANE to ensure the Local Data Folder is found.
:* If the redirect file does not exist, TANE will create a new one and create a new local data folder in the default location and you are back to your starting point.
<br>
'''TROUBLESHOOTING:'''
* If a new unused /build xxxxxxxx folder is created in the default location upon restarting, you have not followed the steps correctly - please review the steps again.
* If you are asked to enter your username again, you have not followed the steps correctly - please review the steps again.

=Creating a New Local Data Folder=

Sometimes your Local Data Folder can end up with corrupt data. In this case, the solution is to create a new folder which contains no 3rd party content. From there, you can then IMPORT your old content and work out which items may be causing issues.

# Open the Launcher > Trainz Settings > Install (tab).
#:*...see the "Local Data Folder" field, this is the path for your game data.
#:*...the default path is C:\Users\<username>\AppData\Local\N3V Games\<version>\build folder
#::*The default build folder uses an alphanumeric system generated name. The next steps are important to make sure you are looking at the correct folder if you have more than one
# Highlight the full path and use Ctrl-C to copy it.
# Open Windows Explorer and paste the path into the Explorer address dropdown (usually opens to "this PC")
#:* Key-press <Enter>.
#:* You are now in your games current data directory.
# Navigate up one directory level (you can use the little "up arrow" on the left of of the address dropdown)
# Create a new folder and give it a name
# Now double-click into this new folder (it will be empty), and copy the path just like you did in the above step #2.
# Now go back to Launcher > Trainz Settings > Install tab, paste the new path, replacing the current path, in the "Local Data Folder" field
# Close the Trainz Settings form (a message will appear saying the game needs a restart, click OK, then close the Launcher too)
# Restart the game. A few things will happen
#:*...in Explorer you'll see the folder get populated with some new sub-folders and files.
#:*...the "Trainz Performance Configuration" form will open (you can set these parameter here\now or skip is and do it later on the Performance tab)
#:*...you'll need to provide your user name\password in Trainz Settings > Internet (tab)
# Click Start Trainz and complete the database build

* Now your application is pointing to a "clean data directory".

NOTE:
* This process does not copy any of your local content across.
* This process is applicable to both TANE and TRS19

Return to [[Help:TRS19|TRS19 Help Page]]
[[Category:TRS19]]
[[Category: Help]]

Additional Info: [[Help:Importing Content|Importing Content]]

Help:Importing Content

2019-07-17T00:03:45Z

Zikchil: /* Recommended Methods of Transferring Content */

TRS2019 has been designed to be backwards compatible with the majority of content from previous versions of Trainz so it is possible to import your content from TANE into TRS2019 (and even from one build of TRS2019 into a new one).

It is important to know that TRS2019 requires the original textures to show correctly in-game, and therefore built-in content and DLC content, which does not contain source files, cannot be imported directly (or it will become 'faulty'). All DLC packs are expected to become available for TRS2019 via the Asset Download tool after TRS2019 is fully released (may not be available during Early Access).

Built-in content from TS2010 and earlier (excluding routes that were new in TS2010) is available from the Download Station.

We are in the process of preparing the TS12 and TS2010 routes for downloading.

==Recommended Methods of Transferring Content==
There are several different methods that can be used to transfer content between different installations/versions of Trainz. Some are more suitable for smaller amounts of content, whilst others are suited to large amounts of content.

Use the Status column to avoid content marked as ‘payware’, ‘built-in’, or ‘installed from DLS’.

<div style="background-color: #ff9797;border-style: dotted; width:800px; overflow:auto; ">
DO NOT attempt to transfer content marked as ‘payware’ or ‘built-in’ manually as it will not include the textures and will show as faulty.<br>
This content is downloaded via in-game Asset Download window. <br>
</div>

It is also recommended that content marked as ‘installed from DLS’ be downloaded again, see section [[#Content from the Download Station|Content From Download Station]].

===Using Columns in Content Manager===
<span class="mw-customtoggle-myDivision-usingcolumns">'''+ Click to show/hide Using Columns in Content Manager'''</span>

<div class="mw-collapsible mw-collapsed" style="overflow:auto;" id="mw-customcollapsible-myDivision-usingcolumns">

:Using columns in Content Manager is very simple, and can make finding specific content much easier!

:To start with, you will need to ensure that Content Manager is not set to thumbnail mode, as this will turn off the columns. The option for this is found in the Trainz Settings.

:To add columns, simply right click on one of the column names and go to ‘insert column’, then click on the Column you wish to add’.

:To sort by a column, click on the column name. This will sort in ascending order, if you click again then it will sort in descending order.

:For transferring content, add the ‘status’ column, then click on this column to sort by status. Now locate all content marked as ‘locally modified’, as this will be mostly content you have created, or content you have edited or installed from 3rd party websites.
<span class="mw-customtoggle-myDivision-usingcolumns">'''+ Click to show/hide Using Columns in Content Manager'''</span>
</div>

==Transferring via CDP files (Easiest)==
One method you can use is to save your content to a cdp file, or cdp files, and then import this into TRS2019. Note: cdp files should not be made larger than 500MB in size, so as to ensure that the file does not become corrupted and can be imported successfully by Trainz.

This method is recommended for transferring smaller numbers of assets, or individual assets.

To save the cdp file, follow these steps:
# Open Trainz Content or Content Manager in your old installation of Trainz
# Locate and select the asset(s) you wish to transfer
# Right click and click on 'Export to CDP' (or 'Save as CDP')
# Choose a location you’ll remember to save them to, then give the cdp file a name and click on 'Save'

You can save multiple assets to the same cdp file. To do so, hold the CTRL key and left click on each asset, then follow steps 3 and 4 above.

To import the cdp files, follow these steps:

# Open TRS2019's Trainz Content (content manager) tool by clicking on 'Manage Content' on the Launcher
# Drag and drop the 'cdp' files into the Trainz Content window

The content will then be installed. You can import multiple cdp files at the same time.

==Transferring via 'Open for Edit' (Better for transferring a large amount of content)==
For importing large amounts of content, we recommend the following approach for importing content from your older installation of Trainz:

# Open Trainz Content or Content Manager in your previous installation of Trainz
# Locate an asset you wish to transfer
# Right click on the asset, then go to 'Open'
# Click on 'Open for Editing'
# Repeat for all other assets you wish to transfer.

When you have opened for edit every asset you wish to transfer, right click on one of the assets, then go to 'open' and click on 'Show in Explorer' or 'Show in Finder'.

You should then see an Explorer/Finder window open showing the open asset. Go to the 'Address' bar at the top, and click on the folder called 'Editing'. This will show all of the open for edit assets.

To import the content, follow these steps:
# Open TRS2019's Trainz Content (content manager) tool by clicking on 'Manage Content' on the launcher
# Select all of the folders within the 'Editing' folder in Explorer/Finder
# Drag and Drop these into the Trainz Content window

The content will then be imported into TRS2019.

An alternative option, once you have opened your assets for edit, is to find the location of your LocalData folder and then import directly from this using the ‘import content folder’ tool. This is done by following these steps:

# Open the launcher screen for your previous installation of Trainz
# Click on Trainz Settings
# Click on the ‘Install’ tab
# Your LocalData location will then be shown in the ‘LocalData’ path box. The last folder in the path will be named ‘build xxxxxxxxx’ (the Xs will be random letters and numbers)
# Open the launcher screen for TRS2019
# Click on Manage Content
# Click on ‘File’ at the top of the screen, then click on ‘import content folder’
# Go to the location that was shown in the install tab of your previous installation
# Click on the ‘Editing’ folder in the ‘build xxxxxxxxx’ folder
# click on ‘Open’
# Your content will then be imported into TRS2019.

==Dependencies==
Dependencies are the assets that another asset relies on, such as all of the scenery objects used on a route, or the trains used in a session.

You can view an assets dependencies by right clicking on it, then click on ‘list dependencies’.

Alternatively, if you click on ‘list dependencies recursively’, this will display the dependencies of the selected assets dependencies. This is useful if the dependencies are likely to be ‘complex’ objects (ie trains, procedural tracks, complex scenery objects, etc). Use this option if you are not sure.

==Content from the Download Station==
It is recommended that content from the Download Station be downloaded again, rather than be transferred using the above methods. This ensures that you have the latest version of all assets from the Download Station, and will ensure that the assets remain compatible with Multiplayer.

==Further Information==

<div style="background-color: #ff9797;border-style: dotted; width:800px; overflow:auto; ">
Do NOT attempt to transfer assets from previous versions over into TRS2019 by simply copying your LocalData folders or creating .cdps. The format of the LocalData folders may not be compatible with TRS2019.

You must not set TRS19 to use the LocalData folder for Trainz: A New Era or any other version of Trainz. Doing so can cause Trainz to become unstable, or cease to function correctly, and may damage any content in the LocalData folder.

Please note that the following items cannot be imported into TRS2019 directly:

* .ja files
* .tzarc files
</div>

Return to
*[[Help:TRS19|TRS19 Help Page]]
*[[Help:TRS2019_Trainz_Content|Trainz Content]]
*[[Help:Content_Manager|Content Manager]]

[[Category:TRS19]]
[[Category: Help]]

Help:Importing Content

2019-07-17T00:02:26Z

Zikchil: /* Recommended Methods of Transferring Content */

TRS2019 has been designed to be backwards compatible with the majority of content from previous versions of Trainz so it is possible to import your content from TANE into TRS2019 (and even from one build of TRS2019 into a new one).

It is important to know that TRS2019 requires the original textures to show correctly in-game, and therefore built-in content and DLC content, which does not contain source files, cannot be imported directly (or it will become 'faulty'). All DLC packs are expected to become available for TRS2019 via the Asset Download tool after TRS2019 is fully released (may not be available during Early Access).

Built-in content from TS2010 and earlier (excluding routes that were new in TS2010) is available from the Download Station.

We are in the process of preparing the TS12 and TS2010 routes for downloading.

==Recommended Methods of Transferring Content==
There are several different methods that can be used to transfer content between different installations/versions of Trainz. Some are more suitable for smaller amounts of content, whilst others are suited to large amounts of content.

Use the Status column to avoid content marked as ‘payware’, ‘built-in’, or ‘installed from DLS’.

<div style="background-color: #ff9797;border-style: dotted; width:800px; overflow:auto; ">
DO NOT attempt to transfer content marked as ‘payware’ or ‘built-in’ manually as it will not include the textures and will show as faulty.<br>
This content is downloaded via in-game Asset Download window. <br>
</div>

It is also recommended that content marked as ‘installed from DLS’ be downloaded again, see [[#Content from the Download Station|Content From Download Station]].

===Using Columns in Content Manager===
<span class="mw-customtoggle-myDivision-usingcolumns">'''+ Click to show/hide Using Columns in Content Manager'''</span>

<div class="mw-collapsible mw-collapsed" style="overflow:auto;" id="mw-customcollapsible-myDivision-usingcolumns">

:Using columns in Content Manager is very simple, and can make finding specific content much easier!

:To start with, you will need to ensure that Content Manager is not set to thumbnail mode, as this will turn off the columns. The option for this is found in the Trainz Settings.

:To add columns, simply right click on one of the column names and go to ‘insert column’, then click on the Column you wish to add’.

:To sort by a column, click on the column name. This will sort in ascending order, if you click again then it will sort in descending order.

:For transferring content, add the ‘status’ column, then click on this column to sort by status. Now locate all content marked as ‘locally modified’, as this will be mostly content you have created, or content you have edited or installed from 3rd party websites.
<span class="mw-customtoggle-myDivision-usingcolumns">'''+ Click to show/hide Using Columns in Content Manager'''</span>
</div>

==Transferring via CDP files (Easiest)==
One method you can use is to save your content to a cdp file, or cdp files, and then import this into TRS2019. Note: cdp files should not be made larger than 500MB in size, so as to ensure that the file does not become corrupted and can be imported successfully by Trainz.

This method is recommended for transferring smaller numbers of assets, or individual assets.

To save the cdp file, follow these steps:
# Open Trainz Content or Content Manager in your old installation of Trainz
# Locate and select the asset(s) you wish to transfer
# Right click and click on 'Export to CDP' (or 'Save as CDP')
# Choose a location you’ll remember to save them to, then give the cdp file a name and click on 'Save'

You can save multiple assets to the same cdp file. To do so, hold the CTRL key and left click on each asset, then follow steps 3 and 4 above.

To import the cdp files, follow these steps:

# Open TRS2019's Trainz Content (content manager) tool by clicking on 'Manage Content' on the Launcher
# Drag and drop the 'cdp' files into the Trainz Content window

The content will then be installed. You can import multiple cdp files at the same time.

==Transferring via 'Open for Edit' (Better for transferring a large amount of content)==
For importing large amounts of content, we recommend the following approach for importing content from your older installation of Trainz:

# Open Trainz Content or Content Manager in your previous installation of Trainz
# Locate an asset you wish to transfer
# Right click on the asset, then go to 'Open'
# Click on 'Open for Editing'
# Repeat for all other assets you wish to transfer.

When you have opened for edit every asset you wish to transfer, right click on one of the assets, then go to 'open' and click on 'Show in Explorer' or 'Show in Finder'.

You should then see an Explorer/Finder window open showing the open asset. Go to the 'Address' bar at the top, and click on the folder called 'Editing'. This will show all of the open for edit assets.

To import the content, follow these steps:
# Open TRS2019's Trainz Content (content manager) tool by clicking on 'Manage Content' on the launcher
# Select all of the folders within the 'Editing' folder in Explorer/Finder
# Drag and Drop these into the Trainz Content window

The content will then be imported into TRS2019.

An alternative option, once you have opened your assets for edit, is to find the location of your LocalData folder and then import directly from this using the ‘import content folder’ tool. This is done by following these steps:

# Open the launcher screen for your previous installation of Trainz
# Click on Trainz Settings
# Click on the ‘Install’ tab
# Your LocalData location will then be shown in the ‘LocalData’ path box. The last folder in the path will be named ‘build xxxxxxxxx’ (the Xs will be random letters and numbers)
# Open the launcher screen for TRS2019
# Click on Manage Content
# Click on ‘File’ at the top of the screen, then click on ‘import content folder’
# Go to the location that was shown in the install tab of your previous installation
# Click on the ‘Editing’ folder in the ‘build xxxxxxxxx’ folder
# click on ‘Open’
# Your content will then be imported into TRS2019.

==Dependencies==
Dependencies are the assets that another asset relies on, such as all of the scenery objects used on a route, or the trains used in a session.

You can view an assets dependencies by right clicking on it, then click on ‘list dependencies’.

Alternatively, if you click on ‘list dependencies recursively’, this will display the dependencies of the selected assets dependencies. This is useful if the dependencies are likely to be ‘complex’ objects (ie trains, procedural tracks, complex scenery objects, etc). Use this option if you are not sure.

==Content from the Download Station==
It is recommended that content from the Download Station be downloaded again, rather than be transferred using the above methods. This ensures that you have the latest version of all assets from the Download Station, and will ensure that the assets remain compatible with Multiplayer.

==Further Information==

<div style="background-color: #ff9797;border-style: dotted; width:800px; overflow:auto; ">
Do NOT attempt to transfer assets from previous versions over into TRS2019 by simply copying your LocalData folders or creating .cdps. The format of the LocalData folders may not be compatible with TRS2019.

You must not set TRS19 to use the LocalData folder for Trainz: A New Era or any other version of Trainz. Doing so can cause Trainz to become unstable, or cease to function correctly, and may damage any content in the LocalData folder.

Please note that the following items cannot be imported into TRS2019 directly:

* .ja files
* .tzarc files
</div>

Return to
*[[Help:TRS19|TRS19 Help Page]]
*[[Help:TRS2019_Trainz_Content|Trainz Content]]
*[[Help:Content_Manager|Content Manager]]

[[Category:TRS19]]
[[Category: Help]]

TrainzUtil

2019-07-13T01:57:39Z

Zikchil: /* Usage */

[[TrainzUtil]] is a command line [[Content Management]] tool.

=Functionality=

[[TrainzUtil]] is capable of performing some content management tasks including:
* Installation, removal and editing of custom content.
* Limited searching of local content.
* Packaging local content for distribution.
[[TrainzUtil]] provides a small subset of the available content management functions, for most operations [[Content Manager]] should be used.

=Usage=

[[TrainzUtil]] is a command line utility and cannot be started from the [[Trainz Launcher]]. To start [[TrainzUtil]] open a command prompt and navigate to your Trainz "bin" directory (e.g. C:\Program Files\Auran\TS2010\Bin or D:N3V Games\Trainz A New Era etc). You can then launch [[TrainzUtil]] with command arguments as below.

In TRS19, you can enable trainzutil by clicking Trainz Settings > Dev > Enable Advanced debug commands, then restarting the game. You can then run the trainzutil commands from Launcher > Developer > Run trainzutil command.

NOTE: Due to the Windows command prompt treating the '<' and '>' characters as pipe operators, be sure to include quotes around any KUID parameters. For example:

trainzutil delete "<kuid:87854:982511580>"

* TrainzUtil help
:''Display TrainzUtil help text.'' (''...start here to see all current command line entries available'')
* TrainzUtil version
:''Display the TrainzUtil build version.''
* TrainzUtil echo <TEXT>
:''Echo the supplied text.''
* TrainzUtil time
:''Echoes the current time in RFC 822 format.''
* TrainzUtil setlanguage <langCode>
:''Set the Trainz language to the language code supplied (eg. US, FR, RU, etc).''
* TrainzUtil installCDP <PATH>
:''Install an asset from a CDP file.''
* TrainzUtil installfrompath <PATH>
:''Install an asset from a directory.''
* TrainzUtil installfromdls <KUID>
:''Install an asset from the Auran Download Station.''
* TrainzUtil edit <KUID>
:''Open an asset for editing.''
* TrainzUtil generateKUID
:''Generate a new KUID number in the local user's KUID range.''
* TrainzUtil createCDP <OUTPUT PATH> <KUID1> <KUID2> ... <KUIDX>
:''Export assets to a CDP file.''
* TrainzUtil repairdatabase
:''Repairs the Trainz Asset Database.''
* TrainzUtil repairdatabase extended
:''Forces DLC packages to be reinstalled and fully repairs database corruption. [https://support.trainzportal.com/index.php?/Knowledgebase/Article/View/36/8/extended-database-repair:Full Details here]''
* TrainzUtil printconfig <KUID>
:''Print the contents of an assets config file to the console.''
* TrainzUtil backupkeywords
:''Backup all the keywords of your assets.''
* TrainzUtil importkeywords
:''Import keywords into the Trainz Asset Database.''
* TrainzUtil add-keyword <keyword> <KUID> [..]
:''Add a keyword to the specified assets.''
* TrainzUtil remove-keyword <keyword> <KUID> [..]
:''Remove a keyword from the specified assets.''
* TrainzUtil search-by-keyword <keyword>
:''Returns a list of all assets with the specified keyword.''
* TrainzUtil commit <KUID>
:''Commit any edits that have been made to the specified asset.''
* TrainzUtil revert <KUID>
:''Discard any edits that have been made to the specified asset.''
* TrainzUtil delete <KUID>
:''Delete the specified asset from disk.''
* TrainzUtil list <KUID> [..]
:''Parses the specified kuid list into the results.''
* TrainzUtil list-latest-versions <KUID>
:''Get the latest known version of an asset. Multiple KUIDs may be specified as multiple arguments.''
* TrainzUtil list-dependencies <KUID>
:''Get an assets direct dependencies.''
* TrainzUtil list-dependants <KUID>
:''Get an assets direct dependants.''
* TrainzUtil authors
:''List of all the authorIDs that have content in the game.''
* TrainzUtil searchbycategory [-a] <CategoryList>
:''List all the local assets with a category set in this format, "CMP;MESH|BD;-ACTV|VE|SCEN". Use the -a parameter if you want to search the [[Download Station]] as well.''
* TrainzUtil filterbystatus <status> <KUID>
:''List all assets from the specified list which match the specified status flags.''
* TrainzUtil importconsists <PATH>
:''Import an old style Surveyor consist list, creating consist assets for any unknown entries.''
* TrainzUtil setnextcontentid <int>
:''Provides a 'next content ID' hint for the KUID generator.''
* TrainzUtil status <KUID>
:''Print the status of the specified asset.''
:''This will output + <KUID> : <Flags> : <category> : <username> where flags are a series of letters with case indicating boolean state. (capital letters are flagged true and lowercase are flagged false.)''
:*''Aa - The asset is archived.''
:*''Bb - The asset is builtin or packaged content.''
:*''Cc - The asset is in the base content set.''
:*''Dd - The asset is on the download station.''
:*''Ee - The asset is open for edit.''
:*''Ff - The asset is faulty.''
:*''Ii - The asset is installed locally.''
:*''Ll - The asset is locally modified.''
:*''Mm - The asset has missing dependencies.''
:*''Oo - The asset is obsolete.''
:*''Pp - The asset is listed in the DLS index as payware DLC.''
:*''Uu - The asset has an update available.''
:*''Xx - The asset is authorised for use in this Trainz installation.''
* TrainzUtil validate <KUID>
:''Perform validation and display any errors or warnings relating to this asset.''
* TrainzUtil compile <PATH>
:''Compile a script file.''
:*''<-d> Display gamescript documentation.''
:*''<-s> Silent mode.''
:*''<-bPATH> Specify a file path for the compile log.''
:*''<-pPATH> Specify the output directory.''
:*''<-oPATH> Specify the output library filename.''
:*''<PATH> Input source file.''
:*''<-iPATH> Additional include path.''
* TrainzUtil convert-config <PATH>
:''Converts a config.txt file to config.chump or vice versa.''
* TrainzUtil open-in-driver [-wait] <KUID>
:''Open the specified route or session asset in Driver. Optionally wait until the module is exited.''
* TrainzUtil open-in-surveyor [-wait] <KUID>
:''Open the specified route or session asset in Surveyor. Optionally wait until the module is exited.''
* TrainzUtil open-in-preview [-wait] <KUID>
:''Open the specified route or session asset in the asset preview tool. Optionally wait until the module is exited.''
* TrainzUtil encrypt <PATH>
:''Encrypt a script file (gs --> gse).''
* TrainzUtil export-package <device-type> <package-name> <package-build-number> [<dependency-package-name> ...] <kuid>
:''Export assets to a device package. Multiple KUIDs may be specified as multiple arguments.''
* TrainzUtil update-package <package-name>
:''Update prebuilt data within a package.''
* TrainzUtil install-package <PATH>
:''Install a package from the specified path.''
* TrainzUtil clean-package [-a] <package-name>
:''Remove the local build's prebuilt data from within a package. Use the -a parameter if you want to strip all prebuilt data.''
* TrainzUtil uninstall-package <package-name>
:''Uninstall the specified package.''
* TrainzUtil list-package-assets <package-name>
:''List the assets available in the specified package.''
* TrainzUtil prebuild [--force] [--nofail] [--clear] [<KUID> ..]
:''Precache all installed content.''
* TrainzUtil downloadcontentlistings
:''Fully download the latest content listings.''
* TrainzUtil listbuilds <PATH>
:''Print the list of installed build numbers to a file.''
* TrainzUtil quit
:''Requests the GUI to close.''
* TrainzUtil async <command..>
:''Begins running the specified command asynchronously.''
* TrainzUtil sync
:''Waits for all async commands to complete.''
* TrainzUtil wait <seconds>
:''Pause for the specified number of seconds.''
* TrainzUtil @<file.txt>
:''Batch-execute a series of commands from the specified text file (every argument must be between double quotes). Every line of that text file will be processed like a separate call to TrainzUtil''
* set <variable> <command..>
:''Used in a batch file, runs the specified command and overwrites the named variable with the result.''
* append <variable> <command..>
:''Used in a batch file, runs the specified command and appends the result into the named variable.''
* iferr <variable> <command..>
:''Used in a batch file, runs the specified command only if the named variable contains one or more errors.''
* iferrflag <command..>
:''Used in a batch file, runs the specified command only if an error has occurred in the batch file execution up to this point.''
* ifnone <variable> <command..>
:''Used in a batch file, runs the specified command only if the named variable contains no assets.''
* ifhas <variable> <command..>
:''Used in a batch file, runs the specified command only if the named variable contains one or more assets.''
* print <variable>
:''Used in a batch file, prints the content of the named variable.''
* printerrors <variable>
:''Used in a batch file, prints any errors contained in the named variable.''
* abort <TEXT>
:''Used in a batch files, aborts processing of the batch file immediately without raising any further errors. If arguments are present, they are logged as a single error string.''
* $(<variable>)
:''Used as a command parameter in a batch file, replaced with the KUID(s) from the specified variable.''

=Notes=
Due to the Windows command prompt treating the '<' and '>' characters as pipe operators, be sure to include quotes around any KUID parameters. For example:

trainzutil delete "<kuid:87854:982511580>"

[[Content Creation]]

Dispatchin' the Action

2019-04-18T14:40:01Z

Zikchil: /* Hints */

[[File:dspna00.jpg|320px]]

It is expected that with some consideration experienced players will enjoy solving the problems presented in this TRS19 session unassisted. For those who would like some help, the following is provided:

==Hints==

As the dispatcher you are responsible for directing rail traffic over your territory, keeping everything moving as safely and effectively as possible.<br>
<br>
<u>'''Passenger Task Objectives'''</u>

*Passengers are the most time sensitive cargo so it's best to begin by getting them on their way.
*:*Navigate to Oyonix and select the passenger train.
*:*The easiest way to do this is to click the driver portrait at lower left and find Kat in the list of drivers.

*The first stop on the passenger working is Smallbrook Jct.
*:*Issue the driver command Navigate to... and from the industry rollout select Smallbrook Jct.
*:*Next issue the Load command.
*:*Repeat these steps for the other stations listed in the Passenger Tasks objective.

*It's ok to hold the passenger train at stops en route to await opposing movements approaching on single track sections, but try not to keep the passengers waiting anywhere for too long.
<br>
<u>'''Freight Task Objectives'''</u>

*The freight tasks can be completed in whatever order you like.

*The first task in the list is the transfer of 10 loaded coal hoppers to the power station at Westside.
*:*Driver Miksa is in charge of suitable power for this task and is available at Pinecone Kurri Ridge for orders.
*:*The loaded hoppers are ready at the nearby Daydream Mine.
*:*You can begin by issuing the Couple > command and selecting Coal Hopper 1 from the list of vehicles.

*You can also issue additional commands so that once the consist is assembled the train can get underway.
*:*You might order Miksa to navigate directly to Westside Power Co and Unload but be aware this could delay trains travelling in the opposite direction.

*An effective dispatcher will coordinate opposing movements such that whenever possible everything is kept on the move.
*:*Where single track sections are involved, trains will inevitably need to stop for meets but careful planning helps keep these delays to a minimum.

*Drive to Trackmark > is a helpful command for arranging meets.
*:*For example if you order Miksa to Drive to Trackmark > TM60 he will stop on the main line at Fogarty's End short of the entrance to the single track section.
*:*This means any opposing movement out of St.Nicolaas can be safely directed as far as the siding at Fogarty's End regardless of Miksa's progress.

*Similarly a following movement out of St.Nicolaas can be sent as far as the siding at Kalen Turner Industries using TM50.

*TM00 at the north end of the main yard can be useful when directing the marshalling of consists for the various tasks.
*:*It's also helpful if you wish to complete the CP Rail switching task under AI control.

*The available trackmarks can be studied in Map View or you can refer to the diagrams below.

*At St.Nicolaas main yard there are several drivers available to help you complete the remaining road freight tasks.
*:*In the yard as out on the road it's best to keep the drivers out of each other's way wherever possible to avoid delays.

*An effective approach is to issue orders incrementally.
*:*For example you might send Marilyn out to Clearwater Logging to load logs and run around train.
*:*From there you could send her directly to Gard Family Forestry, but at this point it may not be clear what other movements will need that stretch of track when she's ready to leave.

*Alternatively after loading logs, Marilyn can be ordered to return to the main yard using e.g. TM10.
*:*That way when she arrives back at the yard with logs in tow you can make a more informed decision about the timing of her next move based on the progress of other trains.

*The session is complete when all the tasks have been accomplished.
*Full points are awarded if the passenger service is completed within 45 minutes and the session is completed overall within 90 minutes.<br>

==Trackmark Locations==
<br>
<font size=3>St.Nicolaas Main Yard</font>

[[Image:Schematic_StNicolaas.jpg]]

----

<font size=3>Kalen Turner Industries</font>

[[Image:Schematic_KalenTurner_.jpg]]

----

<font size=3>Fogarty's End</font>

[[Image:Schematic_FogartysEnd.jpg]]

----

<font size=3>Arsao Village</font>

[[Image:Schematic_ArsaoVillage_.jpg]]

----

<font size=3>Smallbrook Jct</font>

[[Image:Schematic_SmallbrookJct_.jpg]]

Dispatchin' the Action

2019-04-18T14:39:29Z

Zikchil: /* Hints */

[[File:dspna00.jpg|320px]]

It is expected that with some consideration experienced players will enjoy solving the problems presented in this TRS19 session unassisted. For those who would like some help, the following is provided:

==Hints==

As the dispatcher you are responsible for directing rail traffic over your territory, keeping everything moving as safely and effectively as possible.<br>
<br>
<u>'''Passenger Task Objectives'''</u>

*Passengers are the most time sensitive cargo so it's best to begin by getting them on their way.
*:*Navigate to Oyonix and select the passenger train.
*:*The easiest way to do this is to click the driver portrait at lower left and find Kat in the list of drivers.

*The first stop on the passenger working is Smallbrook Jct.
*:*Issue the driver command Navigate to... and from the industry rollout select Smallbrook Jct.
*:*Next issue the Load command.
*:*Repeat these steps for the other stations listed in the Passenger Tasks objective.

*It's ok to hold the passenger train at stops en route to await opposing movements approaching on single track sections, but try not to keep the passengers waiting anywhere for too long.
<br>
<u>'''Freight Task Objectives'''</u>

*The freight tasks can be completed in whatever order you like.

*The first task in the list is the transfer of 10 loaded coal hoppers to the power station at Westside.
*:*Driver Miksa is in charge of suitable power for this task and is available at Pinecone Kurri Ridge for orders.
*:*The loaded hoppers are ready at the nearby Daydream Mine.
*:*You can begin by issuing the Couple > command and selecting Coal Hopper 1 from the list of vehicles.

*You can also issue additional commands so that once the consist is assembled the train can get underway.
*:*You might order Miksa to navigate directly to Westside Power Co and Unload but be aware this could delay trains travelling in the opposite direction.

*An effective dispatcher will coordinate opposing movements such that whenever possible everything is kept on the move.
*:*Where single track sections are involved, trains will inevitably need to stop for meets but careful planning helps keep these delays to a minimum.

*Drive to Trackmark > is a helpful command for arranging meets.
*:*For example if you order Miksa to Drive to Trackmark > TM60 he will stop on the main line at Fogarty's End short of the entrance to the single track section.
*:*This means any opposing movement out of St.Nicolaas can be safely directed as far as the siding at Fogarty's End regardless of Miksa's progress.

*Similarly a following movement out of St.Nicolaas can be sent as far as the siding at Kalen Turner Industries using TM50.

*TM00 at the north end of the main yard can be useful when directing the marshalling of consists for the various tasks.
*:*It's also helpful if you wish to complete the CP Rail switching task under AI control.

*The available trackmarks can be studied in Map View or you can refer to the diagrams below.

*At St.Nicolaas main yard there are several drivers available to help you complete the remaining road freight tasks.
*:*In the yard as out on the road it's best to keep the drivers out of each other's way wherever possible to avoid delays.

*An effective approach is to issue orders incrementally.
*:*For example you might send Marilyn out to Clearwater Logging to load logs and run around train.
*:*From there you could send her directly to Gard Family Forestry, but at this point it may not be clear what other movements will need that stretch of track when she's ready to leave.

*Alternatively after loading logs, Marilyn can be ordered to return to the main yard using e.g. TM10.
*:*That way when she arrives back at the yard with logs in tow you can make a more informed decision about the timing of her next move based on the progress of other trains.

*The session is complete when all the tasks have been accomplished.
*Full points are awarded if the passenger service is completed within 45 minutes and the session is completed overall within 90 minutes.
<br>

==Trackmark Locations==
<br>
<font size=3>St.Nicolaas Main Yard</font>

[[Image:Schematic_StNicolaas.jpg]]

----

<font size=3>Kalen Turner Industries</font>

[[Image:Schematic_KalenTurner_.jpg]]

----

<font size=3>Fogarty's End</font>

[[Image:Schematic_FogartysEnd.jpg]]

----

<font size=3>Arsao Village</font>

[[Image:Schematic_ArsaoVillage_.jpg]]

----

<font size=3>Smallbrook Jct</font>

[[Image:Schematic_SmallbrookJct_.jpg]]

Dispatchin' the Action

2019-04-17T16:01:17Z

Zikchil: /* Hints */

[[File:dspna00.jpg|320px]]

It is expected that with some consideration experienced players will enjoy solving the problems presented in this TRS19 session unassisted. For those who would like some help, the following is provided:

==Hints==

As the dispatcher you are responsible for directing rail traffic over your territory, keeping everything moving as safely and effectively as possible.<br>
<br>
<u>'''Passenger Task Objectives'''</u>

*Passengers are the most time sensitive cargo so it's best to begin by getting them on their way.
*:*Navigate to Oyonix and select the passenger train.
*:*The easiest way to do this is to click the driver portrait at lower left and find Kat in the list of drivers.

*The first stop on the passenger working is Smallbrook Jct.
*:*Issue the driver command Navigate to... and from the industry rollout select Smallbrook Jct.
*:*Next issue the Load command.
*:*Repeat these steps for the other stations listed in the Passenger Tasks objective.

*It's ok to hold the passenger train at stops en route to await opposing movements approaching on single track sections, but try not to keep the passengers waiting anywhere for too long.
<br>
<u>'''Freight Task Objectives'''</u>

*The freight tasks can be completed in whatever order you like.

*The first task in the list is the transfer of 10 loaded coal hoppers to the power station at Westside.
*:*Driver Miksa is in charge of suitable power for this task and is available at Pinecone Kurri Ridge for orders.
*:*The loaded hoppers are ready at the nearby Daydream Mine.
*:*You can begin by issuing the Couple > command and selecting Coal Hopper 1 from the list of vehicles.

*You can also issue additional commands so that once the consist is assembled the train can get underway.
*:*You might order Miksa to navigate directly to Westside Power Co and Unload but be aware this could delay trains travelling in the opposite direction.

*An effective dispatcher will coordinate opposing movements such that whenever possible everything is kept on the move.
*:*Where single track sections are involved, trains will inevitably need to stop for meets but careful planning helps keep these delays to a minimum.

*Drive to Trackmark > is a helpful command for arranging meets.
*:*For example if you order Miksa to Drive to Trackmark > TM60 he will stop on the main line at Fogarty's End short of the entrance to the single track section.
*:*This means any opposing movement out of St.Nicolaas can be safely directed as far as the siding at Fogarty's End regardless of Miksa's progress.

*Similarly a following movement out of St.Nicolaas can be sent as far as the siding at Kalen Turner Industries using TM50.

*TM00 at the north end of the main yard can be useful when directing the marshalling of consists for the various tasks.
*:*It's also helpful if you wish to complete the CP Rail switching task under AI control.

*The available trackmarks can be studied in Map View or you can refer to the diagrams below.

*At St.Nicolaas main yard there are several drivers available to help you complete the remaining road freight tasks.
*:*In the yard as out on the road it's best to keep the drivers out of each other's way wherever possible to avoid delays.

*An effective approach is to issue orders incrementally.
*:*For example you might send Marilyn out to Clearwater Logging to load logs and run around train.
*:*From there you could send her directly to Gard Family Forestry, but at this point it may not be clear what other movements will need that stretch of track when she's ready to leave.

*Alternatively after loading logs, Marilyn can be ordered to return to the main yard using e.g. TM10.
*:*That way when she arrives back at the yard with logs in tow you can make a more informed decision about the timing of her next move based on the progress of other trains.

*The session is complete when all the tasks have been accomplished.
*Full points are awarded if the passenger service is completed within 45 minutes and the session is completed overall within 90 minutes.

==Trackmark Locations==
<br>
<font size=3>St.Nicolaas Main Yard</font>

[[Image:Schematic_StNicolaas.jpg]]

----

<font size=3>Kalen Turner Industries</font>

[[Image:Schematic_KalenTurner_.jpg]]

----

<font size=3>Fogarty's End</font>

[[Image:Schematic_FogartysEnd.jpg]]

----

<font size=3>Arsao Village</font>

[[Image:Schematic_ArsaoVillage_.jpg]]

----

<font size=3>Smallbrook Jct</font>

[[Image:Schematic_SmallbrookJct_.jpg]]

Dispatchin' the Action

2019-04-16T23:54:11Z

Zikchil: /* Hints */

[[File:dspna00.jpg|320px]]

It is expected that with some consideration experienced players will enjoy solving the problems presented in this TRS19 session unassisted. For those who would like some help, the following is provided:

==Hints==

As the dispatcher you are responsible for directing rail traffic over your territory, keeping everything moving as safely and effectively as possible.<br>
<br>
<u>'''Passenger Tasks Objective'''</u>

*Passengers are the most time sensitive cargo so it's best to begin by getting them on their way.
*:*Navigate to Oyonix and select the passenger train.
*:*The easiest way to do this is to click the driver portrait at lower left and find Kat in the list of drivers.

*The first stop on the passenger working is Smallbrook Jct.
*:*Issue the driver command Navigate to... and from the industry rollout select Smallbrook Jct.
*:*Next issue the Load command.
*:*Repeat these steps for the other stations listed in the Passenger Tasks objective.

*It's ok to hold the passenger train at stops en route to await opposing movements approaching on single track sections, but try not to keep the passengers waiting anywhere for too long.
<br>
<u>'''Freight Tasks Objective'''</u>

*The freight tasks can be completed in whatever order you like.

*The first task in the list is the transfer of 10 loaded coal hoppers to the power station at Westside.
*:*Driver Miksa is in charge of suitable power for this task and is available at Pinecone Kurri Ridge for orders.
*:*The loaded hoppers are ready at the nearby Daydream Mine.
*:*You can begin by issuing the Couple > command and selecting Coal Hopper 1 from the list of vehicles.

*You can also issue additional commands so that once the consist is assembled the train can get underway.
*:*You might order Miksa to navigate directly to Westside Power Co and Unload but be aware this could delay trains travelling in the opposite direction.

*An effective dispatcher will coordinate opposing movements such that whenever possible everything is kept on the move.
*:*Where single track sections are involved, trains will inevitably need to stop for meets but careful planning helps keep these delays to a minimum.

*Drive to Trackmark > is a helpful command for arranging meets.
*:*For example if you order Miksa to Drive to Trackmark > TM60 he will stop on the main line at Fogarty's End short of the entrance to the single track section.
*:*This means any opposing movement out of St.Nicolaas can be safely directed as far as the siding at Fogarty's End regardless of Miksa's progress.

*Similarly a following movement out of St.Nicolaas can be sent as far as the siding at Kalen Turner Industries using TM50.

*TM00 at the north end of the main yard can be useful when directing the marshalling of consists for the various tasks.
*:*It's also helpful if you wish to complete the CP Rail switching task under AI control.

*The available trackmarks can be studied in Map View or you can refer to the diagrams below.

*At St.Nicolaas main yard there are several drivers available to help you complete the remaining road freight tasks.
*:*In the yard as out on the road it's best to keep the drivers out of each other's way wherever possible to avoid delays.

*An effective approach is to issue orders incrementally.
*:*For example you might send Marilyn out to Clearwater Logging to load logs and run around train.
*:*From there you could send her directly to Gard Family Forestry, but at this point it may not be clear what other movements will need that stretch of track when she's ready to leave.

*Alternatively after loading logs, Marilyn can be ordered to return to the main yard using e.g. TM10.
*:*That way when she arrives back at the yard with logs in tow you can make a more informed decision about the timing of her next move based on the progress of other trains.

*The session is complete when all the tasks have been accomplished.
*Full points are awarded if the passenger service is completed within 45 minutes and the session is completed overall within 90 minutes.

==Trackmark Locations==
<br>
<font size=3>St.Nicolaas Main Yard</font>

[[Image:Schematic_StNicolaas.jpg]]

----

<font size=3>Kalen Turner Industries</font>

[[Image:Schematic_KalenTurner_.jpg]]

----

<font size=3>Fogarty's End</font>

[[Image:Schematic_FogartysEnd.jpg]]

----

<font size=3>Arsao Village</font>

[[Image:Schematic_ArsaoVillage_.jpg]]

----

<font size=3>Smallbrook Jct</font>

[[Image:Schematic_SmallbrookJct_.jpg]]

Help:Dual Installations - Beta vs Public Builds

2019-03-04T22:56:54Z

Zikchil: Created page with " <h3> Beta & Public Builds - Managing Two Application Instances </h3> The intent of this process is to afford content creators and players alike a stable unchanging platform ..."

<h3> Beta & Public Builds - Managing Two Application Instances </h3>

The intent of this process is to afford content creators and players alike a stable unchanging platform with some redundancy that safeguards against changes in the application potentially affecting content creation.

'''Notes:'''
*Developing content in any beta means the user is accepting some risk as there is no guarantee from build to build that the application will remain unchanged. That is the nature of “beta”.
**...it ''is'' an excellent way to make sure you remain abreast of changes and can react accordingly.
*Setting up multiple instances of Trainz is a good practice for maintaining the RELEASE “BUILD:” and a BETA “RELEASE ASSERTIONS” BUILD: independent of each other.
*Please note that builds labeled as “RELEASE ASSERTIONS” on the launcher are BETA and not a final release.
**Expect changes to occur between releases.
**Expect assertions and exceptions to occur in beta releases.
*'''Important:''' We recommend users backup the existing application & data directory prior to patching. Adopting this process will allow you to easily roll back if needed.<br>
<h4>Create Two Unique Installation Folders</h4>
*Setting up two directories to manage public and beta builds may be done when running the games installer or manually after the game is already installed.
*This example uses the “installer” approach for TRS19 but is also applicable to TANE. You may derive the manual approach from these steps:
#When the installer is run the first time it shows you the default path the game will be installed to.
#The default path is "C:\Program Files\N3V Games\Trainz Railroad Simulator 2019"
#At this point you may rename the path, or insert a new folder:
#*...for example: "C:\Program Files\N3V Games\TRS19\Public"
#Then for your beta installation:
#*"C:\Program Files\N3V Games\TRS19\Beta"
#Now you have two instances of the application installed
<h4>Create Two Unique Data Folders</h4>
#When installing Trainz, the game will create a clean data folder.
#*We call this "clean" because it has no other content installed except what ships with the game.
#Find this by running the Launcher > Trainz Settings > Install tab, see “Local data folder” path.
#*The system places the data folder in your “user” folder with a alphanumeric name that is great for maintaining separate data directories, but not-so-great at being user-friendly.
#**The following is optional but suggested.
#*#Browse to the location of the “public” installations data folder
#*#Change the folder name for the public release from its alphanumeric name to “Public”
#*#Do the same for the beta build data folder, calling it “Beta”
#**'''Important:''' Update the “Local data folder” path to match your changes
#*Now you have two clearly defined “at a glance” data directories with user friendly names.
#Now create two unique shortcuts on the desktop.
#*One pointing to your “public” installation
#*The other pointing to your “beta” installation
#*Clearly label these two shortcuts (i.e. - “Public” & “Beta”).

That’s it.

'''Sanity Check:''' Moving forward, it is recommended that you backup and archive your work regularly.
*The best time to do this when working on content is when you have reached a milestone and generally at the end of the work day.
*You may do this by making a copy of the entire data directory and compressing (zip\rar\etc.) or exporting to CDP.
* For more info on moving\creating data folders please go [http://online.ts2009.com/mediaWiki/index.php/Help:Moving_Content here].

TrainzUtil

2018-12-19T23:53:52Z

Zikchil: /* Usage */

[[TrainzUtil]] is a command line [[Content Management]] tool.

=Functionality=

[[TrainzUtil]] is capable of performing some content management tasks including:
* Installation, removal and editing of custom content.
* Limited searching of local content.
* Packaging local content for distribution.
[[TrainzUtil]] provides a small subset of the available content management functions, for most operations [[Content Manager]] should be used.

=Usage=

[[TrainzUtil]] is a command line utility and cannot be started from the [[Trainz Launcher]]. To start [[TrainzUtil]] open a command prompt and navigate to your Trainz "bin" directory (e.g. C:\Program Files\Auran\TS2010\Bin or D:N3V Games\Trainz A New Era etc). You can then launch [[TrainzUtil]] with command arguments as below.

In TRS19, you can enable trainzutil by clicking Trainz Settings > Dev > Enable Advanced debug commands, then restarting the game. You can then run the trainzutil commands from Launcher > Developer > Run trainzutil command.

NOTE: Due to the Windows command prompt treating the '<' and '>' characters as pipe operators, be sure to include quotes around any KUID parameters. For example:

trainzutil delete "<kuid:87854:982511580>"

* TrainzUtil help
:''Display TrainzUtil help text.'' (''...start here to see all current command line entries available'')
* TrainzUtil version
:''Display the TrainzUtil build version.''
* TrainzUtil echo <TEXT>
:''Echo the supplied text.''
* TrainzUtil time
:''Echoes the current time in RFC 822 format.''
* TrainzUtil setlanguage <langCode>
:''Set the Trainz language to the language code supplied (eg. US, FR, RU, etc).''
* TrainzUtil installCDP <PATH>
:''Install an asset from a CDP file.''
* TrainzUtil installfrompath <PATH>
:''Install an asset from a directory.''
* TrainzUtil installfromdls <KUID>
:''Install an asset from the Auran Download Station.''
* TrainzUtil edit <KUID>
:''Open an asset for editing.''
* TrainzUtil generateKUID
:''Generate a new KUID number in the local user's KUID range.''
* TrainzUtil createCDP <OUTPUT PATH> <KUID1> <KUID2> ... <KUIDX>
:''Export assets to a CDP file.''
* TrainzUtil repairdatabase
:''Repairs the Trainz Asset Database.''
* TrainzUtil repairdatabase extended
:''Forces DLC packages to be reinstalled and fully repairs database corruption. [https://support.trainzportal.com/index.php?/Knowledgebase/Article/View/36/8/extended-database-repair:Full Details here]''
* TrainzUtil printconfig <KUID>
:''Print the contents of an assets config file to the console.''
* TrainzUtil backupkeywords
:''Backup all the keywords of your assets.''
* TrainzUtil importkeywords
:''Import keywords into the Trainz Asset Database.''
* TrainzUtil add-keyword <keyword> <KUID> [..]
:''Add a keyword to the specified assets.''
* TrainzUtil remove-keyword <keyword> <KUID> [..]
:''Remove a keyword from the specified assets.''
* TrainzUtil search-by-keyword <keyword>
:''Returns a list of all assets with the specified keyword.''
* TrainzUtil commit <KUID>
:''Commit any edits that have been made to the specified asset.''
* TrainzUtil revert <KUID>
:''Discard any edits that have been made to the specified asset.''
* TrainzUtil delete <KUID>
:''Delete the specified asset from disk.''
* TrainzUtil list <KUID> [..]
:''Parses the specified kuid list into the results.''
* TrainzUtil list-latest-versions <KUID>
:''Get the latest known version of an asset. Multiple KUIDs may be specified as multiple arguments.''
* TrainzUtil list-dependencies <KUID>
:''Get an assets direct dependencies.''
* TrainzUtil list-dependants <KUID>
:''Get an assets direct dependants.''
* TrainzUtil authors
:''List of all the authorIDs that have content in the game.''
* TrainzUtil searchbycategory [-a] <CategoryList>
:''List all the local assets with a category set in this format, "CMP;MESH|BD;-ACTV|VE|SCEN". Use the -a parameter if you want to search the [[Download Station]] as well.''
* TrainzUtil filterbystatus <status> <KUID>
:''List all assets from the specified list which match the specified status flags.''
* TrainzUtil importconsists <PATH>
:''Import an old style Surveyor consist list, creating consist assets for any unknown entries.''
* TrainzUtil setnextcontentid <int>
:''Provides a 'next content ID' hint for the KUID generator.''
* TrainzUtil status <KUID>
:''Print the status of the specified asset.''
:''This will output + <KUID> : <Flags> : <category> : <username> where flags are a series of letters with case indicating boolean state. (capital letters are flagged true and lowercase are flagged false.)''
:*''Aa - The asset is archived.''
:*''Bb - The asset is builtin or packaged content.''
:*''Cc - The asset is in the base content set.''
:*''Dd - The asset is on the download station.''
:*''Ee - The asset is open for edit.''
:*''Ff - The asset is faulty.''
:*''Ii - The asset is installed locally.''
:*''Ll - The asset is locally modified.''
:*''Mm - The asset has missing dependencies.''
:*''Oo - The asset is obsolete.''
:*''Pp - The asset is listed in the DLS index as payware DLC.''
:*''Uu - The asset has an update available.''
:*''Xx - The asset is authorised for use in this Trainz installation.''
* TrainzUtil validate <KUID>
:''Perform validation and display any errors or warnings relating to this asset.''
* TrainzUtil compile <PATH>
:''Compile a script file.''
:*''<-d> Display gamescript documentation.''
:*''<-s> Silent mode.''
:*''<-bPATH> Specify a file path for the compile log.''
:*''<-pPATH> Specify the output directory.''
:*''<-oPATH> Specify the output library filename.''
:*''<PATH> Input source file.''
:*''<-iPATH> Additional include path.''
* TrainzUtil convert-config <PATH>
:''Converts a config.txt file to config.chump or vice versa.''
* TrainzUtil open-in-driver [-wait] <KUID>
:''Open the specified route or session asset in Driver. Optionally wait until the module is exited.''
* TrainzUtil open-in-surveyor [-wait] <KUID>
:''Open the specified route or session asset in Surveyor. Optionally wait until the module is exited.''
* TrainzUtil open-in-preview [-wait] <KUID>
:''Open the specified route or session asset in the asset preview tool. Optionally wait until the module is exited.''
* TrainzUtil encrypt <PATH>
:''Encrypt a script file (gs --> gse).''
* TrainzUtil export-package <device-type> <package-name> <package-build-number> [<dependency-package-name> ...] <kuid>
:''Export assets to a device package. Multiple KUIDs may be specified as multiple arguments.''
* TrainzUtil update-package <package-name>
:''Update prebuilt data within a package.''
* TrainzUtil install-package <PATH>
:''Install a package from the specified path.''
* TrainzUtil clean-package [-a] <package-name>
:''Remove the local build's prebuilt data from within a package. Use the -a parameter if you want to strip all prebuilt data.''
* TrainzUtil uninstall-package <package-name>
:''Uninstall the specified package.''
* TrainzUtil list-package-assets <package-name>
:''List the assets available in the specified package.''
* TrainzUtil downloadcontentlistings
:''Fully download the latest content listings.''
* TrainzUtil listbuilds <PATH>
:''Print the list of installed build numbers to a file.''
* TrainzUtil quit
:''Requests the GUI to close.''
* TrainzUtil async <command..>
:''Begins running the specified command asynchronously.''
* TrainzUtil sync
:''Waits for all async commands to complete.''
* TrainzUtil wait <seconds>
:''Pause for the specified number of seconds.''
* TrainzUtil @<file.txt>
:''Batch-execute a series of commands from the specified text file (every argument must be between double quotes). Every line of that text file will be processed like a separate call to TrainzUtil''
* set <variable> <command..>
:''Used in a batch file, runs the specified command and overwrites the named variable with the result.''
* append <variable> <command..>
:''Used in a batch file, runs the specified command and appends the result into the named variable.''
* iferr <variable> <command..>
:''Used in a batch file, runs the specified command only if the named variable contains one or more errors.''
* iferrflag <command..>
:''Used in a batch file, runs the specified command only if an error has occurred in the batch file execution up to this point.''
* ifnone <variable> <command..>
:''Used in a batch file, runs the specified command only if the named variable contains no assets.''
* ifhas <variable> <command..>
:''Used in a batch file, runs the specified command only if the named variable contains one or more assets.''
* print <variable>
:''Used in a batch file, prints the content of the named variable.''
* printerrors <variable>
:''Used in a batch file, prints any errors contained in the named variable.''
* abort <TEXT>
:''Used in a batch files, aborts processing of the batch file immediately without raising any further errors. If arguments are present, they are logged as a single error string.''
* $(<variable>)
:''Used as a command parameter in a batch file, replaced with the KUID(s) from the specified variable.''

=Notes=
Due to the Windows command prompt treating the '<' and '>' characters as pipe operators, be sure to include quotes around any KUID parameters. For example:

trainzutil delete "<kuid:87854:982511580>"

[[Content Creation]]

TrainzUtil

2018-12-19T23:46:42Z

Zikchil: /* Usage */

[[TrainzUtil]] is a command line [[Content Management]] tool.

=Functionality=

[[TrainzUtil]] is capable of performing some content management tasks including:
* Installation, removal and editing of custom content.
* Limited searching of local content.
* Packaging local content for distribution.
[[TrainzUtil]] provides a small subset of the available content management functions, for most operations [[Content Manager]] should be used.

=Usage=

[[TrainzUtil]] is a command line utility and cannot be started from the [[Trainz Launcher]]. To start [[TrainzUtil]] open a command prompt and navigate to your Trainz "bin" directory (e.g. C:\Program Files\Auran\TS2010\Bin or D:N3V Games\Trainz A New Era etc). You can then launch [[TrainzUtil]] with command arguments as below.

In TRS19, you can enable trainzutil by clicking Trainz Settings > Dev > Enable Advanced debug commands, then restarting the game. You can then run the trainzutil commands from Launcher > Developer > Run trainzutil command.

NOTE: Due to the Windows command prompt treating the '<' and '>' characters as pipe operators, be sure to include quotes around any KUID parameters. For example:

trainzutil delete "<kuid:87854:982511580>"

* TrainzUtil help
:''Display TrainzUtil help text.''
::Use this command for all the current command line entries available (possibly updated in game faster than on this page)
* TrainzUtil version
:''Display the TrainzUtil build version.''
* TrainzUtil echo <TEXT>
:''Echo the supplied text.''
* TrainzUtil time
:''Echoes the current time in RFC 822 format.''
* TrainzUtil setlanguage <langCode>
:''Set the Trainz language to the language code supplied (eg. US, FR, RU, etc).''
* TrainzUtil installCDP <PATH>
:''Install an asset from a CDP file.''
* TrainzUtil installfrompath <PATH>
:''Install an asset from a directory.''
* TrainzUtil installfromdls <KUID>
:''Install an asset from the Auran Download Station.''
* TrainzUtil edit <KUID>
:''Open an asset for editing.''
* TrainzUtil generateKUID
:''Generate a new KUID number in the local user's KUID range.''
* TrainzUtil createCDP <OUTPUT PATH> <KUID1> <KUID2> ... <KUIDX>
:''Export assets to a CDP file.''
* TrainzUtil repairdatabase
:''Repairs the Trainz Asset Database.''
* TrainzUtil repairdatabase extended
:''Forces DLC packages to be reinstalled and fully repairs database corruption. [https://support.trainzportal.com/index.php?/Knowledgebase/Article/View/36/8/extended-database-repair:Full Details here]''
* TrainzUtil printconfig <KUID>
:''Print the contents of an assets config file to the console.''
* TrainzUtil backupkeywords
:''Backup all the keywords of your assets.''
* TrainzUtil importkeywords
:''Import keywords into the Trainz Asset Database.''
* TrainzUtil add-keyword <keyword> <KUID> [..]
:''Add a keyword to the specified assets.''
* TrainzUtil remove-keyword <keyword> <KUID> [..]
:''Remove a keyword from the specified assets.''
* TrainzUtil search-by-keyword <keyword>
:''Returns a list of all assets with the specified keyword.''
* TrainzUtil commit <KUID>
:''Commit any edits that have been made to the specified asset.''
* TrainzUtil revert <KUID>
:''Discard any edits that have been made to the specified asset.''
* TrainzUtil delete <KUID>
:''Delete the specified asset from disk.''
* TrainzUtil list <KUID> [..]
:''Parses the specified kuid list into the results.''
* TrainzUtil list-latest-versions <KUID>
:''Get the latest known version of an asset. Multiple KUIDs may be specified as multiple arguments.''
* TrainzUtil list-dependencies <KUID>
:''Get an assets direct dependencies.''
* TrainzUtil list-dependants <KUID>
:''Get an assets direct dependants.''
* TrainzUtil authors
:''List of all the authorIDs that have content in the game.''
* TrainzUtil searchbycategory [-a] <CategoryList>
:''List all the local assets with a category set in this format, "CMP;MESH|BD;-ACTV|VE|SCEN". Use the -a parameter if you want to search the [[Download Station]] as well.''
* TrainzUtil filterbystatus <status> <KUID>
:''List all assets from the specified list which match the specified status flags.''
* TrainzUtil importconsists <PATH>
:''Import an old style Surveyor consist list, creating consist assets for any unknown entries.''
* TrainzUtil setnextcontentid <int>
:''Provides a 'next content ID' hint for the KUID generator.''
* TrainzUtil status <KUID>
:''Print the status of the specified asset.''
:''This will output + <KUID> : <Flags> : <category> : <username> where flags are a series of letters with case indicating boolean state. (capital letters are flagged true and lowercase are flagged false.)''
:*''Aa - The asset is archived.''
:*''Bb - The asset is builtin or packaged content.''
:*''Cc - The asset is in the base content set.''
:*''Dd - The asset is on the download station.''
:*''Ee - The asset is open for edit.''
:*''Ff - The asset is faulty.''
:*''Ii - The asset is installed locally.''
:*''Ll - The asset is locally modified.''
:*''Mm - The asset has missing dependencies.''
:*''Oo - The asset is obsolete.''
:*''Pp - The asset is listed in the DLS index as payware DLC.''
:*''Uu - The asset has an update available.''
:*''Xx - The asset is authorised for use in this Trainz installation.''
* TrainzUtil validate <KUID>
:''Perform validation and display any errors or warnings relating to this asset.''
* TrainzUtil compile <PATH>
:''Compile a script file.''
:*''<-d> Display gamescript documentation.''
:*''<-s> Silent mode.''
:*''<-bPATH> Specify a file path for the compile log.''
:*''<-pPATH> Specify the output directory.''
:*''<-oPATH> Specify the output library filename.''
:*''<PATH> Input source file.''
:*''<-iPATH> Additional include path.''
* TrainzUtil convert-config <PATH>
:''Converts a config.txt file to config.chump or vice versa.''
* TrainzUtil open-in-driver [-wait] <KUID>
:''Open the specified route or session asset in Driver. Optionally wait until the module is exited.''
* TrainzUtil open-in-surveyor [-wait] <KUID>
:''Open the specified route or session asset in Surveyor. Optionally wait until the module is exited.''
* TrainzUtil open-in-preview [-wait] <KUID>
:''Open the specified route or session asset in the asset preview tool. Optionally wait until the module is exited.''
* TrainzUtil encrypt <PATH>
:''Encrypt a script file (gs --> gse).''
* TrainzUtil export-package <device-type> <package-name> <package-build-number> [<dependency-package-name> ...] <kuid>
:''Export assets to a device package. Multiple KUIDs may be specified as multiple arguments.''
* TrainzUtil update-package <package-name>
:''Update prebuilt data within a package.''
* TrainzUtil install-package <PATH>
:''Install a package from the specified path.''
* TrainzUtil clean-package [-a] <package-name>
:''Remove the local build's prebuilt data from within a package. Use the -a parameter if you want to strip all prebuilt data.''
* TrainzUtil uninstall-package <package-name>
:''Uninstall the specified package.''
* TrainzUtil list-package-assets <package-name>
:''List the assets available in the specified package.''
* TrainzUtil downloadcontentlistings
:''Fully download the latest content listings.''
* TrainzUtil listbuilds <PATH>
:''Print the list of installed build numbers to a file.''
* TrainzUtil quit
:''Requests the GUI to close.''
* TrainzUtil async <command..>
:''Begins running the specified command asynchronously.''
* TrainzUtil sync
:''Waits for all async commands to complete.''
* TrainzUtil wait <seconds>
:''Pause for the specified number of seconds.''
* TrainzUtil @<file.txt>
:''Batch-execute a series of commands from the specified text file (every argument must be between double quotes). Every line of that text file will be processed like a separate call to TrainzUtil''
* set <variable> <command..>
:''Used in a batch file, runs the specified command and overwrites the named variable with the result.''
* append <variable> <command..>
:''Used in a batch file, runs the specified command and appends the result into the named variable.''
* iferr <variable> <command..>
:''Used in a batch file, runs the specified command only if the named variable contains one or more errors.''
* iferrflag <command..>
:''Used in a batch file, runs the specified command only if an error has occurred in the batch file execution up to this point.''
* ifnone <variable> <command..>
:''Used in a batch file, runs the specified command only if the named variable contains no assets.''
* ifhas <variable> <command..>
:''Used in a batch file, runs the specified command only if the named variable contains one or more assets.''
* print <variable>
:''Used in a batch file, prints the content of the named variable.''
* printerrors <variable>
:''Used in a batch file, prints any errors contained in the named variable.''
* abort <TEXT>
:''Used in a batch files, aborts processing of the batch file immediately without raising any further errors. If arguments are present, they are logged as a single error string.''
* $(<variable>)
:''Used as a command parameter in a batch file, replaced with the KUID(s) from the specified variable.''

=Notes=
Due to the Windows command prompt treating the '<' and '>' characters as pipe operators, be sure to include quotes around any KUID parameters. For example:

trainzutil delete "<kuid:87854:982511580>"

[[Content Creation]]

Help:Moving Content

2018-11-26T20:39:50Z

Zikchil: /* Creating a New Local Data Folder */

Trainz stores additional content and user settings separately from the Trainz installation folder. A platform-specific default path is used, which can be accessed in your platform-specific file manager as described below. This folder may grow to a substantial size over time. If required, you may specify an alternate location for storing your content.

These instructions apply to TANE build 82340 and above. The same steps can be used for TRS2019, just replace 'TANE' with 'TRS2019' for folder names!

=Locating your Local Data Folder=

From the launcher of any Trainz installation, you can click the "Trainz Settings" button and then switch to the "Install" tab to see the full path to that installation's local data folder. You can navigate directly to that path using your system's file manager, however please keep in mind that the parent folders of the default location may be hidden on some systems so simply starting at the top level of your computer and working your way down may not work.

In order to navigate directly to the local data folder's default location, the following steps can be used:

==Windows==
In Windows, the local data folder is stored by default at a subfolder of "C:\Users\<username>\AppData\Local\N3V Games\TANE" (where "<username>" is the username of the logged-in Windows user account.)

You may access this location in Windows Explorer by entering the path "%appdata%\..\Local\N3V Games\TANE" into the Window Explorer address bar. At this location you will see one or more local data folders, corresponding with your various Trainz installations. The name of each folder here includes a random character string which has no meaning but simply allows for multiple installs to coexist without overwriting each other's data files.

You will also find a text file at this location named "userdata-redirect-map.txt" which lists the correlation between each Trainz installation and its local data folder. While it is possible to hand-edit this file using a program such as WordPad.exe, it is not recommended due to the potential for data loss.

==Mac OS X==
In Mac OS X, the local data folder is stored by default at a subfolder of "/Users/<username>/Library/Containers/com.n3vgames.tane" (where "<username>" is the username of the logged-in Mac OS X user account.)

You may access this location in Finder by using "Go To" (command-shift-G) and then entering the address "~/Library/Containers/com.n3vgames.tane/Data". At this location you will see one or more local data folders, corresponding with your various Trainz installations. The name of each folder here includes a random character string which has no meaning but simply allows for multiple installs to coexist without overwriting each other's data files.

You will also find a file at this location named "userdata-redirect-map.txt" which lists the correlation between each Trainz installation and its local data folder. It is typically not possible to hand-edit this file due to the way that Mac OS X encodes file paths.

=Copy\Move\Archive your Local Data Folder=

# Open "Launcher > Trainz Settings > Install tab".
#:* Note the path displayed in the "Local Data Folder" field (this is your current data directory where your user content resides).
#:* <i>Recommended...</i>
#::* Highlight and Copy this path to Notepad.
#::* Verify all other tabs contain the settings you want, including your authentication credentials.<br>
# Open Windows Explorer and navigate to the current data folder (you may paste the path from step 1 to open directly).
# Open a second instance of Windows Explorer and create a new empty folder at the desired location (e.g. D:\TANE_Content)
#:* Highlight and Copy this new path to your clipboard
#:* Paste this new path into the "Local Data Folder" field
# Close the Settings dialog
#:* ...there will be a prompt telling you about restarting, acknowledge it.
#:* ...close the Launcher
# Focus on the first instance of Windows Explorer, copy all files\folders here into the new folder (the 2nd instance of Explorer).
#:* i.e. folders like backup, cache, etc plus assets.tdx and keystore.tdx.
# Start the launcher
#:* If you're watching the new directory in Explorer you'll see some changes occur (files added).
# '''OPTIONAL''' - Access "Trainz Settings".
#:* All settings verified in step 1 should be present on all tabs.
# Click "Start Trainz"
# Application will launch as expected.
#:* If content is missing, or if a database repair commences, or you're prompted to login, you have made a mistake and will need to re-check the settings above.
<br>
'''Benefits of this process...'''
* Provides a method for you to create data directories using naming conventions easily tracked by humans (as opposed to the machine name Trainz generates for its folders)
* Allows you to move content between builds and patches without resorting to CDP export\import.
* Allows you to work independently from your "source content" making changes without risk and...,
* Point back to your old folder anytime you need a reference or to check "how it worked" before you started modifying content.
* Creates a backup of the "old" content folder and optionally archive\delete the old folder to free up space.

'''WARNING:'''
* DO NOT ever delete the C:\Users\<pc name>\AppData\Local\N3V Games\TANE folder OR the userdata-redirect-map.txt file in that folder.
:* This file is required by TANE to ensure the Local Data Folder is found.
:* If the redirect file does not exist, TANE will create a new one and create a new local data folder in the default location and you are back to your starting point.
<br>
'''TROUBLESHOOTING:'''
* If a new unused /build xxxxxxxx folder is created in the default location upon restarting, you have not followed the steps correctly - please review the steps again.
* If you are asked to enter your username again, you have not followed the steps correctly - please review the steps again.

=Creating a New Local Data Folder=

Sometimes your Local Data Folder can end up with corrupt data. In this case, the solution is to create a new folder which contains no 3rd party content. From there, you can then IMPORT your old content and work out which items may be causing issues.

# Open the Launcher > Trainz Settings > Install (tab).
#:*...see the "Local Data Folder" field, this is the path for your game data.
#:*...the default path is C:\Users\<username>\AppData\Local\N3V Games\<version>\build folder
#::*The default build folder uses an alphanumeric system generated name. The next steps are important to make sure you are looking at the correct folder if you have more than one
# Highlight the full path and use Ctrl-C to copy it.
# Open Windows Explorer and paste the path into the Explorer address dropdown (usually opens to "this PC")
#:* Key-press <Enter>.
#:* You are now in your games current data directory.
# Navigate up one directory level (you can use the little "up arrow" on the left of of the address dropdown)
# Create a new folder and give it a name
# Now double-click into this new folder (it will be empty), and copy the path just like you did in the above step #2.
# Now go back to Launcher > Trainz Settings > Install tab, paste the new path, replacing the current path, in the "Local Data Folder" field
# Close the Trainz Settings form (a message will appear saying the game needs a restart, click OK, then close the Launcher too)
# Restart the game. A few things will happen
#:*...in Explorer you'll see the folder get populated with some new sub-folders and files.
#:*...the "Trainz Performance Configuration" form will open (you can set these parameter here\now or skip is and do it later on the Performance tab)
#:*...you'll need to provide your user name\password in Trainz Settings > Internet (tab)
# Click Start Trainz and complete the database build

* Now your application is pointing to a "clean data directory".

NOTE:
* This process does not copy any of your local content across.
* This process is applicable to both TANE and TRS19

Return to [[Help:TRS19|TRS19 Help Page]]
[[Category:TRS19]]
[[Category: Help]]

Help:Moving Content

2018-06-04T14:10:16Z

Zikchil: /* Copy\Move\Archive your Local Data Folder */

Trainz stores additional content and user settings separately from the Trainz installation folder. A platform-specific default path is used, which can be accessed in your platform-specific file manager as described below. This folder may grow to a substantial size over time. If required, you may specify an alternate location for storing your content.

These instructions apply to build 82340 and above.

=Locating your Local Data Folder=

From the launcher of any Trainz installation, you can click the "Trainz Settings" button and then switch to the "Install" tab to see the full path to that installation's local data folder. You can navigate directly to that path using your system's file manager, however please keep in mind that the parent folders of the default location may be hidden on some systems so simply starting at the top level of your computer and working your way down may not work.

In order to navigate directly to the local data folder's default location, the following steps can be used:

==Windows==
In Windows, the local data folder is stored by default at a subfolder of "C:\Users\<username>\AppData\Local\N3V Games\TANE" (where "<username>" is the username of the logged-in Windows user account.)

You may access this location in Windows Explorer by entering the path "%appdata%\..\Local\N3V Games\TANE" into the Window Explorer address bar. At this location you will see one or more local data folders, corresponding with your various Trainz installations. The name of each folder here includes a random character string which has no meaning but simply allows for multiple installs to coexist without overwriting each other's data files.

You will also find a text file at this location named "userdata-redirect-map.txt" which lists the correlation between each Trainz installation and its local data folder. While it is possible to hand-edit this file using a program such as WordPad.exe, it is not recommended due to the potential for data loss.

==Mac OS X==
In Mac OS X, the local data folder is stored by default at a subfolder of "/Users/<username>/Library/Containers/com.n3vgames.tane" (where "<username>" is the username of the logged-in Mac OS X user account.)

You may access this location in Finder by using "Go To" (command-shift-G) and then entering the address "~/Library/Containers/com.n3vgames.tane/Data". At this location you will see one or more local data folders, corresponding with your various Trainz installations. The name of each folder here includes a random character string which has no meaning but simply allows for multiple installs to coexist without overwriting each other's data files.

You will also find a file at this location named "userdata-redirect-map.txt" which lists the correlation between each Trainz installation and its local data folder. It is typically not possible to hand-edit this file due to the way that Mac OS X encodes file paths.

=Copy\Move\Archive your Local Data Folder=

# Open "Launcher > Trainz Settings > Install tab".
#:* Note the path displayed in the "Local Data Folder" field (this is your current data directory where your user content resides).
#:* <i>Recommended...</i>
#::* Highlight and Copy this path to Notepad.
#::* Verify all other tabs contain the settings you want, including your authentication credentials.<br>
# Open Windows Explorer and navigate to the current data folder (you may paste the path from step 1 to open directly).
# Open a second instance of Windows Explorer and create a new empty folder at the desired location (e.g. D:\TANE_Content)
#:* Highlight and Copy this new path to your clipboard
#:* Paste this new path into the "Local Data Folder" field
# Close the Settings dialog
#:* ...there will be a prompt telling you about restarting, acknowledge it.
#:* ...close the Launcher
# Focus on the first instance of Windows Explorer, copy all files\folders here into the new folder (the 2nd instance of Explorer).
#:* i.e. folders like backup, cache, etc plus assets.tdx and keystore.tdx.
# Start the launcher
#:* If you're watching the new directory in Explorer you'll see some changes occur (files added).
# '''OPTIONAL''' - Access "Trainz Settings".
#:* All settings verified in step 1 should be present on all tabs.
# Click "Start Trainz"
# Application will launch as expected.
#:* If content is missing, or if a database repair commences, or you're prompted to login, you have made a mistake and will need to re-check the settings above.
<br>
'''Benefits of this process...'''
* Provides a method for you to create data directories using naming conventions easily tracked by humans (as opposed to the machine name Trainz generates for its folders)
* Allows you to move content between builds and patches without resorting to CDP export\import.
* Allows you to work independently from your "source content" making changes without risk and...,
* Point back to your old folder anytime you need a reference or to check "how it worked" before you started modifying content.
* Creates a backup of the "old" content folder and optionally archive\delete the old folder to free up space.

'''WARNING:'''
* DO NOT ever delete the C:\Users\<pc name>\AppData\Local\N3V Games\TANE folder OR the userdata-redirect-map.txt file in that folder.
:* This file is required by TANE to ensure the Local Data Folder is found.
:* If the redirect file does not exist, TANE will create a new one and create a new local data folder in the default location and you are back to your starting point.
<br>
'''TROUBLESHOOTING:'''
* If a new unused /build xxxxxxxx folder is created in the default location upon restarting, you have not followed the steps correctly - please review the steps again.
* If you are asked to enter your username again, you have not followed the steps correctly - please review the steps again.

=Creating a New Local Data Folder=

Sometimes your Local Data Folder can end up with corrupt data. In this case, the solution is to create a new folder which contains no 3rd party content. From there, you can then IMPORT your old content and work out which items may be causing issues.

* Open the Launcher > Install tab and check the path to your Local Data Folder. The default path is C:\Users\<username>\AppData\Local\N3V Games\TANE\build xxxxxxxx
* Highlight the full path name and use Ctrl-C to copy
* Close TANE (and check in Task Manager that it has ended - this may take a few minutes in some circumstances)
* Use Crtl-V to paste the path into Windows Explorer
* Go up one directory level and rename the folder by adding "-old" to the name (this effectively creates a backup for you)
* Open a NEW Windows Explorer window and create a Folder in the desired location (e.g. D:\TANE_data)
* Open Launcher > Trainz Settings > Install tab and browse to find your new folder (D:\TANE_data) then click Select Folder
* Close TANE (a message will appear saying the game needs a restart)
* Restart TANE and check your Install path is pointing to the new location.
* Click Start Trainz and wait for TANE to complete a database rebuild (this should only take a few minutes)

Now your TANE install points to the new Local Data Folder at the new location.
NOTE: This process does not copy any of your local content across.

Help:Moving Content

2018-03-12T19:30:13Z

Zikchil: /* Moving your Local Data Folder */

Trainz stores additional content and user settings separately from the Trainz installation folder. A platform-specific default path is used, which can be accessed in your platform-specific file manager as described below. This folder may grow to a substantial size over time. If required, you may specify an alternate location for storing your content.

These instructions apply to build 82340 and above.

=Locating your Local Data Folder=

From the launcher of any Trainz installation, you can click the "Trainz Settings" button and then switch to the "Install" tab to see the full path to that installation's local data folder. You can navigate directly to that path using your system's file manager, however please keep in mind that the parent folders of the default location may be hidden on some systems so simply starting at the top level of your computer and working your way down may not work.

In order to navigate directly to the local data folder's default location, the following steps can be used:

==Windows==
In Windows, the local data folder is stored by default at a subfolder of "C:\Users\<username>\AppData\Local\N3V Games\TANE" (where "<username>" is the username of the logged-in Windows user account.)

You may access this location in Windows Explorer by entering the path "%appdata%\..\Local\N3V Games\TANE" into the Window Explorer address bar. At this location you will see one or more local data folders, corresponding with your various Trainz installations. The name of each folder here includes a random character string which has no meaning but simply allows for multiple installs to coexist without overwriting each other's data files.

You will also find a text file at this location named "userdata-redirect-map.txt" which lists the correlation between each Trainz installation and its local data folder. While it is possible to hand-edit this file using a program such as WordPad.exe, it is not recommended due to the potential for data loss.

==Mac OS X==
In Mac OS X, the local data folder is stored by default at a subfolder of "/Users/<username>/Library/Containers/com.n3vgames.tane" (where "<username>" is the username of the logged-in Mac OS X user account.)

You may access this location in Finder by using "Go To" (command-shift-G) and then entering the address "~/Library/Containers/com.n3vgames.tane/Data". At this location you will see one or more local data folders, corresponding with your various Trainz installations. The name of each folder here includes a random character string which has no meaning but simply allows for multiple installs to coexist without overwriting each other's data files.

You will also find a file at this location named "userdata-redirect-map.txt" which lists the correlation between each Trainz installation and its local data folder. It is typically not possible to hand-edit this file due to the way that Mac OS X encodes file paths.

=Copy\Move\Archive your Local Data Folder=

# Open "Launcher > Trainz Settings > Install tab".
#:* Note the path displayed in the "Local Data Folder" field (this is your current data directory where your user content resides).
#:* <i>Recommended...</i>
#::* Highlight and Copy this path to Notepad.
#::* Verify all other tabs contain the settings you want, including your authentication credentials.<br>
# Open Windows Explorer and navigate to the current data folder (you may paste the path from step 1 to open directly).
# Open a second instance of Windows Explorer and create a new empty folder at the desired location (e.g. D:\TANE_Content)
#:* Highlight and Copy this new path to your clipboard
#:* Paste this new path into the "Local Data Folder" field
# Close the Settings dialog
#:* ...there will be a prompt telling you about restarting, acknowledge it.
#:* ...close the Launcher
# Focus on the first instance of Windows Explorer, copy all files\folders here into the new folder (the 2nd instance of Explorer).
#:* i.e. folders like backup, cache, etc plus assets.tdx and keystore.tdx.
# Start the launcher
#:* If you're watching the new directory in Explorer you'll see some changes occur (files added).
# '''OPTIONAL''' - Access "Trainz Settings".
#:* All settings verified in step 1 should be present on all tabs.
# Click "Start Trainz"
# Application will launch as expected.
#:* If content is missing, or if a database repair commences, or you're prompted to login, you have made a mistake and will need to re-check the settings above.
<br>
'''Benefits of this process...'''
* Provides a method for you to create data directories using naming conventions easily tracked by humans (as opposed to the machine name Trainz generates for its folders)
* Allows you to move content between builds and patches without resorting to CDP export\import.
* Allows you to work independently from your "source content" making changes without risk and...,
* Point back to your old folder anytime you need a reference or to check "how it worked" before you started modifying content.
* Creates a backup of the "old" content folder and optionally archive\delete the old folder to free up space.

----

'''WARNING:'''
* DO NOT ever delete the C:\Users\<pc name>\AppData\Local\N3V Games\TANE folder OR the userdata-redirect-map.txt file in that folder.
:* This file is required by TANE to ensure the Local Data Folder is found.
:* If the redirect file does not exist, TANE will create a new one and create a new local data folder in the default location and you are back to your starting point.
<br>
'''TROUBLESHOOTING:'''
* If a new unused /build xxxxxxxx folder is created in the default location upon restarting, you have not followed the steps correctly - please review the steps again.
* If you are asked to enter your username again, you have not followed the steps correctly - please review the steps again.

=Creating a New Local Data Folder=

Sometimes your Local Data Folder can end up with corrupt data. In this case, the solution is to create a new folder which contains no 3rd party content. From there, you can then IMPORT your old content and work out which items may be causing issues.

* Open the Launcher > Install tab and check the path to your Local Data Folder. The default path is C:\Users\<username>\AppData\Local\N3V Games\TANE\build xxxxxxxx
* Highlight the full path name and use Ctrl-C to copy
* Close TANE (and check in Task Manager that it has ended - this may take a few minutes in some circumstances)
* Use Crtl-V to paste the path into Windows Explorer
* Go up one directory level and rename the folder by adding "-old" to the name (this effectively creates a backup for you)
* Open a NEW Windows Explorer window and create a Folder in the desired location (e.g. D:\TANE_data)
* Open Launcher > Trainz Settings > Install tab and browse to find your new folder (D:\TANE_data) then click Select Folder
* Close TANE (a message will appear saying the game needs a restart)
* Restart TANE and check your Install path is pointing to the new location.
* Click Start Trainz and wait for TANE to complete a database rebuild (this should only take a few minutes)

Now your TANE install points to the new Local Data Folder at the new location.
NOTE: This process does not copy any of your local content across.

Help:Surveyor Layers Tools

2017-11-10T16:08:22Z

Zikchil:

When you create a new route, you are by default adding objects to the route layer and so they will be present in any session created for the route.
*To switch to working in a session layer, open the layers tab and Click LMB where it says “Session-layer”.
*Objects you add will now be placed in the session layer.
*To move the object to a different layer, use the Properties Tool (the '?') and left click on the object to move. Then scroll to the new layer by using the spinners on either side of the Layer name.

If you Click Place a scenery object on a new route, Click on a scenery object, then on the Edit Properties button (N). Beside an option to name the object, which layer the object is on can be seen. To move the object to another layer scroll to that layer by using the spinners on either side of the Layer name.

[[File:layers.jpg|400px]]
{{clear}}
== What are Layers? ==
Layers allow you to split design elements into easily manageable sections. In T:ANE, Layers work in the same way as many other graphical editing applications.

You can lock Layers so that anything associated with them cannot be edited and you can hide Layers to make your Route easier to work with. For example, you can add all trees in a “Tree Layer” then use Hide Layer to hide all the trees while you continue working on other aspects of the Route or Session.

Layers exist in either the Route or a Session. Layers applied to a Route are available to all Sessions for that Route, whereas layers applied to a Session are only available for that Session.

So think of the "Route" as things that never (or rarely) change such as the terrain, the forests and scenery, and the track. The "Session" contains those things that often change such as which trains are placed on the tracks and which commands are given to which trains etc.

== [[File:layer hide.jpg]] Hide Layer ==

Click LMB on Hide Layer to clear space when working on a route, Click again to make it appear.
{{clear}}

== [[File:layer lock.jpg]] Lock Layer ==

{{clear}}
Click LMB on Lock Layer to prevent edits from being made, Click again to enable it.

== [[File:object add.jpg]] Add Layer ==

{{clear}}
Click LMB on the
Add Layer button. Enter a name for the new layer
and select Route level or Session level in the popup
dialogue and accept.

== [[File:area cancel.jpg]] Delete Layer ==

{{clear}}
Select a layer and Click LMB on the Delete Layer
button to remove it.

== [[File:layer merge.jpg]] Merge Layer ==

{{clear}}
Select a layer and Click LMB on Merge Layers button.
A popup dialogue gives you the option to choose a
specific layer to merge with.

== [[File:lock entire route.jpg]] Lock Entire Route ==
Click LMB on Lock Entire Route to disable editing on all layers. Ideal for preventing accidental changes when inspecting whole routes.
{{clear}}

;<big> See Also </big>
* [[Help:Surveyor_Tools]]
* [[Help:Surveyor]]
* [https://youtu.be/KoXvafsMC3k Understanding Layers in Surveyor Video]

[[Category:Help|Surveyor Tools Layers]]

TrainzUtil

2017-11-08T16:36:31Z

Zikchil: /* Usage */

Help:VE61

2017-11-01T16:08:21Z

Zikchil:

'''Required tag ''tagname'' was missing and has been set to default.'''

A top-level tag that defines a value that is required for this asset was not found in the [[config.txt file]]. A default value has been supplied for the tag for validation purposes.

<b><u>For Example:</u></b>

! VE61: Required tag 'interior-controls-type' was missing and has been set to default.

The asset will be configured with the default for the interior controls type (type ''full'' for this example).

Notes
*In some cases the default value may be unsuitable and may create an error.
*The error message displayed may contain text other than what's in this example such as, 'mesh-table-lod-transition-distances'. Whatever tag is missing is referenced in this manner.

[[Category:Validation Errors]]