Trainz/Kinds/kind engine
KIND Engine assets are classified as rolling stock which contain diesel or electric loco engine performance characteristics. The related sister-KIND or class asset is kind steam-engine which uses many if not all of the same (sub-)containers or Child classes listed below, but has a different pallet of base data which needs be modeled and defined in the parent class (i.e. the container 'KIND Engine'—those tags and special KIND containers discussed here below). This modular breakout should make working with configs easier for the new and old Trainzers to get a handle on.
|
|||
|
Historical engine-specs
editFormats of engine specifications evolved from the earliest Trainz versions, perhaps more than any other digital modeling group of assets, which is readily understandable given the dependency of a locomotive's driving behavior (the physical reality modeled and simulated in a digital virtual world) depend more than any other class of object on tight interaction between scripting, animation elements, and the physics model within Trainz. Unfortunately, the older Content Creator's Guides (early era, HTML pages and files, after UTC as *.pdf files) were also generally kept online for ease of updating, and cannot now*[notes 1] be readily accessed by new comers or others interested in comparing different digital models.
|
The containers and gross changes in engine-specs may be compared to the current grouping of tags and containers by seeing the CCGTC Online page: Kind: Engine.
KIND Hierarchy
edit This Trainz/Kinds/kind engine section is a stub placeholder, an outline or marker that this section of the book is otherwise incomplete. You can help the Wikibooks Trainz project by expanding it with fuller discussion of the topic. Work needed: Need some background text here! |
Parent Classes
editChild Classes-containers
editThe engine child data structures are termed containers in Trainz and each defines the parameters and variables the simulator software needs to produce a dynamic working 3D asset.
Supported Tags
editkind "engine" throttle-power { } dynamic-brake { } pressure { } mass { } motor { } flowsize { } volume { } scale "" epbrakes "" (Obsolete tag) autopilot-stop-distance 5.0 autopilot-crawl-distance 20.0 autopilot-caution-speed-multiplier 0.5 throttle-adjustment-rate 0.01
throttle-power
edit- Type: throttle-power Container
- Desc: Acceleration variables in cabin mode.
dynamic-brake
edit- Type: dynamic-brake Container
- Desc: Deceleration variables while dynamic braking in cabin mode.
pressure
edit- Type: pressure Container
- Desc: TBD
mass
edit- Type: mass Container
- Desc: TBD
motor
edit- Type: motor Container
- Desc: TBD
flowsize
edit- Type: flowsize Container
- Desc: TBD
volume
edit- Type: volume Container
- Desc: TBD
scale
edit- Type: Obsolete
- Desc: Obsolete
- Type: Obsolete single value
- Desc: Obsoleted in release of TS2009
- Corrective action: Move into description block text or delete line.
autopilot-stop-distance
edit- Type: float
- Desc: How far (in meters) in front of a typical obstruction (red light, etc.) the AI will attempt to stop the train. Changing this value can help fine-tune the accuracy of the AI's movement, however attempting to make the train stop too close to a target may result in overruns in some cases. This tag is intended for special-case usage only.
autopilot-crawl-distance
edit- Type: float
- Desc: Once this distance (in meters) from the intended stopping position has been reached, the AI will 'crawl' rather than attempt to speed up to reach its destination. Changing this value can help fine-tune the accuracy of the AI's movement, however attempting to make the train stop too close to a target may result in overruns in some cases. This tag is intended for special-case usage only.
autopilot-caution-speed-multiplier
edit- Type: float
- Desc: The AI will slow to this multiple of the speed limit when operating under caution conditions. This can be set to 1.0 in order to effectively remove caution-speed driving, however this can increase the risk of overruns in some cases
throttle-adjustment-rate
edit- Type: float
- Desc: Defines the adjustment rate at which the engine's throttle will adjust to match the train's throttle. Increasing this rate will make the engine more responsive at the possible cost of audio or driving realism. In DCC mode, a minimum value of 0.1 is used.
Example Config.txt
editSample config.txt file for an enginespec asset, with the Standard Tags excluded for brevity:∅
Downloads
editAttach sample files here?
Footnotes
editThis reference page is adapted from the TrainzOnline Wiki under the CC-BY-SA 3.0 License. This page will likely include more textual explanations, exposition, history, and/or examples than the source page on the same topic. The TrainzOnline Wiki is for the most part maintained by the programmers or knowledgeable content creators and may have newer more up-to-date information on the current trainz-build code standards, which have some tendency to change as features are added to the software. |