Merge pull request #16 from WolfKnight98/passenger-control

1.3.0 - Passenger control update

.gitignore

@@ -1 +1,2 @@
-saves/*.json
+saves/*.json
+.vscode/settings.json

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2020 WolfKnight
+Copyright (c) 2020-2021 WolfKnight
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -25,23 +25,39 @@ Although these can be viewed ingame through the operator manual, the default key
 All of the configuration for the Wraith ARS 2X is done inside the `config.lua` file, below is a copy of the configuration file. All of the options have comments to describe what they do, along with the available options you can set. You have the ability to change the key binds for the large and small key set, the default operator menu options, and the default UI element scale and safezone. 
 ```lua
 -- Radar fast limit locking
--- When enabled, the player will be able to define a fast limit within the radar's menu, when a vehicle 
+-- When enabled, the player will be able to define a fast limit within the radar's menu, when a vehicle
 -- exceeds the fast limit, it will be locked into the fast box. Default setting is disabled to maintain realism
-CONFIG.allow_fast_limit = false 
+CONFIG.allow_fast_limit = true
+
+-- Radar only lock players with auto fast locking
+-- When enabled, the radar will only automatically lock a speed if the caught vehicle has a real player in it.
+CONFIG.only_lock_players = false
 
 -- In-game first time quick start video
--- When enabled, the player will be asked if they'd like to view the quick start video the first time they 
--- open the remote. 
-CONFIG.allow_quick_start_video = true 
+-- When enabled, the player will be asked if they'd like to view the quick start video the first time they
+-- open the remote.
+CONFIG.allow_quick_start_video = true
+
+-- Allow passenger view
+-- When enabled, the front seat passenger will be able to view the radar and plate reader from their end.
+CONFIG.allow_passenger_view = true
+
+-- Allow passenger control
+-- Dependent on CONFIG.allow_passenger_view. When enabled, the front seat passenger will be able to open the
+-- radar remote and control the radar and plate reader for themself and the driver.
+CONFIG.allow_passenger_control = true
+
+-- Set this to true if you use Sonoran CAD with the WraithV2 plugin
+CONFIG.use_sonorancad = false
 
 -- Sets the defaults of all keybinds
 -- These keybinds can be changed by each person in their GTA Settings->Keybinds->FiveM
 CONFIG.keyDefaults =
 {
-	-- Remote control key 
+	-- Remote control key
 	remote_control = "f5",
 
-	-- Radar key lock key 
+	-- Radar key lock key
 	key_lock = "l",
 
 	-- Radar front antenna lock/unlock Key
@@ -58,33 +74,41 @@ CONFIG.keyDefaults =
 }
 
 -- Here you can change the default values for the operator menu, do note, if any of these values are not
--- one of the options listed, the script will not work. 
-CONFIG.menuDefaults = 
+-- one of the options listed, the script will not work.
+CONFIG.menuDefaults =
 {
 	-- Should the system calculate and display faster targets
 	-- Options: true or false
-	["fastDisplay"] = true, 
+	["fastDisplay"] = true,
 
 	-- Sensitivity for each radar mode, this changes how far the antennas will detect vehicles
 	-- Options: 0.2, 0.4, 0.6, 0.8, 1.0
-	["same"] = 0.6, 
-	["opp"] = 0.6, 
+	["same"] = 0.6,
+	["opp"] = 0.6,
 
-	-- The volume of the audible beep 
-	-- Options: 0.0, 0.2, 0.4, 0.6, 0.8, 1.0 
+	-- The volume of the audible beep
+	-- Options: 0.0, 0.2, 0.4, 0.6, 0.8, 1.0
 	["beep"] = 0.6,
-	
-	-- The volume of the verbal lock confirmation 
-	-- Options: 0.0, 0.2, 0.4, 0.6, 0.8, 1.0 
+
+	-- The volume of the verbal lock confirmation
+	-- Options: 0.0, 0.2, 0.4, 0.6, 0.8, 1.0
 	["voice"] = 0.6,
-	
-	-- The volume of the plate reader audio 
-	-- Options: 0.0, 0.2, 0.4, 0.6, 0.8, 1.0 
-	["plateAudio"] = 0.6, 
+
+	-- The volume of the plate reader audio
+	-- Options: 0.0, 0.2, 0.4, 0.6, 0.8, 1.0
+	["plateAudio"] = 0.6,
 
 	-- The speed unit used in conversions
-	-- Options: mph or kmh 
-	["speedType"] = "mph"
+	-- Options: mph or kmh
+	["speedType"] = "mph",
+
+	-- The state for automatic speed locking. This requires CONFIG.allow_fast_limit to be true.
+	-- Options: true or false
+	["fastLock"] = false,
+
+	-- The speed limit required for automatic speed locking. This requires CONFIG.allow_fast_limit to be true.
+	-- Options: 0 to 200
+	["fastLimit"] = 60
 }
 
 -- Here you can change the default scale of the UI elements, as well as the safezone size
@@ -94,19 +118,19 @@ CONFIG.uiDefaults =
 	-- Options: 0.25 - 2.5
 	scale =
 	{
-		radar = 1.0, 
-		remote = 1.0, 
-		plateReader = 1.0
-	}, 
+		radar = 0.75,
+		remote = 0.75,
+		plateReader = 0.75
+	},
 
 	-- The safezone size, must be a multiple of 5.
 	-- Options: 0 - 100
-	safezone = 20 
+	safezone = 20
 }
 ```
 
 ## Suggestions
 If there is an improvement that you think should be made, open a pull request with your modified code, I will then review your request and either accept/deny it. Code in a pull request should be well formatted and commented, it will make it much easier for others to read and understand. In the event that you want to suggest something, but don't know how to code, open an issue with the enhancement tag and then fully describe your suggestion. 
 
 ## Reporting issues/bugs
-Open an issue if you encounter any problems with the resource, if applicable, try to include detailed information on the issue and how to reproduce it. This will make it much easier to find and fix. 
+Open an issue if you encounter any problems with the resource, if applicable, try to include detailed information on the issue and how to reproduce it. This will make it much easier to find and fix.