65df821e2b
* Update documentation guidelines * Add version info part 1 * Add version info part 2 * Add removed in version to frontmatter and tag testmissions as removed * Add version info part 3 * Seaparate ACE3 and ACEX Features/Framework menus, Add ACEX Headless documentation * Add ACEX support to extract_dependencies.py * Merge useful-functions into frameworks * Move class-names to main menu * Prettify class-names table titles * Fix table of contents on documentation guidelines and tips * Merge mission-tools into frameworks * Merge modules into frameworks * Rename to Frameworks (plural) * Fix capitalization in class-names * Improve wiki menu positioning * Add 'mod' to documentation guidelines * Update frameworks sections description for new content * Update wiki menu descriptions * Fix class-names 4 digit versions * More places for descriptions * Include documentation in PRs if applicable note * Add short ACE3 and ACEX description page, outlining the difference
1.8 KiB
| layout | title | description | group | order | parent | mod | version | ||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| wiki | Vehicle Lock Framework | Explains how to configure the Vehicle Lock system. | framework | 5 | wiki | ace |
|
1. Overview
These modules allow you to lock and unlock vehicles and their inventory using a key. Players don't receive a key automatically.
2. Mission Setup
Vehicle Lock can be configured through a mission module or functions.
For key names, see Class Names.
Sync the module with vehicles and players. Custom keys will be handed to players for every synced vehicle. It is only valid for objects present at mission start.
3. Scripting
3.1 Assing Vehicle Key
ace_vehiclelock_fnc_addKeyForVehicle
| Arguments | Type | Optional (default value) | |
|---|---|---|---|
| 0 | Unit | Object | Required |
| 1 | Vehicle | Object | Required |
| 2 | Use Custom Key | Boolean | Optional (default: false, false for side key, true for custom key) |
| R | None | None | Return value |
3.1.1 Example
[bob, car1, true] call ace_vehiclelock_fnc_addKeyForVehicle;
| Arguments | Explanation | |
|---|---|---|
| 0 | bob |
Unit the key will be added to |
| 1 | car1 |
Vehicle the key will work on |
| 2 | true |
Set custom key |
3.2 Override Side
To override a vehicle's side, allowing locking and unlocking using a different side's key, use the following on that vehicle (use wanted side instead of west):
this setVariable ["ace_vehiclelock_lockSide", west];
3.3 Set Lock Pick Strength
To override default lock pick strength for a vehicle, that is how long lock picking will take, use the following on that vehicle (use wanted time in seconds instead of 5):
this setVariable ["ace_vehiclelock_lockpickStrength", 5];