UltimateLocker - Lock Everything & Auto Lock

UltimateLocker - Lock Everything & Auto Lock, allows you to place Code Locks/Key Lock on Vehicles, Furnaces, Weapon Racks, Turrets, Mining Quarry, Pump Jack, Motorbike, Motorbike With Sidecar, Pedal Bike, Pedal Trike, Deployable Items and much more.
Plus you can decide whether to automatically position the code locks, with many configurations and share locks with your clan/team members.
Place Code Lock wherever you want and Auto Lock with a single plugin.
You can decide which entities to enable Code Lock on.
It has commands for administrators to lock, unlock and remove Code Locks/Key Lock.

IMPORTANT: Added the ability to also place Key Locks, in addition to Code Locks.

Place Code Lock/Key Lock wherever you want with a single plugin:

1. Vehicle Locks
2. Motorbike, Motorbike With Sidecar, Pedal Bike, Pedal Trike
3. Furnaces, Refineries, and more
4. Weapon Rack Lock
5. Farming Lock
6. Electricity Lock / Electrical Lock
7. Industrial Lock
8. Construction Lock
9. Mining Quarry, Pump Jack
10. Items Lock
11. Trap Lock
12. Turrets Lock
13. Misc Lock
14. Fun Lock
15. Deployable Lock
16. And so on...
     

EXAMPLES OF OPERATION/USE:

Some examples of how the plugin works when there is a Code Lock/Key Lock to which you do not have access:

• Usage block/loot furnaces, refineries, electric furnaces, water dispensers, industrial conveyor, industrial crafter, car lift, elevator, small generator, metal shop front, dropbox, mail box, vending machine, etc...
• Usage block: workbench, research table, repair table, computer station, mixing table, etc...
• Device Identifier: If the Auto Turrets, CCTV Camera, PTZ CCTV Camera, etc…, are locked with Code Lock/Key Lock, you cannot access them remotely if you do not have access to Code lock/Key Lock, even if you know the identification number.
• Block use and loot of vehicles, including horses
• Block use and loot of vehicles, including Motorbike, Motorbike With Sidecar, Pedal Bike, Pedal Trike.
• Block use and loot of: Mining Quarry, Pump Jack.
• Auto Turret authorization lock, rotation, attack mode, remote control, lock to change identification ID.
• Locking loot and usafe of SAM Site.
• Lock to change camera identification ID and remote control.
• Block personal Quarry Mining usage and loot
• FARM: fertilizer container block, sowing block, harvesting/cutting plants and clone, or harvesting dead plants, composter block, etc...
• Weapon rack: weapons storage and collection block, weapon reloading, weapon exchange.
• Blocking the insertion and removal of electrical cables and pipes from the various components.
• Blocking the use of electrical components: switching on/off switches, switches, buttons, changing timer duration and much more...
• Blocking use and frequency change of transceiver components, RF Broadcaster, RF Receiver.
• Blocking the use of some entertainment objects such as the piano, drums, boom box, arcade games, etc...
• Block fun objects such as Strobe Light, Laser Light, Sound Light, Neon Sign, etc...
• And much more, with new items that will be added in future releases or at your suggestion via a request for support or comment
   

AUTO LOCK:

The plugin integrates an automatic positioning system for Code Lock or Key Lock.
Using the /autolock or /codelock command the player can manage all the settings:

• Sharing locks with clan/team members.
• Create a code lock pin and/or update all your codelock pins with 1 click.
• Create a Guest pin for your Code Lock and/or update all Guest pins of your code locks with 1 click.
• Enable the ability to use Key Locks, if you do not have Code Locks in your inventory.
• Streamer mode: to hide the display of the Code Lock pin on the screen.
• In addition, there will be many other options that can be enabled/disabled. These options will be available based on how the plugin has been configured.
  For example: has the ability to place the code lock on the furnaces been enabled? Then there will be the option to enable and/or disable the automatic positioning of the locks on the furnaces. And so on for all the other configurations.
• And many other new features and features that will arrive with the next plugin updates.

----------

PERMISSIONS:

• ultimatelocker.use - Allows you to use the plugin to place Code Locks/Key Locks.
• ultimatelocker.admin - Allows you to execute some commands reserved for administrators.
• ultimatelocker.bypass.force - Allows you to bypass Code Locks/Key Locks.
• ultimatelocker.autolock.enabled - This role is required to be able to use the automatic positioning system of Code Lock or Key Lock.
• ultimatelocker.autolock.nolockrequired - With this role you do not need to have the Code Lock in your inventory, the Code Lock will be placed even if you do not have one.

COMMANDS FOR PLAYERS

Commands can be typed in chat (by putting the / character in front of the command), or from console.
 

• /ul code <code> — Change the Code Lock code of the entity you are looking at, if you own the entity or if it belongs to a clan/team member.
• /ul codeall <code> — Change the Code Lock code on all entities owned by the player.
  ----------

COMMANDS FOR ADMIN

Commands can be typed in chat (by putting the / character in front of the command), or from console.
To use these commands you must have the role: ultimatelocker.admin
 

• /ul unlock — Unlock the Code Lock/Key Lock of the entity you are watching.
• /ul unlockall <steamID> — Unlock all player Code Locks/Key Locks.
• /ul lock — Lock the Code Lock/Key Lock of the entity you are watching.
• /ul lockall <steamID>  — Lock all player Code Locks/Key Locks.
• /ul remove — Removes the Code Lock/Key Lock of the entity you are watching.
• /ul removeall <steamID>  — Removes all player Code Locks/Key Locks.
• /ul code <code> <steamID> — Change the Code Lock code of the entity you are looking at. You must pass the entity owner's steamID instead of <steamID>. Instead of <code> you must insert the new code. Must consist of 4 numbers.
• /ul codeall <code> <steamID> — Change the Code Lock code on all entities owned by the player. You must pass the steamID of the player whose code you want to change instead of the <steamID>. Instead of <code> you must insert the new code. Must consist of 4 numbers.
• /ul show — Shows the Code Lock code of the entity you are looking at.
  --------------------
• NB: To use these commands you must set the configuration AllowAdminToBypassCodeLock to be set to true or have the role ultimatelocker.bypass.force.
  --------------------
   

Commands can be added or modified in the configuration file: /oxide/config/UltimateLocker.json

CLAN/TEAM

If the player is part of a clan/team, he can block, unlock or remove Code Locks/Key Locks placed by other teammates, if enabled in the configurations.

CONFIGURATION

The settings and options can be configured in the UltimateLocker under the config directory.
The use of an editor and validator is recommended to avoid formatting issues and syntax errors.

{
  "TimeZone": "Europe/London",
  "ChatPrefix": "UltimateLocker",
  "AllowAdminToBypassCodeLock (Allows admin to bypass Code Lock without using commands). Default False.)": false,
  "Chat Command": [
    "ul",
    "ultimatelocker"
  ],
  "Auto Lock Configuration": {
    "Chat Command": [
      "autolock",
      "codelock"
    ],
    "Allow automatic lock placement by default. (Default: TRUE)": true,
    "Allow automatic placement of Key Locks if there are no Code Locks in the inventory. (Default: TRUE)": true,
    "Allow Guest Code by default. (Default: FALSE)": false,
    "Allow automatic Share locks with clan/team members by default. (Default: TRUE)": true,
    "Enable streamer mode by default. (Default: FALSE)": false,
    "Allow automatic lock on Doors by default. (Default: TRUE)": true,
    "Allow automatic lock on Boxes by default. (Default: FALSE)": false,
    "Allow automatic lock on Storage Container by default. (Default: FALSE)": false,
    "Allow automatic lock on Lockers by default. (Default: TRUE)": true,
    "Allow automatic lock on TC (Cupboards) by default. (Default: TRUE)": true,
    "Allow automatic lock on Vehicle by default. (Default: TRUE)": true,
    "Allow automatic lock on Furnace by default. (Default: FALSE)": false,
    "Allow automatic lock on Vending Machine by default. (Default: FALSE)": false,
    "Allow automatic lock on Composter by default. (Default: FALSE)": false,
    "Allow automatic lock on Mixing Table by default. (Default: FALSE)": false,
    "Allow automatic lock on Planter by default. (Default: FALSE)": false,
    "Allow automatic lock on Auto Turret by default. (Default: FALSE)": false,
    "Allow automatic lock on SAM Site by default. (Default: FALSE)": false,
    "Allow automatic lock on Traps by default. (Default: FALSE)": false,
    "Allow automatic lock on Weapon Rack by default. (Default: TRUE)": true,
    "Allow automatic lock on Stash by default. (Default: FALSE)": false,
    "Allow automatic lock on Neon Sign by default. (Default: FALSE)": false,
    "Allow automatic lock on Other Lockable Entities by default. (Default: FALSE)": false,
    "Allow automatic lock on Other Custom Entities by default. (Default: FALSE)": false
  },
  "Requires Building Privilege to place Code Locks. (Default: TRUE)": true,
  "Requires Building Privilege to place Code Locks in unowned vehicles. (Default: FALSE)": false,
  "Allow deployment of Code Lock in vehicles owned by other players. (Default: FALSE)": false,
  "Allow deployment of Code Lock in unowned vehicles. (Default: TRUE)": true,
  "Allow pushing vehicles blocked by the Code Lock (Default: TRUE)": true,
  "Set player as owner when placing a Mining Quarry or Pump Jack (also static). (Default: TRUE)": true,
  "Enable Lock": {
    "Vehicles": [
      {
        "ItemName": "Minicopter",
        "EnableLock": true,
        "PrefabName": "assets/content/vehicles/minicopter/minicopter.entity.prefab",
        "RequiredPermission": [
          ""
        ]
      },
      {
        "ItemName": "Scrap Transport Helicopter",
        "EnableLock": true,
        "PrefabName": "assets/content/vehicles/scrap heli carrier/scraptransporthelicopter.prefab",
        "RequiredPermission": [
          ""
        ]
      },
      {
        "ItemName": "Attack Helicopter",
        "EnableLock": true,
        "PrefabName": "assets/content/vehicles/attackhelicopter/attackhelicopter.entity.prefab",
        "RequiredPermission": [
          ""
        ]
      },
      {
        "ItemName": "Armored / Hot Air Balloon",
        "EnableLock": true,
        "PrefabName": "assets/prefabs/deployable/hot air balloon/hotairballoon.prefab",
        "RequiredPermission": [
          ""
        ]
      },
      {
        "ItemName": "Row Boat",
        "EnableLock": true,
        "PrefabName": "assets/content/vehicles/boats/rowboat/rowboat.prefab",
        "RequiredPermission": [
          ""
        ]
      },
      {
        "ItemName": "RHIB",
        "EnableLock": true,
        "PrefabName": "assets/content/vehicles/boats/rhib/rhib.prefab",
        "RequiredPermission": [
          ""
        ]
      },
      {
        "ItemName": "Tugboat",
        "EnableLock": true,
        "PrefabName": "assets/content/vehicles/boats/tugboat/tugboat.prefab",
        "RequiredPermission": [
          ""
        ]
      },
      {
        "ItemName": "Submarinesolo",
        "EnableLock": true,
        "PrefabName": "assets/content/vehicles/submarine/submarinesolo.entity.prefab",
        "RequiredPermission": [
          ""
        ]
      },
      {
        "ItemName": "Submarine Duo",
        "EnableLock": true,
        "PrefabName": "assets/content/vehicles/submarine/submarineduo.entity.prefab",
        "RequiredPermission": [
          ""
        ]
      },
      {
        "ItemName": "Horse",
        "EnableLock": true,
        "PrefabName": "assets/rust.ai/nextai/testridablehorse.prefab",
        "RequiredPermission": [
          ""
        ]
      },
      {
        "ItemName": "Tomaha Snowmobile",
        "EnableLock": true,
        "PrefabName": "assets/content/vehicles/snowmobiles/tomahasnowmobile.prefab",
        "RequiredPermission": [
          ""
        ]
      },
      {
        "ItemName": "Snowmobile",
        "EnableLock": true,
        "PrefabName": "assets/content/vehicles/snowmobiles/snowmobile.prefab",
        "RequiredPermission": [
          ""
        ]
      },
      {
        "ItemName": "Sedan",
        "EnableLock": true,
        "PrefabName": "assets/content/vehicles/sedan_a/sedantest.entity.prefab",
        "RequiredPermission": [
          ""
        ]
      },
      {
        "ItemName": "2 Module Car",
        "EnableLock": true,
        "PrefabName": "assets/content/vehicles/modularcar/2module_car_spawned.entity.prefab",
        "RequiredPermission": [
          ""
        ]
      },
      {
        "ItemName": "3 Module Car",
        "EnableLock": true,
        "PrefabName": "assets/content/vehicles/modularcar/3module_car_spawned.entity.prefab",
        "RequiredPermission": [
          ""
        ]
      },
      {
        "ItemName": "4 Module Car",
        "EnableLock": true,
        "PrefabName": "assets/content/vehicles/modularcar/4module_car_spawned.entity.prefab",
        "RequiredPermission": [
          ""
        ]
      }
    ],
    "Deployables": [
      {
        "ItemName": "Large Furnace",
        "EnableLock": true,
        "PrefabName": "assets/prefabs/deployable/furnace.large/furnace.large.prefab",
        "RequiredPermission": [
          ""
        ]
      },
      {
        "ItemName": "Furnace",
        "EnableLock": true,
        "PrefabName": "assets/prefabs/deployable/furnace/furnace.prefab",
        "RequiredPermission": [
          ""
        ]
      },
      {
        "ItemName": "Legacy Furnace",
        "EnableLock": true,
        "PrefabName": "assets/prefabs/deployable/legacyfurnace/legacy_furnace.prefab",
        "RequiredPermission": [
          ""
        ]
      },
      {
        "ItemName": "Refinery",
        "EnableLock": true,
        "PrefabName": "assets/prefabs/deployable/oil refinery/refinery_small_deployed.prefab",
        "RequiredPermission": [
          ""
        ]
      },
      {
        "ItemName": "Electric Furnace",
        "EnableLock": true,
        "PrefabName": "assets/prefabs/deployable/playerioents/electricfurnace/electricfurnace.deployed.prefab",
        "RequiredPermission": [
          ""
        ]
      },
      {
        "ItemName": "Stone Fireplace",
        "EnableLock": true,
        "PrefabName": "assets/prefabs/deployable/fireplace/fireplace.deployed.prefab",
        "RequiredPermission": [
          ""
        ]
      },
      {
        "ItemName": "BBQ",
        "EnableLock": true,
        "PrefabName": "assets/prefabs/deployable/bbq/bbq.deployed.prefab",
        "RequiredPermission": [
          ""
        ]
      },
      {
        "ItemName": "Hobo Barrel",
        "EnableLock": true,
        "PrefabName": "assets/prefabs/misc/twitch/hobobarrel/hobobarrel.deployed.prefab",
        "RequiredPermission": [
          ""
        ]
      },
      {
        "ItemName": "Storage Barrel B",
        "EnableLock": true,
        "PrefabName": "assets/prefabs/misc/decor_dlc/storagebarrel/storage_barrel_b.prefab",
        "RequiredPermission": [
          ""
        ]
      },
      {
        "ItemName": "Storage Barrel C",
        "EnableLock": true,
        "PrefabName": "assets/prefabs/misc/decor_dlc/storagebarrel/storage_barrel_c.prefab",
        "RequiredPermission": [
          ""
        ]
      },
      ............
    ]
  },
  "VersionNumber": {
    "Major": 1,
    "Minor": 0,
    "Patch": 0
  }
}

1. TimeZone: Default: Europe/London
2. ChatPrefix: — Chat message prefix.
3. AllowAdminToBypassCodeLock (Allows admin to bypass Code Locks/Key Locks without using commands). Default FALSE.
4. Chat Command: Here you can add, edit or delete Commands can be typed in chat (by putting the / character in front of the command), or from console.
5. Requires Building Privilege to place Code Locks: Requires Building Privilege to place Code Locks/Key Lock. Default: TRUE
6. Requires Building Privilege to place Code Locks in unowned vehicles: Requires Building Privilege to place Code Locks/Key Lock in unowned vehicles. Default: FALSE
7. Allow deployment of Code Lock in vehicles owned by other players: Allow deployment of Code Lock in vehicles owned by other players. Default: FALSE
8. Allow deployment of Code Lock in unowned vehicles: Allow deployment of Code Lock in unowned vehicles. Default: TRUE
9. Allow pushing vehicles blocked by the Code Lock: Allow pushing vehicles/horses blocked by the Code Lock. Default: TRUE
10. Sets player as owner when placing a Mining Quarry or Pump Jack (also static): Set the player as owner of the Mining Quarry or Pump Jack placed (also those statistics). Default: TRUE
11. Enable Lock: Here you can set which entities to enable, on which you can place a Code Lock/Key Lock.
    1. ItemName: The name of the entity
    2. EnableLock: Whether or not to enable Code Lock/Key Lock placement for this entity.
    3. RequiredPermission: Here you can specify the roles required to be able to insert a Code Lock/Key Lock in the entities enabled in the configuration.
       You can specify 1 or more roles, and as long as the player has at least one of these roles he can enter the Code Lock/Key Lock.
       Here you can specify the roles required to be able to insert a Code Lock/Key Lock in the entities enabled in the configuration.
       You can specify 1 or more roles, and as long as the player has at least one of these roles he can enter the Code Lock/Key Lock.
       When you enter a role, a server-side role will be created which must then be assigned to the player, here are some examples.
       1. “RequiredPermission”: [ “vip_1”]: In this case the ultimatelocker.vip_1 role will be created, it will be necessary to assign this role to the player to enable the insertion of the Code Lock/Key Lock in the configured entity.
       2. “RequiredPermission”: [ “user_1”, “vip_2” ]: In this case the ultimatelocker.user_1 and ultimatelocker.vip_2 roles will be created and it will be necessary to assign one of these roles to the player (or even both) to enable the insertion of the Code Lock/Key Lock in the configured entity.
       3. The role name must respect certain parameters and can only contain these alphanumeric characters:
          a-z A-Z 0-9 . _ –
       4. Any unsupported characters will be removed, the space character will be replaced by the _ character.

AUTO LOCK – CONFIGURATION

• Chat Command: Here you can specify 1 or more commands to open the UI for Auto Lock settings
• Allow automatic …. …. by default: The settings that start with “Allow automatic …. …. by default“, are the basic settings once the Auto Lock system is enabled.
  EXAMPLE: If you have Auto Lock enabled and have the setting “Allow automatic lock on Doors by default = true“, then it will be set to automatically place the code lock /key lock on doors by default. After that the player can change this setting via the UI. This applies to all basic “allow configuration properties”.

LOCALIZATION

The plugin, therefore the automatic messages and statistics, are translated into the following languages:

• English
• Italian

Translation files are located in the /oxide/lang folder, here is an example of a /oxide/lang/en/UltimateLocker.json translation file.

You can add translations for other languages by adding them to the folder: /oxide/lang

AVAILABLE ENTITIES

VEHICLES:

Minicopter, Scrap Transport Helicopter, Attack Helicopter, Armored / Hot Air Balloon, Kayak, Row Boat, RHIB, Tugboat, Submarine Solo, Submarine Duo, Horse, Tomaha Snowmobile, Snowmobile, Sedan, 2 Module Car, 3 Module Car, 4 Module Car, Motorbike, Motorbike With Sidecar, Pedal Bike, Pedal Trike.

DEPLOYABLES:

Large Furnace, Furnace, Legacy Furnace, Refinery, Electric Furnace, Stone Fireplace, BBQ, Hobo Barrel, Storage Barrel B, Storage Barrel C, RHIB Storage, Metal Shop Front, Dropbox, Mail Box, Vending Machine, Computer Station, Twitch Rivals Desk, Mixing Table, Composter, Small Planter Box, Large Planter Box, Minecart Planter, Bath Tub Planter, Rail Road Planter, Hitch & Trough, Small Water Catcher, Large Water Catcher, Water Barrel, Powered Water Purifier, Fluid Switch & Pump, Repair Bench, Research Table, Workbench Level 1, Workbench Level 2, Workbench Level 3, Button, Switch, Smart Switch, Timer, Small Generator, SAM Site, Auto Turret, Flame Turret, Shotgun Trap, Modular Car Lift, Snow Machine, Fogger-3000, Elevator, Mining Quarry, Pump Jack, Tall Weapon Rack, Horizontal Weapon Rack, Wide Weapon Rack, Weapon Rack Stand, Frontier Bolts Single Item Rack, Frontier Horseshoe Single Item Rack, Frontier Horns Single Item Rack, Small Stash, Chippy Arcade Game, Strobe Light, Laser Light, Sound Light, Small Neon Sign, Medium Neon Sign, Large Neon Sign, Medium Animated Neon Sign, Large Animated Neon Sign, Search Light, CCTV Camera, PTZ CCTV Camera, RF Broadcaster, RF Receiver, Industrial Conveyor, Industrial Crafter, Wheelbarrow Piano, Junkyard Drum Kit, Boom Box, Chinese Lantern, Chinese Lantern White, Tuna Can Lamp, Lantern, Camp Fire, Cursed Cauldron, Skull Fire Pit, Jack O Lantern Angry, Jack O Lantern Happy

NEW ENTITIES

New entities will be added with future releases.
If you want to request the addition of a specific entity, feel free to open a support request and it will be added to the plugin.

ENTITY IMAGE PREVIEW

VEHICLES:

Minicopter	Scrap Transport Helicopter	Attack Helicopter	Hot Air Balloon
Armored Hot Air Balloon	Kayak	Row Boat	RHIB
Tugboat	Submarine Solo	Submarine Duo	Horse
Snowmobile	Tomaha Snowmobile	Sedan	2 Module Car
3 Module Car	4 Module Car	Motorbike	Motorbike With Sidecar
Pedal Bike	Pedal Trike

DEPLOYABLES:

Large Furnace	Furnace	Legacy Furnace	Small Oil Refinery
Electric Furnace	Stone Fireplace	Barbeque (BBQ)	Hobo Barrel
Storage Barrel Vertical	Storage Barrel Horizontal	Metal Shop Front	Drop Box
Mail Box	Vending Machine	Computer Station	Twitch Rivals Desk
Mixing Table	Composter	Small Planter Box	Large Planter Box
Minecart Planter	Bath Tub Planter	Rail Road Planter	Hitch & Trough
Small Water Catcher	Large Water Catcher	Water Barrel	Powered Water Purifier
Fluid Switch & Pump	Repair Bench	Research Table	Workbench Level 1
Workbench Level 2	Workbench Level 3	Button	Switch
Smart Switch	Timer	Small Generator	SAM Site
Auto Turret	Flame Turret	Shotgun Trap	Modular Car Lift
Snow Machine	Fogger-3000	Elevator	Mining Quarry
Pump Jack	RHIB Storage
Tall Weapon Rack	Horizontal Weapon Rack	Wide Weapon Rack	Weapon Rack Stand
Frontier Bolts Single Item Rack	Frontier Horseshoe Single Item Rack	Frontier Horns Single Item Rack
Small Stash	Chippy Arcade Game	Strobe Light	Laser Light
Sound Light	Small Neon Sign	Medium Neon Sign	Large Neon Sign
Medium Animated Neon Sign	Large Animated Neon Sign	Search Light	CCTV Camera
PTZ CCTV Camera	RF Broadcaster	RF Receiver	Industrial Conveyor
Industrial Crafter	Wheelbarrow Piano	Junkyard Drum Kit	Boom Box
Chinese Lantern	Chinese Lantern White	Tuna Can Lamp	Lantern
Camp Fire	Cursed Cauldron	Skull Fire Pit	Jack O Lantern Angry
Jack O Lantern Happy