Class Router - Revision history

Pw3r: /* PostMessage */

2024-02-25T23:29:44Z

PostMessage

← Older revision		Revision as of 23:29, 25 February 2024
Line 64:		Line 64:
	*Specifying ''0'' as the source will make the message apper to emanate from the Router itself.		*Specifying ''0'' as the source will make the message apper to emanate from the Router itself.
	*Specifying MESSAGE_BROADCAST as the destination will send the message to all GameObjects on the map.		*Specifying MESSAGE_BROADCAST as the destination will send the message to all GameObjects on the map.
	~~<br><br>~~
	~~This Method~~ is obsolete, as it requires the use of integer router IDs. To use PostMessage without the Router~~, use a~~ GameObject.PostMessage() instead. Only the destination is required, and the source will be the object the function is called on.
			Note this function is '''obsolete''', as it requires the use of integer router IDs. To use PostMessage without the Router call GameObject.PostMessage() instead. Only the destination is required, and the source will be the object the function is called on.

	For example:		For example:

Pw3r: /* PostMessage */

2024-02-25T23:28:02Z

PostMessage

← Older revision		Revision as of 23:28, 25 February 2024
Line 50:		Line 50:
	{{MethodHeader\|public obsolete native void PostMessage(int srcId, int dstId, string major, string minor, float delay)}}		{{MethodHeader\|public obsolete native void PostMessage(int srcId, int dstId, string major, string minor, float delay)}}
	;Parameters		;Parameters
	*'''srcId''' = GameObject to specify as the message source.		*'''srcId''' = Integer ID of the GameObject to specify as the message source.
	*'''dstId''' = GameObject to ~~specify as~~ the message ~~destination~~.		*'''dstId''' = Integer ID of the GameObject to post the message to.
	*'''major''' = Message major string.		*'''major''' = Message major string.
	*'''minor''' = Message minor string.		*'''minor''' = Message minor string.
Line 65:		Line 65:
	*Specifying MESSAGE_BROADCAST as the destination will send the message to all GameObjects on the map.		*Specifying MESSAGE_BROADCAST as the destination will send the message to all GameObjects on the map.
	<br><br>		<br><br>
	This Method is obsolete, it ~~uses an~~ integer ~~lookup with the Router, which now needs to be an object lookup~~. To use PostMessage without the Router, use a GameObject PostMessage instead. Only the destination is required.		This Method is obsolete, as it requires the use of integer router IDs. To use PostMessage without the Router, use a GameObject.PostMessage() instead. Only the destination is required, and the source will be the object the function is called on.

	~~Was~~ - Router.PostMessage (~~me.~~GetId(), me.GetId(), "~~Timer~~-Event", "", 2.0);		For example:
	~~Now~~ - PostMessage(me, "~~Timer~~-Event", "", 2.0);		Old - Router.PostMessage(GetId(), myTrain.GetId(), "Animation-Event", "Left-Opening", 0.0);
			New - PostMessage(myTrain, "Animation-Event", "Left-Opening", 0.0);

	~~Was - Router.PostMessage (me.GetId(), nMyTrainID, "Animation-Event", "Left-Opening", 0.0);~~
	~~Now - PostMessage(myTrain, "Animation-Event", "Left-Opening", 0.0);~~

	~~Was - MeshObject objAsset = cast<MeshObject>Router.GetGameObject(sAssetName);~~
	~~Now - MeshObject objAsset = cast<MeshObject>(cast<GameObject> msg.src);~~
	<br>		<br>

Christopher824: /* PostMessage */

2022-10-12T17:29:53Z

PostMessage

← Older revision		Revision as of 17:29, 12 October 2022
Line 72:		Line 72:
	Was - Router.PostMessage (me.GetId(), nMyTrainID, "Animation-Event", "Left-Opening", 0.0);		Was - Router.PostMessage (me.GetId(), nMyTrainID, "Animation-Event", "Left-Opening", 0.0);
	Now - PostMessage(myTrain, "Animation-Event", "Left-Opening", 0.0);		Now - PostMessage(myTrain, "Animation-Event", "Left-Opening", 0.0);

			Was - MeshObject objAsset = cast<MeshObject>Router.GetGameObject(sAssetName);
			Now - MeshObject objAsset = cast<MeshObject>(cast<GameObject> msg.src);
			<br>

	==Related Methods==		==Related Methods==

Christopher824: /* PostMessage */

2022-10-12T17:24:28Z

PostMessage

← Older revision		Revision as of 17:24, 12 October 2022
Line 71:		Line 71:

	Was - Router.PostMessage (me.GetId(), nMyTrainID, "Animation-Event", "Left-Opening", 0.0);		Was - Router.PostMessage (me.GetId(), nMyTrainID, "Animation-Event", "Left-Opening", 0.0);
	Now - PostMessage(myTrain, "~~Timer~~-Event", "", 0.0);		Now - PostMessage(myTrain, "Animation-Event", "Left-Opening", 0.0);

	==Related Methods==		==Related Methods==

Christopher824: /* PostMessage */

2022-10-12T17:21:20Z

PostMessage

← Older revision		Revision as of 17:21, 12 October 2022
Line 71:		Line 71:

	Was - Router.PostMessage (me.GetId(), nMyTrainID, "Animation-Event", "Left-Opening", 0.0);		Was - Router.PostMessage (me.GetId(), nMyTrainID, "Animation-Event", "Left-Opening", 0.0);
	Now - PostMessage(myTrain, "Timer-Event", "", 2.0);		Now - PostMessage(myTrain, "Timer-Event", "", 0.0);

	==Related Methods==		==Related Methods==

Christopher824: /* PostMessage */

2022-10-12T17:09:33Z

PostMessage

← Older revision		Revision as of 17:09, 12 October 2022
Line 60:		Line 60:
	Router.PostMessage(Router,Router.MESSAGE_BROADCAST,"Sinking","StartThePumps",0.0);		Router.PostMessage(Router,Router.MESSAGE_BROADCAST,"Sinking","StartThePumps",0.0);
	;Notes		;Notes
	*Router.PostMessage provides the facility for code which does not belong to a ~~GameObjject~~ thread to post a message,		*Router.PostMessage provides the facility for code which does not belong to a GameObject thread to post a message,
	*Since these scripts will not have a GameObject Id an alternative source must be specified.		*Since these scripts will not have a GameObject Id an alternative source must be specified.
	*Specifying ''0'' as the source will make the message apper to emanate from the Router itself.		*Specifying ''0'' as the source will make the message apper to emanate from the Router itself.
	*Specifying MESSAGE_BROADCAST as the destination will send the message to all GameObjects on the map.		*Specifying MESSAGE_BROADCAST as the destination will send the message to all GameObjects on the map.
	<br><br>		<br><br>
	This Method is obsolete, it uses an integer lookup with the Router, which now needs to be an object lookup		This Method is obsolete, it uses an integer lookup with the Router, which now needs to be an object lookup. To use PostMessage without the Router, use a GameObject PostMessage instead. Only the destination is required.
	To use PostMessage without the Router, use a GameObject PostMessage instead.

	Was - Router.PostMessage (me.GetId(), me.GetId(), "Timer-Event", "", 2.0);		Was - Router.PostMessage (me.GetId(), me.GetId(), "Timer-Event", "", 2.0);

Christopher824: /* PostMessage */

2022-10-12T17:07:20Z

PostMessage

← Older revision		Revision as of 17:07, 12 October 2022
Line 48:		Line 48:

	==PostMessage==		==PostMessage==
	{{MethodHeader\|public native void PostMessage(int srcId, int dstId, string major, string minor, float delay)}}		{{MethodHeader\|public obsolete native void PostMessage(int srcId, int dstId, string major, string minor, float delay)}}
	;Parameters		;Parameters
	*'''srcId''' = GameObject to specify as the message source.		*'''srcId''' = GameObject to specify as the message source.
Line 64:		Line 64:
	*Specifying ''0'' as the source will make the message apper to emanate from the Router itself.		*Specifying ''0'' as the source will make the message apper to emanate from the Router itself.
	*Specifying MESSAGE_BROADCAST as the destination will send the message to all GameObjects on the map.		*Specifying MESSAGE_BROADCAST as the destination will send the message to all GameObjects on the map.
	<br>		<br><br>
			This Method is obsolete, it uses an integer lookup with the Router, which now needs to be an object lookup
			To use PostMessage without the Router, use a GameObject PostMessage instead.

			Was - Router.PostMessage (me.GetId(), me.GetId(), "Timer-Event", "", 2.0);
			Now - PostMessage(me, "Timer-Event", "", 2.0);

			Was - Router.PostMessage (me.GetId(), nMyTrainID, "Animation-Event", "Left-Opening", 0.0);
			Now - PostMessage(myTrain, "Timer-Event", "", 2.0);

	==Related Methods==		==Related Methods==

Windwalkr at 16:22, 9 February 2010

2010-02-09T16:22:30Z

← Older revision		Revision as of 16:22, 9 February 2010
Line 1:		Line 1:
	__FORCETOC__		__FORCETOC__
	*[[TrainzScript ~~Langage~~ Reference\|API Hierarchy]]		*[[TrainzScript Language Reference\|API Hierarchy]]
	**Router		**Router
	<br>		<br>

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:37:34Z

Categories

New page

__FORCETOC__
*[[TrainzScript Langage Reference|API Hierarchy]]
**Router
 

*The Router class handles the transmission of messages between game objects and contains methods to provide references to specific objects given their name or Id.
 

==Constants==

{{TableHeader|width=95%|margin=15px}}
|-
|public define int MESSAGE_BROADCAST = 0||The message will be sent to all objects in the Router
|}
 

==GetGameObject==
{{MethodHeader|public native GameObject GetGameObject(string uniqueName) public native GameObject GetGameObject(int uniqueId)}}
;Parameters
*'''uniqueName''' = Name of object as assigned in Surveyor.
*'''uniqueId''' = Id of object as assigned by the Router for each session.
;Returned Value
*A reference to the GameObject described, null if no such object exists.
;Syntax
GameObject go = Router.GetGameObject(vehicle.GetName());
;Notes
*The objects name will normally be its username with a unique serial added by the game when the object is placed.
*This name can be edited by the user.
*Remember that not all objects will be named.
*Although Surveyor issues a warning on any attempt to name an object using a name which already exists, no restriction is actually enforced.
*As a result it is possible that a name will not be unique.
*Reference to an object's Id on the other hand is guaranteed to be unique for the current session.
*Ids are not preserved between sessions.
 

==Info==
{{MethodHeader|public native void Router.Info(void)}}
;Parameters
*None
;Returned Value
*None
;Syntax
Router.Info();
;Notes
*Logs current Router information to ''jetlog.txt''.
*Used for debugging a session.
 

==PostMessage==
{{MethodHeader|public native void PostMessage(int srcId, int dstId, string major, string minor, float delay)}}
;Parameters
*'''srcId''' = GameObject to specify as the message source.
*'''dstId''' = GameObject to specify as the message destination.
*'''major''' = Message major string.
*'''minor''' = Message minor string.
*'''delay''' = Number of seconds to wait before the message is dispatched, can be 0.0.
;Returned Value
*None
;Syntax
Router.PostMessage(Router,Router.MESSAGE_BROADCAST,"Sinking","StartThePumps",0.0);
;Notes
*Router.PostMessage provides the facility for code which does not belong to a GameObjject thread to post a message,
*Since these scripts will not have a GameObject Id an alternative source must be specified.
*Specifying ''0'' as the source will make the message apper to emanate from the Router itself.
*Specifying MESSAGE_BROADCAST as the destination will send the message to all GameObjects on the map.
 

==Related Methods==
*[[Class GameObject#ClearMessages|GameObject.ClearMessages()]]
*[[Class GameObject#PostMessage|GameObject.PostMessage()]]
*[[Class GameObject#SendMessage|GameObject.SendMessage()]]
*[[Class GameObject#Sniff|GameObject.Sniff()]]

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