Class World - Revision history

Ciceronmt: /* GetNamedObjectList */

2022-07-29T15:42:21Z

GetNamedObjectList

← Older revision		Revision as of 15:42, 29 July 2022
Line 718:		Line 718:
	*When the search completes, a message of type "ObjectSearch","AsyncResult" will be posted to the result object.		*When the search completes, a message of type "ObjectSearch","AsyncResult" will be posted to the result object.
	*With expiration notices are enabled, only one notification of type "ObjectSearch","Expired" will be posted for each search.		*With expiration notices are enabled, only one notification of type "ObjectSearch","Expired" will be posted for each search.
	*Added in TRS19		*Added in TRS19.
			*''As personal experience has shown, the number of lines in this list is limited to 1000, so for large routes, unfortunately, such a search is not complete.''
	<br>		<br>

Ciceronmt: /* GetGameObjectByIDIfLoaded */

2022-07-28T04:42:13Z

GetGameObjectByIDIfLoaded

← Older revision		Revision as of 04:42, 28 July 2022
Line 554:		Line 554:
	;Syntax		;Syntax
	GameObject my_object = World.GetGameObjectByID(objectID);		GameObject my_object = World.GetGameObjectByID(objectID);
	if (my_object Interface.Print("Object exists and is loaded");		if (my_object) Interface.Print("Object exists and is loaded");
	;Notes		;Notes
	*Added in TRS19		*Added in TRS19

Marekp9: /* SetGameDate */ Corrected Time to Date

2021-03-26T18:46:05Z

SetGameDate: Corrected Time to Date

← Older revision		Revision as of 18:46, 26 March 2021
Line 1,130:		Line 1,130:

	==SetGameDate==		==SetGameDate==
	{{MethodHeader\|public void ~~SetGameTime~~(int year, int month, int date)}}		{{MethodHeader\|public void SetGameDate(int year, int month, int date)}}
	;Parameters		;Parameters
	*'''year''' = The year to set (1970-2038)		*'''year''' = The year to set (1970-2038)
Line 1,138:		Line 1,138:
	*None		*None
	;Syntax		;Syntax
	World.~~SetGameTime~~(2000, 12, 25); // sets date to 25 December 2000		World.SetGameDate(2000, 12, 25); // sets date to 25 December 2000
	;Notes		;Notes
	*In multiplayer, this will only succeed on the server.		*In multiplayer, this will only succeed on the server.

Danny252: /* CreateTrain */ Fix formatting

2020-12-28T17:21:18Z

CreateTrain: Fix formatting

← Older revision		Revision as of 17:21, 28 December 2020
Line 252:		Line 252:

	==CreateTrain==		==CreateTrain==
	{{MethodHeader\|public native [[Class Train\|Train]] CreateTrain([[Class KUID\|KUID]][ ] consist, string trackmarkName, bool direction)<br>public native [[Class Train\|Train]] CreateTrain([[Class KUID\|KUID]][ ] consist, [[Class TrackMark\|TrackMark]] trackmark, bool direction)<br>public native [[Class Train\|Train]] CreateTrain([[Class KUID\|KUID]][ ] consist, [[Class Buildable\|Buildable]] buildable, string trackName, float position, bool direction)}}<br>public native [[Class Train\|Train]] CreateTrain([[Class KUID\|KUID]][ ] consist, [[Class GSTrackSearch\|GSTrackSearch]] tracksearch, bool avoidDerailments)}}<br>public native [[Class Train\|Train]] CreateTrain([[Class KUID\|KUID]][ ] consist, [[Class GSTrackSearch\|GSTrackSearch]] tracksearch)}}		{{MethodHeader\|public native [[Class Train\|Train]] CreateTrain([[Class KUID\|KUID]][ ] consist, string trackmarkName, bool direction)<br>public native [[Class Train\|Train]] CreateTrain([[Class KUID\|KUID]][ ] consist, [[Class TrackMark\|TrackMark]] trackmark, bool direction)<br>public native [[Class Train\|Train]] CreateTrain([[Class KUID\|KUID]][ ] consist, [[Class Buildable\|Buildable]] buildable, string trackName, float position, bool direction)<br>public native [[Class Train\|Train]] CreateTrain([[Class KUID\|KUID]][ ] consist, [[Class GSTrackSearch\|GSTrackSearch]] tracksearch, bool avoidDerailments)<br>public native [[Class Train\|Train]] CreateTrain([[Class KUID\|KUID]][ ] consist, [[Class GSTrackSearch\|GSTrackSearch]] tracksearch)}}
	;Parameters		;Parameters
	*'''consist''' = An array of vehicle KUIDs used to describe the required Train object.		*'''consist''' = An array of vehicle KUIDs used to describe the required Train object.

Danny252: /* GetSurveyorSavedConsist */ Add link to TrainUtil

2020-12-28T17:09:09Z

GetSurveyorSavedConsist: Add link to TrainUtil

← Older revision		Revision as of 17:09, 28 December 2020
Line 780:		Line 780:
	;Notes		;Notes
	*Remember that the returned data is in a Soup format, which is not the same thing as a Train.		*Remember that the returned data is in a Soup format, which is not the same thing as a Train.
	*TrainUtil.~~CreateTrainFormSoup~~() can be used to create a train from the returned Soup.		*[[Class TrainUtil#CreateTrainFromSoup\|TrainUtil.CreateTrainFromSoup()]] can be used to create a train from the returned Soup.
	*This method only works in Surveyor.		*This method only works in Surveyor.
	*Obsolete in TRS19.		*Obsolete in TRS19.

Danny252: Update to current state of world.gs

2020-12-28T17:07:29Z

Update to current state of world.gs

Show changes

Danny252: Add reference links to other classes

2020-12-28T15:10:07Z

Add reference links to other classes

Show changes

Danny252: Change link to library reference, not language reference

2020-12-28T14:56:04Z

Change link to library reference, not language reference

← Older revision		Revision as of 14:56, 28 December 2020
Line 1:		Line 1:
	*[[TrainzScript ~~Language~~ Reference\|API Hierarchy]]		*[[TrainzScript Library Reference\|API Hierarchy]]
	**World		**World
	<br>		<br>

Ciceronmt: /* GetTrainzVersion */

2020-10-31T05:33:45Z

GetTrainzVersion

← Older revision		Revision as of 05:33, 31 October 2020
Line 552:		Line 552:
	float version = World.GetTrainzVersion();		float version = World.GetTrainzVersion();
	;Notes		;Notes
	*The value returned corresponds to the version number ~~you can see in the bottom-right side~~ of ~~the main Trainz menu screen~~.		*The value returned corresponds to the version number of Content manager (for example 4.6).
	<br>		<br>

Pw3r at 02:27, 24 July 2020

2020-07-24T02:27:47Z

← Older revision		Revision as of 02:27, 24 July 2020
Line 402:		Line 402:
	GameObject[] Industries = World.GetIndustryList();		GameObject[] Industries = World.GetIndustryList();
	;Notes		;Notes
			*This function is obsolete and should not be used.
	<br>		<br>

Line 413:		Line 414:
	Junction[] junctions = World.GetJunctionList();		Junction[] junctions = World.GetJunctionList();
	;Notes		;Notes
	*Junction objects attached to fixed track junctions are not ~~currently~~ returned by this method.		*This function is obsolete and should not be used.
			*Junction objects attached to fixed track junctions are not returned by this method.
	<br>		<br>

Line 465:		Line 467:
	Signal[] signals = World.GetSignalList();		Signal[] signals = World.GetSignalList();
	;Notes		;Notes
			*This function is obsolete and should not be used.
	<br>		<br>

Line 513:		Line 516:
	Trackmark[] trackmarks = World.GetTrackmarkList();		Trackmark[] trackmarks = World.GetTrackmarkList();
	;Notes		;Notes
			*This function is obsolete and should not be used.
	<br>		<br>

Line 524:		Line 528:
	Train[] trains = World.GetTrainList();		Train[] trains = World.GetTrainList();
	;Notes		;Notes
			*This function is obsolete and should not be used.
	<br>		<br>

Line 559:		Line 564:
	Trigger[] triggers = World.GetTriggerList();		Trigger[] triggers = World.GetTriggerList();
	;Notes		;Notes
			*This function is obsolete and should not be used.
	*This method does not return scenery triggers, ie those attached to SceneryWithTrack objects and their descendants.		*This method does not return scenery triggers, ie those attached to SceneryWithTrack objects and their descendants.
	<br>		<br>
Line 571:		Line 577:
	Vehicle[] vehicles = World.GetVehicleList();		Vehicle[] vehicles = World.GetVehicleList();
	;Notes		;Notes
			*This function is obsolete and should not be used.
	<br>		<br>