HowTo/Upgrade obsolete script functions - Revision history

Kcrowder13: added link to example code correction.

2025-05-21T10:16:11Z

added link to example code correction.

← Older revision		Revision as of 10:16, 21 May 2025
Line 73:		Line 73:

	'''Further Reading'''		'''Further Reading'''
	* See [[HowTo/Search_for_objects_in_the_world]] for a practical example of how to list objects using category codes.		* See [[HowTo/Search_for_objects_in_the_world]] for a practical example of how to list objects using category codes. Example code correction See: [[Talk:HowTo/Search for objects in the world]]

	==Asset.GetConfigSoup==		==Asset.GetConfigSoup==

Vincentrh at 11:58, 11 August 2023

2023-08-11T11:58:20Z

← Older revision		Revision as of 11:58, 11 August 2023
Line 84:		Line 84:
	'''Replacement Function'''<br>		'''Replacement Function'''<br>
	A new async query interface exists on Asset which will cache the config file on a background thread. To use this feature script must first call Asset.CacheConfigSoup(), and then wait on the returned AsyncQueryHelper. When the caching is complete, the caller may call Asset.GetConfigSoupCached() to get the config file Soup.		A new async query interface exists on Asset which will cache the config file on a background thread. To use this feature script must first call Asset.CacheConfigSoup(), and then wait on the returned AsyncQueryHelper. When the caching is complete, the caller may call Asset.GetConfigSoupCached() to get the config file Soup.

			'''Further Reading'''
			* See [[HowTo/Read string table or Config text]] for more clarifications.

	==Asset.GetStringTable==		==Asset.GetStringTable==
Line 94:		Line 97:
	'''Replacement Function'''<br>		'''Replacement Function'''<br>
	A new async query interface exists on Asset which will cache the config file on a background thread. To use this feature script must first call Asset.CacheConfigSoup(), and then wait on the returned AsyncQueryHelper. When the caching is complete, the caller may call Asset.GetStringTable() to get the StringTable.		A new async query interface exists on Asset which will cache the config file on a background thread. To use this feature script must first call Asset.CacheConfigSoup(), and then wait on the returned AsyncQueryHelper. When the caching is complete, the caller may call Asset.GetStringTable() to get the StringTable.

			'''Further Reading'''
			* See [[HowTo/Read string table or Config text]] for more clarifications.

	==TrainzScript.GetAssetList==		==TrainzScript.GetAssetList==

Pcas1986: added link to simple examples page

2022-08-26T03:16:27Z

added link to simple examples page

← Older revision		Revision as of 03:16, 26 August 2022
Line 131:		Line 131:
	* [[Compatibility_mode\|Compatibility Mode Setting]]		* [[Compatibility_mode\|Compatibility Mode Setting]]
	* [[Asynchronous_Route_Streaming\| Asynchronous Route Streaming]]		* [[Asynchronous_Route_Streaming\| Asynchronous Route Streaming]]
			* [[HowTo/Upgrade obsolete script functions - simple examples]]

Pw3r at 00:38, 22 June 2022

2022-06-22T00:38:01Z

← Older revision		Revision as of 00:38, 22 June 2022
Line 44:		Line 44:

	'''Further Reading'''		'''Further Reading'''
	* See [[Class_Library]] for more information on the Library class and the LibraryCall interface.		* See the [[Class_Library\|Library class documentation]] for more information on the Library class and the LibraryCall interface.

	==Router.GetGameObject==		==Router.GetGameObject==

Pw3r at 00:37, 22 June 2022

2022-06-22T00:37:10Z

← Older revision		Revision as of 00:37, 22 June 2022
Line 41:		Line 41:
	'''Replacement Function'''<br>		'''Replacement Function'''<br>
	Cases which are found to call this variant should be updated to call the non-obsolete LibraryCall function, by declaring the objectParam as a GSObject array.<br>		Cases which are found to call this variant should be updated to call the non-obsolete LibraryCall function, by declaring the objectParam as a GSObject array.<br>
	Cases which are found to override this variant should be updated to instead override the GSObject variant, but changing the function prototype and updating any uses of the objectParam as required. This may mean adding new explicit casts, and care should be taken to validate that those casts succeed.		Cases which are found to override this variant should be updated to instead override the GSObject variant, but changing the function prototype and updating any uses of the objectParam as required. This may mean adding new explicit casts, and care should be taken to validate that those casts succeed.<br>

	'''Further Reading'''		'''Further Reading'''
	* See ~~GameObjectID.gs in your Trainz installations resources/script folder~~ for more information on the ~~GameObjectID~~ class.		* See [[Class_Library]] for more information on the Library class and the LibraryCall interface.
	* See [[HowTo/Upgrade_GameObject.GetName()]] for a practical example of how to replace some common script name uses with GameObjectID or localised name.

	==Router.GetGameObject==		==Router.GetGameObject==

Pw3r at 00:35, 22 June 2022

2022-06-22T00:35:13Z

← Older revision		Revision as of 00:35, 22 June 2022
Line 34:		Line 34:
	==Library.LibraryCall==		==Library.LibraryCall==
	'''Previous Usage'''<br>		'''Previous Usage'''<br>
	An alternate version of the LibraryCall interface which accepts a GameObject ~~parameter~~ instead of GSObject. This function was added as obsolete, in order to highlight scripts which were mistakenly calling LibraryCall with a GameObject array, and relying on the script compiler to implicitly cast the type.		An alternate version of the [[Class_Library#LibraryCall\|LibraryCall]] interface which accepts GameObject parameters instead of GSObject. This function was added as obsolete, in order to highlight scripts which were mistakenly calling LibraryCall with a GameObject array, and relying on the script compiler to implicitly cast the type.

	'''Reason for Obsoletion'''<br>		'''Reason for Obsoletion'''<br>

Pw3r at 00:33, 22 June 2022

2022-06-22T00:33:34Z

@@ Line 27: / Line 27: @@
 '''Replacement Function'''<br>
 Cases which use of the script name as an ID can be swapped to using the objects GameObjectID instead. Cases which use it for display to the player should instead use the localised name.
 '''Further Reading'''

Windwalkr at 05:38, 21 June 2022

2022-06-21T05:38:07Z

@@ Line 100: / Line 100: @@
 '''Replacement Function'''<br>
 A much more powerful asset search system exists in [[Class_TrainzAssetSearch|TrainzAssetSearch]]. This class allows script to asynchronously search on any criteria, eliminating the performance concerns.
 ==See Also==

Pw3r at 05:39, 3 March 2022

2022-03-03T05:39:56Z

← Older revision		Revision as of 05:39, 3 March 2022
Line 16:		Line 16:
	'''Further Reading'''		'''Further Reading'''
	* See GameObjectID.gs in your Trainz installations resources/script folder for more information on the GameObjectID class.		* See GameObjectID.gs in your Trainz installations resources/script folder for more information on the GameObjectID class.
	* See [[HowTo/Upgrade_GameObject.GetId]] for a practical example of how to replace some common integer ID uses with GameObjectID.		* See [[HowTo/Upgrade_GameObject.GetId()]] for a practical example of how to replace some common integer ID uses with GameObjectID.

	==GameObject.GetName==		==GameObject.GetName==

Pw3r at 03:43, 3 March 2022

2022-03-03T03:43:56Z

← Older revision		Revision as of 03:43, 3 March 2022
Line 102:		Line 102:

	==See Also==		==See Also==
	* [[TrainzScript_Language_Reference]]		* [[TrainzScript_Language_Reference\|TrainzScript Language Reference]]
	* [[Compatibility_mode]]		* [[Compatibility_mode\|Compatibility Mode Setting]]
	* [[Asynchronous_Route_Streaming\| Asynchronous Route Streaming]]		* [[Asynchronous_Route_Streaming\| Asynchronous Route Streaming]]