TrainzOnline - User contributions [en]

File:TrainzScriptNpp.rar

2020-11-22T18:51:29Z

Callavsg: Callavsg uploaded a new version of "File:TrainzScriptNpp.rar"

Syntax highlightning files for use with Notepad++

User:Callavsg

2020-11-22T18:38:35Z

Callavsg:

I'm just a normal guy living in Germany. I have a normal job with working for Amazon in Workflow Management.

Writing code in my free time now for 14 years, mainly by using C++. I like to experiment, find hacks/workarounds and always try to find another point of view.

[[Category:Script Creators]]

Callavsg's Scripting Tools

2020-11-22T18:34:17Z

Callavsg: /* Syntax Highlighting */

==Syntax Highlighting==

Syntax highlightning is one of the basics that makes your life easier when writing code.

[[Media:TrainzScriptNpp.rar]] offers you even this and also includes auto-completion for Notepad++. Just follow the ReadMe.txt and have fun!

[[File:Syntax_highlight.png|758px]]

==Exit==

[[Tools|Return to Tools]]

File:Syntax highlight.png

2020-11-22T18:31:01Z

Callavsg:

Callavsg's Scripting Tools

2020-11-22T18:28:52Z

Callavsg:

==Syntax Highlighting==

Syntax highlightning is one of the basics that makes your life easier when writing code.

[[Media:TrainzScriptNpp.rar]] offers you even this for Notepad++. Just follow the ReadMe.txt and have fun!

==Exit==

[[Tools|Return to Tools]]

Tools

2020-11-22T18:26:42Z

Callavsg: /* Third-party 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.

[[AssetX Wiki|AssetX]] - ''A multi purpose toolbox by Andi06 and PEV designed to view, edit and repair the majority of files used in all versions of TRS from TRS2004 onwards.''

[[Basemapz]] - ''A tool to assist in creating Model Trainz baseboards from scale plans by ModelerMJ.''

[[Retain My Asset Names]] (RMAN) - ''A Trainz Asset Name management and organization tool that projects user-assigned custom asset names from a local user database across various and future Trainz version asset libraries (by [https://forums.auran.com/trainz/member.php?41964-deneban deneban])

[[Shane Turner's Trainz Tools]] - ''Tools to enhance and help resolve some Trainz technical problems. Hosted on the same site as the PEV Trainz Tools''

[[Trainz Tools by PEV]] - ''Editing and repair tools for most Trainz Content files. Shane Turner now hosts these.''

[[TransDEM]] - Converts digital elevation files to efficently model prototype railroads.

[[vvmm's Trainz Tools]] - Tools for opening TZarc files, explore CDP files contents, list kuids etc.

[[callavsg's Scripting Tools]] - Tools for scripting, such as synatx highlighting and No-Code tools

More ''TBA''

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

[[Category:TBD]]
[[Category:Trainz Wiki]]

Tools

2020-11-22T18:25:29Z

Callavsg: /* Third-party 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.

[[AssetX Wiki|AssetX]] - ''A multi purpose toolbox by Andi06 and PEV designed to view, edit and repair the majority of files used in all versions of TRS from TRS2004 onwards.''

[[Basemapz]] - ''A tool to assist in creating Model Trainz baseboards from scale plans by ModelerMJ.''

[[Retain My Asset Names]] (RMAN) - ''A Trainz Asset Name management and organization tool that projects user-assigned custom asset names from a local user database across various and future Trainz version asset libraries (by [https://forums.auran.com/trainz/member.php?41964-deneban deneban])

[[Shane Turner's Trainz Tools]] - ''Tools to enhance and help resolve some Trainz technical problems. Hosted on the same site as the PEV Trainz Tools''

[[Trainz Tools by PEV]] - ''Editing and repair tools for most Trainz Content files. Shane Turner now hosts these.''

[[TransDEM]] - Converts digital elevation files to efficently model prototype railroads.

[[vvmm's Trainz Tools]] - Tools for opening TZarc files, explore CDP files contents, list kuids etc.

[[callavsg's Scripting Tools]] - Tools for synatx highlighting and scripting helpers

More ''TBA''

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

[[Category:TBD]]
[[Category:Trainz Wiki]]

Callavsg's Scripting Tools

2020-11-22T18:23:28Z

Callavsg: Created page with "==Syntax Highlighting== Syntax highlightning is one of the basics that makes your life easier when writing code. Media:TrainzScriptNpp.rar offers you even this for Note..."

Tools

2020-11-22T18:17:41Z

Callavsg: /* Third-party 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.

[[AssetX Wiki|AssetX]] - ''A multi purpose toolbox by Andi06 and PEV designed to view, edit and repair the majority of files used in all versions of TRS from TRS2004 onwards.''

[[Basemapz]] - ''A tool to assist in creating Model Trainz baseboards from scale plans by ModelerMJ.''

[[Retain My Asset Names]] (RMAN) - ''A Trainz Asset Name management and organization tool that projects user-assigned custom asset names from a local user database across various and future Trainz version asset libraries (by [https://forums.auran.com/trainz/member.php?41964-deneban deneban])

[[Shane Turner's Trainz Tools]] - ''Tools to enhance and help resolve some Trainz technical problems. Hosted on the same site as the PEV Trainz Tools''

[[Trainz Tools by PEV]] - ''Editing and repair tools for most Trainz Content files. Shane Turner now hosts these.''

[[TransDEM]] - Converts digital elevation files to efficently model prototype railroads.

[[vvmm's Trainz Tools]] - Tools for opening TZarc files, explore CDP files contents, list kuids etc.

[[callavsg's Scripting Tools]] - Tools for synatx highlightning and scripting helpers

More ''TBA''

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

[[Category:TBD]]
[[Category:Trainz Wiki]]

File:TrainzScriptNpp.rar

2020-11-22T18:16:15Z

Callavsg: Syntax highlightning files for use with Notepad++

Syntax highlightning files for use with Notepad++

Class Browser

2019-04-12T09:16:53Z

Callavsg: /* SetElementObjectProperty */

*[[TrainzScript Language Reference|API Hierarchy]]
**[[Class GSObject|GSObject]] *
***[[Class GameObject|GameObject]]
****Browser
 

*This class provides an interface with the Trainz [[MiniBrowser]] allowing the programmer to provide a simple HTML interface.
*The browser supports a small subset of HTML code.
*Muliple browsers are supported.
*To create a new Browser, use [[Class Constructors#NewBrowser|Constructors.NewBrowser()]].
*To populate with HTML code use either [[#LoadHTMLString|LoadHTMLString]] or [[#LoadHTMLFile|LoadHTMLFile]]
*Refer to the [[MiniBrowser]] page for details of supported tags.
 

==Messages==
*Messages sent to and from Browser objects are listed below:
 
{{TableHeader|width=50%|margin=15px}}
|-
|bgcolor="#EEEEEE"|'''Major'''||bgcolor="#EEEEEE"|'''Minor'''||bgcolor="#EEEEEE"|'''Source'''||bgcolor="#EEEEEE" |'''Destination'''
|-
|[[Browser Messages|Browser-URL]]||''URL''||Browser||Broadcast
|-
|[[Browser Messages|Browser-Closed]]||null||Browser||Broadcast
|}
 
*The ''URL '' in a ''Browser-URL'' message uses a special hyperlink tag in the form ''live://linkname''.
*If your HTML contains the link ''<a href=live://anthem>Play the national anthem</a>'' and the user clicks on the link, then the Browser-URL message will take the form of ''Browser-URL,live://anthem'' and your script can intercept the message and respond accordingly.
*Since messages from Browser objects are always broadcast it is crucial that you ensure that the message is originating from the expected window. You can do this by inspecting the source of the message.
*When the user closes the browser window by either clicking on the close button or pressing the Esc key, a message with a ''Browser-Closed'' message is broadcast. The Browser object would normally be reset to null in response, so that the browser window disappears.
 

==Constants==
*Constants defined in this class are:
 
{{TableHeader|width=95%|margin=15px}}
|bgcolor=#EEEEEE|Browser Window Styles||bgcolor=#EEEEEE|
|-
|width=300|public define int STYLE_NO_FRAME = 0 ||Frameless Browser (not in a bordered window).
|-
|public define int STYLE_DEFAULT = 1 ||Default browser style. This is defined by Trainz itself and usually means the browser window will have a framed border.
|-
|public define int STYLE_TOOLTIP = 2 ||Browser with no frame and no facility for user interaction.
|}
 

==General Methods==
===BringToFront===
{{MethodHeader|public native void BringToFront(void)}}
;Parameters
*None
;Returned Value
*None
;Syntax
browser.BringToFront();
;Notes
*Brings the window in front of all other browsers.
 

===GetAsset===
{{MethodHeader|public native Asset GetAsset(void)}}
;Parameters
*None
;Returned Value
*The Asset from which this Browser is loading html data and resources.
;Syntax
Asset asset = browser.GetAsset();
;Notes
*The returned asset will be the asset used in the last call to [[#LoadHTMLFile|LoadHTMLFile]] or [[#LoadHTMLString|LoadHTMLString]].
*If there has been no such call the returned value will be null.
 

===GetWindowVisible===
{{MethodHeader|public native bool GetWindowVisible(void)}}
;Parameters
*None
;Returned Value
*True to indicate that the browser is currently visible on screen, false that the browser is hidden.
;Syntax
hidden = !browser.GetWindowVisible();
;Notes
 

===LoadHTMLFile===
{{MethodHeader|public native void LoadHTMLFile(Asset asset, string filename)}}
;Parameters
*'''asset''' = reference to the asset where the HTML file and other resources are located.
*'''filename''' = HTML file to load, may include a relative path specifier.
;Returned Value
*None
;Syntax
browser.LoadHTMLFile(resourceAsset,"/html/File-01.html");
;Notes
*The asset may be of any type, as long as the appropriate files are included in its folder structure.
 

===LoadHTMLString===
{{MethodHeader|public native void LoadHTMLString(Asset asset, string htmlData)}}
;Parameters
*'''asset''' = reference to the asset where any resources required are located.
*'''htmlData''' = string containing HTML code to load into browser.
;Returned Value
*None
;Syntax
browser.LoadHTMLString(resourceAsset,htmlData);
;Notes
*The asset may be of any type, as long as the appropriate files are included in its folder structure.
 

===ResetScrollBar===
{{MethodHeader|public native void ResetScrollBar(void)}}
;Parameters
*None
;Returned Value
*None
;Syntax
browser.ResetScrollBar();
;Notes
*Moves the scrollbar grip and the html contents to the top.
 

===SetCloseEnabled===
{{MethodHeader|public native void SetCloseEnabled(bool enabled)}}
;Parameters
*'''enabled''' = Set to false to prevent the user from closing the browser, set to true to enable closure.
;Returned Value
*None
;Syntax
browser.SetCloseEnabled(false);
;Notes
 

===SetParam===
{{MethodHeader|public native void SetParam(int index, string value)}}
;Parameters
*'''index''' = index of parameter to set.
*'''value''' = string value to assign to the specified parameter.
;Returnd Value
*None
;Syntax
browser.SetParam(2,"Birmingham New Street");
;Notes
*HTML code may contain changeable parameters denoted by the placeholder characters ''$#'', where # is a number.
*SetParam() intructs the parser to substitute the text in the function parameter for the placeholder when the browser is loaded.
 

===SetScrollEnabled===
{{MethodHeader|public native void SetScrollEnabled(bool enabled)}}
;Parameters
*'''enabled''' = Set to false to prevent the user from scrolling the browser, set to true to enable.
;Returned Value
*None
;Syntax
browser.SetScrollEnabled(false);
;Notes
 

===SetWindowStyle===
{{MethodHeader|public native void SetWindowStyle(int style)}}
;Parameters
*'''style''' = One of the [[#Constants|Browser Window Style]] constants defining the type of browser to be provided.
;Returned Value
*None
;Syntax
browser.SetWindowStyle(Browser.STYLE_DEFAULT);
;Notes
 

===SetWindowVisible===
{{MethodHeader|public native void SetWindowVisible(bool visible)}}
;Parameters
*'''visible''' = true to show the browser window, false to hide it.
;Returned Value
*None
;Syntax
SetWindowVisible(!GetWindowVisible());
;Notes
 

==Browser Size & Position==
*This group of methods are used to retrieve and set the position and size of the Browser window.
*A pixel coordinate system is used with 0,0 being the top left and ScreenWidth - 1, ScreenHeight - 1 being the bottom right.
===GetWindowLeft===
{{MethodHeader|public native int GetWindowLeft(void)}}
*Retrieves the pixel coordinate of the left hand edge.
===GetWindowTop===
{{MethodHeader|public native int GetWindowTop(void)}}
*Retrieves the pixel coordinate of the top edge.
===GetWindowRight===
{{MethodHeader|public native int GetWindowRight(void)}}
*Retrieves the pixel coordinate of the right hand edge.
===GetWindowBottom===
{{MethodHeader|public native int GetWindowBottom(void)}}
*Retrieves the pixel coordinate of the bottom edge.
===GetWindowWidth===
{{MethodHeader|public native int GetWindowWidth(void)}}
*Retrieves the width of the window in pixels.
===GetWindowHeight===
{{MethodHeader|public native int GetWindowHeight(void)}}
*Retrieves the height of the window in pixels.
;Parameters
*None
;Syntax
int width = browser.GetWindowWidth();
;Notes
 

===SetWindowLeft===
{{MethodHeader|public native void SetWindowLeft(int left)}}
*Sets the pixel coordinate of the left hand edge.
===SetWindowTop===
{{MethodHeader|public native void SetWindowTop(int top)}}
*Sets the pixel coordinate of the top edge.
===SetWindowRight===
{{MethodHeader|public native void SetWindowRight(int right)}}
*Sets the pixel coordinate of the right hand edge.
===SetWindowBottom===
{{MethodHeader|public native void SetWindowBottom(int bottom)}}
*Sets the pixel coordinate of the bottom edge.
===SetWindowRect===
{{MethodHeader|public native void SetWindowRect(int left, int, top, int right, int bottom)}}
*Sets the pixel coordinates of all four edges in a single call.
===SetWindowWidth===
{{MethodHeader|public native void SetWindowWidth(int width)}}
*Sets the width of the window in pixels.
===SetWindowHeight===
{{MethodHeader|public native void SetWindowHeight(int height )}}
*Sets the height of the window in pixels.
===SetWindowSize===
{{MethodHeader|public native void SetWindowSize(int width, int height )}}
*Sets the height and width of the window in pixels.
===SetWindowPosition===
{{MethodHeader|public native void SetWindowPosition(int left, int top)}}
*Moves the window to the specified coordinates without affecting its size.
;Parameters
*'''left''' = Pixel coordinate of the left hand edge.
*'''top''' = Pixel coordinate of the top edge.
*'''right''' = Pixel coordinate of the right hand edge.
*'''bottom''' = Pixel coordinate of the bottom edge.
*'''width''' = Window width in pixels.
*'''height''' = Window height in pixels.
;Returned Value
*None
;Syntax
browser.SetWindowRect(0,0,200,300);
;Notes
 

===SetWindowGrow===
{{MethodHeader|public native void SetWindowGrow(int minWidth, int minHeight, int maxWidth, int maxHeight)}}
;Parameters
*'''minWidth,minHeight''' = Minimum width and height in pixels.
*'''maxWidth,maxHeight''' = Maximum width and height in pixels.
;Returned Value
*None
;Syntax
browser.SetWindowGrow(100,100,300,300);
;Notes
*Defines a maximum and minimum height and width that the browser window will be constrained to.
 

==Trainz Object HTML Element==
*<nowiki><trainz-object></nowiki> tags define special browser objects which the user can interact with.
*These include a graphic dial, a text entry box or a browser frame and a range of parameters can be applied.
 
{{TableHeader|width=50%|margin=15px}}
|-
|bgcolor="#EEEEEE"|'''Property'''||bgcolor="#EEEEEE"|'''Value'''||bgcolor="#EEEEEE"|'''Description'''
|-
|style||string||Type of control, "dial", "text-line" or "browser"
|-
|id||string||Name of this object in the browser.
|-
|width||integer||Pixel width of area to display object in.
|-
|height||integer||Pixel height of area to display object in.
|-
|texture||filename||Filename of texture for the object.
|-
|min||float||Maximum value of control.
|-
|max||float||Maximum value of control.
|-
|valmin||float||Minimum possible value the object can be.
|-
|valmax||float||Maximum possible value the object can be.
|-
|step||integer||Steps in this control.
|-
|clickstep||integer||Number of steps per click
|-
|value||float||initial default value of the object.
|}
 
*The HTML definition for a dial would be
<nowiki><a href="live://dial/dcc" tooltip="Speed control"></nowiki>
<trainz-object style=dial
width=100
height=100
id="dcc"
texture="newdriver/dcc/dcc_controller.tga"
min=0.1
max=0.9
valmin=-1.0
valmax=1.0
step=0
clickstep=1
value=0.5>
</trainz-object>
</a>
 
*This HTML code implements the issuing of a Browser-URL message whenever the dial is adjusted by the user.
*When the asset script receives the message it will be able to query the control to determine what it needs to do.
*Similarly if the script updates any of the dial's properties the HTML graphics will reflect the change.
 

===GetElementProperty===
{{MethodHeader|public native string GetElementProperty(string elementId, string propertyId)}}
;Parameters
*'''elementId''' = Name of HTML element to query.
*'''propertyId''' = Name of trainz-object property to retrieve.
;Returned Value
*Current value of specified property.
;Syntax
float speed = (float)browser.GetElementProperty("dcc","value"); // returns the current dial position
;Notes
*All values are returned in string format and must be cast or converted as appropriate.
 

===SetElementObjectProperty===
{{MethodHeader|public native void SetElementProperty(string elementId, string propertyId, object value)}}
Sets the property of the named object element in this browser to the given object.

This method is used to assign an object value to the property contained in an element that is in the HTML page this Browser is currently loaded with.

An element in a HTML page is usually a something like a text entry box, dial or button defined by a <trainz-object> tag. Each element has multiple properties in it and this method allows those property items to be set by name.

Parameters:
*elementID Name of element to set the property of.
*propertyID Property in the element to set. Properties the <trainz-object> tag supports can be used.
*value Object the is the value the property will be assigned. 

Some element properties are references to objects, such as the "driver-commands" property of "driver-order-bar"-elements.
With this method you can for example pass a DriverCommands object reference to the driver-order-bar element.
Also an embedded browser can receive an Asset reference for it's "asset" property via this method. This will change the asset where images are loaded from.

 

===SetElementProperty===
{{MethodHeader|public native void SetElementProperty(string elementId, string propertyId, string value)}}
;Parameters
*'''elementId''' = Name of HTML element to update.
*'''propertyId''' = Name of trainz-object property to update.
*'''value''' = New value to set.
;Returned Value
*None
;Syntax
browser.SetElementProperty("dcc","value",(string)speed); // updates the current dial position
;Notes
*All values must be cast or converted to string format for use in this method.
 

==Trainz Text HTML Element==
*<nowiki><trainz-text></nowiki> tags define text strings which can be updated without the need to reload the page.
*These take the form <nowiki><trainz-text id="speed" text="0mph"></trainz-text></nowiki>
*The text tag specifies the default text that is displayed for the item when the page is initially created.
*Once the page is loaded, a script can use SetTrainzText() to provide a dynamic update.
 

===SetTrainzText===
{{MethodHeader|public native void SetTrainzText(string id, string text)}}
;Parameters
*'''id''' = The id of the ''trainz-text'' item to update.
*'''text''' = The string value to provide.
;Returned Value
*None
;Syntax
browser.SetTrainzText("speed","90mph");
;Notes
 

==Code Examples==
*This code illustrates the basics of handling a browser.
class TestBrowser isclass MapObject {

// A global variable to hold the browser object
Browser browser;

void OpenBrowser(void) {
// if the browser doesn't already exist it needs to be created
if (!browser) browser = Constructors.NewBrowser();
// define the size and style and load HTML, in this case from a file in the calling asset
browser.SetWindowPosition(0,0);
browser.SetWindowStyle(browser.STYLE_DEFAULT);
browser.SetWindowSize(200,500);
browser.LoadHTMLFile(GetAsset(),"HTMLSource.html");
}

void CloseBrowser(Message msg) {
// if the browser has been closed we need to destroy the reference to it
if (msg.src == browser) browser = null;
}

void BrowserLink(Message msg) {
// make sure that we are responding to the correct browser object
if (msg.src != browser) return;
// carry out the appropriate response to the link
string link = msg.minor;
if (link == "live://anthem") {
World.Play2DSound(GetAsset(),"God Save the Queen.wav");
}
else if (link == "live://travesty") {
World.Play2DSound(GetAsset(),"Advance Australia Fair.wav");
}
}

public void Init(void) {
inherited();
// create handlers for the browser messages
AddHandler(me,"Browser-URL","","BrowserLink");
AddHandler(me,"Browser-Closed","","CloseBrowser");
// open the browser window
OpenBrowser();
}

};
 

==Related Methods==
[[Class Constructors#NewBrowser|Constructors.NewBrowser()]] 
 

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

Class Browser

2019-04-12T07:39:26Z

Callavsg: /* SetElementObjectProperty */

*[[TrainzScript Language Reference|API Hierarchy]]
**[[Class GSObject|GSObject]] *
***[[Class GameObject|GameObject]]
****Browser
 

*This class provides an interface with the Trainz [[MiniBrowser]] allowing the programmer to provide a simple HTML interface.
*The browser supports a small subset of HTML code.
*Muliple browsers are supported.
*To create a new Browser, use [[Class Constructors#NewBrowser|Constructors.NewBrowser()]].
*To populate with HTML code use either [[#LoadHTMLString|LoadHTMLString]] or [[#LoadHTMLFile|LoadHTMLFile]]
*Refer to the [[MiniBrowser]] page for details of supported tags.
 

==Messages==
*Messages sent to and from Browser objects are listed below:
 
{{TableHeader|width=50%|margin=15px}}
|-
|bgcolor="#EEEEEE"|'''Major'''||bgcolor="#EEEEEE"|'''Minor'''||bgcolor="#EEEEEE"|'''Source'''||bgcolor="#EEEEEE" |'''Destination'''
|-
|[[Browser Messages|Browser-URL]]||''URL''||Browser||Broadcast
|-
|[[Browser Messages|Browser-Closed]]||null||Browser||Broadcast
|}
 
*The ''URL '' in a ''Browser-URL'' message uses a special hyperlink tag in the form ''live://linkname''.
*If your HTML contains the link ''<a href=live://anthem>Play the national anthem</a>'' and the user clicks on the link, then the Browser-URL message will take the form of ''Browser-URL,live://anthem'' and your script can intercept the message and respond accordingly.
*Since messages from Browser objects are always broadcast it is crucial that you ensure that the message is originating from the expected window. You can do this by inspecting the source of the message.
*When the user closes the browser window by either clicking on the close button or pressing the Esc key, a message with a ''Browser-Closed'' message is broadcast. The Browser object would normally be reset to null in response, so that the browser window disappears.
 

==Constants==
*Constants defined in this class are:
 
{{TableHeader|width=95%|margin=15px}}
|bgcolor=#EEEEEE|Browser Window Styles||bgcolor=#EEEEEE|
|-
|width=300|public define int STYLE_NO_FRAME = 0 ||Frameless Browser (not in a bordered window).
|-
|public define int STYLE_DEFAULT = 1 ||Default browser style. This is defined by Trainz itself and usually means the browser window will have a framed border.
|-
|public define int STYLE_TOOLTIP = 2 ||Browser with no frame and no facility for user interaction.
|}
 

==General Methods==
===BringToFront===
{{MethodHeader|public native void BringToFront(void)}}
;Parameters
*None
;Returned Value
*None
;Syntax
browser.BringToFront();
;Notes
*Brings the window in front of all other browsers.
 

===GetAsset===
{{MethodHeader|public native Asset GetAsset(void)}}
;Parameters
*None
;Returned Value
*The Asset from which this Browser is loading html data and resources.
;Syntax
Asset asset = browser.GetAsset();
;Notes
*The returned asset will be the asset used in the last call to [[#LoadHTMLFile|LoadHTMLFile]] or [[#LoadHTMLString|LoadHTMLString]].
*If there has been no such call the returned value will be null.
 

===GetWindowVisible===
{{MethodHeader|public native bool GetWindowVisible(void)}}
;Parameters
*None
;Returned Value
*True to indicate that the browser is currently visible on screen, false that the browser is hidden.
;Syntax
hidden = !browser.GetWindowVisible();
;Notes
 

===LoadHTMLFile===
{{MethodHeader|public native void LoadHTMLFile(Asset asset, string filename)}}
;Parameters
*'''asset''' = reference to the asset where the HTML file and other resources are located.
*'''filename''' = HTML file to load, may include a relative path specifier.
;Returned Value
*None
;Syntax
browser.LoadHTMLFile(resourceAsset,"/html/File-01.html");
;Notes
*The asset may be of any type, as long as the appropriate files are included in its folder structure.
 

===LoadHTMLString===
{{MethodHeader|public native void LoadHTMLString(Asset asset, string htmlData)}}
;Parameters
*'''asset''' = reference to the asset where any resources required are located.
*'''htmlData''' = string containing HTML code to load into browser.
;Returned Value
*None
;Syntax
browser.LoadHTMLString(resourceAsset,htmlData);
;Notes
*The asset may be of any type, as long as the appropriate files are included in its folder structure.
 

===ResetScrollBar===
{{MethodHeader|public native void ResetScrollBar(void)}}
;Parameters
*None
;Returned Value
*None
;Syntax
browser.ResetScrollBar();
;Notes
*Moves the scrollbar grip and the html contents to the top.
 

===SetCloseEnabled===
{{MethodHeader|public native void SetCloseEnabled(bool enabled)}}
;Parameters
*'''enabled''' = Set to false to prevent the user from closing the browser, set to true to enable closure.
;Returned Value
*None
;Syntax
browser.SetCloseEnabled(false);
;Notes
 

===SetParam===
{{MethodHeader|public native void SetParam(int index, string value)}}
;Parameters
*'''index''' = index of parameter to set.
*'''value''' = string value to assign to the specified parameter.
;Returnd Value
*None
;Syntax
browser.SetParam(2,"Birmingham New Street");
;Notes
*HTML code may contain changeable parameters denoted by the placeholder characters ''$#'', where # is a number.
*SetParam() intructs the parser to substitute the text in the function parameter for the placeholder when the browser is loaded.
 

===SetScrollEnabled===
{{MethodHeader|public native void SetScrollEnabled(bool enabled)}}
;Parameters
*'''enabled''' = Set to false to prevent the user from scrolling the browser, set to true to enable.
;Returned Value
*None
;Syntax
browser.SetScrollEnabled(false);
;Notes
 

===SetWindowStyle===
{{MethodHeader|public native void SetWindowStyle(int style)}}
;Parameters
*'''style''' = One of the [[#Constants|Browser Window Style]] constants defining the type of browser to be provided.
;Returned Value
*None
;Syntax
browser.SetWindowStyle(Browser.STYLE_DEFAULT);
;Notes
 

===SetWindowVisible===
{{MethodHeader|public native void SetWindowVisible(bool visible)}}
;Parameters
*'''visible''' = true to show the browser window, false to hide it.
;Returned Value
*None
;Syntax
SetWindowVisible(!GetWindowVisible());
;Notes
 

==Browser Size & Position==
*This group of methods are used to retrieve and set the position and size of the Browser window.
*A pixel coordinate system is used with 0,0 being the top left and ScreenWidth - 1, ScreenHeight - 1 being the bottom right.
===GetWindowLeft===
{{MethodHeader|public native int GetWindowLeft(void)}}
*Retrieves the pixel coordinate of the left hand edge.
===GetWindowTop===
{{MethodHeader|public native int GetWindowTop(void)}}
*Retrieves the pixel coordinate of the top edge.
===GetWindowRight===
{{MethodHeader|public native int GetWindowRight(void)}}
*Retrieves the pixel coordinate of the right hand edge.
===GetWindowBottom===
{{MethodHeader|public native int GetWindowBottom(void)}}
*Retrieves the pixel coordinate of the bottom edge.
===GetWindowWidth===
{{MethodHeader|public native int GetWindowWidth(void)}}
*Retrieves the width of the window in pixels.
===GetWindowHeight===
{{MethodHeader|public native int GetWindowHeight(void)}}
*Retrieves the height of the window in pixels.
;Parameters
*None
;Syntax
int width = browser.GetWindowWidth();
;Notes
 

===SetWindowLeft===
{{MethodHeader|public native void SetWindowLeft(int left)}}
*Sets the pixel coordinate of the left hand edge.
===SetWindowTop===
{{MethodHeader|public native void SetWindowTop(int top)}}
*Sets the pixel coordinate of the top edge.
===SetWindowRight===
{{MethodHeader|public native void SetWindowRight(int right)}}
*Sets the pixel coordinate of the right hand edge.
===SetWindowBottom===
{{MethodHeader|public native void SetWindowBottom(int bottom)}}
*Sets the pixel coordinate of the bottom edge.
===SetWindowRect===
{{MethodHeader|public native void SetWindowRect(int left, int, top, int right, int bottom)}}
*Sets the pixel coordinates of all four edges in a single call.
===SetWindowWidth===
{{MethodHeader|public native void SetWindowWidth(int width)}}
*Sets the width of the window in pixels.
===SetWindowHeight===
{{MethodHeader|public native void SetWindowHeight(int height )}}
*Sets the height of the window in pixels.
===SetWindowSize===
{{MethodHeader|public native void SetWindowSize(int width, int height )}}
*Sets the height and width of the window in pixels.
===SetWindowPosition===
{{MethodHeader|public native void SetWindowPosition(int left, int top)}}
*Moves the window to the specified coordinates without affecting its size.
;Parameters
*'''left''' = Pixel coordinate of the left hand edge.
*'''top''' = Pixel coordinate of the top edge.
*'''right''' = Pixel coordinate of the right hand edge.
*'''bottom''' = Pixel coordinate of the bottom edge.
*'''width''' = Window width in pixels.
*'''height''' = Window height in pixels.
;Returned Value
*None
;Syntax
browser.SetWindowRect(0,0,200,300);
;Notes
 

===SetWindowGrow===
{{MethodHeader|public native void SetWindowGrow(int minWidth, int minHeight, int maxWidth, int maxHeight)}}
;Parameters
*'''minWidth,minHeight''' = Minimum width and height in pixels.
*'''maxWidth,maxHeight''' = Maximum width and height in pixels.
;Returned Value
*None
;Syntax
browser.SetWindowGrow(100,100,300,300);
;Notes
*Defines a maximum and minimum height and width that the browser window will be constrained to.
 

==Trainz Object HTML Element==
*<nowiki><trainz-object></nowiki> tags define special browser objects which the user can interact with.
*These include a graphic dial, a text entry box or a browser frame and a range of parameters can be applied.
 
{{TableHeader|width=50%|margin=15px}}
|-
|bgcolor="#EEEEEE"|'''Property'''||bgcolor="#EEEEEE"|'''Value'''||bgcolor="#EEEEEE"|'''Description'''
|-
|style||string||Type of control, "dial", "text-line" or "browser"
|-
|id||string||Name of this object in the browser.
|-
|width||integer||Pixel width of area to display object in.
|-
|height||integer||Pixel height of area to display object in.
|-
|texture||filename||Filename of texture for the object.
|-
|min||float||Maximum value of control.
|-
|max||float||Maximum value of control.
|-
|valmin||float||Minimum possible value the object can be.
|-
|valmax||float||Maximum possible value the object can be.
|-
|step||integer||Steps in this control.
|-
|clickstep||integer||Number of steps per click
|-
|value||float||initial default value of the object.
|}
 
*The HTML definition for a dial would be
<nowiki><a href="live://dial/dcc" tooltip="Speed control"></nowiki>
<trainz-object style=dial
width=100
height=100
id="dcc"
texture="newdriver/dcc/dcc_controller.tga"
min=0.1
max=0.9
valmin=-1.0
valmax=1.0
step=0
clickstep=1
value=0.5>
</trainz-object>
</a>
 
*This HTML code implements the issuing of a Browser-URL message whenever the dial is adjusted by the user.
*When the asset script receives the message it will be able to query the control to determine what it needs to do.
*Similarly if the script updates any of the dial's properties the HTML graphics will reflect the change.
 

===GetElementProperty===
{{MethodHeader|public native string GetElementProperty(string elementId, string propertyId)}}
;Parameters
*'''elementId''' = Name of HTML element to query.
*'''propertyId''' = Name of trainz-object property to retrieve.
;Returned Value
*Current value of specified property.
;Syntax
float speed = (float)browser.GetElementProperty("dcc","value"); // returns the current dial position
;Notes
*All values are returned in string format and must be cast or converted as appropriate.
 

===SetElementObjectProperty===
{{MethodHeader|public native void SetElementProperty(string elementId, string propertyId, object value)}}
Sets the property of the named object element in this browser to the given object.

This method is used to assign an object value to the property contained in an element that is in the HTML page this Browser is currently loaded with.

An element in a HTML page is usually a something like a text entry box, dial or button defined by a <trainz-object> tag. Each element has multiple properties in it and this method allows those property items to be set by name.

Parameters:
*elementID Name of element to set the property of.
*propertyID Property in the element to set. Properties the <trainz-object> tag supports can be used.
*value Object the is the value the property will be assigned. 

Some element properties are references to objects, such as the "driver-commands" property of "driver-order-bar"-elements.
With this method you can for example pass a DriverCommands object reference to the driver-order-bar element.
Also an embedded browser can receive an Asset reference for it's "asset" property via this method. This will change the asset where images are loaded from (It might also be possible to send a string representation of the assets KUID via the SetElementProperty mathod)

 

===SetElementProperty===
{{MethodHeader|public native void SetElementProperty(string elementId, string propertyId, string value)}}
;Parameters
*'''elementId''' = Name of HTML element to update.
*'''propertyId''' = Name of trainz-object property to update.
*'''value''' = New value to set.
;Returned Value
*None
;Syntax
browser.SetElementProperty("dcc","value",(string)speed); // updates the current dial position
;Notes
*All values must be cast or converted to string format for use in this method.
 

==Trainz Text HTML Element==
*<nowiki><trainz-text></nowiki> tags define text strings which can be updated without the need to reload the page.
*These take the form <nowiki><trainz-text id="speed" text="0mph"></trainz-text></nowiki>
*The text tag specifies the default text that is displayed for the item when the page is initially created.
*Once the page is loaded, a script can use SetTrainzText() to provide a dynamic update.
 

===SetTrainzText===
{{MethodHeader|public native void SetTrainzText(string id, string text)}}
;Parameters
*'''id''' = The id of the ''trainz-text'' item to update.
*'''text''' = The string value to provide.
;Returned Value
*None
;Syntax
browser.SetTrainzText("speed","90mph");
;Notes
 

==Code Examples==
*This code illustrates the basics of handling a browser.
class TestBrowser isclass MapObject {

// A global variable to hold the browser object
Browser browser;

void OpenBrowser(void) {
// if the browser doesn't already exist it needs to be created
if (!browser) browser = Constructors.NewBrowser();
// define the size and style and load HTML, in this case from a file in the calling asset
browser.SetWindowPosition(0,0);
browser.SetWindowStyle(browser.STYLE_DEFAULT);
browser.SetWindowSize(200,500);
browser.LoadHTMLFile(GetAsset(),"HTMLSource.html");
}

void CloseBrowser(Message msg) {
// if the browser has been closed we need to destroy the reference to it
if (msg.src == browser) browser = null;
}

void BrowserLink(Message msg) {
// make sure that we are responding to the correct browser object
if (msg.src != browser) return;
// carry out the appropriate response to the link
string link = msg.minor;
if (link == "live://anthem") {
World.Play2DSound(GetAsset(),"God Save the Queen.wav");
}
else if (link == "live://travesty") {
World.Play2DSound(GetAsset(),"Advance Australia Fair.wav");
}
}

public void Init(void) {
inherited();
// create handlers for the browser messages
AddHandler(me,"Browser-URL","","BrowserLink");
AddHandler(me,"Browser-Closed","","CloseBrowser");
// open the browser window
OpenBrowser();
}

};
 

==Related Methods==
[[Class Constructors#NewBrowser|Constructors.NewBrowser()]] 
 

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

2018-03-09T15:05:51Z

2016-04-18T20:47:03Z

Callavsg:

HowTo/Your first Trainz Script

2016-04-18T20:28:39Z

Callavsg: Created page with "Scripting is one of most powerful tools when creating trainz assets. More and more content creators are using scripts to extend the funciontallity of their contents, so script..."

HowTo

2016-04-18T19:45:56Z

Callavsg:

This page lists available "How To" Guides which describe how to achieve certain tasks related to Trainz.

Users are encouraged to add their own guides to this page in a similar fashion, or expand on existing guides. Please keep in mind that this site is dedicated to the current version of Trainz and that techniques used should relate to this version. Editors note: all pages here should fit the pattern "How to X", as in "How to place signals". Pages and topics which cannot be phrased in this manner do not belong on this page.

==Using "Manage Content" in TANE==
* [[/Download an Asset from the Download Station/]]
* [[/Configure and use Columns in content windows/]]
* [[/Use the "Status" column in content windows/]]
* [[/Edit and Submit content/]]
* [[/View by thumbnail images/]]
* [[/Fix Errors and Warnings/]]
* [[/Use Search Filters/]]

==Content Creation: Routes==
* [[/Create a Route in 10 Minutes/]]
* [[/Add Bumpy Track/]]
* [[/Make a Track Cutting/]]
* [[/Place Signals/]]
* [[/Build a Bridge/]]
* [[/Build a Tunnel/]]
* [[/Build a Crossing/]]
* [[/Build Catenary/]]
* [[/Use Superelevation/]]
* [[/Use Trig Stations/]]
* [[/Configure an iPortal/]]
* [[/Configure An Interlocking Tower/]]

==Content Creation: Assets==
* [[/Make your first Trainz Asset/]]
* [[/Export from Max/]]
* [[/Export from Blender/]]
* [[/Export from Blender using FBX/]]
* [[/Solve Blender Modelling Problems/]]
* [[/Scaling setup in Blender/]]
* [[/Build normal maps in Max/]]
* [[/Localize an Asset/]]
* [[/Build a scripted asset/]]
* [[/Reskin an Asset/]]
* [[/Reskin an Asset using an alias/]]
* [[/Build a Car for Traffic (stand-alone version)/]]
* [[/Build a Car for Traffic (mesh library version)/]]
* [[/Build a cab interior/]]
* [[/Build a drivable car/]]
* [[/Render to Texture/]]
* [[/Build a simple animated scenery asset in Blender/]]
* [[/Build Passenger Enabled Assets/]]
* [[/Create a High Voltage Power Line Spline/]]
* [[/Create transparent windows in Blender/]]
* [[/Create a Fence Spline Featuring LOD and Random Meshes/]]
* [[/Create a Neon Font Effect with PhotoShop C4/]]
* [[/Build an animated Neon Sign/]]
* [[/Configure a spline for collisions/]]
* [[/Build Procedural Track for T:ANE/]]
* [[/Update your auto-generated next KUID/]]

==Content Creation: Scripting==
* [[/Your first Trainz Script/]]

==Creating and Configuring Content In-game==
* [[/Create an Interactive Session/]]
* [[/Add Carz Traffic to a Route/]]
* [[/Tune a Steam Locomotive Enginespec/]]
* [[/Configure an Interactive Industry/]]
* [[/Implement a Destination Sign System/]]
* [[/Upload a new asset to the DownloadStation/]]
* [[/Update an existing asset on the DownloadStation/]]

==Documentation Suggestions==

* [[/Build normal maps in Blender/]]
* [[/Build a house/]]
* [[/Build a tree/]]
* [[/Build a track/]]
* [[/Build a tunnel/]]
* [[/Build a hedge/]]
* [[/Build a fence/]]
* [[/Build a road/]]
* [[/Build a road crossing/]]
* [[/Build a train car/]]
* [[/Build a bogey/]]
* [[/Build a ground texture/]]
* [[/Build an interactive industry/]]
* [[/Add attached track/]]
* [[/Add an intro page to a session/]]
* [[/Register with Planet Auran/]]
* [[/Create an Achievement/]]
* [[/Use a map to create a baseboard/]]
* [[/Create a displacement map/]]

== See Also==

* [[Content Configuration]] - ''A reference manual covering all content types.''

[[Category:How-to guides| ]]