Class Library - Revision history

Pw3r: /* LibraryCall */

2022-06-22T00:18:10Z

LibraryCall

← Older revision		Revision as of 00:18, 22 June 2022
Line 75:		Line 75:
	<br>		<br>

	===LibraryCall===		===LibraryCall (obsolete)===
	{{MethodHeader\|public obsolete string LibraryCall(string function, string[] stringParam, GameObject[] objectParam)}}		{{MethodHeader\|public obsolete string LibraryCall(string function, string[] stringParam, GameObject[] objectParam)}}
	An obsolete variant of the LibraryCall interface. This function is obsolete, and calling it may generate errors or warnings. Scripts which access obsolete functions cannot be uploaded to the Download Station.<br>		An obsolete variant of the LibraryCall interface. This function is obsolete, and calling it may generate errors or warnings. Scripts which access obsolete functions cannot be uploaded to the Download Station.<br>

Pw3r at 00:17, 22 June 2022

2022-06-22T00:17:52Z

← Older revision		Revision as of 00:17, 22 June 2022
Line 41:		Line 41:
	;Notes		;Notes
	*See [[Class PropertyObject#GetProperties\|PropertyObject.GetProperties()]] for further details.		*See [[Class PropertyObject#GetProperties\|PropertyObject.GetProperties()]] for further details.
			<br>

			===SetProperties===
			{{MethodHeader\|public void SetProperties(Soup soup)}}
			;Parameters
			*[[Class Soup\|Soup]] database to initialise the Library's properties.
			;Returned Value
			*None
			;Notes
			*See [[Class PropertyObject#SetProperties\|PropertyObject.SetProperties()]] for further details.
	<br>		<br>

	===LibraryCall===		===LibraryCall===
	{{MethodHeader\|public string LibraryCall(string function, string[ ] ~~Strings~~, GSObject[ ] ~~Objects~~)}}		{{MethodHeader\|public string LibraryCall(string function, string[] stringParam, GSObject[] objectParam)}}
	;Parameters		;Parameters
	*'''function''' = A string ~~identifier defining~~ the Library function to be called.		*'''function''' = A string identifying the Library function to be called.
	*'''Strings''' = An array of ~~strings~~ to be used as determined by the ~~script programmer~~.		*'''Strings''' = An array of string parameters to be used (or not) as determined by the Library author.
	*'''Objects''' = An array of [[Class GSObject\|GSObjects]] to be used as determined by the ~~script programmer~~.		*'''Objects''' = An array of [[Class GSObject\|GSObjects]] parameters to be used (or not) as determined by the Library author.
	;Returned Value		;Returned Value
	*A ~~string~~ to be ~~interpreted as determined~~ by the ~~script programmer~~.		*A result value, to be defined and implemented by the Library author.
	;Syntax		;Syntax
	string result = ~~Codelib~~.LibraryCall("AFunction",~~Strings~~,~~Objects~~);		string result = helperLibrary.LibraryCall("AFunction", stringParams, objectParams);
	;Notes		;Notes
	*The LibraryCall function is a very reliable API, as it exists in all Trainz versions and on all versions of your library asset. This allows you to remove support for a function, add parameters, etc without breaking compilation of scripts which use that function.		*The LibraryCall function is a very reliable API, as it exists in all Trainz versions and on all versions of your library asset. This allows you to add/remove support for a function, add parameters, etc without breaking compilation of scripts which use that function.
	*LibraryCall() is not be the most efficient API, and more direct methods should be considered for frequent use queries.		*LibraryCall() is not be the most efficient API, and more direct methods should be considered for frequent use queries.
	*How the arguments are used and processed is left to the library author to decide.		*How the arguments are used and processed is left to the library author to decide.
Line 65:		Line 75:
	<br>		<br>

	===~~SetProperties~~===		===LibraryCall===
	{{MethodHeader\|public ~~void SetProperties~~(~~Soup soup~~)}}		{{MethodHeader\|public obsolete string LibraryCall(string function, string[] stringParam, GameObject[] objectParam)}}
	~~;Parameters~~		An obsolete variant of the LibraryCall interface. This function is obsolete, and calling it may generate errors or warnings. Scripts which access obsolete functions cannot be uploaded to the Download Station.<br>
	*[[Class Soup\|Soup]] database to ~~initialise~~ the ~~Library's properties~~.		<br>
	~~;Returned Value~~		Any uses of this function should be updated to use the GSObject[] variant, detailed above. For more information see [[HowTo/Upgrade_obsolete_script_functions]].<br>
	*None
	~~;Notes~~
	*See [[~~Class PropertyObject#SetProperties\|PropertyObject.SetProperties()~~]] ~~for further details~~.
	<br>		<br>

Pw3r: /* LibraryCall */

2022-06-22T00:05:45Z

LibraryCall

← Older revision		Revision as of 00:05, 22 June 2022
Line 54:		Line 54:
	string result = Codelib.LibraryCall("AFunction",Strings,Objects);		string result = Codelib.LibraryCall("AFunction",Strings,Objects);
	;Notes		;Notes
	*This ~~method provides~~ a ~~virtual~~ function ~~call~~.		*The LibraryCall function is a very reliable API, as it exists in all Trainz versions and on all versions of your library asset. This allows you to remove support for a function, add parameters, etc without breaking compilation of scripts which use that function.
	*It is ~~through this method that all library calls are processed~~ and ~~it must~~ be ~~overridden if you want your library to do anything~~.		*LibraryCall() is not be the most efficient API, and more direct methods should be considered for frequent use queries.
	*How the arguments are used and processed is left to the library author to decide.		*How the arguments are used and processed is left to the library author to decide.
	*This means that any external code using your library would need to use the function arguments as your implementation requires.		*If your library is going to be available for use by others, then you should thoroughly document the parameters and how to interpret any returned values.
	*If your library is going to be available for use by others, then you ~~would need to specify and~~ document the parameters and how to interpret any returned values.		*The name of the library call is specified in the 'function' parameter, while the parameters for the library calls are provided for through the stringParam and objectParam arrays.
	*The name of the library call is specified in the function ~~argument~~ while parameters for the library calls are provided for through the ~~string~~ and ~~GSObject~~ arrays.
	*Some guidelines to follow if you want your library to be robust and bullet proof:		*Some guidelines to follow if you want your library to be robust and bullet proof:
	**Never assume the arguments are valid.		**Never assume the passed in arguments are valid.
	**When processing the arguments, make sure they are not null before using them, there is no need to check an argument you don't use.
	**Make sure the elements in the parameter arrays exist before trying to use them. This can be done by verifying the size of array and making sure the element that you are about to process is not null.		**Make sure the elements in the parameter arrays exist before trying to use them. This can be done by verifying the size of array and making sure the element that you are about to process is not null.
	**If using the GSObject array, cast the array member to the type you are expecting and verify the cast~~, there are no guarantees of what the object might be.~~		**If using the GSObject array, cast the array member to the type you are expecting, and verify the cast does not fail (and resolve to null).
	**A cast will be needed to access the objects in any event as GSObject has no methods or data members.
	**If the cast fails, the object the cast was assigned to ~~will be~~ null.
	*LibraryCall() may not be the most efficient way to handle a library function call and may seem rather crude, but this is a temporary measure that will be replaced with a more elegant direct-call interface in a future version of Trainz.
	*The current library call mechanism will still remain supported so existing library assets are not broken.
	<br>		<br>

Danny252: Change link to library reference, not language reference

2020-12-28T13:45:42Z

Change link to library reference, not language reference

← Older revision		Revision as of 13:45, 28 December 2020
Line 4:		Line 4:

	==Script Heirarchy==		==Script Heirarchy==
	*[[TrainzScript ~~Language~~ Reference\|API Hierarchy]]		*[[TrainzScript Library Reference\|API Hierarchy]]
	**[[Class GSObject\|GSObject]]		**[[Class GSObject\|GSObject]]
	***[[Class GameObject\|GameObject]]		***[[Class GameObject\|GameObject]]

Tonyhilliam at 07:42, 14 August 2014

2014-08-14T07:42:22Z

← Older revision		Revision as of 07:42, 14 August 2014
Line 14:		Line 14:
	* A library is a self-contained code module that can be accessed by the script of any other asset.		* A library is a self-contained code module that can be accessed by the script of any other asset.
	* Library assets allow content creators to create reusable code repositories that any script can access without having to include a duplicate source file into the asset folder.		* Library assets allow content creators to create reusable code repositories that any script can access without having to include a duplicate source file into the asset folder.
	* A Library class is the only way you can get an OnlineAccess object to access [[Planet Auran]] services from a Trainz script.		* A Library class is the only way you can get an OnlineAccess object to access [[Planet_Auran_account\|Planet Auran]] services from a Trainz script.
	<br>		<br>

Line 24:		Line 24:
	*None		*None
	;Returned Value		;Returned Value
	*An OnlineAccess reference allowing access to [[Planet Auran]] services when online.		*An OnlineAccess reference allowing access to [[Planet_Auran_account\|Planet Auran]] services when online.
	;Syntax		;Syntax
	OnlineAccess channel = GetOnlineAccess();		OnlineAccess channel = GetOnlineAccess();
	;Notes		;Notes
	*This method is the mechanism used to access [[Planet Auran]] via an OnlineAccess object from a script.		*This method is the mechanism used to access [[Planet_Auran_account\|Planet Auran]] via an OnlineAccess object from a script.
	*Script programmers should be careful not to allow other classes access to the OnlineAccess structure, either directly or indirectly, in order to prevent asset spoofing.		*Script programmers should be careful not to allow other classes access to the OnlineAccess structure, either directly or indirectly, in order to prevent asset spoofing.
	*It is only through this private method that you can obtain an OnlineAccess object.		*It is only through this private method that you can obtain an OnlineAccess object.

Pcas1986 at 05:12, 14 February 2014

2014-02-14T05:12:29Z

← Older revision		Revision as of 05:12, 14 February 2014
Line 279:		Line 279:

	==Categories==		==Categories==
	[[Category:Script Class~~]][[Category:Asset KIND~~]]		[[Category:Script Class]]
	{{ORP-bot\|Script}}		{{ORP-bot\|Script}}

Fabartus: fmt, new user notes

2013-07-27T03:44:57Z

fmt, new user notes

@@ Line 1: / Line 1: @@
 *[[TrainzScript Language Reference|API Hierarchy]]
 **[[Class GSObject|GSObject]]
@@ Line 275: / Line 280: @@
 ==Categories==
 [[Category:Script Class]][[Category:Asset KIND]]

Windwalkr at 09:48, 18 October 2010

2010-10-18T09:48:43Z

← Older revision		Revision as of 09:48, 18 October 2010
Line 9:		Line 9:
	* A library is a self-contained code module that can be accessed by the script of any other asset.		* A library is a self-contained code module that can be accessed by the script of any other asset.
	* Library assets allow content creators to create reusable code repositories that any script can access without having to include a duplicate source file into the asset folder.		* Library assets allow content creators to create reusable code repositories that any script can access without having to include a duplicate source file into the asset folder.
	* A Library class is the only way you can get an OnlineAccess object to access Planet Auran services from a Trainz script.		* A Library class is the only way you can get an OnlineAccess object to access [[Planet Auran]] services from a Trainz script.
	<br>		<br>

Line 19:		Line 19:
	*None		*None
	;Returned Value		;Returned Value
	*An OnlineAccess reference allowing access to Planet Auran services when online.		*An OnlineAccess reference allowing access to [[Planet Auran]] services when online.
	;Syntax		;Syntax
	OnlineAccess channel = GetOnlineAccess();		OnlineAccess channel = GetOnlineAccess();
	;Notes		;Notes
	*This method is the mechanism used to access Planet Auran via an OnlineAccess object from a script.		*This method is the mechanism used to access [[Planet Auran]] via an OnlineAccess object from a script.
	*Script programmers should be careful not to allow other classes access to the OnlineAccess structure, either directly or indirectly, in order to prevent asset spoofing.		*Script programmers should be careful not to allow other classes access to the OnlineAccess structure, either directly or indirectly, in order to prevent asset spoofing.
	*It is only through this private method that you can obtain an OnlineAccess object.		*It is only through this private method that you can obtain an OnlineAccess object.

Windwalkr at 16:21, 9 February 2010

2010-02-09T16:21:07Z

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

1 revision

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