diff --git a/addons/vehiclelock/readme.md b/addons/vehiclelock/readme.md index a1bd223a52..b05248d5a8 100644 --- a/addons/vehiclelock/readme.md +++ b/addons/vehiclelock/readme.md @@ -5,7 +5,7 @@ Adds keys as an item, to lock and unlock vehicles. Primary target would be role play or TVT, but has uses in all game types, even co-ops (e.g.: DAC AI will steal unlocked vehicles) Two key modes (can be used together): -Simple Side based keys (e.g. "ACE_key_west" works on any hunter) +Simple Side based keys (e.g. "ACE_key_west" works on any [WEST] vehicle like the M-ATV//hunter) Custom keys (one key will only open a specific vehicle and nothing else) #### Items Added: @@ -18,24 +18,20 @@ Custom keys (one key will only open a specific vehicle and nothing else) `ACE_key_civ` #### Magazine added: -`ACE_key_customKeyMagazine` (should never be manualy added, needs to be 'programed' to work on a vehicle) +`ACE_key_customKeyMagazine` (should never be manualy added, needs to be "programed" to work on a vehicle, see `ACE_VehicleLock_fnc_addKeyForVehicle`) ## For Mission Makers: #### Modules: -* Vehicle Lock Setup - Settings for lockpick strength and initial vehicle lock state. -* Vehicle Key Assign - Sync with vehicles and players. Will handout custom keys to players for every synced vehicle. - -#### Global Variable: -* `ACE_VehicleLock_DefaultLockpickStrength` - Time in seconds to lock pick globaly, can also set per-vehicle (-1 would disable) +* Vehicle Lock Setup - Settings for locking inventory of locked vehicles, default lockpick time, and initial vehicle lock state. +* Vehicle Key Assign - Sync with vehicles and players. Will handout custom keys to players for every synced vehicle. Will NOT work for JIP units. #### Vehicle setVariables: * `ACE_VehicleLock_lockSide` - SIDE: overrides a vehicle's side, allows indfor to use little-bird's with indp keys * `ACE_vehicleLock_lockpickStrength` - NUMBER: secons, determines how long lockpicking with take, overrides ACE_VehicleLock_DefaultLockpickStrength -* `ACE_VehicleLock_customKeys` - ARRAY: array of strings of magazinesDetails, use the following function to modify -`[bob, car1, true] call ACE_VehicleLock_fnc_addKeyForVehicle;` -will add a `ACE_magazine_customKey` to bob and program it to work on car1 +#### Public Functions: +`[bob, car1, true] call ACE_VehicleLock_fnc_addKeyForVehicle;` - will add a `ACE_magazine_customKey` to bob and program it to work on car1 ## Maintainers