TrainzScript Library Reference

From TrainzOnline
(Difference between revisions)
Jump to: navigation, search
 
(9 intermediate revisions by 4 users not shown)
Line 1: Line 1:
−
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.
+
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 GSObject|GSObject]] *
+
*[[class AssetCategory|AssetCategory]]
 +
*[[class GSObject|GSObject]]
 
**[[class Asset|Asset]]
 
**[[class Asset|Asset]]
 +
**[[class DLCInfo|DLCInfo]]
 +
**[[class GameObjectID|GameObjectID]]
 
**[[class GameObject|GameObject]]
 
**[[class GameObject|GameObject]]
 +
***[[class AsyncQueryHelper|AsyncQueryHelper]]
 +
****[[class AsyncObjectSearchResult|AsyncObjectSearchResult]]
 +
****[[class AsyncTrainzAssetSearchObject|AsyncTrainzAssetSearchObject]]
 
***[[class Browser|Browser]]
 
***[[class Browser|Browser]]
 +
***[[class BrowserInterface|BrowserInterface]]
 +
***[[class CabinControl|CabinControl]]
 +
***[[class ConstructorsBase|ConstructorsBase]]
 +
****[[class Constructors|Constructors]]
 +
***[[class DLCStore|DLCStore]]
 +
***[[class DriverCommand|DriverCommand]]
 +
***[[class DriverCommands|DriverCommands]]
 +
***[[class HTMLPropertyHandler|HTMLProprtyHandler]]
 +
***[[class Interface|Interface]]
 +
***[[class InterlockingTowerPath|InterlockingTowerPath]]
 +
***[[class JunctionBaseGameObject|JunctionBaseGameObject]] (Additional parent class: [[class JunctionBase|JunctionBase]])
 +
***[[class NavPoints|NavPoints]]
 +
***[[class ChatChannel|ChatChannel]]
 +
***[[class OnlineAccess|OnlineAccess]]
 +
***[[class OnlineGroup|OnlineGroup]]
 +
***[[class Track|Track]]
 +
***[[class TrackCircuitBlock|TrackCircuitBlock]]
 
***[[class Train|Train]]
 
***[[class Train|Train]]
 +
***[[class TrainzAssetSearch|TrainzAssetSearch]]
 
***[[class TrainzGameObject|TrainzGameObject]]
 
***[[class TrainzGameObject|TrainzGameObject]]
−
****[[class GameplayMenu|GameplayMenu]]
+
****[[class GameplayMenuBase|GameplayMenuBase]]
−
*[[class PropertyObject|PropertyObject]] *
+
*****[[class GameplayMenu|GameplayMenu]]
−
****[[class MeshObject|MeshObject]]
+
*****[[class GameplayMenuMobile|GameplayMenuMobile]]
 +
****[[class Library|Library]] (Additional parent class: [[class PropertyObject|PropertyObject]])
 +
*****[[class OAChat|OAChat]]
 +
*****[[class Servlet|Servlet]]
 +
*****[[class SessionVariables|SessionVariables]]
 +
*****[[class WaybillManager|WaybillManager]]
 +
****[[class MeshObject|MeshObject]] (Additional parent class: [[class PropertyObject|PropertyObject]])
 
*****[[class Bogey|Bogey]]
 
*****[[class Bogey|Bogey]]
 
*****[[class Cabin|Cabin]]
 
*****[[class Cabin|Cabin]]
Line 18: Line 48:
 
******[[class SceneryWithTrack|SceneryWithTrack]]
 
******[[class SceneryWithTrack|SceneryWithTrack]]
 
*******[[class Buildable|Buildable]]
 
*******[[class Buildable|Buildable]]
−
********[[Class Industry|Industry]]
+
********[[class Industry|Industry]]
 +
*********[[class BaseIndustry|BaseIndustry]]
 +
**********[[class GenericPassengerStation|GenericPassengerStation]]
 +
*********[[class BasePortal|BasePortal]]
 +
*********[[class GenericIndustry|GenericIndustry]]
 
*******[[class Crossing|Crossing]]
 
*******[[class Crossing|Crossing]]
−
*******[[class Turntable|Turntable]]
+
*******[[Class_Turntable|TurnTable]]
−
*[[class JunctionBase|JunctionBase]] *
+
 
******[[class Trackside|Trackside]]
 
******[[class Trackside|Trackside]]
−
*******[[class Junction|Junction]]
+
*******[[class CarSignal|CarSignal]]
 +
*******[[class Junction|Junction]] (Additional parent class: [[class JunctionBase|JunctionBase]])
 
*******[[class Signal|Signal]]
 
*******[[class Signal|Signal]]
−
*******[[class Trackmark|Trackmark]]
+
*******[[class TrackMark|TrackMark]]
 
*******[[class Trigger|Trigger]]
 
*******[[class Trigger|Trigger]]
 
*******[[class Vehicle|Vehicle]]
 
*******[[class Vehicle|Vehicle]]
 
********[[class Locomotive|Locomotive]]
 
********[[class Locomotive|Locomotive]]
−
****[[class Library|Library]]
+
*****[[class DriverCharacter|DriverCharacter]]
 +
****[[class ScenarioBehavior|ScenarioBehavior]]
 +
*****[[class ConditionalScenarioBehavior|ConditionalScenarioBehavior]]
 +
*****[[class ScenarioBehaviorTemplate|ScenarioBehaviorTemplate]]
 +
***[[class TrainzScriptBase|TrainzScriptBase]]
 +
****[[class World|World]]
 +
***[[class World1|World1]]
 +
**[[class HTMLBuffer|HTMLBuffer]]
 +
**[[class IndustryTrainController|IndustryTrainController]]
 
**[[class KUID|KUID]]
 
**[[class KUID|KUID]]
 +
**[[class KUIDList|KUIDList]]
 +
**[[class LoadingReport|LoadingReport]]
 +
**[[class Menu|Menu]]
 +
**[[class Permit|Permit]]
 +
**[[class ProductFilter|ProductFilter]]
 +
**[[class ProductQueue|ProductQueue]]
 +
**[[class SecurityToken|SecurityToken]]
 
**[[class Soup|Soup]]
 
**[[class Soup|Soup]]
 
**[[class StringTable|StringTable]]
 
**[[class StringTable|StringTable]]
−
*[[class Constructors|Constructors]] *
+
**[[class TrackPathDisplay|TrackPathDisplay]]
−
*[[class GSTrackSearch|GSTrackSearch]] *
+
**[[class TrainTimeTable|TrainTimeTable]]
−
*[[Class Interface|Interface]] *
+
*[[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 World|World]] *
+
*[[class Router|Router]]
−
*[[class World1|World1]] *
+
*[[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