TrainzOnline - User contributions [en]

Tools

2009-02-17T04:11:50Z

Wozzel: /* Auran-provided Tools */

=Auran-provided Tools=

The following executable tools are made available to Trainz users.

[[Content Manager]] - ''Auran's included content management GUI, which provides functionality for downloading, installing, managing and building custom content.''

[[Content Creator Plus]] - ''Auran's included content creation GUI, which provides functionality for creating, editing, viewing and validating asset configurations.''

[[Trainz Mesh Importer]] - ''An xml-to-im converter that can be used to simplify conversion of models from various formats into Trainz .im format.''

[[TrainzUtil]] - ''A command line content management tool.''

=Third-party Tools=

The following Trainz-related tools are maintained by Trainz 3rd-party developers.

[[Trainz Tools by PEV]] - ''View images of all texture types used in TS2009, and convert them to BMP files using "Texture Viewer", or convert any texture file to a TGA with appropriate texture.txt file with "Texture2TGA", or convert PM's to IM's with "PM2IM".''

More ''TBD''

=Native APIs=

Auran provides some native (C++) libraries which allow Trainz 3rd-party developers to access specific Trainz internal files and functionality which are otherwise opaque. These are provided in DLL form within the Trainz installation, and should not be redistributed as their implementation is specific to each Trainz install version.

[[TrainzNativeInterface]] - A helper DLL which provides the basic functionality for communication between Trainz executables and third-party DLLs.

=Documentation=

[[Command Line Guidelines]] - ''Details guidelines for developing Trainz-related command-line utilities with the intention of creating a standardised, easy-to-use interface.''

''TBD''

Content Creator Plus

2009-02-17T04:08:28Z

Wozzel:

Content Creator Plus is Auran's included content creation GUI.

'''Functionality'''

Content Creator Plus is intended to address the following functions:
* Create new asset configurations.
* Edit and View existing asset configurations.
* Validate asset configurations.

'''Ideology'''

Content Creator Plus is designed to allow content creators to easily create and edit asset configurations.

KIND Behavior

2009-01-06T06:35:16Z

Wozzel:

KIND Behavior is a a configurable behavior module that forms part of a
session.

==KIND Hierarchy==
===Parent Classes===
* ''none.''

===Child Classes===
* ''none.''

==Supported Tags==
Each Behavior asset supports the following tags. Each tag is shown here with its default value.
* ''none.''

==Example Config.txt==
Sample [[config.txt file]] for a library asset:

username "testBehavior"
kind "behavior"
kuid <kuid:171456:100035>
script "behavior"
class "DisplayHTMLRule"
trainz-build 2.9
category-class "YH"
category-region "00"
category-era "2000s"
description "Test Behavior asset, displays an Html file."
icon-texture "html_type.tga"

string-table
{
html_description "Display page <a href=live://property/page>$0</a> of html asset <a href=live://property/asset>$1</a> in a new in-game window."
description "Display a page from a HTML asset in a browser window."
description_info "Display page ''$0'' of html asset ''$1'' in a new in-game window."
display-name-page "HTML page name"
display-desc-page "Name of HTML page without the .html extension"
display-name-asset "HTML asset"
display-desc-asset "HTML asset where the page can be found"
click_to_select "click to select"
}

thumbnails
{
0
{
image "thumb.jpg"
width 240
height 180
}
}

==Downloads==
''Attach sample files here?''

==Categories==
[[Category:Asset KIND]]

KIND Library

2009-01-06T06:13:27Z

Wozzel:

KIND Library is a coded module that interacts with other coded modules.

==KIND Hierarchy==
===Parent Classes===
* ''none.''

===Child Classes===
* ''none.''

==Supported Tags==
Each Library asset supports the following tags. Each tag is shown here with its default value.
* ''none.''

==Example Config.txt==
Sample [[config.txt file]] for a library asset, with the Standard Tags excluded for brevity:

[[TagName_Kind|kind]] "library"
script "LibraryScript.gs"
class "LibraryClass"

==Downloads==
''Attach sample files here?''

==Categories==
[[Category:Asset KIND]]

KIND HTML-asset

2009-01-06T05:57:53Z

Wozzel:

KIND html-asset can be referenced from the scripts and from
some of the Surveyor rules (i.e. you select the html-asset
by name, then type in the name of the *.html fle in the
small edit box).

A typical example of KIND html-asset in use is the in-game tutorial.

==KIND Hierarchy==
===Parent Classes===
* ''none.''

===Child Classes===
* ''none.''

==Supported Tags==
Each HTML asset supports the following tags. Each tag is shown here with its default value.
* ''none.''

==Example Config.txt==
Sample [[config.txt file]] for a html-asset, with the Standard Tags excluded for brevity:

[[TagName_Kind|kind]] "html-asset"
[[TagName_Username|username]] "My HTML Page"
[[TagName_Kuid|kuid]] <KUID2:####:#####:0>

==Downloads==
See HTML Tutorials for examples

==Categories==
[[Category:Asset KIND]]