Class InterlockingTower
From TrainzOnline
(Difference between revisions)
| Line 28: | Line 28: | ||
Creates a new blank path for use by this tower. Any script which needs to create a path should call this function. Any tower which needs to customise the class can then just override this to create their type. | Creates a new blank path for use by this tower. Any script which needs to create a path should call this function. Any tower which needs to customise the class can then just override this to create their type. | ||
;Returns | ;Returns | ||
| − | *A newly created and initialised [[InterlockingTowerPath]] object. | + | *InterlockingTowerPath - A newly created and initialised [[InterlockingTowerPath]] object. |
<br>{{MethodHeader|public string[] GetLocalisedPathNames()}} | <br>{{MethodHeader|public string[] GetLocalisedPathNames()}} | ||
| Line 34: | Line 34: | ||
Returns a list of the current (localised) path names. | Returns a list of the current (localised) path names. | ||
;Returns | ;Returns | ||
| − | *A string array, containing the localised names of every path. | + | *string[] - A string array, containing the localised names of every path. |
<br>{{MethodHeader|public InterlockingTowerPath FindPathByName(string pathName)}} | <br>{{MethodHeader|public InterlockingTowerPath FindPathByName(string pathName)}} | ||
;Description | ;Description | ||
| + | Finds and returns an interlocking path by name, or localised name (for the current language). | ||
;Parameters | ;Parameters | ||
| + | *pathName - The name (or localised name) of the path to find. | ||
;Returns | ;Returns | ||
| + | *InterlockingTowerPath - The found [[InterlockingTowerPath]], or null if no match was found | ||
| + | |||
<br>{{MethodHeader|public InterlockingTowerPath[] GetConflictingPaths(InterlockingTowerPath path)}} | <br>{{MethodHeader|public InterlockingTowerPath[] GetConflictingPaths(InterlockingTowerPath path)}} | ||
Revision as of 10:24, 14 October 2015
The InterlockingTower class is the script representation of an in game Interlocking Tower (aka Signal Tower). Interlocking Towers are used to define track "paths" that trains can travel down.
- API Hierarchy
- GSObject *
- GameObject
- TrainzGameObject
- PropertyObject *
- MeshObject
- MapObject
- InterlockingTower
- MapObject
- MeshObject
- GameObject
- GSObject *
Related Classes
Common functions
Below is a list of some of the basic common functions on the InterlockingTower script class. This list is not intended to be comprehensive, merely provide an overview.
public InterlockingTowerPath CreateNewPath()
- Description
Creates a new blank path for use by this tower. Any script which needs to create a path should call this function. Any tower which needs to customise the class can then just override this to create their type.
- Returns
- InterlockingTowerPath - A newly created and initialised InterlockingTowerPath object.
public string[] GetLocalisedPathNames()
- Description
Returns a list of the current (localised) path names.
- Returns
- string[] - A string array, containing the localised names of every path.
public InterlockingTowerPath FindPathByName(string pathName)
- Description
Finds and returns an interlocking path by name, or localised name (for the current language).
- Parameters
- pathName - The name (or localised name) of the path to find.
- Returns
- InterlockingTowerPath - The found InterlockingTowerPath, or null if no match was found
public InterlockingTowerPath[] GetConflictingPaths(InterlockingTowerPath path)
- Description
- Parameters
- Returns
public mandatory void SetAIState(int aiState)
- Description
- Parameters
- Returns
public void AssignPathToTrain(Train train, string pathName)
- Description
- Parameters
- Returns
public void CancelPathForTrain(Train train, string pathName)
- Description
- Parameters
- Returns
public void SetPanicStateForPath(string pathName)
- Description
- Parameters
- Returns
public void SetTrainAsPassing(Train train, Signal entrySignal)
- Description
- Parameters
- Returns
