Class InterlockingTowerPath
From TrainzOnline
(Difference between revisions)
(Created page with "The InterlockingTowerPath class is the script representation of an individual Interlocking Tower "Path". In this context a path represents the track that a train can take thro...") |
|||
| Line 13: | Line 13: | ||
==Common functions== | ==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. | 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. | ||
| + | |||
| + | <br>{{MethodHeader|public mandatory void Init(InterlockingTower tower, SecurityToken token)}} | ||
| + | ;Description | ||
| + | ;Parameters | ||
| + | ;Returns | ||
| + | |||
| + | <br>{{MethodHeader|public void SetPathName(string pathName)}} | ||
| + | ;Description | ||
| + | ;Parameters | ||
| + | ;Returns | ||
| + | |||
| + | <br>{{MethodHeader|public string GetPathName()}} | ||
| + | ;Description | ||
| + | ;Parameters | ||
| + | ;Returns | ||
| + | |||
| + | <br>{{MethodHeader|public string GetLocalisedPathName()}} | ||
| + | ;Description | ||
| + | ;Parameters | ||
| + | ;Returns | ||
| + | |||
| + | <br>{{MethodHeader|public bool IsObjectInPathDefinition(MapObject obj, int childIndex, bool bIncludeExternalRequirements)}} | ||
| + | ;Description | ||
| + | ;Parameters | ||
| + | ;Returns | ||
| + | |||
| + | <br>{{MethodHeader|public bool IsObjectOnPath(MapObject obj)}} | ||
| + | ;Description | ||
| + | ;Parameters | ||
| + | ;Returns | ||
| + | |||
| + | <br>{{MethodHeader|public int GetPathClearMethod()}} | ||
| + | ;Description | ||
| + | ;Parameters | ||
| + | ;Returns | ||
| + | |||
| + | <br>{{MethodHeader|public void SetPathClearMethod(int clearMethod)}} | ||
| + | ;Description | ||
| + | ;Parameters | ||
| + | ;Returns | ||
| + | |||
| + | <br>{{MethodHeader|public void ActivatePath(SecurityToken token)}} | ||
| + | ;Description | ||
| + | ;Parameters | ||
| + | ;Returns | ||
| + | |||
| + | <br>{{MethodHeader|public void CancelPath(SecurityToken token)}} | ||
| + | ;Description | ||
| + | ;Parameters | ||
| + | ;Returns | ||
| + | |||
| + | <br>{{MethodHeader|public void SetPanicState(SecurityToken token)}} | ||
| + | ;Description | ||
| + | ;Parameters | ||
| + | ;Returns | ||
| + | |||
| + | <br>{{MethodHeader|public void AddTrain(SecurityToken token, Train train)}} | ||
| + | ;Description | ||
| + | ;Parameters | ||
| + | ;Returns | ||
| + | |||
| + | <br>{{MethodHeader|public void RemoveTrain(SecurityToken token, Train train)}} | ||
| + | ;Description | ||
| + | ;Parameters | ||
| + | ;Returns | ||
| + | |||
| + | <br>{{MethodHeader|public bool IsOccupiedByTrain(Train train, bool bRequireHasClearedEntrySignal)}} | ||
| + | ;Description | ||
| + | ;Parameters | ||
| + | ;Returns | ||
| + | |||
| + | <br>{{MethodHeader|public void EnablePathVisualisation(bool enable, bool bShouldIncludeAllTCBs)}} | ||
| + | ;Description | ||
| + | ;Parameters | ||
| + | ;Returns | ||
Revision as of 11:15, 14 October 2015
The InterlockingTowerPath class is the script representation of an individual Interlocking Tower "Path". In this context a path represents the track that a train can take through an Interlocking Tower controlled area. It is defined by a number of trackside objects (signals, junctions and crossings) and the state that those objects must be in to allow the train passage through that path. Each path has an entry and exit signal. When a train approaches an entry signal the Interlocking Tower (and related libraries) will attempt to assign it a specific path, so that it may pass the signal.
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 mandatory void Init(InterlockingTower tower, SecurityToken token)
- Description
- Parameters
- Returns
public void SetPathName(string pathName)
- Description
- Parameters
- Returns
public string GetPathName()
- Description
- Parameters
- Returns
public string GetLocalisedPathName()
- Description
- Parameters
- Returns
public bool IsObjectInPathDefinition(MapObject obj, int childIndex, bool bIncludeExternalRequirements)
- Description
- Parameters
- Returns
public bool IsObjectOnPath(MapObject obj)
- Description
- Parameters
- Returns
public int GetPathClearMethod()
- Description
- Parameters
- Returns
public void SetPathClearMethod(int clearMethod)
- Description
- Parameters
- Returns
public void ActivatePath(SecurityToken token)
- Description
- Parameters
- Returns
public void CancelPath(SecurityToken token)
- Description
- Parameters
- Returns
public void SetPanicState(SecurityToken token)
- Description
- Parameters
- Returns
public void AddTrain(SecurityToken token, Train train)
- Description
- Parameters
- Returns
public void RemoveTrain(SecurityToken token, Train train)
- Description
- Parameters
- Returns
public bool IsOccupiedByTrain(Train train, bool bRequireHasClearedEntrySignal)
- Description
- Parameters
- Returns
public void EnablePathVisualisation(bool enable, bool bShouldIncludeAllTCBs)
- Description
- Parameters
- Returns
