[AWSD Controls] Option to only work when holding RightMouse

plugins.json

@@ -628,10 +628,10 @@
 	"wasd_controls": {
 		"title": "WASD Controls",
 		"icon": "sports_esports",
-		"author": "JannisX11",
+		"author": "JannisX11, caioraphael1",
 		"description": "Adds a WASD controlled viewport navigation mode",
 		"about": "The WASD mode can be enabled from the View menu.\nThe keys can be remapped in the keybindings menu.\nThe sensitivity can be changed in the settings under Preview, along with the movement plane.\nHold Control to move faster.",
-		"version": "1.1.0",
+		"version": "1.2.0",
 		"min_version": "4.3.0",
 		"variant": "both"
 	},

plugins/wasd_controls.js

@@ -1,99 +1,158 @@
 (function() {
-
 let deletables = [];
-
 let old_animate;
+let rightMouseDown = false;
 
 BBPlugin.register('wasd_controls', {
 	title: 'WASD Controls',
 	icon: 'sports_esports',
-	author: 'JannisX11',
+	author: 'JannisX11, caioraphael1',
 	description: 'Adds a WASD controlled viewport navigation mode',
 	about: 'The WASD mode can be enabled from the View menu.\nThe keys can be remapped in the keybindings menu.\nThe sensitivity can be changed in the settings under Preview, along with the movement plane.\nHold Control to move faster.',
-	version: '1.1.0',
+	version: '1.2.0',
 	min_version: '4.3.0',
 	variant: 'both',
 	onload() {
 		let navigate_forward = new KeybindItem('navigate_forward', {
-		    name: 'Move Forward',
-		    icon: 'arrow_upward',
-		    category: 'navigate',
+			name: 'Move Forward',
+			icon: 'arrow_upward',
+			category: 'navigate',
 			keybind: new Keybind({key: 'w', ctrl: null})
-		})
+		});
 		let navigate_backward = new KeybindItem('navigate_backward', {
-		    name: 'Move Backward',
-		    icon: 'arrow_upward',
-		    category: 'navigate',
+			name: 'Move Backward',
+			icon: 'arrow_downward',
+			category: 'navigate',
 			keybind: new Keybind({key: 's', ctrl: null})
-		})
+		});
 		let navigate_left = new KeybindItem('navigate_left', {
-		    name: 'Move Left',
-		    icon: 'arrow_upward',
-		    category: 'navigate',
+			name: 'Move Left',
+			icon: 'arrow_back',
+			category: 'navigate',
 			keybind: new Keybind({key: 'a', ctrl: null})
-		})
+		});
 		let navigate_right = new KeybindItem('navigate_right', {
-		    name: 'Move Right',
-		    icon: 'arrow_upward',
-		    category: 'navigate',
+			name: 'Move Right',
+			icon: 'arrow_forward',
+			category: 'navigate',
 			keybind: new Keybind({key: 'd', ctrl: null})
-		})
+		});
 		let navigate_down = new KeybindItem('navigate_down', {
-		    name: 'Move Down',
-		    icon: 'arrow_upward',
-		    category: 'navigate',
+			name: 'Move Down',
+			icon: 'expand_more',
+			category: 'navigate',
 			keybind: new Keybind({key: 16, ctrl: null})
-		})
+		});
 		let navigate_up = new KeybindItem('navigate_up', {
-		    name: 'Move Up',
-		    icon: 'arrow_upward',
-		    category: 'navigate',
+			name: 'Move Up',
+			icon: 'expand_less',
+			category: 'navigate',
 			keybind: new Keybind({key: 32, ctrl: null})
-		})
-		let navigation_keybinds = [navigate_forward, navigate_backward, navigate_left, navigate_right, navigate_down, navigate_up];
+		});
+
+		let navigate_faster = new KeybindItem('navigate_faster', {
+			name: 'Move Faster',
+			icon: 'expand_less',
+			category: 'navigate',
+			keybind: new Keybind({key: 17, ctrl: null})
+		});
+		let navigate_slower = new KeybindItem('navigate_slower', {
+			name: 'Move Slower',
+			icon: 'expand_less',
+			category: 'navigate',
+			keybind: new Keybind({key: 18, ctrl: null})
+		});
+
+
+		let navigation_keybinds = [navigate_forward, navigate_backward, navigate_left, navigate_right, navigate_down, navigate_up, navigate_faster, navigate_slower];
 		deletables.push(...navigation_keybinds);
 
 		function setupWASDMovement(preview, length = 1) {
 			let pos = new THREE.Vector3().copy(preview.camera.position);
 			pos.add(preview.camera.getWorldDirection(new THREE.Vector3()).normalize().multiplyScalar(length));
 			preview.controls.target.copy(pos);
-
-			preview.controls.enable_zoom = false;
 		}
 
+		deletables.push(new Setting('wasd_enabled', {
+			name: 'WASD Controls: Enabled',
+			description: '_',
+			category: 'preview',
+			value: false,
+			onChange(value) {
+				BarItems.wasd_movement.value = value
+				BarItems.wasd_movement.updateEnabledState();
+				setupWASDMovement(Preview.selected, value ? 1 : 16);
+			}
+		}));
+
 		let wasd_toggle = new Toggle('wasd_movement', {
-		    name: 'WASD Movement',
-		    icon: 'sports_esports',
-		    category: 'navigate',
+			name: 'WASD Movement',
+			icon: 'sports_esports',
+			category: 'navigate',
 			value: false,
 			onChange(value) {
+				settings.wasd_enabled.value = value
+				Settings.saveLocalStorages();
 				setupWASDMovement(Preview.selected, value ? 1 : 16);
-				Preview.all.forEach(preview => {
-					preview.controls.enableZoom = !value;
-				})
 			}
-		})
-		function isWASDMovementEnabled() {
-			return Preview.selected && BarItems.wasd_movement && BarItems.wasd_movement.value;
-		}
+		});
+
 		deletables.push(wasd_toggle);
 		MenuBar.menus.view.addAction('_');
 		MenuBar.menus.view.addAction(wasd_toggle);
+		BarItems.wasd_movement.value = settings.wasd_enabled.value
+		BarItems.wasd_movement.updateEnabledState();
+
+		function isWASDMovementEnabled() {
+			if (settings.wasd_requires_hold_right_mouse.value) {
+				return Preview.selected && BarItems.wasd_movement && BarItems.wasd_movement.value && rightMouseDown;
+			} else {
+				return Preview.selected && BarItems.wasd_movement && BarItems.wasd_movement.value
+			}
+		}
+
+		deletables.push(new Setting('base_speed', {
+			name: 'WASD Controls: Base Speed',
+			description: '-', 
+			category: 'preview',
+			type: 'number',
+			value: 50,
+			min: 1
+		}));
 
-		deletables.push(new Setting('wasd_sensitivity', {
-			name: 'WASD Sensitivity',
+		deletables.push(new Setting('move_faster_mult', {
+			name: 'WASD Controls: Move Faster Multiplier',
+			description: '-', 
 			category: 'preview',
 			type: 'number',
-			value: 100,
+			value: 2,
+			max: 10,
 			min: 1
-		}))
+		}));
+
+		deletables.push(new Setting('move_slower_mult', {
+			name: 'WASD Controls: Move Slower Multiplier',
+			description: '-', 
+			category: 'preview',
+			type: 'number',
+			value: 0.5,
+			max: 1,
+			min: 0.1
+		}));
 
 		deletables.push(new Setting('wasd_y_level', {
-			name: 'WASD Navigation at Y Level',
+			name: 'WASD Controls: Navigate at Y Level',
 			description: 'Navigate using WASD at consistent Y level rather than on camera plane',
 			category: 'preview',
 			value: true
-		}))
+		}));
+
+		deletables.push(new Setting('wasd_requires_hold_right_mouse', {
+			name: 'WASD Controls: Navigation only works when holding the right mouse button',
+			description: 'The WASD Controls needs to be enabled for this to work.',
+			category: 'preview',
+			value: false
+		}));
 
 		let pressed_keys = [];
 		Blockbench.on('press_key', data => {
@@ -104,30 +163,50 @@ BBPlugin.register('wasd_controls', {
 					data.capture();
 				}
 			}
-		})
+		});
+
 		document.addEventListener('keyup', event => {
 			pressed_keys.remove(event.which);
-		})
+		});
 
-		function doWASDMovement() {
+		document.addEventListener('mousedown', event => {
+			if (event.button === 2) { // Right mouse button
+				rightMouseDown = true;
+			}
+		});
 
+		document.addEventListener('mouseup', event => {
+			if (event.button === 2) { // Right mouse button
+				rightMouseDown = false;
+			}
+		});
+
+		function doWASDMovement() {
 			let movement = new THREE.Vector3(0, 0, 0);
+
 			let uses_wasd_movement = false;
 			function add(x, y, z) {
 				movement.x += x;
 				movement.y += y;
 				movement.z += z;
 				uses_wasd_movement = true;
 			}
+
 			if (pressed_keys.includes(navigate_forward.keybind.key)) add(0, 0, -1);
 			if (pressed_keys.includes(navigate_backward.keybind.key)) add(0, 0, 1);
 			if (pressed_keys.includes(navigate_left.keybind.key)) add(-1, 0, 0);
 			if (pressed_keys.includes(navigate_right.keybind.key)) add(1, 0, 0);
 			if (pressed_keys.includes(navigate_down.keybind.key)) add(0, -1, 0);
 			if (pressed_keys.includes(navigate_up.keybind.key)) add(0, 1, 0);
 
+
 			if (uses_wasd_movement) {
 				setupWASDMovement(Preview.selected);
+
+				let speedMultiplier = 1.0; // Default speed
+
+				if (pressed_keys.includes(navigate_faster.keybind.key)) speedMultiplier *= settings.move_faster_mult.value;
+				else if (pressed_keys.includes(navigate_slower.keybind.key)) speedMultiplier *= settings.move_slower_mult.value;
 
 				if (settings.wasd_y_level.value) {
 					let vec = Preview.selected.controls.object.getWorldDirection(new THREE.Vector3()).normalize();
@@ -136,7 +215,8 @@ BBPlugin.register('wasd_controls', {
 				} else {
 					movement.applyEuler(Preview.selected.controls.object.rotation);
 				}
-				movement.multiplyScalar(Settings.get('wasd_sensitivity') * (Pressing.ctrl || Pressing.overrides.ctrl ? 2.4 : 1) / 100);
+
+				movement.multiplyScalar(Settings.get('base_speed') * speedMultiplier / 100);
 				Preview.selected.camera.position.add(movement);
 				Preview.selected.controls.target.add(movement);
 			}
@@ -149,21 +229,25 @@ BBPlugin.register('wasd_controls', {
 			if (isWASDMovementEnabled() && pressed_keys.length) {
 				doWASDMovement();
 			}
-		}
+
+			// Ensure zoom is disabled when moving
+			Preview.all.forEach(preview => {
+				preview.controls.enableZoom = !isWASDMovementEnabled();
+			});
+		};
 	},
 	oninstall() {
-		MenuBar.menus.view.highlight(BarItems.wasd_movement)
+		MenuBar.menus.view.highlight(BarItems.wasd_movement);
 	},
 	onunload() {
 		deletables.forEach(action => {
 			action.delete();
-		})
+		});
 		setupWASDMovement(Preview.selected, 16);
 		Preview.all.forEach(preview => {
 			preview.controls.enableZoom = true;
-		})
+		});
 		window.animate = old_animate;
 	}
 });
-
-})()
+})();