TrainzOnline - User contributions [en]

https://wiki.trainzsimulator.com/api.php?action=feedcontributions&feedformat=atom&user=Marinus TrainzOnline - User contributions [en] 2026-11-05T05:47:06Z User contributions MediaWiki 1.46.2 https://wiki.trainzsimulator.com/index.php?title=New_TrainzScript_Features_-_TS2009&diff=1687 New TrainzScript Features - TS2009 2010-10-31T00:32:42Z

<p>Marinus: /* Global script context */</p> <hr /> <div>The following features are newly added to TrainzScript in [[TS2009]].<br /> <br /> <br /> = Cross-asset script includes =<br /> As of trainz-build 2.9, any scripted asset may directly include script files from the top-level directory of any other scripted asset. In your script code, you use the 'include' keyword as normal to import the script file. In order for Trainz to find the include file, you must make the following [[config.txt file]] changes:<br /> <br /> * Add a ''script-include-table'' and list the KUID of the asset(s) from which you will be including files.<br /> * Add the same KUIDs to your asset's ''kuid-table''.<br /> <br /> You must ensure that there are no script filename conflicts between any assets involved.<br /> <br /> = Global script context =<br /> Trainz now runs multiple concurrent script virtual machines (VMs). Objects in each VM are largely disassociated, but because the native interface is shared, there is some level of cross-talk. This has not been clearly delineated, and is likely to change in future versions once we've had time to investigate it further. For now, you should treat the VMs as completely distinct except where Auran documentation explicitly declares otherwise.<br /> <br /> The two obvious script contexts are the global menu system, and the active module.<br /> * The global VM is responsible for global settings libraries, menubar interface addons, etc. and does not have access to the World. It persists until Trainz exits.<br /> * The active module VM is responsible for maintaining the session, route, and gameplay aspects and does not persist beyond the lifetime of the module.<br /> <br /> <br /> [[KIND Library|Libraries]] can be forced to always load in the global script context using a config.txt tag<br /> always-load-in-global-context 1<br /> <br /> If a library is shared between assets, it is important to be aware in which context the library is loaded. A script running in a gameplay context can make calls to a Library in the global context. The reverse is not possible. If ''always-load-in-global-context'' is not used, assets running in gameplay context will access an instance of the library also running in gameplay context. Assets running in global context however access an instance of the library in global context. In other words, there are two parallel instances of the ibrary. To prevent this situation the ''always-load-in-global-context'' tag forces the library to only load once (in global context). The library resisting in global context is then available to other assets in gameplay and global context.<br /> <br /> '''CAUTION:''' there are some pitfalls when passing data between objects in different contexts. No references to objects of another context can be stored as members. This means you must make a copy of every ''reference'' type (e.g. strings and arrays) you want to store in another context. In other words, you need to extract any relevant details during the cross-context call and keep copies. [[Types#string|Strings]] are copied using [[class Str#CloneString|Str.CloneString()]] and [[Types#Array|arrays]] can be copied using the [[Arrays#copy|copy()]] operator. There are also possible limitations to cross context message passing, sniffing, etc.<br /> <br /> Scripts running in global context cannot use some of the functions which are intended for the game context (e.g. driver module). This concerns mainly functions of [[class World]] and [[class Interface]]. Calling these functions from global context causes a ''ER_NativeCallError'' script exception.<br /> <br /> = Global settings libraries =<br /> Global settings libraries are standard script libraries with an additional tag entry in their [[config.txt file]]s.<br /> <br /> custom-category-list "GSET"<br /> <br /> The global settings libraries are loaded into the global VM in the following scenarios:<br /> * The user clicks on the library in the [[Trainz Settings]] dialog.<br /> * Another script in the global VM calls GetLibrary().<br /> * The library is a built-in settings library recognized by Trainz, and Trainz wishes to read the current settings.<br /> <br /> ''note: Currently there is nothing to stop a global settings library from being loaded into a module VM. It is likely that we'll change this prior to release, to ensure that they're loaded into the global VM regardless of from where they're instantiated.''<br /> <br /> Libraries loaded into the global module have their properties saved to the global settings file.<br /> <br /> The following TS2009 built-in content are Global Settings Libraries:<br /> * "Video Settings" <kuid:30501:1021><br /> * "Surveyor Settings" <kuid:30501:1022><br /> * "Global Interface Addons" <kuid:30501:1026><br /> <br /> <br /> = Interface Addons =<br /> Interface Addons are standard script libraries with an additional tag entry in their [[config.txt file]]s.<br /> <br /> custom-category-list "GADD"<br /> <br /> Interface Addons are loaded into the global VM by the "Global Interface Addons" library. The user must choose to enable the interface addon before it is loaded.<br /> <br /> ''note: As they are normal script libraries, the interface addons may be loaded through other means. The "Global Interface Addons" library also provides a mechanism for users to unload addons. At the current time, this requires the user to reload Trainz; it is likely that we will add a script mechanism to truly unload the library, or at least tell it to clean up. We are also likely to provide a mechanism for interface addons to determine whether they were loaded by the Global Interface Addon (and should display their UI) or by some other mechanism (in which case they should remain hidden.)'' <br /> <br /> The following TS2009 built-in content are Interface Addons:<br /> * "iTrainz Chat Interface" <kuid:30501:1003><br /> <br /> <br /> = iTrainz URL Helper library =<br /> This script library provides a unified mechanism for handling custom ''trainz://xx/yy'' style URLs, regardless of where they occur in the game. The library is used by native code, and by scripts via the new TrainzScript.OpenURL() function. Script code should never call into this library directly where a call to TrainzScript.OpenURL() would suffice, as the native code may perform some URL parsing before handing over to the script library.<br /> <br /> The "iTrainz URL Helper library" is <kuid:30501:1025>.<br /> <br /> ''note: Currently there is nothing to stop this library from being loaded into a module VM. It is likely that we'll change this prior to release, to ensure that it's loaded into the global VM regardless of from where it's instantiated.''<br /> <br /> The current version of the library supports the following URL styles:<br /> * ''trainz://buddy/NAME'' - routed to the "iTrainz Chat Interface"<br /> * ''trainz://channel/NAME'' - routed to the "iTrainz Chat Interface"<br /> <br /> The OpenURL() call will additionally support the following URL styles internally:<br /> * ''trainz://install/KUID'' - opens an 'asset details' window which allows the user to install the specified content.</div>

Marinus https://wiki.trainzsimulator.com/index.php?title=New_TrainzScript_Features_-_TS2009&diff=1686 New TrainzScript Features - TS2009 2010-10-31T00:20:12Z

<p>Marinus: /* Global script context */ - added always-load-in-global-context information</p> <hr /> <div>The following features are newly added to TrainzScript in [[TS2009]].<br /> <br /> <br /> = Cross-asset script includes =<br /> As of trainz-build 2.9, any scripted asset may directly include script files from the top-level directory of any other scripted asset. In your script code, you use the 'include' keyword as normal to import the script file. In order for Trainz to find the include file, you must make the following [[config.txt file]] changes:<br /> <br /> * Add a ''script-include-table'' and list the KUID of the asset(s) from which you will be including files.<br /> * Add the same KUIDs to your asset's ''kuid-table''.<br /> <br /> You must ensure that there are no script filename conflicts between any assets involved.<br /> <br /> = Global script context =<br /> Trainz now runs multiple concurrent script virtual machines (VMs). Objects in each VM are largely disassociated, but because the native interface is shared, there is some level of cross-talk. This has not been clearly delineated, and is likely to change in future versions once we've had time to investigate it further. For now, you should treat the VMs as completely distinct except where Auran documentation explicitly declares otherwise.<br /> <br /> The two obvious script contexts are the global menu system, and the active module.<br /> * The global VM is responsible for global settings libraries, menubar interface addons, etc. and does not have access to the World. It persists until Trainz exits.<br /> * The active module VM is responsible for maintaining the session, route, and gameplay aspects and does not persist beyond the lifetime of the module.<br /> <br /> <br /> [[KIND Library|Libraries]] can be forced to always load in the global script context using a config.txt tag<br /> always-load-in-global-context 1<br /> <br /> If a library is shared between assets, it is important to be aware in which context the library is loaded. If ''always-load-in-global-context'' is not used, assets running in local (active module) context will access an instance of the library also running in local context. Assets running in global context however access an instance of the library in global context. In other words, there are two parallel instances of the ibrary. To prevent this situation the ''always-load-in-global-context'' tag forces the library to only load once (in global context). The library resisting in global context is then available to other assets in local and global context.<br /> <br /> '''CAUTION:''' there are some pitfalls when passing data between objects in different contexts. No references to objects of another context can be stored as members. This means you must make a copy of every ''reference'' type (e.g. strings and arrays) you want to store in another context. In other words, you need to extract any relevant details during the cross-context call and keep copies. [[Types#string|Strings]] are copied using [[class Str#CloneString|Str.CloneString()]] and [[Types#Array|arrays]] can be copied using the [[Arrays#copy|copy()]] operator. There are also possible limitations to cross context message passing, sniffing, etc.<br /> <br /> Scripts running in global context cannot use some of the functions which are intended for the game context (e.g. driver module). This concerns mainly functions of [[class World]] and [[class Interface]]. Calling these functions from global context causes a ''ER_NativeCallError'' script exception.<br /> <br /> = Global settings libraries =<br /> Global settings libraries are standard script libraries with an additional tag entry in their [[config.txt file]]s.<br /> <br /> custom-category-list "GSET"<br /> <br /> The global settings libraries are loaded into the global VM in the following scenarios:<br /> * The user clicks on the library in the [[Trainz Settings]] dialog.<br /> * Another script in the global VM calls GetLibrary().<br /> * The library is a built-in settings library recognized by Trainz, and Trainz wishes to read the current settings.<br /> <br /> ''note: Currently there is nothing to stop a global settings library from being loaded into a module VM. It is likely that we'll change this prior to release, to ensure that they're loaded into the global VM regardless of from where they're instantiated.''<br /> <br /> Libraries loaded into the global module have their properties saved to the global settings file.<br /> <br /> The following TS2009 built-in content are Global Settings Libraries:<br /> * "Video Settings" <kuid:30501:1021><br /> * "Surveyor Settings" <kuid:30501:1022><br /> * "Global Interface Addons" <kuid:30501:1026><br /> <br /> <br /> = Interface Addons =<br /> Interface Addons are standard script libraries with an additional tag entry in their [[config.txt file]]s.<br /> <br /> custom-category-list "GADD"<br /> <br /> Interface Addons are loaded into the global VM by the "Global Interface Addons" library. The user must choose to enable the interface addon before it is loaded.<br /> <br /> ''note: As they are normal script libraries, the interface addons may be loaded through other means. The "Global Interface Addons" library also provides a mechanism for users to unload addons. At the current time, this requires the user to reload Trainz; it is likely that we will add a script mechanism to truly unload the library, or at least tell it to clean up. We are also likely to provide a mechanism for interface addons to determine whether they were loaded by the Global Interface Addon (and should display their UI) or by some other mechanism (in which case they should remain hidden.)'' <br /> <br /> The following TS2009 built-in content are Interface Addons:<br /> * "iTrainz Chat Interface" <kuid:30501:1003><br /> <br /> <br /> = iTrainz URL Helper library =<br /> This script library provides a unified mechanism for handling custom ''trainz://xx/yy'' style URLs, regardless of where they occur in the game. The library is used by native code, and by scripts via the new TrainzScript.OpenURL() function. Script code should never call into this library directly where a call to TrainzScript.OpenURL() would suffice, as the native code may perform some URL parsing before handing over to the script library.<br /> <br /> The "iTrainz URL Helper library" is <kuid:30501:1025>.<br /> <br /> ''note: Currently there is nothing to stop this library from being loaded into a module VM. It is likely that we'll change this prior to release, to ensure that it's loaded into the global VM regardless of from where it's instantiated.''<br /> <br /> The current version of the library supports the following URL styles:<br /> * ''trainz://buddy/NAME'' - routed to the "iTrainz Chat Interface"<br /> * ''trainz://channel/NAME'' - routed to the "iTrainz Chat Interface"<br /> <br /> The OpenURL() call will additionally support the following URL styles internally:<br /> * ''trainz://install/KUID'' - opens an 'asset details' window which allows the user to install the specified content.</div>

Marinus https://wiki.trainzsimulator.com/index.php?title=KIND_Library&diff=1685 KIND Library 2010-10-31T00:16:25Z

<p>Marinus: /* Supported Tags */</p> <hr /> <div>KIND Library is a coded module that interacts with other coded modules.<br /> <br /> ==KIND Hierarchy==<br /> ===Parent Classes===<br /> * ''none.''<br /> <br /> ===Child Classes===<br /> * ''none.''<br /> <br /> <br /> ==Supported Tags==<br /> Each Library asset supports the following tags. Each tag is shown here with its default value.<br /> * ''always-load-in-global-context'' if set to '1', library is always loaded to [[New_TrainzScript_Features#Global_script_context|global script context]]<br /> <br /> ==Example Config.txt==<br /> Sample [[config.txt file]] for a library asset, with the Standard Tags excluded for brevity:<br /> <br /> kind "library"<br /> script "LibraryScript.gs"<br /> class "LibraryClass"<br /> <br /> ==Downloads==<br /> ''Attach sample files here?''<br /> <br /> ==Categories==<br /> [[Category:Asset KIND]]</div>

Marinus https://wiki.trainzsimulator.com/index.php?title=Arrays&diff=1684 Arrays 2010-10-31T00:10:58Z

<p>Marinus: </p> <hr /> <div>==Declaration, Initialisation & Population==<br /> *Arrays need to be declared and initialised before they can be accessed, and it will usually be necessary to populate the array with meaningful data.<br><br><br /> <br /> {{MethodHeader|Declaration}}<br /> *A declaration reserves memory for the variable and allocates a name for that particular array. This is analogous to a housing developer buying a site and reserving it for future construction.<br /> <br /> *To declare an array you must first define the type of object which the array will contain, followed by opening and closing square braces and the name you will use to reference the array variable.<br /> <br /> *Just as residential developments can consist of any building type, arrays can consist of almost any class, including classes which you have defined yourself.<br /> <br /> Vehicle[] vehicles;<br /> int[] numberList;<br /> string[] words;<br /> GameObject[] objects;<br /> MyOwnClass[] myObjects;<br /> <br /> {{MethodHeader|Initialisation}}<br /> *In the same way that a developer must decide how many units he wants to build, you must decide how many members your array will initially be able to contain. You will be able to make the array larger or smaller later, for now you are just setting the initial size.<br /> *To initialise the array you use the keyword new, followed by the class of object that the array is to contain and the initial number of members in square brackets.<br /> <br /> vehicles = new Vehicle[5];<br /> numberList = new int[10];<br /> words = new string[2];<br /> objects = new GameObject[3];<br /> myObjects = new MyOwnClass[7];<br /> <br /> *It is possible, and often convenient, to declare and initialise the array in a single statement:<br /> <br /> Vehicle[] vehicles = new Vehicle[5];<br /> int[] numberList = new int[10];<br /> string[] words = new string[2];<br /> GameObject[] objects = new GameObject[3];<br /> MyOwnClass[] myObjects = new MyOwnClass[7];<br /> <br /> {{MethodHeader|Population}}<br /> *We now have a plot of land and some completed buildings but it will still be meaningless to call at an individual house because no-one will be living there.<br /> <br /> *You can populate the individual elements by assigning a value to an indexed position in the array. The syntax for this is:<br /> <br /> vehicles[0] = GetMyTrain().GetVehicles[3];<br /> numberList[0] = 0;<br /> words[3] = "sentences"<br /> objects[0] = me;<br /> myObjects[2] = Router,GetGameObject("my sibling");<br /> <br /> {{MethodHeader|Array Methods}}<br /> *A further shortcut is to use a method which returns an array to initialise and populate your array in a single statement. Often the same statement can also contain the declaration:<br /> <br /> Vehicle[] vehicles = World.GetVehicleList();<br /> int[] numberList = GetNumberList(1,10);<br /> string[] words = Str.Tokens("comma,separated,list",",");<br /> <br /> *You can write your own methods to return arrays:<br /> <br /> int[] GetNumberList(int start, int count) {<br /> int[] result = new int[0];<br /> int i;<br /> for (i = start; i < count; i++) {<br /> result[result.size()] = i;<br /> }<br /> return result;<br /> }<br /> <br /> ==Array Operators==<br /> {{MethodHeader|Appending to an Array}}<br /> *This is a syntax which allows you to increase the size of a properly initialised array by adding a new member to the end. Since array indexing starts at zero, the last member will always be ''array[array.size() - 1]''. <br /> <br /> *Trying to read from ''array[array.size()]'' will result in a range error because you are attempting to access a location which does not exist.<br /> <br /> *Assigning to ''array[array.size()]'' however, will create a new member and increment the number of items in the array.<br /> <br /> vehicles[vehicles.size()] = me;<br /> <br /> {{MethodHeader|Indexing}}<br /> *A subscript enclosed in square brackets serves to define an individual item within an array. The notation will only be meaningful if that particular item has a value assigned. Assuming that this is the case when it isn't is a common error, and one that can be very difficult to find.<br /> <br /> *Given these statements:<br /> <br /> int[] numbers = new int[3];<br /> numbers[0] = 0;<br /> numbers[2] = 2;<br /> <br /> *''numbers[0]'' will return zero as an integer<br /> *''numbers[2]'' will return the value 2<br /> *''numbers[1]'' however will return null since no value has been assigned to that particular item.<br /> <br /> *Array indexing starts at zero (don't ask why) and finishes at ''array.size() - 1''.<br /> <br /> <br /> {{MethodHeader|Range Indexing}}<br /> *Whilst it is straightforward to erase a value from an array by assigning it to null, this doesn't affect the size of the array itself.<br /> <br /> *Given these statements:<br /> <br /> int[] numbers = new int[3];<br /> numbers[0] = 0;<br /> numbers[1] = 1;<br /> numbers[2] = 2;<br /> <br /> *Making the assignment ''numbers[2] = null'' will clear out the value but the array will still contain 3 items.<br /> <br /> *You can delete items and reduce the size of the array at the same time by specifying a range index like this:<br /> <br /> numbers[0,1] = null;<br /> <br /> *The first index is the position of the item to remove and the second is one greater than the position of the last item.<br /> <br /> numbers[0,1] = null removes the first item<br /> numbers[2,3] = null removes the last item<br /> <br /> *Array range indexing is an important tool for use with strings (which are really arrays of characters)<br /> <br /> <br /> {{MethodHeader|size()}}<br /> *''array.size()'' returns a count of the items in the array, this is no guarantee that all of the items have a value.<br /> <br /> <br /> {{anchor|copy}}{{MethodHeader|copy()}}<br /> *''copy()'' creates a duplicate of the array, the syntax is:<br /> <br /> int[] old = new int[3];<br /> int[] new;<br /> new.copy(old);<br /> <br /> *There is a subtle difference between copying an array and creating a duplicate reference to it by assignment. In the case above, the array ''new'' is an entirely separate variable from the array ''old''. Changing the values of one will not affect the other.<br /> <br /> int[] old = new int[3];<br /> int[] new;<br /> new = old;<br /> <br /> *will produce a similar result at first glance, but in this case assigning a new value to ''new[1]'' will also change the value of ''old[1]''. This is because the assignment effectively creates an alternative name for the same data.<br /> <br /> ==Code Samples==<br /> {{MethodHeader|Array Handling Methods}}<br /> *These are example routines which carry out some basic operations on string arrays, all the routines are case sensitive. They can be used for other object types with appropriate modification.<br /> <br /> *Member returns true if the string 's' is contained within the array 'strings'.<br /> <br /> public bool Member(string[] strings, string s) {<br /> int n;<br /> bool result = false;<br /> if (strings.size() == 0) {return result;}<br /> for (n = 0; n < strings.size(); n++) {<br /> if (s == strings[n]) {<br /> result = true;<br /> break;<br /> }<br /> }<br /> return result;<br /> }<br /> <br /> *Add will append string 's' to the end of the array 'strings' as long as 's' is not already present.<br /> <br /> public void Add(string[] strings, string s) {<br /> if (Member(strings,s)) return;<br /> else {strings[strings.size()] = s;}<br /> }<br /> <br /> *Remove will delete any instance of string 's' from the array and reduce the size of the array accordingly.<br /> <br /> public void Remove(string[] strings, string s) {<br /> int n;<br /> if (strings.size() == 0) return;<br /> for (n = 0; n < strings.size(); n++) {<br /> if (s == strings[n]) {strings[n,n+1] = null;}<br /> }<br /> }<br /> <br /> *Sort will perform a case sensitive alpha sort of the strings in the array. This is a flagged bubble sort, simple but slow, and is fine for most small arrays. For large arrays you should write your own quicksort method.<br /> <br /> public void Sort(string[] strings) {<br /> int x,y;<br /> string temp;<br /> bool flag;<br /> for (x = 0; x < strings.size(); x++) {<br /> flag = false;<br /> for (y = 0; y < strings.size() - 1; y++) {<br /> if (strings[y] > strings[y + 1]) {<br /> temp = strings[y + 1];<br /> strings[y + 1] = strings[y];<br /> strings[y] = temp;<br /> flag = true;<br /> }<br /> }<br /> if (!flag) break;<br /> }<br /> }<br /> <br /> ==See Also==</div>

Marinus https://wiki.trainzsimulator.com/index.php?title=Types&diff=1683 Types 2010-10-31T00:09:22Z

<p>Marinus: added anchors</p> <hr /> <div>{{anchor|bool}}{{MethodHeader|bool}}<br /> *Contains the Boolean constants ''true'' or ''false''<br /> *Casting an integer of value 0 to a bool will result in ''false'', any other value will result in ''true''.<br /> !false = true<br /> (bool) 0 = false<br /> <br><br /> <br /> {{anchor|int}}{{MethodHeader|int}}<br /> *32 bit integer<br /> *Range from -2147483647 .. 2147483647<br /> Formats<br /> 100<br /> +100<br /> -100<br /> hex?<br /> <br><br /> <br /> {{anchor|float}}{{MethodHeader|float}}<br /> *32 bit floating number<br /> Formats<br /> 1.0<br /> 1.0f<br /> polish notation?<br /> <br><br /> <br /> {{anchor|object}}{{MethodHeader|object}}<br /> *''object'' is a base class which may be used to store references to objects of any class.<br /> <br><br /> <br /> {{anchor|string}}{{MethodHeader|string}}<br /> *Strings can be indexed as arrays.<br /> *Strings support the following escape sequences<br /> \r ?<br /> \n New line<br /> \t Tab character<br /> \l ?<br /> \a ?<br /> \b ?<br /> \\ Backslash<br /> \" Double quote mark<br /> \' Single quote mark<br /> \0 ?<br /> <br><br /> <br /> {{anchor|Array}}{{MethodHeader|Array Types}}<br /> *Arrays are indexed lists of any base type or any class type including GameObjects.<br /> *Arrays are declared using these statements<br /> Train[] trains;<br /> int[] Numbers = new int[n]; // where ''n'' is the number of items in the array.<br /> *The keyword ''new'' creates the array but does not initialise any of the members<br /> Numbers[3] = 256; // assigns a value to the array. Array indices start at zero<br /> *Arrays may also be returned by methods<br /> Signal[] signals = World.GetSignalList() // creates an array of signals from a built in method<br /> Numbers[Numbers.size()] = 5; // adds a new value after the end of the array, increasing its size by 1<br /> Numbers[0,1] = null; // deletes the first value from the array, decreasing its size by 1<br /> <br></div>

Marinus https://wiki.trainzsimulator.com/index.php?title=Types&diff=1682 Types 2010-10-31T00:07:18Z

<p>Marinus: </p> <hr /> <div>{{MethodHeader|bool}}<br /> *Contains the Boolean constants ''true'' or ''false''<br /> *Casting an integer of value 0 to a bool will result in ''false'', any other value will result in ''true''.<br /> !false = true<br /> (bool) 0 = false<br /> <br><br /> <br /> {{MethodHeader|int}}<br /> *32 bit integer<br /> *Range from -2147483647 .. 2147483647<br /> Formats<br /> 100<br /> +100<br /> -100<br /> hex?<br /> <br><br /> <br /> {{MethodHeader|float}}<br /> *32 bit floating number<br /> Formats<br /> 1.0<br /> 1.0f<br /> polish notation?<br /> <br><br /> <br /> {{MethodHeader|object}}<br /> *''object'' is a base class which may be used to store references to objects of any class.<br /> <br><br /> <br /> {{anchor|string}}{{MethodHeader|string}}<br /> *Strings can be indexed as arrays.<br /> *Strings support the following escape sequences<br /> \r ?<br /> \n New line<br /> \t Tab character<br /> \l ?<br /> \a ?<br /> \b ?<br /> \\ Backslash<br /> \" Double quote mark<br /> \' Single quote mark<br /> \0 ?<br /> <br><br /> <br /> {{MethodHeader|Array Types}}<br /> *Arrays are indexed lists of any base type or any class type including GameObjects.<br /> *Arrays are declared using these statements<br /> Train[] trains;<br /> int[] Numbers = new int[n]; // where ''n'' is the number of items in the array.<br /> *The keyword ''new'' creates the array but does not initialise any of the members<br /> Numbers[3] = 256; // assigns a value to the array. Array indices start at zero<br /> *Arrays may also be returned by methods<br /> Signal[] signals = World.GetSignalList() // creates an array of signals from a built in method<br /> Numbers[Numbers.size()] = 5; // adds a new value after the end of the array, increasing its size by 1<br /> Numbers[0,1] = null; // deletes the first value from the array, decreasing its size by 1<br /> <br></div>

Marinus https://wiki.trainzsimulator.com/index.php?title=Template:Anchor&diff=1681 Template:Anchor 2010-10-31T00:05:58Z

<p>Marinus: </p> <hr /> <div><span id="{{{1}}}"></span><br /> <noinclude></div>

Marinus https://wiki.trainzsimulator.com/index.php?title=Template:Anchor&diff=1680 Template:Anchor 2010-10-31T00:05:05Z

<p>Marinus: </p> <hr /> <div><span id="{{1}}"></span><br /> <noinclude></div>

Marinus https://wiki.trainzsimulator.com/index.php?title=Template:Anchor&diff=1679 Template:Anchor 2010-10-31T00:03:51Z

<p>Marinus: Replacing page with '<span id="{{anchorencode:{{{1|}}}"></span> <noinclude>'</p> <hr /> <div><span id="{{anchorencode:{{{1|}}}"></span><br /> <noinclude></div>

Marinus https://wiki.trainzsimulator.com/index.php?title=Template:Anchor&diff=1678 Template:Anchor 2010-10-31T00:00:20Z

<p>Marinus: from http://en.wikipedia.org/wiki/Template:Anchor</p> <hr /> <div>{{#if: {{{1|}}}|<span id="{{anchorencode:{{{1|}}}}}"></span>{{#if: {{{2|}}}|<span id="{{anchorencode:{{{2|}}}}}"></span>{{#if: {{{3|}}}|<span id="{{anchorencode:{{{3|}}}}}"></span>{{#if: {{{4|}}}|<span id="{{anchorencode:{{{4|}}}}}"></span>{{#if: {{{5|}}}|<span id="{{anchorencode:{{{5|}}}}}"></span>{{#if: {{{6|}}}|<span id="{{anchorencode:{{{6|}}}}}"></span>{{#if: {{{7|}}}|<span id="{{anchorencode:{{{7|}}}}}"></span>{{#if: {{{8|}}}|<span id="{{anchorencode:{{{8|}}}}}"></span>{{#if: {{{9|}}}|<span id="{{anchorencode:{{{9|}}}}}"></span>{{#if: {{{10|}}}|<span id="{{anchorencode:{{{10|}}}}}"></span>{{#if: {{{11|}}}|<span class="error">[[Template:Anchor]] (or Anchors): too many anchors, maximum is 10.</span>}} }} }} }} }} }} }} }} }} }} }}<noinclude></div>

Marinus https://wiki.trainzsimulator.com/index.php?title=Class_Str&diff=1677 Class Str 2010-10-30T23:32:31Z

<p>Marinus: added CloneString</p> <hr /> <div>*[[TrainzScript Language Reference|API Hierarchy]]<br /> **Str<br /> <br><br /> <br /> *Str is a static class providing string utility functions not supported by the native string object. <br /> *When used in game code these methods must be prefixed ''Str.'' to reference the class.<br /> *Some of these methods directly amend their parameters rather than returning values via the method.<br /> <br><br /> <br /> ==Left==<br /> {{MethodHeader|public void Left(string s, int count)}}<br /> ;Parameters<br /> *'''s''' = string to be processed.<br /> *'''count''' = count of characters to retain.<br /> ;Returned Value<br /> *None<br /> ;Syntax<br /> string s = "Afternoon";<br /> Str.TrimLeft(s,5); // s will now be equal to "After"<br /> ;Notes<br /> *Sets ''s'' to be a substring of itself consisting of its first ''count'' characters.<br /> *Method does not return a value.<br /> <br><br /> <br /> ==Mid==<br /> {{MethodHeader|public void Mid(string s, int first, int count)}}<br /> ;Parameters<br /> *'''s''' = string to be processed.<br /> *'''first''' = index of first character to retain.<br /> *'''count''' = number of characters to retain.<br /> ;Returned Value<br /> *None<br /> ;Syntax<br /> string s = "Afternoon";<br /> Str.Mid(s,3,4); // s will now be equal to "tern"<br /> ;Notes<br /> *Sets ''s'' to be a substring of itself ''count'' characters long starting with the ''first'' character.<br /> *Method does not return a value.<br /> <br><br /> <br /> ==Right==<br /> {{MethodHeader|public void Right(string s, int count)}}<br /> ;Parameters<br /> *'''s''' = string to be processed.<br /> *'''count''' = number of characters to retain.<br /> ;Returned Value<br /> *None<br /> ;Syntax<br /> string s = "Afternoon";<br /> Str.Right(s,4); // s will now be equal to "noon"<br /> ;Notes<br /> *Sets ''s'' to be a substring of itself composed of the last ''count'' characters.<br /> *Method does not return a value.<br /> <br><br /> <br /> ==ToInt==<br /> {{MethodHeader|public native int ToInt(string s)}}<br /> ;Parameters<br /> *'''s''' = string parameter, which should be a string representation of an integer.<br /> ;Returned Value<br /> *Integer value of string parameter.<br /> ;Syntax<br /> int n = Str.ToInt("1234");<br /> ;Notes<br /> *Converts ''s'' to an integer.<br /> *Method returns 0 if the string cannot be converted.<br /> <br><br /> <br /> ==ToFloat==<br /> {{MethodHeader|public native float ToFloat(string s)}}<br /> ;Parameters<br /> *'''s''' = string parameter, which should be a string representation of a floating point number.<br /> ;Returned Value<br /> *Floating point value.<br /> ;Syntax<br /> float length = Str.ToFloat("1.5");<br /> ;Notes<br /> *Converts ''s'' to a floating point number.<br /> *Method returns 0.0 if the string cannot be converted.<br /> <br><br /> <br /> ==Tokens==<br /> {{MethodHeader|public native string[ ] Tokens(string s, string delimiters)}}<br /> ;Parameters<br /> *'''s''' = string to be processed.<br /> *'''delimiters''' = string of characters to use as token boundaries.<br /> ;Returned Value<br /> *Array of string tokens.<br /> ;Syntax<br /> string[] sentence = Str.Tokens("Once upon a time",""); // sentence contains an array of four strings:<br /> // ["Once","upon","a","time"].<br /> int wordCount = Str.Tokens("Once upon a time","").size(); // returns 4<br /> string firstWord = Str.Tokens("Once upon a time","")[0]; // returns "Once"<br /> <br /> string kuidStr = "<kuid:1234:5678>"<br /> string userID = Str.Tokens(kuidStr,"<:>")[1]; // returns "1234"<br /> ;Notes<br /> *Splits a string into an array of tokens using any of the characters in ''delimiters'' as token boundaries.<br /> *Characters contained within the ''delimiters'' string are never returned.<br /> *If ''delimiters'' is null or an empty string then white space will be assumed to define the token boundaries.<br /> <br><br /> <br /> ==ToLower==<br /> {{MethodHeader|public native void ToLower(string s)}}<br /> ;Parameters<br /> *'''s''' = string to be processed.<br /> ;Returned Value<br /> *None<br /> ;Syntax<br /> Str.ToLower("UPPER CASE STRING");<br /> ;Notes<br /> *Converts the string parameter ''s'' to lower case.<br /> *Method does not return a value.<br /> <br><br /> <br /> ==ToUpper==<br /> {{MethodHeader|public native void ToUpper(string s)}}<br /> ;Parameters<br /> *'''s''' = string to be processed.<br /> ;Returned Value<br /> *None<br /> ;Syntax<br /> Str.ToUpper("lower case string");<br /> ;Notes<br /> *Converts the string parameter ''s'' to upper case.<br /> *Method does not return a value.<br /> <br><br /> <br /> ==TrimLeft==<br /> {{MethodHeader|public native void TrimLeft(string s, string trim)}}<br /> ;Parameters<br /> *'''s''' = string to be processed.<br /> *'''trim''' = characters to remove<br /> ;Returned Value<br /> *None<br /> ;Syntax<br /> Str.TrimLeft("Once upon a time","Once "); // returns "upon a time"<br /> Str.TrimLeft(" result",""); // returns "result"<br /> ;Notes<br /> *If ''trim'' is an empty string then all white space will be stripped from the front of the string.<br /> *Method does not return a value.<br /> <br><br /> <br /> ==TrimRight==<br /> {{MethodHeader|public native void TrimRight(string s, string trim)}}<br /> ;Parameters<br /> *'''s''' = string to be processed.<br /> *'''trim''' = characters to remove<br /> ;Returned Value<br /> *None<br /> ;Syntax<br /> Str.TrimRight("Once upon a time"," a time"); // returns "Once upon"<br /> Str.TrimRight("result ",""); // returns "result<br /> ;Notes<br /> *If ''trim'' is an empty string then all white space will be stripped from the end of the string.<br /> *Method does not return a value.<br /> <br><br /> <br /> ==UnpackInt==<br /> {{MethodHeader|public native int UnpackInt(string s)}}<br /> ;Parameters<br /> *'''s''' = string to be processed.<br /> ;Returned Value<br /> *First integer value in ''s''.<br /> ;Syntax<br /> int n = UnpackInt("21st May 2008"); // returns 21 and amends ''s'' to "st May 2008" <br /> ;Notes<br /> *Strips the first integer value found from the string parameter and returns it in the method result.<br /> <br><br /> <br /> ==UnpackFloat==<br /> {{MethodHeader|public native float UnpackFloat(string s)}}<br /> ;Parameters<br /> *'''s''' = string to be processed.<br /> ;Returned Value<br /> *First float value in ''s''.<br /> ;Syntax<br /> float distance = UnpackFloat("21.5 miles"); // returns 21.5 and amends ''s'' to " miles".<br /> ;Notes<br /> *Strips the first floating point value found from the string parameter and returns it in the method result.<br /> <br><br /> <br /> ==UnpackString==<br /> {{MethodHeader|public native string UnpackString(string s)}}<br /> ;Parameters<br /> *'''s''' = string to be processed.<br /> ;Returned Value<br /> *First string in ''s'', excluding any leading white space.<br /> ;Syntax<br /> string s = "Once upon a time";<br /> string firstWord = UnpackString(s); // returns "Once", s becomes " upon a time"<br /> string secondWord = UnpackString(s); // returns "upon", s becomes " a time"<br /> string thirdWord = UnpackString(s); // returns "a", s becomes " time"<br /> string fourthWord = UnpackString(s); // returns "time", s becomes ""<br /> ;Notes<br /> *Strips the first word from the string parameter (using white space for word separation) and returns it in the method result. <br /> *Any leading white space is removed from the string before parsing.<br /> <br><br /> <br /> ==CloneString==<br /> {{MethodHeader|public string CloneString(string s)}}<br /> ;Parameters<br /> *'''s''' = The string to clone.<br /> ;Returned Value<br /> *string - A new string in the current gamescript context which has contents that exactly match the original string.<br /> ;Syntax<br /> string original="Hello World!"<br /> string copy;<br /> copy=Str.CloneString(original);<br /> ;Notes<br /> *CloneString() creates a copy of the string passed. <br /> *Ordinarily 'copying' a string will just create a new object that references the old string. This is not allowed across different contexts.<br /> *CloneString() creates a new string for use in the current context.<br /> <br /> <br /> ==Related Methods==<br /> <br /> [[Class TrainUtil#AlreadyThereStr|TrainUtil.AlreadyThereStr()]]<br /> <br /> [[Class TrainUtil#CompareStrLists|TrainUtil.CompareStrLists()]]<br /> <br /> [[Class TrainUtil#GetUpTo|TrainUtil.GetUpTo()]]<br /> <br /> [[Class TrainUtil#HasPrefix|TrainUtil.HasPrefix()]]<br /> <br /> [[Class TrainUtil#HasSufix|TrainUtil.HasSufix()]] ''(sic)''<br /> <br /> [[Class TrainUtil#StrSubst|TrainUtil.StrSubst()]]<br /> <br /> <br /> ==Categories==<br /> [[Category:Script Class]]</div>

Marinus https://wiki.trainzsimulator.com/index.php?title=Class_GameplayMenu&diff=1676 Class GameplayMenu 2010-10-30T23:01:31Z

<p>Marinus: </p> <hr /> <div>*[[TrainzScript Language Reference|API Hierarchy]]<br /> **[[Class GSObject|GSObject]]<br /> ***[[Class GameObject|GameObject]]<br /> ****[[Class TrainzGameObject|TrainzGameObject]]<br /> *****GameplayMenu<br /> <br><br /> * A class that implements an in-game Menu like the Routes or Scenario Menu.<br /> * This script is running in the [[New TrainzScript Features#Global script context|global script context]]<br /> * Used with [[KIND Gameplaymenu]] assets<br /> <br><br /> <br /> ==Constants==<br /> <br><br /> ===Menu Modes===<br /> <br><br /> {{TableHeader|width=95%|margin=15px}}<br /> |width=375|public define int MENUMODE_NONE = 0||Not visible.<br /> |-<br /> |public define int MENUMODE_BUTTON = 1;||Visible as a button on the gameplay menu.<br /> |-<br /> |public define int MENUMODE_MENU = 2;||Visible as a full-screen menu.<br /> |}<br /> <br><br /> ==Members==<br /> <br><br /> {{TableHeader|width=95%|margin=15px}}<br /> |width=375|<b> Browser m_browser</b>||An internal reference to the embedded browser object, which displays this game menu<br /> |}<br /> <br><br /> <br /> ==Methods==<br /> {{MethodHeader|public void SetGameplayMenuMode(Browser browser, int menuMode)}}<br /> ;Parameters<br /> *'''browser ''' = The Browser control which is used to visualise this GameplayMenu.<br /> *'''menuMode''' = One of the [[#Menu Modes|MENUMODE_*]] defines, indicating which mode we are switching to.<br /> ;Returned Value<br /> *None<br /> ;Notes<br /> *Called whenever the menumode of this GameplayMenu is changed.<br /> *Change the appearance of this menu based on menuMode by changing the HTML code of the embedded browser object [[#Members|m_browser]]<br /> <br><br /> {{MethodHeader|public native void CloseGameplayMenu(void)}}<br /> ;Parameters<br /> *none<br /> ;Returned Value<br /> *none<br /> ;Notes<br /> *This function causes this gameplay menu to be closed, returning the user to the game main menu.<br /> <br><br /> {{MethodHeader|public void UserRequestGoBack(void)}}<br /> ;Parameters<br /> *none<br /> ;Returned Value<br /> *none<br /> ;Notes<br /> *Called whenever the user requests a "go back" action. <br /> *If the user has navigated to some form of "sub menu", this should return them to the main level of this gameplay menu. <br /> *If at the main level, this should close the gameplay menu and return to the game main menu.<br /> <br><br /> {{MethodHeader|public void TADRequestRefresh(void)}}<br /> ;Parameters<br /> *<br /> ;Returned Value<br /> *<br /> ;Notes<br /> *Called on a fullscreen menu when the TAD is modified.<br /> *Dynamic menus based on lists of assets may wish to refresh their view of the world at this time.<br /> <br><br /> {{MethodHeader|native bool LoadDriverQuickDrive(KUID kuid)}}<br /> ;Parameters<br /> *'''kuid''' = the KUID of the map to QuickDrive.<br /> ;Returned Value<br /> *True on success. False if something failed.<br /> ;Notes<br /> *Loads the Driver module with the supplied map<br /> <br><br /> {{MethodHeader|native bool LoadDriverSession(KUID kuid)}}<br /> ;Parameters<br /> *'''kuid''' = the KUID of the session to Drive.<br /> ;Returned Value<br /> *True on success. False if something failed.<br /> ;Notes<br /> *Loads the Driver module with a session<br /> <br><br /> {{MethodHeader|native bool LoadDriverScenario(KUID kuid)}}<br /> ;Parameters<br /> *'''kuid''' = the KUID of the scenario to Drive.<br /> ;Returned Value<br /> *True on success. False if something failed.<br /> ;Notes<br /> *Loads the Driver module with a scenario<br /> *INTERNAL USE ONLY. DO NOT USE! This function will not be maintained in future versions of Trainz.<br /> <br><br /> {{MethodHeader|native bool LoadDriverSavedSession(string theSavedSession)}}<br /> ;Parameters<br /> * do not use<br /> ;Returned Value<br /> *True on success. False if something failed.<br /> ;Notes<br /> *INTERNAL USE ONLY. DO NOT USE! This function will not be maintained in future versions of Trainz.<br /> <br><br /> {{MethodHeader|native bool LoadSurveyorNew()}}<br /> ;Parameters<br /> *none<br /> ;Returned Value<br /> *True on success. False if something failed.<br /> ;Notes<br /> *Loads the Surveyor module with a new map.<br /> <br><br /> {{MethodHeader|native bool LoadSurveyorMap(KUID kuid)}}<br /> ;Parameters<br /> *'''kuid''' = the KUID of the map to load.<br /> ;Returned Value<br /> *True on success. False if something failed.<br /> ;Notes<br /> *Loads the Surveyor module with a map.<br /> <br><br /> {{MethodHeader|native bool LoadSurveyorMapNewSession(KUID kuid)}}<br /> ;Parameters<br /> *'''kuid''' = the KUID of the map to load.<br /> ;Returned Value<br /> *True on success. False if something failed.<br /> ;Notes<br /> *Loads the Surveyor module with a map, to start a new session.<br /> <br><br /> {{MethodHeader|native bool LoadSurveyorSession(KUID kuid)}}<br /> ;Parameters<br /> *'''kuid''' = the KUID of the session to load.<br /> ;Returned Value<br /> *True on success. False if something failed.<br /> ;Notes<br /> *Loads the Surveyor module with a session.<br /> <br><br /> {{MethodHeader|native bool LoadRailyard(KUID kuid)}}<br /> ;Parameters<br /> *'''kuid''' = the KUID of the vehicle to select in Railyard. May be null.<br /> ;Returned Value<br /> *True on success. False if something failed.<br /> ;Notes<br /> *Loads the Railyard module, optionally displaying the specified vehicle.<br /> <br><br /> {{MethodHeader|native Soup GetSavedSessionInfo()}}<br /> ;Parameters<br /> *<br /> ;Returned Value<br /> *<br /> ;Notes<br /> *INTERNAL USE ONLY. DO NOT USE! This function will not be maintained in future versions of Trainz.<br /> <br><br /> {{MethodHeader|native bool DeleteMap(KUID theMap)}}<br /> ;Parameters<br /> *'''theMap''' = the KUID of the route to delete<br /> ;Returned Value<br /> *True if successfully deleted.<br /> ;Notes<br /> *Deletes a specific map, and all sessions that use it<br /> <br><br /> {{MethodHeader|native bool DeleteSession(KUID theSession)}}<br /> ;Parameters<br /> *'''theSession''' = the session to delete<br /> ;Returned Value<br /> *True if successfully deleted.<br /> ;Notes<br /> *Deletes a specific session<br /> <br><br /> {{MethodHeader|native bool DeleteScenario(KUID theScenario)}}<br /> ;Parameters<br /> *'''theScenario''' = the scenario to delete<br /> ;Returned Value<br /> *True if successfully deleted.<br /> ;Notes<br /> *Deletes a specific scenario<br /> *INTERNAL USE ONLY. DO NOT USE! This function will not be maintained in future versions of Trainz.<br /> <br><br /> {{MethodHeader|native bool DeleteSavedSession(string theSavedSession)}}<br /> ;Parameters<br /> * N/A<br /> ;Returned Value<br /> * N/A<br /> ;Notes<br /> *INTERNAL USE ONLY. DO NOT USE! This function will not be maintained in future versions of Trainz.<br /> <br /> <br /> <br><br /> <br /> ==Categories==<br /> [[Category:Script Class]]</div>

Marinus https://wiki.trainzsimulator.com/index.php?title=Class_GameplayMenu&diff=1675 Class GameplayMenu 2010-10-30T23:00:00Z

<p>Marinus: </p> <hr /> <div>*[[TrainzScript Language Reference|API Hierarchy]]<br /> **[[Class GSObject|GSObject]]<br /> ***[[Class GameObject|GameObject]]<br /> ****[[Class TrainzGameObject|TrainzGameObject]]<br /> *****GameplayMenu<br /> <br><br /> * A class that implements an in-game Menu like the Routes or Scenario Menu.<br /> * This script is running in the [[New TrainzScript Features#Global script context|global script context]]<br /> * Used with [[kind gameplaymenu]] assets<br /> <br><br /> <br /> ==Constants==<br /> <br><br /> ===Menu Modes===<br /> <br><br /> {{TableHeader|width=95%|margin=15px}}<br /> |width=375|public define int MENUMODE_NONE = 0||Not visible.<br /> |-<br /> |public define int MENUMODE_BUTTON = 1;||Visible as a button on the gameplay menu.<br /> |-<br /> |public define int MENUMODE_MENU = 2;||Visible as a full-screen menu.<br /> |}<br /> <br><br /> ==Members==<br /> <br><br /> {{TableHeader|width=95%|margin=15px}}<br /> |width=375|<b> Browser m_browser</b>||An internal reference to the embedded browser object, which displays this game menu<br /> |}<br /> <br><br /> <br /> ==Methods==<br /> {{MethodHeader|public void SetGameplayMenuMode(Browser browser, int menuMode)}}<br /> ;Parameters<br /> *'''browser ''' = The Browser control which is used to visualise this GameplayMenu.<br /> *'''menuMode''' = One of the [[#Menu Modes|MENUMODE_*]] defines, indicating which mode we are switching to.<br /> ;Returned Value<br /> *None<br /> ;Notes<br /> *Called whenever the menumode of this GameplayMenu is changed.<br /> *Change the appearance of this menu based on menuMode by changing the HTML code of the embedded browser object [[#Members|m_browser]]<br /> <br><br /> {{MethodHeader|public native void CloseGameplayMenu(void)}}<br /> ;Parameters<br /> *none<br /> ;Returned Value<br /> *none<br /> ;Notes<br /> *This function causes this gameplay menu to be closed, returning the user to the game main menu.<br /> <br><br /> {{MethodHeader|public void UserRequestGoBack(void)}}<br /> ;Parameters<br /> *none<br /> ;Returned Value<br /> *none<br /> ;Notes<br /> *Called whenever the user requests a "go back" action. <br /> *If the user has navigated to some form of "sub menu", this should return them to the main level of this gameplay menu. <br /> *If at the main level, this should close the gameplay menu and return to the game main menu.<br /> <br><br /> {{MethodHeader|public void TADRequestRefresh(void)}}<br /> ;Parameters<br /> *<br /> ;Returned Value<br /> *<br /> ;Notes<br /> *Called on a fullscreen menu when the TAD is modified.<br /> *Dynamic menus based on lists of assets may wish to refresh their view of the world at this time.<br /> <br><br /> {{MethodHeader|native bool LoadDriverQuickDrive(KUID kuid)}}<br /> ;Parameters<br /> *'''kuid''' = the KUID of the map to QuickDrive.<br /> ;Returned Value<br /> *True on success. False if something failed.<br /> ;Notes<br /> *Loads the Driver module with the supplied map<br /> <br><br /> {{MethodHeader|native bool LoadDriverSession(KUID kuid)}}<br /> ;Parameters<br /> *'''kuid''' = the KUID of the session to Drive.<br /> ;Returned Value<br /> *True on success. False if something failed.<br /> ;Notes<br /> *Loads the Driver module with a session<br /> <br><br /> {{MethodHeader|native bool LoadDriverScenario(KUID kuid)}}<br /> ;Parameters<br /> *'''kuid''' = the KUID of the scenario to Drive.<br /> ;Returned Value<br /> *True on success. False if something failed.<br /> ;Notes<br /> *Loads the Driver module with a scenario<br /> *INTERNAL USE ONLY. DO NOT USE! This function will not be maintained in future versions of Trainz.<br /> <br><br /> {{MethodHeader|native bool LoadDriverSavedSession(string theSavedSession)}}<br /> ;Parameters<br /> * do not use<br /> ;Returned Value<br /> *True on success. False if something failed.<br /> ;Notes<br /> *INTERNAL USE ONLY. DO NOT USE! This function will not be maintained in future versions of Trainz.<br /> <br><br /> {{MethodHeader|native bool LoadSurveyorNew()}}<br /> ;Parameters<br /> *none<br /> ;Returned Value<br /> *True on success. False if something failed.<br /> ;Notes<br /> *Loads the Surveyor module with a new map.<br /> <br><br /> {{MethodHeader|native bool LoadSurveyorMap(KUID kuid)}}<br /> ;Parameters<br /> *'''kuid''' = the KUID of the map to load.<br /> ;Returned Value<br /> *True on success. False if something failed.<br /> ;Notes<br /> *Loads the Surveyor module with a map.<br /> <br><br /> {{MethodHeader|native bool LoadSurveyorMapNewSession(KUID kuid)}}<br /> ;Parameters<br /> *'''kuid''' = the KUID of the map to load.<br /> ;Returned Value<br /> *True on success. False if something failed.<br /> ;Notes<br /> *Loads the Surveyor module with a map, to start a new session.<br /> <br><br /> {{MethodHeader|native bool LoadSurveyorSession(KUID kuid)}}<br /> ;Parameters<br /> *'''kuid''' = the KUID of the session to load.<br /> ;Returned Value<br /> *True on success. False if something failed.<br /> ;Notes<br /> *Loads the Surveyor module with a session.<br /> <br><br /> {{MethodHeader|native bool LoadRailyard(KUID kuid)}}<br /> ;Parameters<br /> *'''kuid''' = the KUID of the vehicle to select in Railyard. May be null.<br /> ;Returned Value<br /> *True on success. False if something failed.<br /> ;Notes<br /> *Loads the Railyard module, optionally displaying the specified vehicle.<br /> <br><br /> {{MethodHeader|native Soup GetSavedSessionInfo()}}<br /> ;Parameters<br /> *<br /> ;Returned Value<br /> *<br /> ;Notes<br /> *INTERNAL USE ONLY. DO NOT USE! This function will not be maintained in future versions of Trainz.<br /> <br><br /> {{MethodHeader|native bool DeleteMap(KUID theMap)}}<br /> ;Parameters<br /> *'''theMap''' = the KUID of the route to delete<br /> ;Returned Value<br /> *True if successfully deleted.<br /> ;Notes<br /> *Deletes a specific map, and all sessions that use it<br /> <br><br /> {{MethodHeader|native bool DeleteSession(KUID theSession)}}<br /> ;Parameters<br /> *'''theSession''' = the session to delete<br /> ;Returned Value<br /> *True if successfully deleted.<br /> ;Notes<br /> *Deletes a specific session<br /> <br><br /> {{MethodHeader|native bool DeleteScenario(KUID theScenario)}}<br /> ;Parameters<br /> *'''theScenario''' = the scenario to delete<br /> ;Returned Value<br /> *True if successfully deleted.<br /> ;Notes<br /> *Deletes a specific scenario<br /> *INTERNAL USE ONLY. DO NOT USE! This function will not be maintained in future versions of Trainz.<br /> <br><br /> {{MethodHeader|native bool DeleteSavedSession(string theSavedSession)}}<br /> ;Parameters<br /> * N/A<br /> ;Returned Value<br /> * N/A<br /> ;Notes<br /> *INTERNAL USE ONLY. DO NOT USE! This function will not be maintained in future versions of Trainz.<br /> <br /> <br /> <br><br /> <br /> ==Categories==<br /> [[Category:Script Class]]</div>

Marinus https://wiki.trainzsimulator.com/index.php?title=TrainzScript_Library_Reference&diff=1674 TrainzScript Library Reference 2010-10-30T22:58:59Z

<p>Marinus: added gameplaymenu reference</p> <hr /> <div>The following is a list of all "common" classes provided by Auran for use with the Trainz game runtime environment. Some of these classes may not be available from other runtime environments. Please see the [[TrainzScript Language Reference]] for a list of the "core" TrainzScript classes that are present in all runtime environments.<br /> <br /> ''Classes marked with an asterisk have no parent class.''<br /> <br /> *[[class GSObject|GSObject]] *<br /> **[[class Asset|Asset]]<br /> **[[class GameObject|GameObject]]<br /> ***[[class Browser|Browser]]<br /> ***[[class Train|Train]]<br /> ***[[class TrainzGameObject|TrainzGameObject]]<br /> ****[[class GameplayMenu|GameplayMenu]]<br /> ***[[class PropertyObject|PropertyObject]] *<br /> ****[[class MeshObject|MeshObject]]<br /> *****[[class Bogey|Bogey]]<br /> *****[[class Cabin|Cabin]]<br /> *****[[class MapObject|MapObject]]<br /> ******[[class SceneryWithTrack|SceneryWithTrack]]<br /> *******[[class Buildable|Buildable]]<br /> ********[[Class Industry|Industry]]<br /> *******[[class Crossing|Crossing]]<br /> *******[[class Turntable|Turntable]]<br /> ******[[class JunctionBase|JunctionBase]] *<br /> ******[[class Trackside|Trackside]]<br /> *******[[class Junction|Junction]]<br /> *******[[class Signal|Signal]]<br /> *******[[class Trackmark|Trackmark]]<br /> *******[[class Trigger|Trigger]]<br /> *******[[class Vehicle|Vehicle]]<br /> ********[[class Locomotive|Locomotive]]<br /> ****[[class Library|Library]]<br /> **[[class KUID|KUID]]<br /> **[[class Soup|Soup]]<br /> **[[class StringTable|StringTable]]<br /> *[[class Constructors|Constructors]] *<br /> *[[class GSTrackSearch|GSTrackSearch]] *<br /> *[[Class Interface|Interface]] *<br /> *[[class Math|Math]] *<br /> *[[class Router|Router]] *<br /> *[[class Str|Str]] *<br /> *[[class TrainUtil|TrainUtil]] *<br /> *[[class World|World]] *<br /> *[[class World1|World1]] *<br /> <br /> <br /> =Categories=<br /> [[Category:TrainzScript]]</div>

Marinus https://wiki.trainzsimulator.com/index.php?title=Class_GameplayMenu&diff=1673 Class GameplayMenu 2010-10-30T22:57:05Z

<p>Marinus: </p> <hr /> <div>*[[TrainzScript Language Reference|API Hierarchy]]<br /> **[[Class GSObject|GSObject]]<br /> ***[[Class GameObject|GameObject]]<br /> ****[[Class TrainzGameObject|TrainzGameObject]]<br /> *****GameplayMenu<br /> <br><br /> * A class that implements a in-game Menu like the Routes or Scenario Menu.<br /> * This script is running in the [[New TrainzScript Features#Global script context|global script context]]<br /> <br><br /> <br /> ==Constants==<br /> <br><br /> ===Menu Modes===<br /> <br><br /> {{TableHeader|width=95%|margin=15px}}<br /> |width=375|public define int MENUMODE_NONE = 0||Not visible.<br /> |-<br /> |public define int MENUMODE_BUTTON = 1;||Visible as a button on the gameplay menu.<br /> |-<br /> |public define int MENUMODE_MENU = 2;||Visible as a full-screen menu.<br /> |}<br /> <br><br /> ==Members==<br /> <br><br /> {{TableHeader|width=95%|margin=15px}}<br /> |width=375|<b> Browser m_browser</b>||An internal reference to the embedded browser object, which displays this game menu<br /> |}<br /> <br><br /> <br /> ==Methods==<br /> {{MethodHeader|public void SetGameplayMenuMode(Browser browser, int menuMode)}}<br /> ;Parameters<br /> *'''browser ''' = The Browser control which is used to visualise this GameplayMenu.<br /> *'''menuMode''' = One of the [[#Menu Modes|MENUMODE_*]] defines, indicating which mode we are switching to.<br /> ;Returned Value<br /> *None<br /> ;Notes<br /> *Called whenever the menumode of this GameplayMenu is changed.<br /> *Change the appearance of this menu based on menuMode by changing the HTML code of the embedded browser object [[#Members|m_browser]]<br /> <br><br /> {{MethodHeader|public native void CloseGameplayMenu(void)}}<br /> ;Parameters<br /> *none<br /> ;Returned Value<br /> *none<br /> ;Notes<br /> *This function causes this gameplay menu to be closed, returning the user to the game main menu.<br /> <br><br /> {{MethodHeader|public void UserRequestGoBack(void)}}<br /> ;Parameters<br /> *none<br /> ;Returned Value<br /> *none<br /> ;Notes<br /> *Called whenever the user requests a "go back" action. <br /> *If the user has navigated to some form of "sub menu", this should return them to the main level of this gameplay menu. <br /> *If at the main level, this should close the gameplay menu and return to the game main menu.<br /> <br><br /> {{MethodHeader|public void TADRequestRefresh(void)}}<br /> ;Parameters<br /> *<br /> ;Returned Value<br /> *<br /> ;Notes<br /> *Called on a fullscreen menu when the TAD is modified.<br /> *Dynamic menus based on lists of assets may wish to refresh their view of the world at this time.<br /> <br><br /> {{MethodHeader|native bool LoadDriverQuickDrive(KUID kuid)}}<br /> ;Parameters<br /> *'''kuid''' = the KUID of the map to QuickDrive.<br /> ;Returned Value<br /> *True on success. False if something failed.<br /> ;Notes<br /> *Loads the Driver module with the supplied map<br /> <br><br /> {{MethodHeader|native bool LoadDriverSession(KUID kuid)}}<br /> ;Parameters<br /> *'''kuid''' = the KUID of the session to Drive.<br /> ;Returned Value<br /> *True on success. False if something failed.<br /> ;Notes<br /> *Loads the Driver module with a session<br /> <br><br /> {{MethodHeader|native bool LoadDriverScenario(KUID kuid)}}<br /> ;Parameters<br /> *'''kuid''' = the KUID of the scenario to Drive.<br /> ;Returned Value<br /> *True on success. False if something failed.<br /> ;Notes<br /> *Loads the Driver module with a scenario<br /> *INTERNAL USE ONLY. DO NOT USE! This function will not be maintained in future versions of Trainz.<br /> <br><br /> {{MethodHeader|native bool LoadDriverSavedSession(string theSavedSession)}}<br /> ;Parameters<br /> * do not use<br /> ;Returned Value<br /> *True on success. False if something failed.<br /> ;Notes<br /> *INTERNAL USE ONLY. DO NOT USE! This function will not be maintained in future versions of Trainz.<br /> <br><br /> {{MethodHeader|native bool LoadSurveyorNew()}}<br /> ;Parameters<br /> *none<br /> ;Returned Value<br /> *True on success. False if something failed.<br /> ;Notes<br /> *Loads the Surveyor module with a new map.<br /> <br><br /> {{MethodHeader|native bool LoadSurveyorMap(KUID kuid)}}<br /> ;Parameters<br /> *'''kuid''' = the KUID of the map to load.<br /> ;Returned Value<br /> *True on success. False if something failed.<br /> ;Notes<br /> *Loads the Surveyor module with a map.<br /> <br><br /> {{MethodHeader|native bool LoadSurveyorMapNewSession(KUID kuid)}}<br /> ;Parameters<br /> *'''kuid''' = the KUID of the map to load.<br /> ;Returned Value<br /> *True on success. False if something failed.<br /> ;Notes<br /> *Loads the Surveyor module with a map, to start a new session.<br /> <br><br /> {{MethodHeader|native bool LoadSurveyorSession(KUID kuid)}}<br /> ;Parameters<br /> *'''kuid''' = the KUID of the session to load.<br /> ;Returned Value<br /> *True on success. False if something failed.<br /> ;Notes<br /> *Loads the Surveyor module with a session.<br /> <br><br /> {{MethodHeader|native bool LoadRailyard(KUID kuid)}}<br /> ;Parameters<br /> *'''kuid''' = the KUID of the vehicle to select in Railyard. May be null.<br /> ;Returned Value<br /> *True on success. False if something failed.<br /> ;Notes<br /> *Loads the Railyard module, optionally displaying the specified vehicle.<br /> <br><br /> {{MethodHeader|native Soup GetSavedSessionInfo()}}<br /> ;Parameters<br /> *<br /> ;Returned Value<br /> *<br /> ;Notes<br /> *INTERNAL USE ONLY. DO NOT USE! This function will not be maintained in future versions of Trainz.<br /> <br><br /> {{MethodHeader|native bool DeleteMap(KUID theMap)}}<br /> ;Parameters<br /> *'''theMap''' = the KUID of the route to delete<br /> ;Returned Value<br /> *True if successfully deleted.<br /> ;Notes<br /> *Deletes a specific map, and all sessions that use it<br /> <br><br /> {{MethodHeader|native bool DeleteSession(KUID theSession)}}<br /> ;Parameters<br /> *'''theSession''' = the session to delete<br /> ;Returned Value<br /> *True if successfully deleted.<br /> ;Notes<br /> *Deletes a specific session<br /> <br><br /> {{MethodHeader|native bool DeleteScenario(KUID theScenario)}}<br /> ;Parameters<br /> *'''theScenario''' = the scenario to delete<br /> ;Returned Value<br /> *True if successfully deleted.<br /> ;Notes<br /> *Deletes a specific scenario<br /> *INTERNAL USE ONLY. DO NOT USE! This function will not be maintained in future versions of Trainz.<br /> <br><br /> {{MethodHeader|native bool DeleteSavedSession(string theSavedSession)}}<br /> ;Parameters<br /> * N/A<br /> ;Returned Value<br /> * N/A<br /> ;Notes<br /> *INTERNAL USE ONLY. DO NOT USE! This function will not be maintained in future versions of Trainz.<br /> <br /> <br /> <br><br /> <br /> ==Categories==<br /> [[Category:Script Class]]</div>

Marinus https://wiki.trainzsimulator.com/index.php?title=Talk:Class_StringTable&diff=1614 Talk:Class StringTable 2010-10-18T08:53:51Z

<p>Marinus: </p> <hr /> <div>The initial version of this page, and also the comments in stringtable.gs indicate '%' as the meta symbol for replacement variables, but instead it should be '$'</div>

Marinus https://wiki.trainzsimulator.com/index.php?title=Talk:Class_StringTable&diff=1611 Talk:Class StringTable 2010-10-18T08:52:43Z

<p>Marinus: New page: The initial config, and also the comments in stringtable.gs indicate '%' as the meta symbol for replacement variables, but instead it should be '$'</p> <hr /> <div>The initial config, and also the comments in stringtable.gs indicate '%' as the meta symbol for replacement variables, but instead it should be '$'</div>

Marinus https://wiki.trainzsimulator.com/index.php?title=Class_StringTable&diff=1608 Class StringTable 2010-10-18T08:51:29Z

<p>Marinus: Replaced '%' with the correct symbo '$'</p> <hr /> <div>__FORCETOC__<br /> *[[TrainzScript Language Reference|API Hierarchy]]<br /> **[[Class GSObject|GSObject]]<br /> ***StringTable<br /> <br><br /> <br /> *The StringTable class provides access to an asset's string table.<br /> *Any asset can have a string table container in its config.txt file, defined in the following format:<br /> string-table {<br /> Industry_Title "Packing Plant"<br /> Industry_Description "$0 Packing Plant"<br /> Announcement "The train at platform $0 is the $1 for $2, $3 and $4"<br /> }<br /> <br /> *A string can have up to 10 parameters in the range of $0..$9.<br /> *A string table parameter is identified by the percentage character '$' followed by the parameter number.<br /> *The methods in this class allow a string to be retrieved such that its parameters are substituted with the desired string.<br /> *String tables can be used to store segments of HTML code that can be reused with the substituted parameters to define a table for example.<br /> *The Browser class also supports the use of string parameters through its [[Class Browser|Browser.SetParam()]] method.<br /> <br><br /> <br /> ==Methods==<br /> <br><br /> <br /> ===ClearParams===<br /> {{MethodHeader|public native void ClearParams(void)}}<br /> ;Parameters<br /> *None<br /> ;Returned Value<br /> *None<br /> ;Syntax<br /> table.ClearParams();<br /> ;Notes<br /> *Resets the parameter list for the referenced StringTable.<br /> <br><br /> <br /> ===GetLanguage===<br /> {{MethodHeader|public native string GetLanguage(void)}}<br /> ;Parameters<br /> *None<br /> ;Returned Value<br /> *The current language version of Trainz.<br /> ;Syntax<br /> string language = GetLanguage();<br /> ;Notes<br /> <br><br /> <br /> ===GetString===<br /> {{MethodHeader|public native string GetString(string s)<br>public native string GetString0(string s)}}<br /> ;Parameters<br /> *'''s''' = Name of the StringTable value to retrieve.<br /> ;Returned Value<br /> *Value of the named item.<br /> ;Syntax<br /> <font color=#808080>// Industry_Description "Packing Plant"</font><br /> <br /> description = table.GetString("Industry_Description"); // returns "Packing Plant"<br /> ;Notes<br /> *If the named value is not present an empty string is returned.<br /> <br><br /> <br /> ===GetString#===<br /> {{MethodHeader|public string GetString1(string s, string p0)<br>public string GetString10(string s, string p0,.., string p9)}}<br /> ;Parameters<br /> *'''s''' = Name of the StringTable value to retrieve.<br /> *'''p0..p9''' = Replaceable parameters identified by "$0".."$9".<br /> ;Returned Value<br /> *None<br /> ;Syntax<br /> <font color=#808080>// Industry_Description "$0 Packing Plant"</font><br /> <br /> description = table.GetString1("Industry_Description","Wagga Wagga"); // returns "Wagga Wagga Packing Plant"<br /> <br /> <font color=#808080>// Announcement "The train at platform $0 is the $1 for $2, $3 and $4"</font><br /> <br /> description = table.GetString5("Announcement","1","8:15","Chelmsford","Witham","Colchester");<br /> // returns "The train at platform 1 is the 8:15 for Chelmsford, Witham and Colchester"<br /> ;Notes<br /> *A series of methods to retrieve a named string with substitution of up to 10 replaceable parameters.<br /> *The parameters are set up as placeholders within the StringTable using a percentage sign as an escape character.<br /> *Just to keep things simple function name counting starts at 1 and parameter indexing starts at zero.<br /> <br><br /> <br /> ===SetParam===<br /> {{MethodHeader|public native void SetParam(int param, string text)}}<br /> ;Parameters<br /> *'''param''' = Index of parameter to define.<br /> *'''text''' = String value to assign to the defined parameter.<br /> ;Returned Value<br /> *None<br /> ;Syntax<br /> <font color=#808080>// Industry_Description "$0 Packing Plant"</font><br /> <font color=#808080>// Station_Description "$0 Station"</font><br /> <br /> table.SetParam(1,"Fremantle");<br /> table.GetString("Industry_Description"); // returns "Fremantle Packing Plant"<br /> table.GetString("Station_Description"); // returns "Fremantle Station"<br /> ;Notes<br /> *The value assigned to the parameter remains in place until amended or until a call to ClearParams() is made.<br /> <br><br /> <br /> ==Categories==<br /> [[Category:Script Class]]</div>

Marinus https://wiki.trainzsimulator.com/index.php?title=Class_GameplayMenu&diff=1531 Class GameplayMenu 2010-10-15T15:05:38Z

<p>Marinus: /* Methods */</p> <hr /> <div>*[[TrainzScript Language Reference|API Hierarchy]]<br /> **[[Class GSObject|GSObject]]<br /> ***[[Class GameObject|GameObject]]<br /> ****[[Class TrainzGameObject|TrainzGameObject]]<br /> *****[[Class Library| Library]]<br /> ******GameplayMenu<br /> <br><br /> * A class that implements a in-game Menu like the Routes or Scenario Menu.<br /> * This script is running in the [[New TrainzScript Features#Global script context|global script context]]<br /> <br><br /> <br /> ==Constants==<br /> <br><br /> ===Menu Modes===<br /> <br><br /> {{TableHeader|width=95%|margin=15px}}<br /> |width=375|public define int MENUMODE_NONE = 0||Not visible.<br /> |-<br /> |public define int MENUMODE_BUTTON = 1;||Visible as a button on the gameplay menu.<br /> |-<br /> |public define int MENUMODE_MENU = 2;||Visible as a full-screen menu.<br /> |}<br /> <br><br /> ==Members==<br /> <br><br /> {{TableHeader|width=95%|margin=15px}}<br /> |width=375|<b> Browser m_browser</b>||An internal reference to the embedded browser object, which displays this game menu<br /> |}<br /> <br><br /> <br /> ==Methods==<br /> {{MethodHeader|public void SetGameplayMenuMode(Browser browser, int menuMode)}}<br /> ;Parameters<br /> *'''browser ''' = The Browser control which is used to visualise this GameplayMenu.<br /> *'''menuMode''' = One of the [[#Menu Modes|MENUMODE_*]] defines, indicating which mode we are switching to.<br /> ;Returned Value<br /> *None<br /> ;Notes<br /> *Called whenever the menumode of this GameplayMenu is changed.<br /> *Change the appearance of this menu based on menuMode by changing the HTML code of the embedded browser object [[#Members|m_browser]]<br /> <br><br /> {{MethodHeader|public native void CloseGameplayMenu(void)}}<br /> ;Parameters<br /> *none<br /> ;Returned Value<br /> *none<br /> ;Notes<br /> *This function causes this gameplay menu to be closed, returning the user to the game main menu.<br /> <br><br /> {{MethodHeader|public void UserRequestGoBack(void)}}<br /> ;Parameters<br /> *none<br /> ;Returned Value<br /> *none<br /> ;Notes<br /> *Called whenever the user requests a "go back" action. <br /> *If the user has navigated to some form of "sub menu", this should return them to the main level of this gameplay menu. <br /> *If at the main level, this should close the gameplay menu and return to the game main menu.<br /> <br><br /> {{MethodHeader|public void TADRequestRefresh(void)}}<br /> ;Parameters<br /> *<br /> ;Returned Value<br /> *<br /> ;Notes<br /> *Called on a fullscreen menu when the TAD is modified.<br /> *Dynamic menus based on lists of assets may wish to refresh their view of the world at this time.<br /> <br><br /> {{MethodHeader|native bool LoadDriverQuickDrive(KUID kuid)}}<br /> ;Parameters<br /> *'''kuid''' = the KUID of the map to QuickDrive.<br /> ;Returned Value<br /> *True on success. False if something failed.<br /> ;Notes<br /> *Loads the Driver module with the supplied map<br /> <br><br /> {{MethodHeader|native bool LoadDriverSession(KUID kuid)}}<br /> ;Parameters<br /> *'''kuid''' = the KUID of the session to Drive.<br /> ;Returned Value<br /> *True on success. False if something failed.<br /> ;Notes<br /> *Loads the Driver module with a session<br /> <br><br /> {{MethodHeader|native bool LoadDriverScenario(KUID kuid)}}<br /> ;Parameters<br /> *'''kuid''' = the KUID of the scenario to Drive.<br /> ;Returned Value<br /> *True on success. False if something failed.<br /> ;Notes<br /> *Loads the Driver module with a scenario<br /> <br><br /> {{MethodHeader|native bool LoadDriverSavedSession(string theSavedSession)}}<br /> ;Parameters<br /> * do not use<br /> ;Returned Value<br /> *True on success. False if something failed.<br /> ;Notes<br /> *INTERNAL USE ONLY. DO NOT USE! This function will not be maintained in future versions of Trainz.<br /> <br><br /> {{MethodHeader|native bool LoadSurveyorNew()}}<br /> ;Parameters<br /> *none<br /> ;Returned Value<br /> *True on success. False if something failed.<br /> ;Notes<br /> *Loads the Surveyor module with a new map.<br /> <br><br /> {{MethodHeader|native bool LoadSurveyorMap(KUID kuid)}}<br /> ;Parameters<br /> *'''kuid''' = the KUID of the map to load.<br /> ;Returned Value<br /> *True on success. False if something failed.<br /> ;Notes<br /> *Loads the Surveyor module with a map.<br /> <br><br /> {{MethodHeader|native bool LoadSurveyorMapNewSession(KUID kuid)}}<br /> ;Parameters<br /> *'''kuid''' = the KUID of the map to load.<br /> ;Returned Value<br /> *True on success. False if something failed.<br /> ;Notes<br /> *Loads the Surveyor module with a map, to start a new session.<br /> <br><br /> {{MethodHeader|native bool LoadSurveyorSession(KUID kuid)}}<br /> ;Parameters<br /> *'''kuid''' = the KUID of the session to load.<br /> ;Returned Value<br /> *True on success. False if something failed.<br /> ;Notes<br /> *Loads the Surveyor module with a session.<br /> <br><br /> {{MethodHeader|native bool LoadRailyard(KUID kuid)}}<br /> ;Parameters<br /> *'''kuid''' = the KUID of the vehicle to select in Railyard. May be null.<br /> ;Returned Value<br /> *True on success. False if something failed.<br /> ;Notes<br /> *Loads the Railyard module, optionally displaying the specified vehicle.<br /> <br><br /> {{MethodHeader|native Soup GetSavedSessionInfo()}}<br /> ;Parameters<br /> *<br /> ;Returned Value<br /> *<br /> ;Notes<br /> *INTERNAL USE ONLY. DO NOT USE! This function will not be maintained in future versions of Trainz.<br /> <br><br /> {{MethodHeader|native bool DeleteMap(KUID theMap)}}<br /> ;Parameters<br /> *'''theMap''' = the KUID of the route to delete<br /> ;Returned Value<br /> *True if successfully deleted.<br /> ;Notes<br /> *Deletes a specific map, and all sessions that use it<br /> <br><br /> {{MethodHeader|native bool DeleteSession(KUID theSession)}}<br /> ;Parameters<br /> *'''theSession''' = the session to delete<br /> ;Returned Value<br /> *True if successfully deleted.<br /> ;Notes<br /> *Deletes a specific session<br /> <br><br /> {{MethodHeader|native bool DeleteScenario(KUID theScenario)}}<br /> ;Parameters<br /> *'''theScenario''' = the scenario to delete<br /> ;Returned Value<br /> *True if successfully deleted.<br /> ;Notes<br /> *Deletes a specific scenario<br /> <br><br /> {{MethodHeader|native bool DeleteSavedSession(string theSavedSession)}}<br /> ;Parameters<br /> * N/A<br /> ;Returned Value<br /> * N/A<br /> ;Notes<br /> *INTERNAL USE ONLY. DO NOT USE! This function will not be maintained in future versions of Trainz.<br /> <br /> <br /> <br><br /> <br /> ==Categories==<br /> [[Category:Script Class]]</div>

Marinus https://wiki.trainzsimulator.com/index.php?title=Class_GameplayMenu&diff=1530 Class GameplayMenu 2010-10-15T15:05:09Z

<p>Marinus: /* Methods */</p> <hr /> <div>*[[TrainzScript Language Reference|API Hierarchy]]<br /> **[[Class GSObject|GSObject]]<br /> ***[[Class GameObject|GameObject]]<br /> ****[[Class TrainzGameObject|TrainzGameObject]]<br /> *****[[Class Library| Library]]<br /> ******GameplayMenu<br /> <br><br /> * A class that implements a in-game Menu like the Routes or Scenario Menu.<br /> * This script is running in the [[New TrainzScript Features#Global script context|global script context]]<br /> <br><br /> <br /> ==Constants==<br /> <br><br /> ===Menu Modes===<br /> <br><br /> {{TableHeader|width=95%|margin=15px}}<br /> |width=375|public define int MENUMODE_NONE = 0||Not visible.<br /> |-<br /> |public define int MENUMODE_BUTTON = 1;||Visible as a button on the gameplay menu.<br /> |-<br /> |public define int MENUMODE_MENU = 2;||Visible as a full-screen menu.<br /> |}<br /> <br><br /> ==Members==<br /> <br><br /> {{TableHeader|width=95%|margin=15px}}<br /> |width=375|<b> Browser m_browser</b>||An internal reference to the embedded browser object, which displays this game menu<br /> |}<br /> <br><br /> <br /> ==Methods==<br /> {{MethodHeader|public void SetGameplayMenuMode(Browser browser, int menuMode)}}<br /> ;Parameters<br /> *'''browser ''' = The Browser control which is used to visualise this GameplayMenu.<br /> *'''menuMode''' = One of the [[#Menu Modes|MENUMODE_*]] defines, indicating which mode we are switching to.<br /> ;Returned Value<br /> *None<br /> ;Notes<br /> *Called whenever the menumode of this GameplayMenu is changed.<br /> *Change the appearance of this menu based on menuMode by changing the HTML code of the embedded browser object [[Members|m_browser]]<br /> <br><br /> {{MethodHeader|public native void CloseGameplayMenu(void)}}<br /> ;Parameters<br /> *none<br /> ;Returned Value<br /> *none<br /> ;Notes<br /> *This function causes this gameplay menu to be closed, returning the user to the game main menu.<br /> <br><br /> {{MethodHeader|public void UserRequestGoBack(void)}}<br /> ;Parameters<br /> *none<br /> ;Returned Value<br /> *none<br /> ;Notes<br /> *Called whenever the user requests a "go back" action. <br /> *If the user has navigated to some form of "sub menu", this should return them to the main level of this gameplay menu. <br /> *If at the main level, this should close the gameplay menu and return to the game main menu.<br /> <br><br /> {{MethodHeader|public void TADRequestRefresh(void)}}<br /> ;Parameters<br /> *<br /> ;Returned Value<br /> *<br /> ;Notes<br /> *Called on a fullscreen menu when the TAD is modified.<br /> *Dynamic menus based on lists of assets may wish to refresh their view of the world at this time.<br /> <br><br /> {{MethodHeader|native bool LoadDriverQuickDrive(KUID kuid)}}<br /> ;Parameters<br /> *'''kuid''' = the KUID of the map to QuickDrive.<br /> ;Returned Value<br /> *True on success. False if something failed.<br /> ;Notes<br /> *Loads the Driver module with the supplied map<br /> <br><br /> {{MethodHeader|native bool LoadDriverSession(KUID kuid)}}<br /> ;Parameters<br /> *'''kuid''' = the KUID of the session to Drive.<br /> ;Returned Value<br /> *True on success. False if something failed.<br /> ;Notes<br /> *Loads the Driver module with a session<br /> <br><br /> {{MethodHeader|native bool LoadDriverScenario(KUID kuid)}}<br /> ;Parameters<br /> *'''kuid''' = the KUID of the scenario to Drive.<br /> ;Returned Value<br /> *True on success. False if something failed.<br /> ;Notes<br /> *Loads the Driver module with a scenario<br /> <br><br /> {{MethodHeader|native bool LoadDriverSavedSession(string theSavedSession)}}<br /> ;Parameters<br /> * do not use<br /> ;Returned Value<br /> *True on success. False if something failed.<br /> ;Notes<br /> *INTERNAL USE ONLY. DO NOT USE! This function will not be maintained in future versions of Trainz.<br /> <br><br /> {{MethodHeader|native bool LoadSurveyorNew()}}<br /> ;Parameters<br /> *none<br /> ;Returned Value<br /> *True on success. False if something failed.<br /> ;Notes<br /> *Loads the Surveyor module with a new map.<br /> <br><br /> {{MethodHeader|native bool LoadSurveyorMap(KUID kuid)}}<br /> ;Parameters<br /> *'''kuid''' = the KUID of the map to load.<br /> ;Returned Value<br /> *True on success. False if something failed.<br /> ;Notes<br /> *Loads the Surveyor module with a map.<br /> <br><br /> {{MethodHeader|native bool LoadSurveyorMapNewSession(KUID kuid)}}<br /> ;Parameters<br /> *'''kuid''' = the KUID of the map to load.<br /> ;Returned Value<br /> *True on success. False if something failed.<br /> ;Notes<br /> *Loads the Surveyor module with a map, to start a new session.<br /> <br><br /> {{MethodHeader|native bool LoadSurveyorSession(KUID kuid)}}<br /> ;Parameters<br /> *'''kuid''' = the KUID of the session to load.<br /> ;Returned Value<br /> *True on success. False if something failed.<br /> ;Notes<br /> *Loads the Surveyor module with a session.<br /> <br><br /> {{MethodHeader|native bool LoadRailyard(KUID kuid)}}<br /> ;Parameters<br /> *'''kuid''' = the KUID of the vehicle to select in Railyard. May be null.<br /> ;Returned Value<br /> *True on success. False if something failed.<br /> ;Notes<br /> *Loads the Railyard module, optionally displaying the specified vehicle.<br /> <br><br /> {{MethodHeader|native Soup GetSavedSessionInfo()}}<br /> ;Parameters<br /> *<br /> ;Returned Value<br /> *<br /> ;Notes<br /> *INTERNAL USE ONLY. DO NOT USE! This function will not be maintained in future versions of Trainz.<br /> <br><br /> {{MethodHeader|native bool DeleteMap(KUID theMap)}}<br /> ;Parameters<br /> *'''theMap''' = the KUID of the route to delete<br /> ;Returned Value<br /> *True if successfully deleted.<br /> ;Notes<br /> *Deletes a specific map, and all sessions that use it<br /> <br><br /> {{MethodHeader|native bool DeleteSession(KUID theSession)}}<br /> ;Parameters<br /> *'''theSession''' = the session to delete<br /> ;Returned Value<br /> *True if successfully deleted.<br /> ;Notes<br /> *Deletes a specific session<br /> <br><br /> {{MethodHeader|native bool DeleteScenario(KUID theScenario)}}<br /> ;Parameters<br /> *'''theScenario''' = the scenario to delete<br /> ;Returned Value<br /> *True if successfully deleted.<br /> ;Notes<br /> *Deletes a specific scenario<br /> <br><br /> {{MethodHeader|native bool DeleteSavedSession(string theSavedSession)}}<br /> ;Parameters<br /> * N/A<br /> ;Returned Value<br /> * N/A<br /> ;Notes<br /> *INTERNAL USE ONLY. DO NOT USE! This function will not be maintained in future versions of Trainz.<br /> <br /> <br /> <br><br /> <br /> ==Categories==<br /> [[Category:Script Class]]</div>

Marinus https://wiki.trainzsimulator.com/index.php?title=Class_GameplayMenu&diff=1529 Class GameplayMenu 2010-10-15T15:04:09Z

<p>Marinus: </p> <hr /> <div>*[[TrainzScript Language Reference|API Hierarchy]]<br /> **[[Class GSObject|GSObject]]<br /> ***[[Class GameObject|GameObject]]<br /> ****[[Class TrainzGameObject|TrainzGameObject]]<br /> *****[[Class Library| Library]]<br /> ******GameplayMenu<br /> <br><br /> * A class that implements a in-game Menu like the Routes or Scenario Menu.<br /> * This script is running in the [[New TrainzScript Features#Global script context|global script context]]<br /> <br><br /> <br /> ==Constants==<br /> <br><br /> ===Menu Modes===<br /> <br><br /> {{TableHeader|width=95%|margin=15px}}<br /> |width=375|public define int MENUMODE_NONE = 0||Not visible.<br /> |-<br /> |public define int MENUMODE_BUTTON = 1;||Visible as a button on the gameplay menu.<br /> |-<br /> |public define int MENUMODE_MENU = 2;||Visible as a full-screen menu.<br /> |}<br /> <br><br /> ==Members==<br /> <br><br /> {{TableHeader|width=95%|margin=15px}}<br /> |width=375|<b> Browser m_browser</b>||An internal reference to the embedded browser object, which displays this game menu<br /> |}<br /> <br><br /> <br /> ==Methods==<br /> {{MethodHeader|public void SetGameplayMenuMode(Browser browser, int menuMode)}}<br /> ;Parameters<br /> *'''browser ''' = The Browser control which is used to visualise this GameplayMenu.<br /> *'''menuMode''' = One of the [[#Menu Modes|MENUMODE_*]] defines, indicating which mode we are switching to.<br /> ;Returned Value<br /> *None<br /> ;Notes<br /> *Called whenever the menumode of this GameplayMenu is changed.<br /> *Change the appearance of this menu based on menuMode by changing the HTML code of the embedded browser object m_browser<br /> <br><br /> {{MethodHeader|public native void CloseGameplayMenu(void)}}<br /> ;Parameters<br /> *none<br /> ;Returned Value<br /> *none<br /> ;Notes<br /> *This function causes this gameplay menu to be closed, returning the user to the game main menu.<br /> <br><br /> {{MethodHeader|public void UserRequestGoBack(void)}}<br /> ;Parameters<br /> *none<br /> ;Returned Value<br /> *none<br /> ;Notes<br /> *Called whenever the user requests a "go back" action. <br /> *If the user has navigated to some form of "sub menu", this should return them to the main level of this gameplay menu. <br /> *If at the main level, this should close the gameplay menu and return to the game main menu.<br /> <br><br /> {{MethodHeader|public void TADRequestRefresh(void)}}<br /> ;Parameters<br /> *<br /> ;Returned Value<br /> *<br /> ;Notes<br /> *Called on a fullscreen menu when the TAD is modified.<br /> *Dynamic menus based on lists of assets may wish to refresh their view of the world at this time.<br /> <br><br /> {{MethodHeader|native bool LoadDriverQuickDrive(KUID kuid)}}<br /> ;Parameters<br /> *'''kuid''' = the KUID of the map to QuickDrive.<br /> ;Returned Value<br /> *True on success. False if something failed.<br /> ;Notes<br /> *Loads the Driver module with the supplied map<br /> <br><br /> {{MethodHeader|native bool LoadDriverSession(KUID kuid)}}<br /> ;Parameters<br /> *'''kuid''' = the KUID of the session to Drive.<br /> ;Returned Value<br /> *True on success. False if something failed.<br /> ;Notes<br /> *Loads the Driver module with a session<br /> <br><br /> {{MethodHeader|native bool LoadDriverScenario(KUID kuid)}}<br /> ;Parameters<br /> *'''kuid''' = the KUID of the scenario to Drive.<br /> ;Returned Value<br /> *True on success. False if something failed.<br /> ;Notes<br /> *Loads the Driver module with a scenario<br /> <br><br /> {{MethodHeader|native bool LoadDriverSavedSession(string theSavedSession)}}<br /> ;Parameters<br /> * do not use<br /> ;Returned Value<br /> *True on success. False if something failed.<br /> ;Notes<br /> *INTERNAL USE ONLY. DO NOT USE! This function will not be maintained in future versions of Trainz.<br /> <br><br /> {{MethodHeader|native bool LoadSurveyorNew()}}<br /> ;Parameters<br /> *none<br /> ;Returned Value<br /> *True on success. False if something failed.<br /> ;Notes<br /> *Loads the Surveyor module with a new map.<br /> <br><br /> {{MethodHeader|native bool LoadSurveyorMap(KUID kuid)}}<br /> ;Parameters<br /> *'''kuid''' = the KUID of the map to load.<br /> ;Returned Value<br /> *True on success. False if something failed.<br /> ;Notes<br /> *Loads the Surveyor module with a map.<br /> <br><br /> {{MethodHeader|native bool LoadSurveyorMapNewSession(KUID kuid)}}<br /> ;Parameters<br /> *'''kuid''' = the KUID of the map to load.<br /> ;Returned Value<br /> *True on success. False if something failed.<br /> ;Notes<br /> *Loads the Surveyor module with a map, to start a new session.<br /> <br><br /> {{MethodHeader|native bool LoadSurveyorSession(KUID kuid)}}<br /> ;Parameters<br /> *'''kuid''' = the KUID of the session to load.<br /> ;Returned Value<br /> *True on success. False if something failed.<br /> ;Notes<br /> *Loads the Surveyor module with a session.<br /> <br><br /> {{MethodHeader|native bool LoadRailyard(KUID kuid)}}<br /> ;Parameters<br /> *'''kuid''' = the KUID of the vehicle to select in Railyard. May be null.<br /> ;Returned Value<br /> *True on success. False if something failed.<br /> ;Notes<br /> *Loads the Railyard module, optionally displaying the specified vehicle.<br /> <br><br /> {{MethodHeader|native Soup GetSavedSessionInfo()}}<br /> ;Parameters<br /> *<br /> ;Returned Value<br /> *<br /> ;Notes<br /> *INTERNAL USE ONLY. DO NOT USE! This function will not be maintained in future versions of Trainz.<br /> <br><br /> {{MethodHeader|native bool DeleteMap(KUID theMap)}}<br /> ;Parameters<br /> *'''theMap''' = the KUID of the route to delete<br /> ;Returned Value<br /> *True if successfully deleted.<br /> ;Notes<br /> *Deletes a specific map, and all sessions that use it<br /> <br><br /> {{MethodHeader|native bool DeleteSession(KUID theSession)}}<br /> ;Parameters<br /> *'''theSession''' = the session to delete<br /> ;Returned Value<br /> *True if successfully deleted.<br /> ;Notes<br /> *Deletes a specific session<br /> <br><br /> {{MethodHeader|native bool DeleteScenario(KUID theScenario)}}<br /> ;Parameters<br /> *'''theScenario''' = the scenario to delete<br /> ;Returned Value<br /> *True if successfully deleted.<br /> ;Notes<br /> *Deletes a specific scenario<br /> <br><br /> {{MethodHeader|native bool DeleteSavedSession(string theSavedSession)}}<br /> ;Parameters<br /> * N/A<br /> ;Returned Value<br /> * N/A<br /> ;Notes<br /> *INTERNAL USE ONLY. DO NOT USE! This function will not be maintained in future versions of Trainz.<br /> <br /> <br /> <br><br /> ==Categories==<br /> [[Category:Script Class]]</div>

Marinus https://wiki.trainzsimulator.com/index.php?title=Class_GameplayMenu&diff=1528 Class GameplayMenu 2010-10-15T13:47:43Z

<p>Marinus: New page: *API Hierarchy **GSObject ***GameObject ****TrainzGameObject *****[[Class Library| Li...</p> <hr /> <div>*[[TrainzScript Language Reference|API Hierarchy]]<br /> **[[Class GSObject|GSObject]]<br /> ***[[Class GameObject|GameObject]]<br /> ****[[Class TrainzGameObject|TrainzGameObject]]<br /> *****[[Class Library| Library]]<br /> ******GameplayMenu<br /> <br><br /> * A class that implements a in-game Menu like the Routes or Scenario Menu.<br /> <br><br /> <br /> ==Constants==<br /> <br><br /> ===Menu Modes===<br /> <br><br /> {{TableHeader|width=95%|margin=15px}}<br /> |width=375|public define int MENUMODE_NONE = 0||Not visible.<br /> |-<br /> |public define int MENUMODE_BUTTON = 1;||Visible as a button on the gameplay menu.<br /> |-<br /> |public define int MENUMODE_MENU = 2;||Visible as a full-screen menu.<br /> |}<br /> <br><br /> <br /> ==Methods==<br /> {{MethodHeader|public void SetGameplayMenuMode(Browser browser, int menuMode)}}<br /> ;Parameters<br /> *'''browser ''' =The Browser control which is used to visualise this GameplayMenu.<br /> *'''menuMode''' = One of the MENUMODE_* defines, indicating which mode we are switching to.<br /> ;Returned Value<br /> *None<br /> ;Notes<br /> *Called whenever the menumode of this GameplayMenu is changed.<br /> *Change the appearance of this menu based on menuMode by changing the HTML code of the embedded browser object m_browser<br /> <br><br /> {{MethodHeader|public native void CloseGameplayMenu(void)}}<br /> ==Categories==<br /> [[Category:Script Class]]</div>

Marinus https://wiki.trainzsimulator.com/index.php?title=KIND_Gameplaymenu&diff=1527 KIND Gameplaymenu 2010-10-15T13:29:28Z

<p>Marinus: New page: KIND Gameplaymenu provides the possibility to create a user defined gameplay menu, similar to the built-in Routes or Scenarios menu. The actual menu must be implemented as a [[Class Ga...</p> <hr /> <div>[[KIND Gameplaymenu]] provides the possibility to create a user defined gameplay menu, similar to the built-in Routes or Scenarios menu. The actual menu must be implemented as a [[Class GameplayMenu|GameplayMenu]] script.<br /> <br /> <br /> ==KIND Hierarchy==<br /> ===Parent Classes===<br /> * ''unknown''<br /> ===Child Classes===<br /> * ''unknown''<br /> <br /> =Builtins=<br /> The built-in [[KIND Gameplaymenu]] assets include:<br /> <br /> * Routes Menu,<kuid:447264:1006><br /> * Tutorials Menu,<kuid:447264:1007><br /> * Railyard Menu,<kuid:447264:1012><br /> * Savegames Menu,<kuid:447264:1015><br /> * Scenarios Menu,<kuid:447264:1016><br /> * Updates Menu,<kuid:447264:1020><br /> <br /> <br /> <br /> ==Categories==<br /> [[Category:Asset KIND]]</div>

Marinus https://wiki.trainzsimulator.com/index.php?title=TrainzScript_User_Interface&diff=1526 TrainzScript User Interface 2010-10-15T13:12:59Z

<p>Marinus: </p> <hr /> <div>TrainzScript objects provide user interfaces through various techniques. Each technique is appropriate to a different set of data and at a different place in the game environment.<br /> <br /> *Driver HUDs.<br /> *Custom Windows.<br /> *Surveyor Rules Interface.<br /> *Surveyor Object Property Editor.<br /> *Game Menus.<br /> <br /> <br /> Most interface techniques use the Trainz [[MiniBrowser]] as the underlying display technology and Auran's special live: protocol for sensing user input such as clicking on a button.</div>

Marinus