Class InterlockingTowerPath - Revision history

Danny252: Add standard API hierarchy

2020-12-28T13:51:22Z

Add standard API hierarchy

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

	[[~~Image:InterlockingTowerPath_ClassHierarchy.jpg~~]]		*[[TrainzScript Library Reference\|API Hierarchy]]
			*[[Class GSObject\|GSObject]]
			***[[Class GameObject\|GameObject]]
			****InterlockingTowerPath

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

Pw3r at 01:35, 14 October 2015

2015-10-14T01:35:45Z

← Older revision		Revision as of 01:35, 14 October 2015
Line 52:		Line 52:
	;Returns		;Returns
	*bool - Whether the object was found on the path.		*bool - Whether the object was found on the path.


	<br>{{MethodHeader\|public bool IsObjectOnOrBeyondPath(MapObject obj)}}		<br>{{MethodHeader\|public bool IsObjectOnOrBeyondPath(MapObject obj)}}
Line 76:		Line 75:
	Returns whether this path is in a state where it's possible to begin to transition to the state passed. When creating a custom tower script this is an ideal place to perform extra checks for path state changes.		Returns whether this path is in a state where it's possible to begin to transition to the state passed. When creating a custom tower script this is an ideal place to perform extra checks for path state changes.
	;Parameters		;Parameters
	state - The state we want to transition to.		*state - The state we want to transition to.
	;Returns		;Returns
	*bool - true if the path is able to transition to the requested state, false otherwise.		*bool - true if the path is able to transition to the requested state, false otherwise.

Pw3r at 01:35, 14 October 2015

2015-10-14T01:35:03Z

← Older revision		Revision as of 01:35, 14 October 2015
Line 16:		Line 16:
	<br>{{MethodHeader\|public mandatory void Init(InterlockingTower tower, SecurityToken token)}}		<br>{{MethodHeader\|public mandatory void Init(InterlockingTower tower, SecurityToken token)}}
	;Description		;Description
			Initialises the path with the parameters defined, if possible. Will throw an exception and return false if the request is invalid.
	;Parameters		;Parameters
	~~;Returns~~		*tower - The calling interlocking tower.
			*token - A SecurityToken from the owning InterlockingTower, with sufficient rights to activate the path.

	<br>{{MethodHeader\|public void SetPathName(string pathName)}}		<br>{{MethodHeader\|public void SetPathName(string pathName)}}
	;Description		;Description
			Sets the identifying path name. This should be unique within the owning tower.
	;Parameters		;Parameters
	~~;Returns~~		*pathName - The new identifying name for the tower path.

	<br>{{MethodHeader\|public string GetPathName()}}		<br>{{MethodHeader\|public string GetPathName()}}
	;Description		;Description
	~~;Parameters~~		Returns the identifying path name for this tower path.
	;Returns

	<br>{{MethodHeader\|public string GetLocalisedPathName()}}		<br>{{MethodHeader\|public string GetLocalisedPathName()}}
	;Description		;Description
	~~;Parameters~~		Returns the localised path name for this tower path. Localised names are stored in the string-table for the route or session. There is no interface to set this and it must be done by the session creator.
	;Returns

	<br>{{MethodHeader\|public bool IsObjectInPathDefinition(MapObject obj, int childIndex, bool bIncludeExternalRequirements)}}		<br>{{MethodHeader\|public bool IsObjectInPathDefinition(MapObject obj, int childIndex, bool bIncludeExternalRequirements)}}
	;Description		;Description
			Returns whether a given object is part of the definition of this path.
	;Parameters		;Parameters
			*obj - The path object (junction, signal, etc) to search for.
			*childIndex - The index of a child object, or -1 for the object itself.
			*bIncludeExternalRequirements - Whether to also check the external requirement list.
	;Returns		;Returns
			*bool - true if the object was found, false otherwise

	<br>{{MethodHeader\|public bool IsObjectOnPath(MapObject obj)}}		<br>{{MethodHeader\|public bool IsObjectOnPath(MapObject obj)}}
	;Description		;Description
			Performs a track search and returns whether the passed object is on the path somewhere. Avoid calling this often as it can be quite intensive.
	;Parameters		;Parameters
			*obj - The map object to search the path for.
	;Returns		;Returns
			*bool - Whether the object was found on the path.

	<br>{{MethodHeader\|public ~~int GetPathClearMethod~~()}}
			<br>{{MethodHeader\|public bool IsObjectOnOrBeyondPath(MapObject obj)}}
	;Description		;Description
			Returns whether a given object is on this path, or lies on the track beyond the exit signal. Note that searching beyond the path will follow the currently set junction directions.
	;Parameters		;Parameters
			*obj - The map object to search the path for.
	;Returns		;Returns
			*bool - Whether the object was found on the path, or within the search range beyond the path.

			<br>{{MethodHeader\|public int GetPathClearMethod()}}
			;Description
			Returns the currently set path clear method, which is one of the ITP_CLEAR_* defines.

	<br>{{MethodHeader\|public void SetPathClearMethod(int clearMethod)}}		<br>{{MethodHeader\|public void SetPathClearMethod(int clearMethod)}}
	;Description		;Description
			Alters the path clear method for this path.
	;Parameters		;Parameters
			clearMethod - The new clearing method to set, one of the ITP_CLEAR_ defines.

			<br>{{MethodHeader\|bool CanTransitionPathToState(int state)}}
			;Description
			Returns whether this path is in a state where it's possible to begin to transition to the state passed. When creating a custom tower script this is an ideal place to perform extra checks for path state changes.
			;Parameters
			state - The state we want to transition to.
	;Returns		;Returns
			*bool - true if the path is able to transition to the requested state, false otherwise.

	<br>{{MethodHeader\|public void ActivatePath(SecurityToken token)}}		<br>{{MethodHeader\|public void ActivatePath(SecurityToken token)}}
	;Description		;Description
			Begins activating the path, if possible. Will post a message to the owning tower of type "InterlockingTowerPath","Active" when the path is set.
	;Parameters		;Parameters
	~~;Returns~~		*token - A [[SecurityToken]] from the owning tower with rights "path-control".

	<br>{{MethodHeader\|public void CancelPath(SecurityToken token)}}		<br>{{MethodHeader\|public void CancelPath(SecurityToken token)}}
	;Description		;Description
			Begins cancelling the path, if possible. Will post a message to the owner of type "InterlockingTowerPath","Cancelled" when the path is cancelled. This will return all controlled objects to their original state if appropriate, based on m_clearState.
	;Parameters		;Parameters
	~~;Returns~~		*token - A [[SecurityToken]] from the owning tower with rights "path-control".

	<br>{{MethodHeader\|public void SetPanicState(SecurityToken token)}}		<br>{{MethodHeader\|public void SetPanicState(SecurityToken token)}}
	;Description		;Description
			Instantly drops all controlled signals along this path. Does not change junction or crossing state. Used to simulate an emergency situation of some kind. To transition out of a panic state call either ActivatePath or CancelPath.
	;Parameters		;Parameters
	~~;Returns~~		*token - A [[SecurityToken]] from the owning tower with rights "path-control".

	<br>{{MethodHeader\|public void AddTrain(SecurityToken token, Train train)}}		<br>{{MethodHeader\|public void AddTrain(SecurityToken token, Train train)}}
	;Description		;Description
			Adds the train passed to this path. Does not perform any validation on this operation and will warrant all requests from a valid source.
	;Parameters		;Parameters
	~~;Returns~~		*token - A [[SecurityToken]] from the owning tower with rights "path-control".

	<br>{{MethodHeader\|public void RemoveTrain(SecurityToken token, Train train)}}		<br>{{MethodHeader\|public void RemoveTrain(SecurityToken token, Train train)}}
	;Description		;Description
			Removed the train passed from this path. Performs no validation on the operation and will warrant all requests from a valid source.
	;Parameters		;Parameters
	~~;Returns~~		*token - A [[SecurityToken]] from the owning tower with rights "path-control".

	<br>{{MethodHeader\|public bool IsOccupiedByTrain(Train train, bool bRequireHasClearedEntrySignal)}}		<br>{{MethodHeader\|public bool IsOccupiedByTrain(Train train, bool bRequireHasClearedEntrySignal)}}
	;Description		;Description
			Returns whether the path is known to be occupied by a specific train. Does not perform any track searching and is reliant on the owning tower correctly calling AddTrain/RemoveTrain.
	;Parameters		;Parameters
			*train - The train to check for.
			*bRequireHasClearedEntrySignal - If true, return true only if the train has cleared the entry signal and is occupying the path, otherwise it's sufficient that the tower has merely 'added' the train.
	;Returns		;Returns
			*bool - Whether the train has been added to the path and, optionally, has passed the entry signal.

	<br>{{MethodHeader\|public void EnablePathVisualisation(bool enable, bool bShouldIncludeAllTCBs)}}		<br>{{MethodHeader\|public void EnablePathVisualisation(bool enable, bool bShouldIncludeAllTCBs)}}
	;Description		;Description
			Enables/disables visualisation of this path in the game world, using [[TrackPathDisplay]].
	;Parameters		;Parameters
	~~;Returns~~		*enable - true to enable the path visualisation, false to disable it
			*bShouldIncludeAllTCBs - Whether to also add path visualisations for every occupied [[TrackCircuitBlock]].

Pw3r at 01:15, 14 October 2015

2015-10-14T01:15:02Z

← Older revision		Revision as of 01:15, 14 October 2015
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

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

2015-10-14T01:09:06Z

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

New page

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.

[[Image:InterlockingTowerPath_ClassHierarchy.jpg]]

==Related Classes==
* [[Class InterlockingTower|InterlockingTower]]
* [[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.