Adding ability to see a car's vehicle's soundRange variable value

Author: reticulatingsplines

.DS_Store

@@ -10,7 +10,7 @@
 		"watch": "nodemon --watch ./src --ext js,ts",
 		"build": "npm run lint && rollup --config rollup.config.prod.js",
 		"build:dev": "rollup --config rollup.config.dev.js",
-		"lint": "eslint ./src --ext .js --ext .ts",
+		"lint": "eslint ./src --fix --ext .js --ext .ts",
 		"test": "nyc ava"
 	},
 	"repository": {

package.json

@@ -4,7 +4,7 @@
 /**
  * Returns the current version of the plugin.
  */
-export const pluginVersion = "1.1";
+export const pluginVersion = "1.1 by Basssiiie - soundRange fork";
 
 
 /**

src/.DS_Store

@@ -7,7 +7,7 @@ import main from "./main";
 registerPlugin({
 	name: "RideVehicleEditor",
 	version: Environment.pluginVersion,
-	authors: ["Basssiiie"],
+	authors: ["Basssiiie", "reticulatingsplines"],
 	type: "local",
 	licence: "MIT",
 	main,

src/environment.ts

@@ -22,6 +22,7 @@ export interface VehicleSettings
 	mass: number;
 	poweredAcceleration?: number;
 	poweredMaxSpeed?: number;
+	soundRange: number;
 }
 
 
@@ -40,6 +41,7 @@ export default class VehicleEditor
 	readonly isPowered = new Observable<boolean>();
 	readonly poweredAcceleration = new Observable<number>();
 	readonly poweredMaxSpeed = new Observable<number>();
+	readonly soundRange = new Observable<number>();
 
 
 	/**
@@ -203,6 +205,27 @@ export default class VehicleEditor
 		}
 	}
 
+	/**
+	 * Sets the sound_range variable for this vehicle.
+	 * @param soundRange this is a value assigned to vehicles to determine what sounds they play when traveling (e.g. screams)
+	 */
+	setSoundrange(soundRange: number): void
+	{   const currentCar = this.getSelectedCar();
+		if (currentCar)
+		{
+			const vehicleObject = this.getVehicleObject(this.variant);
+			if (vehicleObject.soundRange == 6)
+			{
+				vehicleObject.soundRange = 255;
+				this.soundRange.set(vehicleObject.soundRange);
+			}
+			else
+			{
+			vehicleObject.soundRange = soundRange;
+			this.soundRange.set(soundRange);
+			}
+		}
+	}
 
 	/**
 	 * Scroll the main viewport to the currently selected vehicle.
@@ -234,6 +257,7 @@ export default class VehicleEditor
 			variant: this.variant.get(),
 			seats: this.seats.get(),
 			mass:  this.mass.get(),
+			soundRange: this.soundRange.get(),
 		};
 
 		if (vehicle.isPowered())
@@ -324,16 +348,20 @@ export default class VehicleEditor
 	 * Internal function that applies all vehicle settings to the specified car.
 	 */
 	private applySettingsToCar(car: Car, settings: VehicleSettings, updateObservables: boolean): void
+
 	{
+		const vehicleObj = this.getVehicleObject(settings.variant);
 		car.vehicleObject = settings.variant;
 		car.numSeats = settings.seats;
 		car.mass = settings.mass;
+		vehicleObj.soundRange = settings.soundRange;
 
 		if (updateObservables)
 		{
 			this.variant.set(settings.variant);
 			this.seats.set(settings.seats);
 			this.mass.set(settings.mass);
+			this.soundRange.set(settings.soundRange);
 		}
 
 		const rideTypes = this.rideTypeList.get();
@@ -399,6 +427,7 @@ export default class VehicleEditor
 			this.trackProgress.set(car.trackProgress);
 			this.seats.set(car.numSeats);
 			this.mass.set(car.mass);
+			this.soundRange.set(this.getVehicleObject(car.vehicleObject).soundRange);
 
 			const definition = RideVehicle.getDefinition(car);
 			const isPowered = RideVehicle.isPowered(definition);
@@ -433,17 +462,20 @@ export default class VehicleEditor
 		const vehicleObj = this.getVehicleObject(variant);
 
 		const seats = (vehicleObj.numSeats & 0x7F); // VEHICLE_SEAT_NUM_MASK
+		const soundRange = (vehicleObj.soundRange);
 		const powAcceleration = vehicleObj.poweredAcceleration;
 		const powMaxSpeed = vehicleObj.poweredMaxSpeed;
 		const mass = (vehicleObj.carMass + (car.mass - oldMass));
 		car.vehicleObject = variant;
 		car.numSeats = seats;
 		car.mass = mass;
+		vehicleObj.soundRange = soundRange;
 		car.poweredAcceleration = powAcceleration;
 		car.poweredMaxSpeed = powMaxSpeed;
 		this.variant.set(variant);
 		this.seats.set(seats);
 		this.mass.set(mass);
+		this.soundRange.set(soundRange);
 		this.isPowered.set(RideVehicle.isPowered(vehicleObj));
 		this.poweredAcceleration.set(powAcceleration);
 		this.poweredMaxSpeed.set(powMaxSpeed);

src/registerPlugin.ts

@@ -17,7 +17,7 @@ import DropdownButtonControl from "./dropdownButton";
 const windowId = "ride-vehicle-editor";
 const windowStart = 18;
 const windowWidth = 375;
-const windowHeight = 248;
+const windowHeight = 285;
 const widgetLineHeight = 14;
 const groupboxMargin = 5;
 const groupboxItemMargin = (groupboxMargin + 5);
@@ -55,6 +55,7 @@ export default class VehicleEditorWindow
 	readonly powAccelerationSpinner: SpinnerControl;
 	readonly powMaxSpeedSpinner: SpinnerControl;
 	readonly massSpinner: SpinnerControl;
+	readonly soundRangeList: DropdownControl;
 
 	readonly locateButton: ButtonControl;
 	readonly pickerButton: ButtonControl;
@@ -284,6 +285,29 @@ export default class VehicleEditorWindow
 		});
 		editor.mass.subscribe(v => this.massSpinner.set(v));
 
+		// soundRange ID of the selected vehicle.
+		this.soundRangeList = new DropdownControl({
+			name: "rve-soundRange-list",
+			tooltip: "Pick from available soundRange IDs.",
+			disabledMessage: "No soundRange IDs available.",
+			items: ["ID 0 - Screams 1 and 8", "ID 1 - Screams 1-7", "ID 2 - Screams 1 and 6", "ID 3 - Whistle", "ID 4 - Bell", "ID 255 - No Sound"],
+			disableSingleItem: false,
+			x: groupboxMargin + viewportSize + 5 + (controlsSize * controlLabelPart),
+			y: (editorStartY + 1 + controlHeight * 5),
+			width: (controlsSize * (1 - controlLabelPart)),
+			height: widgetLineHeight,
+			onSelect: (v): void => editor.setSoundrange(v),
+		});
+		editor.soundRange.subscribe(v =>
+			{
+			if (v == 255)
+			{
+				v = 6;
+			}
+			this.soundRangeList.set(v);
+		}
+			);
+
 		// Powered acceleration of the selected vehicle.
 		this.powAccelerationSpinner = new SpinnerControl({
 			name: "rve-powered-acceleration-spinner",
@@ -293,7 +317,7 @@ export default class VehicleEditorWindow
 			minimum: 0,
 			maximum: 256,
 			x: (groupboxMargin + viewportSize + 5) + (controlsSize * controlLabelPart),
-			y: (editorStartY + 1 + controlHeight * 5),
+			y: (editorStartY + 1 + controlHeight * 6),
 			width: (controlsSize * (1 - controlLabelPart)),
 			height: widgetLineHeight,
 			onChange: (v): void => editor.setPoweredAcceleration(v)
@@ -309,7 +333,7 @@ export default class VehicleEditorWindow
 			minimum: 0,
 			maximum: 256,
 			x: (groupboxMargin + viewportSize + 5) + (controlsSize * controlLabelPart),
-			y: (editorStartY + 1 + controlHeight * 6),
+			y: (editorStartY + 1 + controlHeight * 7),
 			width: (controlsSize * (1 - controlLabelPart)),
 			height: widgetLineHeight,
 			onChange: (v): void => editor.setPoweredMaximumSpeed(v)
@@ -390,7 +414,7 @@ export default class VehicleEditorWindow
 				{ text: "Apply this to all trains", onClick: (): void => this.applyToAllTrains() }
 			],
 			x: (groupboxMargin + viewportSize + 5),
-			y: (editorStartY + controlHeight * 7) + 2,
+			y: (editorStartY + controlHeight * 8) + 2,
 			width: 211,
 			height: (widgetLineHeight + 1),
 		});
@@ -401,7 +425,7 @@ export default class VehicleEditorWindow
 			tooltip: "Multiplies all spinner controls by the specified amount",
 			items: ["x1", "x10", "x100"],
 			x: (windowWidth - (groupboxMargin + 45)),
-			y: (editorStartY + controlHeight * 7) + 2,
+			y: (editorStartY + controlHeight * 8) + 2,
 			width: 45,
 			height: widgetLineHeight,
 			onSelect: (i): void => this.updateMultiplier(i)
@@ -503,12 +527,24 @@ export default class VehicleEditorWindow
 				},
 				this.massSpinner.createWidget(),
 
+				// soundRange
+				<LabelWidget>{
+					tooltip: this.soundRangeList.params.tooltip,
+					type: "label",
+					x: (groupboxMargin + viewportSize + 5),
+					y: (editorStartY + controlHeight * 5) + 2,
+					width: (controlsSize * controlLabelPart),
+					height: widgetLineHeight,
+					text: "soundRange:"
+				},
+				this.soundRangeList.createWidget(),
+
 				// Powered acceleration
 				<LabelWidget>{
 					tooltip: this.powAccelerationSpinner.params.tooltip,
 					type: "label",
 					x: (groupboxMargin + viewportSize + 5),
-					y: (editorStartY + controlHeight * 5) + 2,
+					y: (editorStartY + controlHeight * 6) + 2,
 					width: (controlsSize * controlLabelPart),
 					height: widgetLineHeight,
 					text: "Acceleration:"
@@ -520,7 +556,7 @@ export default class VehicleEditorWindow
 					tooltip: this.powMaxSpeedSpinner.params.tooltip,
 					type: "label",
 					x: (groupboxMargin + viewportSize + 5),
-					y: (editorStartY + controlHeight * 6) + 2,
+					y: (editorStartY + controlHeight * 7) + 2,
 					width: (controlsSize * controlLabelPart),
 					height: widgetLineHeight,
 					text: "Max. speed:"
@@ -649,6 +685,7 @@ export default class VehicleEditorWindow
 			this.trackProgressSpinner.active(toggle);
 			this.seatCountSpinner.active(toggle);
 			this.massSpinner.active(toggle);
+			this.soundRangeList.active(toggle);
 
 			// Buttons
 			this.applyToOthersButton.active(toggle);