Class InterlockingTower - Revision history

Danny252: Add standard API hierarchy

2020-12-28T13:51:13Z

Add standard API hierarchy

← Older revision		Revision as of 13:51, 28 December 2020
Line 1:		Line 1:
	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.		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.

	[[~~Image:InterlockingTower_ClassHierarchy.jpg~~]]		*[[TrainzScript Library Reference\|API Hierarchy]]
			*[[Class GSObject\|GSObject]]
			***[[Class GameObject\|GameObject]]
			****[[Class TrainzGameObject\|TrainzGameObject]]
			*****[[Class MeshObject\|MeshObject]]
			****[[Class PropertyObject\|PropertyObject]]
			******[[Class MapObject\|MapObject]]
			*******InterlockingTower

	==Related Classes==		==Related Classes==

Pw3r at 00:57, 14 October 2015

2015-10-14T00:57:23Z

← Older revision		Revision as of 00:57, 14 October 2015
Line 1:		Line 1:
	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.		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.

	*[[~~TrainzScript Language Reference\|API Hierarchy~~]]		[[Image:InterlockingTower_ClassHierarchy.jpg]]
	~~*[[Class GSObject\|GSObject]] ~~
	***[[Class GameObject\|GameObject]]
	****[[Class TrainzGameObject\|TrainzGameObject]]
	~~***[[Class PropertyObject\|PropertyObject]] ~~
	*****[[Class MeshObject\|MeshObject]]
	******[[Class MapObject\|MapObject]]
	*******InterlockingTower
	~~<br>~~


	==Related Classes==		==Related Classes==

Pw3r at 00:42, 14 October 2015

2015-10-14T00:42:56Z

← Older revision		Revision as of 00:42, 14 October 2015
Line 42:		Line 42:
	*pathName - The name (or localised name) of the path to find.		*pathName - The name (or localised name) of the path to find.
	;Returns		;Returns
	*InterlockingTowerPath - The found [[InterlockingTowerPath]], or null if no match was found		*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)}}
	;Description		;Description
			Builds an array of tower paths which have conflicts with the path passed. This will include any other path which shares an object in its path definition or external requirements.
	;Parameters		;Parameters
			*path - The [[InterlockingTowerPath]] to examine and find conflicts for.
	;Returns		;Returns
			*InterlockingTowerPath[] - An array of tower paths which conflict with the path passed. If no conflicts are found this will be an empty array (i.e. not null).

	<br>{{MethodHeader\|public mandatory void SetAIState(int aiState)}}		<br>{{MethodHeader\|public mandatory void SetAIState(int aiState)}}
	;Description		;Description
			Alters the current state of the towers automatic path selection processing.
	;Parameters		;Parameters
	;~~Returns~~		aiState - The new AI state for the tower, see PATH_ASSIGNMENT_ defines.
			;Note
			This function is 'mandatory', meaning that any overriding function must call the inherited() in order to compile.

	<br>{{MethodHeader\|public void AssignPathToTrain(Train train, string pathName)}}		<br>{{MethodHeader\|public void AssignPathToTrain(Train train, string pathName)}}
	;Description		;Description
			Requests a specific path for the specified train. This will create a queue entry for the train if one doesn't already exist, set it's state to queued and set the path to that requested. The path may not be prepared immediately, if there are conflicting queued entries.
	;Parameters		;Parameters
	~~;Returns~~		*train - The train to assign the path to.
			*pathName - The name of the path to assign.

	<br>{{MethodHeader\|public void CancelPathForTrain(Train train, string pathName)}}		<br>{{MethodHeader\|public void CancelPathForTrain(Train train, string pathName)}}
	;Description		;Description
			Cancels a specific path for the train passed. If the train is not known, or there is no InterlockingTrainPath entry for this train and signal, then no action will be taken.
	;Parameters		;Parameters
	~~;Returns~~		*train - The train to cancel the path for.
			*pathName - The name of the path to cancel.

	<br>{{MethodHeader\|public void SetPanicStateForPath(string pathName)}}		<br>{{MethodHeader\|public void SetPanicStateForPath(string pathName)}}
	;Description		;Description
			Sets as specific path to a panic state, dropping all signals immediately, regardless of any occupying or approaching trains.
	;Parameters		;Parameters
	~~;Returns~~		*pathName - The name of the path to set to a panic/emergency state.

	<br>{{MethodHeader\|public void SetTrainAsPassing(Train train, Signal entrySignal)}}		<br>{{MethodHeader\|public void SetTrainAsPassing(Train train, Signal entrySignal)}}
	;Description		;Description
			Sets a train's state for a specific entry signal to STATE_PASSING, so the tower knows the train is not entering the interlocking, and will ignore it until it leaves the area. If the train is not known, or there is no InterlockingTrainPath entry for this train and signal, then no action will be taken.
	;Parameters		;Parameters
	~~;Returns~~		*train - The train to set as passing.
			*entrySignal - The path entry signal that the train is passing.

Pw3r at 00:24, 14 October 2015

2015-10-14T00:24:44Z

← Older revision		Revision as of 00:24, 14 October 2015
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)}}

Pw3r at 00:22, 14 October 2015

2015-10-14T00:22:31Z

← Older revision		Revision as of 00:22, 14 October 2015
Line 24:		Line 24:
	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.

	{{MethodHeader\|public InterlockingTowerPath CreateNewPath()}}		<br>{{MethodHeader\|public InterlockingTowerPath CreateNewPath()}}
	;Description		;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.		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.
Line 30:		Line 30:
	*A newly created and initialised [[InterlockingTowerPath]] object.		*A newly created and initialised [[InterlockingTowerPath]] object.

	{{MethodHeader\|public string[] GetLocalisedPathNames()}}		<br>{{MethodHeader\|public string[] GetLocalisedPathNames()}}
	;Description		;Description
	Returns a list of the current (localised) path names.		Returns a list of the current (localised) path names.
Line 36:		Line 36:
	*A string array, containing the localised names of every path.		*A string array, containing the localised names of every path.

	{{MethodHeader\|public InterlockingTowerPath FindPathByName(string pathName)}}		<br>{{MethodHeader\|public InterlockingTowerPath FindPathByName(string pathName)}}
	;Description		;Description
	;Parameters		;Parameters
	;Returns		;Returns

	{{MethodHeader\|public InterlockingTowerPath[] GetConflictingPaths(InterlockingTowerPath path)}}		<br>{{MethodHeader\|public InterlockingTowerPath[] GetConflictingPaths(InterlockingTowerPath path)}}
	;Description		;Description
	;Parameters		;Parameters
	;Returns		;Returns

	{{MethodHeader\|public mandatory void SetAIState(int aiState)}}		<br>{{MethodHeader\|public mandatory void SetAIState(int aiState)}}
	;Description		;Description
	;Parameters		;Parameters
	;Returns		;Returns

	{{MethodHeader\|public void AssignPathToTrain(Train train, string pathName)}}		<br>{{MethodHeader\|public void AssignPathToTrain(Train train, string pathName)}}
	;Description		;Description
	;Parameters		;Parameters
	;Returns		;Returns

	{{MethodHeader\|public void CancelPathForTrain(Train train, string pathName)}}		<br>{{MethodHeader\|public void CancelPathForTrain(Train train, string pathName)}}
	;Description		;Description
	;Parameters		;Parameters
	;Returns		;Returns

	{{MethodHeader\|public void SetPanicStateForPath(string pathName)}}		<br>{{MethodHeader\|public void SetPanicStateForPath(string pathName)}}
	;Description		;Description
	;Parameters		;Parameters
	;Returns		;Returns

	{{MethodHeader\|public void SetTrainAsPassing(Train train, Signal entrySignal)}}		<br>{{MethodHeader\|public void SetTrainAsPassing(Train train, Signal entrySignal)}}
	;Description		;Description
	;Parameters		;Parameters
	;Returns		;Returns

Pw3r at 00:21, 14 October 2015

2015-10-14T00:21:57Z

@@ Line 24: / Line 24: @@
 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.
 {{MethodHeader|public InterlockingTowerPath CreateNewPath()}}
 ;Description
@@ Line 30: / Line 29: @@
 ;Returns
 *A newly created and initialised [[InterlockingTowerPath]] object.

Pw3r: Created page with "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 ..."

2015-10-14T00:16:43Z

Created page with "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 ..."

New page

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.

*[[TrainzScript Language Reference|API Hierarchy]]
**[[Class GSObject|GSObject]] *
***[[Class GameObject|GameObject]]
****[[Class TrainzGameObject|TrainzGameObject]]
****[[Class PropertyObject|PropertyObject]] *
*****[[Class MeshObject|MeshObject]]
******[[Class MapObject|MapObject]]
*******InterlockingTower
<br>

==Related Classes==
* [[Class InterlockingTowerPath|InterlockingTowerPath]]
* [[Class Signal|Signal]]
* [[Class Junction|Junction]]
* [[Class Crossing|Crossing]]
* [[Class TrackCircuitBlock|TrackCircuitBlock]]
* [[Class TrackPathDisplay|TrackPathDisplay]]

==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.

===CreateNewPath===
{{MethodHeader|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
*A newly created and initialised [[InterlockingTowerPath]] object.