HowTo/Upgrade obsolete script functions - simple examples - Revision history

Pw3r: /* SecurityToken */

2024-02-25T23:16:44Z

SecurityToken

← Older revision		Revision as of 23:16, 25 February 2024
Line 12:		Line 12:

	'''Error Examples'''		'''Error Examples'''

	Error: VE197: Syntax error in script 'somescript.gs' for asset <kuid:0000:0000> "Asset Name".<br>		Error: VE197: Syntax error in script 'somescript.gs' for asset <kuid:0000:0000> "Asset Name".<br>
	Error: VE267: somescript.gs(48) : function SetCrossingAutomatic is obsolete in object Crossing.<br>		Error: VE267: somescript.gs(48) : function SetCrossingAutomatic is obsolete in object Crossing.<br>
Line 34:		Line 35:
	}		}
	</code>		</code>


	=class HTMLWindow=		=class HTMLWindow=

Pw3r at 23:16, 25 February 2024

2024-02-25T23:16:05Z

← Older revision		Revision as of 23:16, 25 February 2024
Line 5:		Line 5:


	=class Crossing=		=class Crossing/Signal/JunctionBase=

	==~~SetCrossingAutomatic()==~~		==SecurityToken==
	~~==SetCrossingState()~~==

			With the addition of Interlocking Towers these script classes had a multitude of functions declared obsolete, and new variants added which take a SecurityToken parameter. This new parameter is entirely optional, and may be passed as null. However, if the relevant object is part of an InterlockingTower 'path' then the tower will take ownership of the object, preventing other scripts from modifying state. In this instance, passing a null SecurityToken will cause a script exception. To avoid this, the caller should first check if the signal/junction/crossing is 'owned', but calling GetSignalOwner(), GetJunctionOwner() or GetCrossingOwner() as appropriate.

			'''Error Examples'''
	Error: VE197: Syntax error in script 'somescript.gs' for asset <kuid:0000:0000> "Asset Name".<br>		Error: VE197: Syntax error in script 'somescript.gs' for asset <kuid:0000:0000> "Asset Name".<br>
	Error: VE267: somescript.gs(48) : function SetCrossingAutomatic is obsolete in object Crossing.<br>		Error: VE267: somescript.gs(48) : function SetCrossingAutomatic is obsolete in object Crossing.<br>
	Error: VE267: somescript.gs(48) : function SetCrossingState is obsolete in object Crossing.		Error: VE267: somescript.gs(48) : function SetCrossingState is obsolete in object Crossing.

	~~This method now requires a SecurityToken as a parameter to the function call~~

	'''Repair'''		'''Repair'''

	You need to ~~initialize a SecurityToken~~, ~~then add it as a parameter to your~~ function ~~calls~~.		You need to check whether the crossing is owned, and call the new function variant instead.

	'''Usage example:'''		'''Usage example:'''

	~~In your header add~~		<code>
			if (!GetCrossingOwner())
	~~SecurityToken stoken;~~		{
			SetCrossingAutomatic(null, false);
	~~Then in your function calls add your token.~~		SetCrossingState(null, 1);
			}
	SetCrossingAutomatic(~~stoken~~, false);		else
	SetCrossingState(~~stoken~~, 1);		{
			// The crossing is under the control of some other script, and calling the
	~~More information on [[Class Crossing]]~~		// above functions (without a valid SecurityToken) will cause exceptions.
			}
			</code>


Line 40:		Line 42:
	VE267: somescript.gs(linenumber) : function GetCompleteIndustryViewDetailsHTMLCode is obsolete in object HTMLWindow.<br>		VE267: somescript.gs(linenumber) : function GetCompleteIndustryViewDetailsHTMLCode is obsolete in object HTMLWindow.<br>

	This error occurs when trying to use this method with an obsolete class. In this case, class GenericIndustry has been obsoleted and replaced with BaseIndustry.		This error occurs when trying to use this method with an obsolete class. In this case, class GenericIndustry has been obsoleted and replaced with BaseIndustry.

	'''Repair'''		'''Repair'''
Line 92:		Line 94:
	''float GetSmoothedVelocity(void);''		''float GetSmoothedVelocity(void);''

	This function return the ~~train's~~ velocity in metres per second and is suitable for human viewing such as a cab display.		This function return the trains velocity in metres per second and is suitable for human viewing such as a cab display.


	''float GetTrainVelocity(void);''		''float GetTrainVelocity(void);''

	This function provides the instantaneous velocity for ~~vehicles in this~~ train, which is good for physics calculations but not good for human-readable display.<br><br>		This function provides the instantaneous velocity for the train, which is good for physics calculations but not good for human-readable display.<br><br>

	'''Usage example:'''		'''Usage example:'''
Line 122:		Line 124:
	''bool GetDirectionRelativeToTrain(void);''		''bool GetDirectionRelativeToTrain(void);''

	This function returns true if the vehicle faces the same way as the Train, false otherwise. This function is a bit tricky to understand and especially when a vehicle, such as a coach/carriage, is involved.		This function returns true if the vehicle faces the same way as the Train, false otherwise. This function is a bit tricky to understand and especially when a vehicle, such as a coach/carriage, is involved.

	'''Usage example1:'''		'''Usage example1:'''

	~~Vehicle myVehicle;~~
	~~bool sameDirectionAsTrain;~~

	sameDirectionAsTrain = GetDirectionRelativeToTrain();		bool sameDirectionAsTrain = GetDirectionRelativeToTrain();

	'''Usage example2:'''		'''Usage example2:'''

			Vehicle[] trainVehicles = GetMyTrain().GetVehicles();

	~~Vehicle[] trainVehicles;~~
	~~Vehicle myVehicle;~~
	~~bool sameDirectionAsTrain;~~
	int i;		int i;
			for (i = 0; i < trainVehicles.size(); ++i)
	~~trainVehicles = GetMyTrain().GetVehicles();~~		{
			bool sameDirectionAsTrain = trainVehicles[i].GetDirectionRelativeToTrain();
	~~if (trainVehicles) { //unlikely to be null but ...~~		if (sameDirectionAsTrain)
			Interface.Print("Vehicle " + i + " is facing forward");
	for (i = 0; i < trainVehicles.size(); ++i) {		else
	~~//get direction of this vehicle in the train~~		Interface.Print("Vehicle " + i + " is facing backwards");
	sameDirectionAsTrain = trainVehicles[i].GetDirectionRelativeToTrain();
	if (sameDirectionAsTrain) {
	~~// do what is necessary here~~
	Interface.Print("Vehicle "+ (i~~+1)~~ + " is facing forward"); ~~// add 1 so that the first vehicle is number 1 and not 0 (zero)~~
	} else {
	Interface.Print("Vehicle "+ (i~~+1)~~ + " is facing backwards");
	}
	}

	}		}

Pcas1986 at 05:41, 13 September 2022

2022-09-13T05:41:48Z

@@ Line 14: / Line 14: @@
 Error: VE267: somescript.gs(48) : function SetCrossingState is obsolete in object Crossing.
-This method now requires a SecrityToken as a parameter to the function call
+This method now requires a SecurityToken as a parameter to the function call
 '''Repair'''
@@ Line 51: / Line 51: @@
   class <myclass> isclass BaseIndustry>
 =class Train=

Pencil42: added class HTMLWindow

2022-08-27T15:32:27Z

added class HTMLWindow

@@ Line 2: / Line 2: @@
 '''Under Development'''  The contents and the layout of this page is under development.
@@ Line 31: / Line 32: @@
 More information on [[Class Crossing]]
@@ Line 62: / Line 81: @@
   mySpeed = GetTrainVelocity();
 =class Vehicle=

Christopher824: added wiki link

2022-08-26T15:46:14Z

added wiki link

← Older revision		Revision as of 15:46, 26 August 2022
Line 29:		Line 29:
	SetCrossingAutomatic(stoken, false);		SetCrossingAutomatic(stoken, false);
	SetCrossingState(stoken, 1);		SetCrossingState(stoken, 1);

			More information on [[Class Crossing]]


	=class Train=		=class Train=

Christopher824: Assed Class Crossing

2022-08-26T15:08:39Z

Assed Class Crossing

← Older revision		Revision as of 15:08, 26 August 2022
Line 2:		Line 2:

	'''Under Development''' The contents and the layout of this page is under development.		'''Under Development''' The contents and the layout of this page is under development.


			=class Crossing=

			==SetCrossingAutomatic()==
			==SetCrossingState()==

			Error: VE197: Syntax error in script 'somescript.gs' for asset <kuid:0000:0000> "Asset Name".<br>
			Error: VE267: somescript.gs(48) : function SetCrossingAutomatic is obsolete in object Crossing.<br>
			Error: VE267: somescript.gs(48) : function SetCrossingState is obsolete in object Crossing.

			This method now requires a SecrityToken as a parameter to the function call

			'''Repair'''

			You need to initialize a SecurityToken, then add it as a parameter to your function calls.

			'''Usage example:'''

			In your header add

			SecurityToken stoken;

			Then in your function calls add your token.

			SetCrossingAutomatic(stoken, false);
			SetCrossingState(stoken, 1);

	=class Train=		=class Train=

Pcas1986: First version and under development

2022-08-26T02:54:52Z

First version and under development

New page

These are examples of solutions for common and simple obsolete Trainzscript functions. This is not an exhaustive list. Solutions for more complex obsolete functions can be found (TBD).

'''Under Development''' The contents and the layout of this page is under development.

=class Train=

==GetVelocity()==

GetVelocity obsolete error or warning: <kuid:0000:0000> : VE267: somescript.gs(299) : function GetVelocity is obsolete in object Train.

'''Repair'''

You have two replacement options in the Train class (train.gs):

''float GetSmoothedVelocity(void);''

This function return the train's velocity in metres per second and is suitable for human viewing such as a cab display.

''float GetTrainVelocity(void);''

This function provides the instantaneous velocity for vehicles in this train, which is good for physics calculations but not good for human-readable display.<br><br>

'''Usage example:'''

float mySpeed;
mySpeed = GetSmoothedVelocity(); // this is the more likely option but depends on what the overall script is trying to do.

// or the more accurate version
mySpeed = GetTrainVelocity();

=class Vehicle=

==GetFacingRelativeToTrain()==

???GetFacingRelativeToTrain obsolete error or warning: <kuid:0000:0000> : VE267: somescript.gs(450) : function GetFacingRelativeToTrain is obsolete in object Vehicle.

'''Repair'''

You have one replacement option in the Vehicle class (vehicle.gs):

''bool GetDirectionRelativeToTrain(void);''

This function returns true if the vehicle faces the same way as the Train, false otherwise. This function is a bit tricky to understand and especially when a vehicle, such as a coach/carriage, is involved.

'''Usage example1:'''

Vehicle myVehicle;
bool sameDirectionAsTrain;

sameDirectionAsTrain = GetDirectionRelativeToTrain();

'''Usage example2:'''

Vehicle[] trainVehicles;
Vehicle myVehicle;
bool sameDirectionAsTrain;
int i;

trainVehicles = GetMyTrain().GetVehicles();

if (trainVehicles) { //unlikely to be null but ...

for (i = 0; i < trainVehicles.size(); ++i) {
//get direction of this vehicle in the train
sameDirectionAsTrain = trainVehicles[i].GetDirectionRelativeToTrain();
if (sameDirectionAsTrain) {
// do what is necessary here
Interface.Print("Vehicle "+ (i+1) + " is facing forward"); // add 1 so that the first vehicle is number 1 and not 0 (zero)
} else {
Interface.Print("Vehicle "+ (i+1) + " is facing backwards");
}
}

}