Danny252: Change link to library reference, not language reference

2020-12-28T13:44:45Z

Change link to library reference, not language reference

← Older revision		Revision as of 13:44, 28 December 2020
Line 1:		Line 1:
	*[[TrainzScript ~~Language~~ Reference\|API Hierarchy]]		*[[TrainzScript Library Reference\|API Hierarchy]]
	*[[Class GSObject\|GSObject]]		*[[Class GSObject\|GSObject]]
	***[[Class GameObject\|GameObject]]		***[[Class GameObject\|GameObject]]

Windwalkr at 16:42, 9 February 2010

2010-02-09T16:42:50Z

← Older revision		Revision as of 16:42, 9 February 2010
Line 1:		Line 1:
	*[[TrainzScript ~~Langage~~ Reference\|API Hierarchy]]		*[[TrainzScript Language Reference\|API Hierarchy]]
	*[[Class GSObject\|GSObject]]		*[[Class GSObject\|GSObject]]
	***[[Class GameObject\|GameObject]]		***[[Class GameObject\|GameObject]]

Windwalkr: 1 revision

2010-02-03T13:58:42Z

1 revision

← Older revision	Revision as of 13:58, 3 February 2010
(No difference)

Andi06: /* GetSignalState */

2008-08-01T21:25:22Z

GetSignalState

New page

*[[TrainzScript Langage Reference|API Hierarchy]]
**[[Class GSObject|GSObject]] *
***[[Class GameObject|GameObject]]
****[[Class TrainzGameObject|TrainzGameObject]]
****[[Class PropertyObject|PropertyObject]] *
*****[[Class MeshObject|MeshObject]]
******[[Class MapObject|MapObject]]
*******Trackside

 
*A parent class for track related items such as junctions, signals, trackmarks, triggers or vehicles.
*Methods generic to all trackside items are provided within this class
*Although more specialised trackside items such as signals and junctions are catered for with appropriate child classes, there is no child class for speedboard items.
*GetSpeedLimit() can be used to determine weather a Trackside object is a speed board or not.
 

==Related Messages==
*Details of messages sent and received by Trackside objects are listed in the appropriate child classes.
 

==BeginTrackSearch==
{{MethodHeader|public native GSTrackSearch BeginTrackSearch(bool direction)}}
;Parameters
*'''direction''' = Direction to search in based on the orientation of the Trackside item relative to the track to which it is attached.
;Returned Value
*A GSTrackSearch object which can be used by [[Class GSTrackSearch|GSTrackSearch]] methods to conduct searches in the specified direction along the current track.
;Syntax
GSTrackSearch gst = BeginTrackSearch(true);
;Notes
*See [[Class GSTrackSearch#Code Examples|GSTrackSearch Code Examples]] for a more detailed example of usage.
 

==GetIsSearchLimit==
{{MethodHeader|public native bool GetIsSearchLimit(void)}}
;Parameters
*None
;Returned Value
*True if the current object is an AI Direction Marker, false otherwise.
;Syntax
if (GetIsSearchLimit()) Interface.Print("Track direction marker found");
;Notes
 

==GetSignalState==
{{MethodHeader|public native int GetSignalState(void)}}
;Parameters
*None
;Returned Value
*One of the [[Class Signal#Signal States|Signal State]] constants representing the current aspect of a signal.
;Syntax
int aspect = GetSignalState();
;Notes
*This method will return GREEN, YELLOW or RED, but will never return AUTOMATIC.
 

==GetSignalStateEx==
{{MethodHeader|public native int GetSignalStateEx(void)}}
;Parameters
*None
;Returned Value
*One of the [[Class Signal#Extended Signal States|Extended Signal State]] constants representing the current aspect of a signal.
;Syntax
int aspect = GetSignalState();
;Notes
*See [[Class Signal|Signal]] for further details.
 

==GetSpeedLimit==
{{MethodHeader|public native float GetSpeedLimit (void)}}
;Parameters
*None
;Returned Value
*The speed limit associated with this object in metres per second.
;Syntax
float limit = GetSpeedLimit();
;Notes
*If the object is not a speedboard a zero or negative value is returned.
*Returned values are in MPS, use the [[Class Train#Measurement Conversion Multipliers|conversion factors]] in the train class to convert to other units.
 

==GetTrack==
{{MethodHeader|public native Track GetTrack(void)}}
;Parameters
*None
;Returned Value
*The track segment that the current object is located on.
;Syntax
Track track = GetTrack();
;Notes
 

==InnerReEnter==
{{MethodHeader|public native bool InnerReEnter(int node)}}
;Parameters
*'''node''' = Node Id of a train to be re-entered into inner trigger radius.
;Returned Value
*True if any part of the train is within the inner trigger radius at the time of the call and the message has been sent, false otherwise.
;Syntax
InnerReEnter(train.GetId());
;Notes
*The effect of this method is to cause a new ''Object,InnerEnter'' message to be sent from the train to this object.
 

==ReEnter==
{{MethodHeader|public native bool ReEnter(int node)}}
;Parameters
*'''node''' = Node Id of a train to be re-entered into the outer trigger radius.
;Returned Value
*True if any part of the train is within the outer trigger radius at the time of the call and the message has been sent, false otherwise.
;Syntax
ReEnter(train.GetId());
;Notes
*The effect of this method is to cause a new ''Object,Enter'' message to be sent from the train to this object.
 

==RequestTrackPermit==
{{MethodHeader|public native Permit RequestTrackPermit(bool direction) public native Permit RequestTrackPermit(bool direction,GameObject owner)}}
;Parameters
*'''direction''' = Direction required by the Permit.
*'''owner''' = The object which is to ''own'' the Permit, to which any relevant messages are sent.
;Returned Value
*A [[Class Permit|Permit]] object for the track on which the current object is placed and for the direction specified.
;Syntax
Permit permit = RequestTrackPermit(true);
;Notes
*If the Trackside object is not on a track a null result may be returned.
*In other cases a [[Class Permit|Permit]] object will always be returned, but may or may not be ''Granted''.
 

==SetSpeedLimit==
{{MethodHeader|public native void SetSpeedLimit(float limit)}}
;Parameters
*'''limit''' = Speed limit to set, in metres per second.
;Returned Value
*None
;Syntax
SetSpeedLimit(100.0)
;Notes
*Use the [[Class Train#Measurement Conversion Multipliers|conversion factors]] in the train class to convert from other units.
*This method allows the speed limit of a trackside item that is a speed board to be changed.
*Using this method for a variable speed limit sign is not fully supported and behavior is not guaranteed.
*It is generally best not to use or rely on this method. (''There's confidence for you'')
*Use a value of zero or less to rescind an existing speed limit.
 

==Related Methods==
[[Class GSTrackSearch#GetDistance|GSTrackSearch.GetDistance()]] 
[[Class GSTrackSearch#GetFacingRelativeToSearchDirection|GSTrackSearch.GetFacingRelativeToSearchDirection()]] 
[[Class GSTrackSearch#GetMapObject|GSTrackSearch.GetMapObject()]] 
[[Class GSTrackSearch#SearchNext|GSTrackSearch.SearchNext()]] 

[[Class TrainUtil#IsPartTrainInTrigger|TrainUtil.IsPartTrainInTrigger]] 
[[Class TrainUtil#IsTrainInTrigger|TrainUtil.IsTrainInTrigger]] 

[[Class World#GetJunctionList|World.GetJunctionList()]] 
[[Class World#GetSignalList|World.GetSignalList()]] 
[[Class World#GetTriggerList|World.GetTriggerList()]] 
[[Class World#GetTrackmarkList|World.GetTrackMarkList()]] 

==Categories==
[[Category:Script Class]]

Class Trackside - Revision history

Danny252: Change link to library reference, not language reference

Windwalkr at 16:42, 9 February 2010

Windwalkr: 1 revision

Andi06: /* GetSignalState */