TrainzScript Library Reference

From TrainzOnline
(Difference between revisions)
Jump to: navigation, search
m (Add AssetCategory)
 
(3 intermediate revisions by one user not shown)
Line 1: Line 1:
 
The following is a list of all 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. This list may not be complete, but will be extended in future.
 
The following is a list of all 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. This list may not be complete, but will be extended in future.
  
−
''Classes marked with an asterisk have no parent class.''
+
The source code for all classes can be found within your Trainz installation, under ''resources/scripts''. Most classes are contained within obviously named files - e.g. the [[Class World|World]] class can be found in ''world.gs'' - although not all classes are in separate files - [[Class TrainUtil|TrainUtil]] is located in ''common.gs''. Thorough documentation of classes, methods, and constants exists within the source code.
  
−
*[[class AssetCategory|AssetCategory]] *
+
*[[class AssetCategory|AssetCategory]]
−
*[[class GSObject|GSObject]] *
+
*[[class GSObject|GSObject]]
 
**[[class Asset|Asset]]
 
**[[class Asset|Asset]]
 
**[[class DLCInfo|DLCInfo]]
 
**[[class DLCInfo|DLCInfo]]
 
**[[class GameObjectID|GameObjectID]]
 
**[[class GameObjectID|GameObjectID]]
 
**[[class GameObject|GameObject]]
 
**[[class GameObject|GameObject]]
−
***[[class AsyncObjectSearchResult|AsyncObjectSearchResult]]
+
***[[class AsyncQueryHelper|AsyncQueryHelper]]
−
***[[class AsyncTrainzAssetSearchObject|AsyncTrainzAssetSearchObject]]
+
****[[class AsyncObjectSearchResult|AsyncObjectSearchResult]]
 +
****[[class AsyncTrainzAssetSearchObject|AsyncTrainzAssetSearchObject]]
 
***[[class Browser|Browser]]
 
***[[class Browser|Browser]]
 
***[[class BrowserInterface|BrowserInterface]]
 
***[[class BrowserInterface|BrowserInterface]]
Line 22: Line 23:
 
***[[class Interface|Interface]]
 
***[[class Interface|Interface]]
 
***[[class InterlockingTowerPath|InterlockingTowerPath]]
 
***[[class InterlockingTowerPath|InterlockingTowerPath]]
−
***[[class JunctionBaseGameObject|JunctionBaseGameObject]] (Additional parent class: [[class JunctionBase|JunctionBase]] *)
+
***[[class JunctionBaseGameObject|JunctionBaseGameObject]] (Additional parent class: [[class JunctionBase|JunctionBase]])
 
***[[class NavPoints|NavPoints]]
 
***[[class NavPoints|NavPoints]]
 
***[[class ChatChannel|ChatChannel]]
 
***[[class ChatChannel|ChatChannel]]
Line 35: Line 36:
 
*****[[class GameplayMenu|GameplayMenu]]
 
*****[[class GameplayMenu|GameplayMenu]]
 
*****[[class GameplayMenuMobile|GameplayMenuMobile]]
 
*****[[class GameplayMenuMobile|GameplayMenuMobile]]
−
****[[class Library|Library]] (Additional parent class: [[class PropertyObject|PropertyObject]] *)
+
****[[class Library|Library]] (Additional parent class: [[class PropertyObject|PropertyObject]])
 
*****[[class OAChat|OAChat]]
 
*****[[class OAChat|OAChat]]
 
*****[[class Servlet|Servlet]]
 
*****[[class Servlet|Servlet]]
 
*****[[class SessionVariables|SessionVariables]]
 
*****[[class SessionVariables|SessionVariables]]
 
*****[[class WaybillManager|WaybillManager]]
 
*****[[class WaybillManager|WaybillManager]]
−
****[[class MeshObject|MeshObject]] (Additional parent class: [[class PropertyObject|PropertyObject]] *)
+
****[[class MeshObject|MeshObject]] (Additional parent class: [[class PropertyObject|PropertyObject]])
 
*****[[class Bogey|Bogey]]
 
*****[[class Bogey|Bogey]]
 
*****[[class Cabin|Cabin]]
 
*****[[class Cabin|Cabin]]
Line 56: Line 57:
 
******[[class Trackside|Trackside]]
 
******[[class Trackside|Trackside]]
 
*******[[class CarSignal|CarSignal]]
 
*******[[class CarSignal|CarSignal]]
−
*******[[class Junction|Junction]] (Additional parent class: [[class JunctionBase|JunctionBase]] *)
+
*******[[class Junction|Junction]] (Additional parent class: [[class JunctionBase|JunctionBase]])
 
*******[[class Signal|Signal]]
 
*******[[class Signal|Signal]]
 
*******[[class TrackMark|TrackMark]]
 
*******[[class TrackMark|TrackMark]]
Line 62: Line 63:
 
*******[[class Vehicle|Vehicle]]
 
*******[[class Vehicle|Vehicle]]
 
********[[class Locomotive|Locomotive]]
 
********[[class Locomotive|Locomotive]]
−
****[[class ModulScript|ModulScript]]
 
 
*****[[class DriverCharacter|DriverCharacter]]
 
*****[[class DriverCharacter|DriverCharacter]]
 
****[[class ScenarioBehavior|ScenarioBehavior]]
 
****[[class ScenarioBehavior|ScenarioBehavior]]
Line 84: Line 84:
 
**[[class TrackPathDisplay|TrackPathDisplay]]
 
**[[class TrackPathDisplay|TrackPathDisplay]]
 
**[[class TrainTimeTable|TrainTimeTable]]
 
**[[class TrainTimeTable|TrainTimeTable]]
−
*[[class GSTrackSearch|GSTrackSearch]] *
+
*[[class GSTrackSearch|GSTrackSearch]]
−
*[[class Math|Math]] *
+
*[[class JunctionBase|JunctionBase]]
−
*[[class Router|Router]] *
+
*[[class Math|Math]]
−
*[[class Str|Str]] *
+
*[[class NamedObjectInfo|NamedObjectInfo]]
−
*[[class TrainUtil|TrainUtil]] *
+
*[[class PropertyObject|PropertyObject]]
 +
*[[class Router|Router]]
 +
*[[class Str|Str]]
 +
*[[class TrainUtil|TrainUtil]]
  
  
 
=Categories=
 
=Categories=
 
[[Category:TrainzScript]]
 
[[Category:TrainzScript]]

Latest revision as of 14:22, 26 February 2024

The following is a list of all 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. This list may not be complete, but will be extended in future.

The source code for all classes can be found within your Trainz installation, under resources/scripts. Most classes are contained within obviously named files - e.g. the World class can be found in world.gs - although not all classes are in separate files - TrainUtil is located in common.gs. Thorough documentation of classes, methods, and constants exists within the source code.


[edit] Categories

Retrieved from "https://online.ts2009.com/mediaWiki/index.php?title=TrainzScript_Library_Reference&oldid=40136"
Personal tools