Class Vehicle - Revision history

Christopher824: added GetFacingRelativeToTrain(void) (obsolete) for repair information

2022-09-14T14:16:49Z

added GetFacingRelativeToTrain(void) (obsolete) for repair information

@@ Line 382: / Line 382: @@
 ;Notes
 Replaces obsolete function GetFacingRelativeToTrain()
 <br>
@@ Line 426: / Line 425: @@
   int eType = GetEngineType();
 ;Notes
 <br>

2022-09-14T13:51:08Z

GetDirectionRelativeToTrain

← Older revision		Revision as of 13:51, 14 September 2022
Line 381:		Line 381:
	bool vehicleToTrain = GetDirectionRelativeToTrain();		bool vehicleToTrain = GetDirectionRelativeToTrain();
	;Notes		;Notes
			Replaces obsolete function GetFacingRelativeToTrain()
			After replacement, you may get inverse or opposite results, so now true is false.
	<br>		<br>

2020-12-28T13:43:16Z

Change link to library reference, not language reference

← Older revision		Revision as of 13:43, 28 December 2020
Line 1:		Line 1:
	*[[TrainzScript ~~Language~~ Reference\|API Hierarchy]]		*[[TrainzScript Library Reference\|API Hierarchy]]
	*[[Class GSObject\|GSObject]]		*[[Class GSObject\|GSObject]]
	***[[Class GameObject\|GameObject]]		***[[Class GameObject\|GameObject]]

2020-07-24T02:24:47Z

NotifyTrainChanged

← Older revision		Revision as of 02:24, 24 July 2020
Line 1,103:		Line 1,103:
	*None		*None
	;Notes		;Notes
	*In ~~ts12~~ only.		*In TS12 and greater only.
	*Override this function as required, but don't forget to call the inherited version in case it does something in the future.		*Override this function as required, but don't forget to call the inherited version in case it does something in the future.
	*Attempting to manipulate the makeup or positioning of any Train from within this function is illegal behavior. If you need to do that, trigger a delayed action using a message or a thread.		*Attempting to manipulate the makeup or positioning of any Train from within this function is illegal behavior. If you need to do that, trigger a delayed action using a message or a thread.

2020-07-24T02:18:04Z

SetRollBasedOnTrack

← Older revision		Revision as of 02:18, 24 July 2020
Line 973:		Line 973:
	{{MethodHeader\|public native void SetRollBasedOnTrack(float multiplier)}}		{{MethodHeader\|public native void SetRollBasedOnTrack(float multiplier)}}
	;Parameters		;Parameters
	*'''multiplier''' = The value to multiply the ~~velocity~~ by to get the train roll angle.		*'''multiplier''' = The value to multiply the curve by to get the train roll angle.
	;Returned Value		;Returned Value
	*None		*None

2020-07-24T02:14:06Z

SetRollBasedOnTrack

← Older revision		Revision as of 02:14, 24 July 2020
Line 971:		Line 971:

	===SetRollBasedOnTrack===		===SetRollBasedOnTrack===
	{{MethodHeader\|public native void SetRollBasedOnTrack(float ~~factor~~)}}		{{MethodHeader\|public native void SetRollBasedOnTrack(float multiplier)}}
	;Parameters		;Parameters
	*'''~~factor~~''' = ~~Arbitrary~~ value ~~used~~ to ~~control~~ the ~~amount of~~ roll.		*'''multiplier''' = The value to multiply the velocity by to get the train roll angle.
	;Returned Value		;Returned Value
	*None		*None
Line 979:		Line 979:
	SetRollBasedOnTrack(2.0);		SetRollBasedOnTrack(2.0);
	;Notes		;Notes
	*~~Roll~~ is a rotation about an axis parallel to the track direction.		*This feature is often used by "non-train" vehicles like aeroplanes or boats.
			*Pitch is the left/right rotation of the vehicle mesh (ie, roation about an axis parallel to the track direction).
	*Use a positive value to lean 'into' the curve, a negative value to lean out.		*Use a positive value to lean 'into' the curve, a negative value to lean out.
	<br>		<br>

2020-07-24T01:57:29Z

SetPitchBasedOnSpeed

← Older revision		Revision as of 01:57, 24 July 2020
Line 900:		Line 900:

	===SetPitchBasedOnSpeed===		===SetPitchBasedOnSpeed===
	{{MethodHeader\|public native void SetPitchBasedOnSpeed(float ~~factor~~)}}		{{MethodHeader\|public native void SetPitchBasedOnSpeed(float multiplier)}}
	;Parameters		;Parameters
	*'''~~factor~~''' = ~~An arbitrary~~ value ~~used~~ to ~~vary~~ the ~~pitch of~~ the train ~~with its velocity~~.		*'''multiplier''' = The value to multiply the velocity by to get the train pitch angle.
	;Returned Value		;Returned Value
	*None		*None
Line 908:		Line 908:
	SetPitchBasedOnSpeed(2.5);		SetPitchBasedOnSpeed(2.5);
	;Notes		;Notes
	*Pitch is rotation about an axis ~~at right angles~~ to the track direction.		*This feature is often used by "non-train" vehicles like helicopters.
			*Pitch is the forward/backward rotation of the vehicle mesh (ie, roation about an axis perpendicular to the track direction).
	<br>		<br>

2020-07-24T01:53:03Z

SetMaximumCoupleVelocity

← Older revision		Revision as of 01:53, 24 July 2020
Line 873:		Line 873:
	{{MethodHeader\|public native void SetMaximumCoupleVelocity(float velocity)}}		{{MethodHeader\|public native void SetMaximumCoupleVelocity(float velocity)}}
	;Parameters		;Parameters
	*'''velocity''' = The maximum speed in metres per second at which this vehicle can be coupled to ~~without breaking a coupler~~.		*'''velocity''' = The maximum speed in metres per second at which this vehicle can be coupled to another, or 0 for no maximum.
	;Returned Value		;Returned Value
	*None		*None
Line 879:		Line 879:
	SetMaximumCoupleVelocity(10);		SetMaximumCoupleVelocity(10);
	;Notes		;Notes
	*"~~Vehicle~~","~~BadCouple~~" ~~are broadcast if~~ this speed ~~is exceeded~~.		*Despite the name, the passed value is a speed (ie. unsigned, ie. must be greater than or equal to 0).
	*If a value of zero is used ~~"Vehicle","BadCouple" messages will not be issued~~.		*If coupler breakage is enabled, then a coupling attempt above this speed will break the coupler, and post a "Coupler breakage" message, followed by a "Collided" message.
			*If coupler breakage is not enabled, hen a coupling attempt above this speed will fail, and post a "BadCouple" message.
			*Passing a value of 0.0/zero can be used allow coupling to happen any speed.
	<br>		<br>

2020-07-24T01:44:17Z

SetDecouplingMask

← Older revision		Revision as of 01:44, 24 July 2020
Line 802:		Line 802:
	{{MethodHeader\|public native void SetDecouplingMask(int mask)}}		{{MethodHeader\|public native void SetDecouplingMask(int mask)}}
	;Parameters		;Parameters
	*'''mask''' = A mask specifying which of the vehilce's couplers are allowed to ~~couple~~.		*'''mask''' = A mask specifying which of the vehilce's couplers are allowed to decouple.
	;Returned Value		;Returned Value
	*None		*None

2020-07-24T01:18:06Z

GetVehicleTypeFlags

← Older revision		Revision as of 01:18, 24 July 2020
Line 627:		Line 627:
	*None		*None
	;Returned Value		;Returned Value
	*~~One~~ of ~~the~~ [[#Vehicle Type Flags\|Vehicle Type Flags]] representing ~~what kind~~ of vehicle ~~the current object is~~.		*A bitfield of [[#Vehicle Type Flags\|Vehicle Type Flags]] representing the characteristics of the vehicle.
	;Syntax		;Syntax
	int flags = GetVehicleTypeFlags();		int flags = GetVehicleTypeFlags();
			if ((Flags.TestAny(flags, Vehicle.TYPE_HAS_INTERIOR)))
			; // This vehicle has an interior
	;Notes		;Notes
			*The returned flags are a bitfield, and must be treated as such. I.e, do '''not''' test if (GetVehicleTypeFlags() == Vehicle.TYPE_LOCOMOTIVE).
	<br>		<br>

← Older revision		Revision as of 13:43, 28 December 2020
Line 1:		Line 1:
	*[[TrainzScript ~~Language~~ Reference\|API Hierarchy]]		*[[TrainzScript Library Reference\|API Hierarchy]]
	*[[Class GSObject\|GSObject]]		*[[Class GSObject\|GSObject]]
	***[[Class GameObject\|GameObject]]		***[[Class GameObject\|GameObject]]