Christopher824: /* FindTriggerContainingNode */ GetId is now obsolete

2023-10-10T21:13:52Z

FindTriggerContainingNode: GetId is now obsolete

← Older revision		Revision as of 21:13, 10 October 2023
Line 46:		Line 46:

	==FindTriggerContainingNode==		==FindTriggerContainingNode==
	{{MethodHeader\|public native string FindTriggerContainingNode(~~int~~ node, bool onlyInner)}}		{{MethodHeader\|public native string FindTriggerContainingNode(GameObjectID node, bool onlyInner)}}
	;Parameters		;Parameters
	*'''node''' = The ~~GameObject Id~~ of a vehicle, usually obtained by a call to [[Class GameObject#GetId\|GetId ()]].		*'''node''' = The GameObjectID of a vehicle, usually obtained by a call to [[Class GameObject#GetId\|GetId ()]].
	*'''onlyInner''' = If true only the inner radius of the trigger will be tested, if false the the trigger name will be returned if the vehicle is within 150 metres of the trigger. <font color=red>which trigger is returned if more than one meets this test?</font>		*'''onlyInner''' = If true only the inner radius of the trigger will be tested, if false the the trigger name will be returned if the vehicle is within 150 metres of the trigger. <font color=red>which trigger is returned if more than one meets this test?</font>
	;Returned Value		;Returned Value
	*The name of the scenery trigger found, an empty string otherwise.		*The name of the scenery trigger found, an empty string otherwise.
	;Syntax		;Syntax
	string trigger = FindTriggerContainingNode(vehicle.~~GetId~~(),true);		string trigger = FindTriggerContainingNode(vehicle.GetGameObjectID(),true);
	;Notes		;Notes
	*This method returns the name of the attached scenery trigger within which the specified vehicle is currently located.		*This method returns the name of the attached scenery trigger within which the specified vehicle is currently located.
			*int GetID() is now obsolete
	<br>		<br>

Danny252: Change link to library reference, not language reference

2020-12-28T13:41:05Z

Change link to library reference, not language reference

← Older revision		Revision as of 13:41, 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:22, 9 February 2010

2010-02-09T16:22:38Z

← Older revision		Revision as of 16:22, 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:39Z

1 revision

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

Andi06: /* Categories */

2008-07-31T00:32:08Z

Categories

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]]
*******SceneryWithTrack
 

*Parent class for scenery objects that have attached track and attached trigger support, such as industries and crossings.
*Where triggers are covered within this document these are attached scenery triggers, as defined in the asset's ''attached-trigger'' table, and should not be confused with Trackside [[Class Trigger|Triggers]].
*Attached scenery triggers and their attributes (name, radius, track) are defined as part of the asset's configuration and cannot be altered or moved in Surveyor.
 

==Related Messages==
*Messages sent to and from SceneryWithTrack objects are listed below:
 
{{TableHeader|width=50%|margin=15px}}
|-
|bgcolor="#EEEEEE"|'''Major'''||bgcolor="#EEEEEE"|'''Minor'''||bgcolor="#EEEEEE"|'''Source'''||bgcolor="#EEEEEE" |'''Destination'''
|-
|[[Object Messages|SceneryTrigger]]||Enter||SceneryWithTrack||Vehicle
|-
|[[Object Messages|SceneryTrigger]]||InnerEnter||SceneryWithTrack||Vehicle
|-
|[[Object Messages|SceneryTrigger]]||Stopped||SceneryWithTrack||Vehicle
|-
|[[Object Messages|SceneryTrigger]]||InnerLeave||SceneryWithTrack||Vehicle
|-
|[[Object Messages|SceneryTrigger]]||Leave||SceneryWithTrack||Vehicle
|-
|[[Object Messages|Object]]||Enter||Vehicle||SceneryWithTrack
|-
|[[Object Messages|Object]]||InnerEnter||Vehicle||SceneryWithTrack
|-
|[[Object Messages|Object]]||Stopped||Vehicle||SceneryWithTrack
|-
|[[Object Messages|Object]]||InnerLeave||Vehicle||SceneryWithTrack
|-
|[[Object Messages|Object]]||Leave||Vehicle||SceneryWithTrack
|}
 
*Embedded [[Class JunctionBase|JunctionBase]] objects issue their own messages in addition to those sent to and from the parent SceneryWithTrack object.
 

==FindTriggerContainingNode==
{{MethodHeader|public native string FindTriggerContainingNode(int node, bool onlyInner)}}
;Parameters
*'''node''' = The GameObject Id of a vehicle, usually obtained by a call to [[Class GameObject#GetId|GetId ()]].
*'''onlyInner''' = If true only the inner radius of the trigger will be tested, if false the the trigger name will be returned if the vehicle is within 150 metres of the trigger. which trigger is returned if more than one meets this test?
;Returned Value
*The name of the scenery trigger found, an empty string otherwise.
;Syntax
string trigger = FindTriggerContainingNode(vehicle.GetId(),true);
;Notes
*This method returns the name of the attached scenery trigger within which the specified vehicle is currently located.
 

==GetAttachedJunctions==
{{MethodHeader|public native JunctionBase[ ] GetAttachedJunctions(void)}}
;Parameters
*None
;Returned Value
*An array of any attached [[Class JunctionBase|JunctionBase]] objects included within this object, null if there are no such attachments.
;Syntax
JunctionBase[] nodes = GetAttachedJunctions();
;Notes
*JunctionBase arrays are only returned for objects set up as fixed track junctions.
*The array contains the JunctionBases listed in the ''junction-vertices'' container in ''config.txt''.
*The size of the array and the ordering of the individual components will match the number and sequence of the subcontainers within the ''junction-vertices'' table.
 

==GetAttachedTrack==
{{MethodHeader|public native Track GetAttachedTrack(string trackName)}}
;Parameters
*'''trackName''' = The named track section as defined in the ''attached-track'' table in ''config.txt''.
;Returned Value
*A reference to a [[Class Track|Track]] object if it exists, a script exception will occur otherwise.
Wouldn't null be more polite than an exception?
;Syntax
Track track = GetAttachedTrack("track01");
;Notes
 

==GetTriggerTrack==
{{MethodHeader|public native Track GetTriggerTrack(string triggerName)}}
;Parameters
*'''triggerName''' = A trigger name as defined in the ''attached-trigger'' container in ''config.txt''.
;Returned Value
*A reference to a [[Class Track|Track]] object if it exists, a script exception will occur otherwise.
Wouldn't null be more polite than an exception?
;Syntax
Track track = GetTriggerTrack("trigger01");
;Notes
*The track returned is as sepcified in the ''track'' tag of the ''attached-trigger'' table in ''config.txt''.
 

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

==InnerReEnterTrain==
{{MethodHeader|public void InnerReEnterTrain(Train train)}}
;Parameters
*'''train''' = A train reference, InnerReEnter will be called on all the vehicles in the train.
;Returned Value
*None
;Syntax
InnerReEnterTrain(train);
;Notes
*Messages are only issued in respect of vehicles actually within the inner trigger at the time of the call?
 

==IsTrainInTriggers==
{{MethodHeader|public native bool IsTrainInTriggers(Train train, bool onlyInner}}
;Parameters
*'''train''' = A reference to the train to look for.
*'''onlyInner''' = If true only the inner radius of the trigger will be tested, if false the the radius tested will be the default 150 metres.
;Returned Value
*True if any part of the specified train is within the trigger radius, false otherwise.
;Syntax
bool trainFound = IsTrainInTriggers(train,true);
;Notes
 

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

==Code Examples==
 

==Related Methods==
[[Class Industry#HasTrack|Industry.HasTrack()]]

[[Class JunctionBase#GetMapObject|JunctionBase.GetMapObject()]]

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

Class SceneryWithTrack - Revision history

Christopher824: /* FindTriggerContainingNode */ GetId is now obsolete

Danny252: Change link to library reference, not language reference

Windwalkr at 16:22, 9 February 2010

Windwalkr: 1 revision

Andi06: /* Categories */