From b2639da28840e6eefbbd0ddd76469017546ff2fe Mon Sep 17 00:00:00 2001 From: BullHorn Date: Sat, 16 May 2015 21:46:17 +0300 Subject: [PATCH 1/9] Documentation: Weather - standardize --- documentation/feature/weather.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/documentation/feature/weather.md b/documentation/feature/weather.md index b8bcf306b8..cc08eeff06 100644 --- a/documentation/feature/weather.md +++ b/documentation/feature/weather.md @@ -6,11 +6,11 @@ group: feature parent: wiki --- -## Overview +## 1. Overview ACE Weather is enabled by default. This feature simulates realistic weather according to map location, time of day, date, etc. -## Dependencies +## 2. Dependencies `ace_common`, `ace_modules` From c05e7fb046ff874a545ad2b0c8cadbd8d396cf30 Mon Sep 17 00:00:00 2001 From: BullHorn Date: Sat, 16 May 2015 23:42:54 +0300 Subject: [PATCH 2/9] Documentation: Vehiclelock - 1st iteration Add feature\Vehiclelock.md and add relevant info for players Edit addons\Vehiclelock\readme.md for typos and errors Edit missionmaker\modules.md for additional info --- addons/vehiclelock/readme.md | 2 +- documentation/feature/vehiclelock.md | 23 +++++++++++++---------- documentation/missionmaker/modules.md | 11 ++++++++++- 3 files changed, 24 insertions(+), 12 deletions(-) diff --git a/addons/vehiclelock/readme.md b/addons/vehiclelock/readme.md index dc013145aa..64ae01a99c 100644 --- a/addons/vehiclelock/readme.md +++ b/addons/vehiclelock/readme.md @@ -31,7 +31,7 @@ Two key modes (can be used together): * `ACE_vehicleLock_lockpickStrength` - NUMBER: secons, determines how long lockpicking with take, overrides ACE_VehicleLock_DefaultLockpickStrength #### 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 +`[bob, car1, true] call ACE_VehicleLock_fnc_addKeyForVehicle;` - will add a `ACE_key_customKeyMagazine` to bob and program it to work on car1 ## Maintainers diff --git a/documentation/feature/vehiclelock.md b/documentation/feature/vehiclelock.md index 5431dc1624..5cea00534d 100644 --- a/documentation/feature/vehiclelock.md +++ b/documentation/feature/vehiclelock.md @@ -1,26 +1,29 @@ --- layout: wiki title: Vehicle Lock -description: +description: The Vehiclelock module enables locking vehicles and their inventory group: feature parent: wiki --- -## Overview +## 1. Overview -### Sub-feature 1 -Short description of sub-feature 1. +ACE Vehicle Lock is disabled by default. This feature adds the ability to lock and unlock vehicles and their inventory using a key. -### Sub-feature 2 -Short description of sub-feature 2. +### 1.1 Key modes +The mission maker can choose one or both methods: +- Side based keys - A key is responsible for locking and unlocking every vehicle specific to a side (BLUFOR, OPFOR, INDEP or Civilian). +- Custom keys - A key is responsible for locking and unclocking only one specific vehicle, determined by the mission maker. + +### 1.2 Lock picking +It is possible to pick a lock of a locked vehicle. -## Usage +## 2. Usage -Short overview of how to use the feature, e.g. menu options, key bindings, -instructions. May not apply to all modules. +Locking, unlocking and picking vehicle locks is possible via the ACE Interact menu. -## Dependencies +## 3. Dependencies `ace_interaction` diff --git a/documentation/missionmaker/modules.md b/documentation/missionmaker/modules.md index 2d7a7d80c1..dcba720c6b 100644 --- a/documentation/missionmaker/modules.md +++ b/documentation/missionmaker/modules.md @@ -280,8 +280,10 @@ The safe zone around players from a different team (in meters)
### 1.17 Vehicle Lock *Part of: ace_vehiclelock* +These modules allow you to lock and unlock vehicles and their inventory using a key. Players don't receive a key automatically; for key names, see [Classnames Wiki](http://ace3mod.com/wiki/missionmaker/classnames.html#vehicle-lock). + #### 1.17.1 Vehicle Key Assign -Sync with vehicles and players. Will handout custom keys to players for every synced vehicle. Only valid for objects present at mission start. +Sync with vehicles and players. Will handout custom keys to players for every synced vehicle. Only valid for objects present at mission start. #### 1.17.2 Vehicle Lock Setup Settings for lockpick strength and initial vehicle lock state. Removes ambiguous lock states. @@ -298,6 +300,13 @@ Set lock state for all vehicles (removes ambiguous lock states)
Default Time to lockpick (in seconds)
`Default value: 10` +#### 1.17.3 Vehicle setVariables: +* `ACE_VehicleLock_lockSide` - SIDE: overrides a vehicle's side, allowing locking and unlocking using a different side's key. For example: Unlocking INDEP vehicles with a BLUFOR key. +* `ACE_vehicleLock_lockpickStrength` - NUMBER: seconds, determines how long lockpicking with take, overrides the value set in the module for a specific vehicle of the mission maker's choice. + +#### 1.17.4 Public functions: +Example: `[bob, car1, true] call ACE_VehicleLock_fnc_addKeyForVehicle;` - will add a key to bob and program it to work only on car1 + ### 1.18 Weather *Part of: ace_weather* From 36782c29a5b2376a2708e44756f458b6dce4bead Mon Sep 17 00:00:00 2001 From: BullHorn Date: Sat, 16 May 2015 23:55:18 +0300 Subject: [PATCH 3/9] Documentation: Vehiclelock - add description Add description - ability to picklock --- documentation/feature/vehiclelock.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/documentation/feature/vehiclelock.md b/documentation/feature/vehiclelock.md index 5cea00534d..ce78566ee6 100644 --- a/documentation/feature/vehiclelock.md +++ b/documentation/feature/vehiclelock.md @@ -8,7 +8,7 @@ parent: wiki ## 1. Overview -ACE Vehicle Lock is disabled by default. This feature adds the ability to lock and unlock vehicles and their inventory using a key. +ACE Vehicle Lock is disabled by default. This feature adds the ability to lock and unlock vehicles and their inventory using a key, as well as lock picking locked vehicles. ### 1.1 Key modes The mission maker can choose one or both methods: From 01e7a0cee4a6acd8a39813174ef492dd83caae88 Mon Sep 17 00:00:00 2001 From: BullHorn Date: Sun, 17 May 2015 15:51:40 +0300 Subject: [PATCH 4/9] Documentation: edit Vehiclelock Improve grammar Add note for users about lock modes Move lock modes description for mission makers --- documentation/feature/vehiclelock.md | 15 ++++++--------- documentation/missionmaker/modules.md | 10 ++++------ 2 files changed, 10 insertions(+), 15 deletions(-) diff --git a/documentation/feature/vehiclelock.md b/documentation/feature/vehiclelock.md index ce78566ee6..4217d13250 100644 --- a/documentation/feature/vehiclelock.md +++ b/documentation/feature/vehiclelock.md @@ -8,21 +8,18 @@ parent: wiki ## 1. Overview -ACE Vehicle Lock is disabled by default. This feature adds the ability to lock and unlock vehicles and their inventory using a key, as well as lock picking locked vehicles. - -### 1.1 Key modes -The mission maker can choose one or both methods: -- Side based keys - A key is responsible for locking and unlocking every vehicle specific to a side (BLUFOR, OPFOR, INDEP or Civilian). -- Custom keys - A key is responsible for locking and unclocking only one specific vehicle, determined by the mission maker. - -### 1.2 Lock picking -It is possible to pick a lock of a locked vehicle. +ACE Vehicle Lock is disabled by default. This feature adds the ability to lock and unlock vehicles and their inventory using a key, as well as picking locks of locked vehicles. ## 2. Usage Locking, unlocking and picking vehicle locks is possible via the ACE Interact menu. +
+
Note:
+

Different locking modes can be set, consult with your mission maker for more information.

+
+ ## 3. Dependencies diff --git a/documentation/missionmaker/modules.md b/documentation/missionmaker/modules.md index dcba720c6b..38b57595a7 100644 --- a/documentation/missionmaker/modules.md +++ b/documentation/missionmaker/modules.md @@ -283,9 +283,10 @@ The safe zone around players from a different team (in meters)
These modules allow you to lock and unlock vehicles and their inventory using a key. Players don't receive a key automatically; for key names, see [Classnames Wiki](http://ace3mod.com/wiki/missionmaker/classnames.html#vehicle-lock). #### 1.17.1 Vehicle Key Assign -Sync with vehicles and players. Will handout custom keys to players for every synced vehicle. Only valid for objects present at mission start. +Sync with vehicles and players. Will handout custom keys to players for every synced vehicle. Only valid for objects present at mission start. +Example: `[bob, car1, true] call ACE_VehicleLock_fnc_addKeyForVehicle;` - will add a key to bob and program it to work only on car1 -#### 1.17.2 Vehicle Lock Setup +#### 1.17.2.1 Vehicle Lock Setup Settings for lockpick strength and initial vehicle lock state. Removes ambiguous lock states. **Settings:** @@ -300,13 +301,10 @@ Set lock state for all vehicles (removes ambiguous lock states)
Default Time to lockpick (in seconds)
`Default value: 10` -#### 1.17.3 Vehicle setVariables: +#### 1.17.2.2 Vehicle setVariables * `ACE_VehicleLock_lockSide` - SIDE: overrides a vehicle's side, allowing locking and unlocking using a different side's key. For example: Unlocking INDEP vehicles with a BLUFOR key. * `ACE_vehicleLock_lockpickStrength` - NUMBER: seconds, determines how long lockpicking with take, overrides the value set in the module for a specific vehicle of the mission maker's choice. -#### 1.17.4 Public functions: -Example: `[bob, car1, true] call ACE_VehicleLock_fnc_addKeyForVehicle;` - will add a key to bob and program it to work only on car1 - ### 1.18 Weather *Part of: ace_weather* From b7944bdb0bdb0a80dcb56bd4a261fc0e8f529899 Mon Sep 17 00:00:00 2001 From: BullHorn Date: Sun, 17 May 2015 17:11:26 +0300 Subject: [PATCH 5/9] Documentation: Weather - add wind usage Add default keys for toggling wind indicator arrow on/off Add explanation for arrow colors --- documentation/feature/weather.md | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/documentation/feature/weather.md b/documentation/feature/weather.md index cc08eeff06..b33b438178 100644 --- a/documentation/feature/weather.md +++ b/documentation/feature/weather.md @@ -11,6 +11,13 @@ parent: wiki ACE Weather is enabled by default. This feature simulates realistic weather according to map location, time of day, date, etc. -## 2. Dependencies +## 2. Usage + +### 2.1 Wind info +- Wind info is toggled on/off using Shift+K +- The arrow representing wind info is based on [Beaufort scale](http://en.wikipedia.org/wiki/Beaufort_scale#Modern_scale) + + +## 3. Dependencies `ace_common`, `ace_modules` From 9b9d2ad0f7d351913308339d6974582e91680706 Mon Sep 17 00:00:00 2001 From: BullHorn Date: Sun, 17 May 2015 17:54:06 +0300 Subject: [PATCH 6/9] Docs - rename ACE to ACE3 Renamed for docs: vehiclelock, weather and windeflection --- documentation/feature/vehiclelock.md | 2 +- documentation/feature/weather.md | 2 +- documentation/feature/windeflection.md | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/documentation/feature/vehiclelock.md b/documentation/feature/vehiclelock.md index 4217d13250..2dc8b7e92d 100644 --- a/documentation/feature/vehiclelock.md +++ b/documentation/feature/vehiclelock.md @@ -8,7 +8,7 @@ parent: wiki ## 1. Overview -ACE Vehicle Lock is disabled by default. This feature adds the ability to lock and unlock vehicles and their inventory using a key, as well as picking locks of locked vehicles. +ACE3 Vehicle Lock is disabled by default. This feature adds the ability to lock and unlock vehicles and their inventory using a key, as well as picking locks of locked vehicles. ## 2. Usage diff --git a/documentation/feature/weather.md b/documentation/feature/weather.md index b33b438178..d2330ed69b 100644 --- a/documentation/feature/weather.md +++ b/documentation/feature/weather.md @@ -8,7 +8,7 @@ parent: wiki ## 1. Overview -ACE Weather is enabled by default. This feature simulates realistic weather according to map location, time of day, date, etc. +ACE3 Weather is enabled by default. This feature simulates realistic weather according to map location, time of day, date, etc. ## 2. Usage diff --git a/documentation/feature/windeflection.md b/documentation/feature/windeflection.md index 386bd849c2..8a0a29ad1d 100644 --- a/documentation/feature/windeflection.md +++ b/documentation/feature/windeflection.md @@ -8,7 +8,7 @@ parent: wiki ## 1. Overview -Wind Deflection is enabled by default. This feature simulates the wind deflection of projectiles fired by players and is designed to work independently or in conjunction with the Advanced Ballistic feature. +ACE3 Wind Deflection is enabled by default. This feature simulates the wind deflection of projectiles fired by players and is designed to work independently or in conjunction with the Advanced Ballistic feature.
Note:
From 9f671e59c11bf96e23e80363a1da0a7c817b1841 Mon Sep 17 00:00:00 2001 From: BullHorn Date: Sun, 17 May 2015 18:00:06 +0300 Subject: [PATCH 7/9] Doc: modules.md - rename 'ACE' to 'ACE3' Rename all relevant instances of 'ACE' to 'ACE3, ignoring code examples --- documentation/missionmaker/modules.md | 24 ++++++++++++------------ 1 file changed, 12 insertions(+), 12 deletions(-) diff --git a/documentation/missionmaker/modules.md b/documentation/missionmaker/modules.md index 38b57595a7..473fd04a9f 100644 --- a/documentation/missionmaker/modules.md +++ b/documentation/missionmaker/modules.md @@ -7,7 +7,7 @@ order: 5 parent: wiki --- -## 1. ACE +## 1. ACE3 ### 1.1 Advanced Ballistics *Part of: ace_advanced_ballistics* @@ -45,10 +45,10 @@ Defines the radius around the player (in meters) at which advanced ballistics ar ### 1.2 Allow Config Export *Part of: ace_Optionmenu* -This modules allows to export all current ACE settings from the ACE Option menu to the clipboard and RPT file. +This modules allows to export all current ACE3 settings from the ACE3 Option menu to the clipboard and RPT file. 1. **Allow (Boolean)**
-Enables the "export" button in the ACE Option menu
+Enables the "export" button in the ACE3 Option menu
`Default value: Yes` ### 1.3 BlueForceTracking @@ -68,7 +68,7 @@ Hide markers for "AI only" groups.
### 1.4 Check PBOs *Part of: ace_common* -If you are worried that players haven't updated ACE or other mods to the version you're using on the server, you can place the "Check PBOs" module on your map. You can choose one of three posible actions that are being executed when a player joins that has a wrong version of ACE or an other mod: +If you are worried that players haven't updated ACE3 or other mods to the version you're using on the server, you can place the "Check PBOs" module on your map. You can choose one of three posible actions that are being executed when a player joins that has a wrong version of ACE3 or an other mod: * Warn once * Warn permanent @@ -81,7 +81,7 @@ What to do with people who do not have the right PBOs.
`Default value: "Warn once"` 2. **Check all addons (Boolean)**
-Check all addons instead of only those of ACE?
+Check all addons instead of only those of ACE3?
`Default value: "No"` 3. **Whitelist**
@@ -107,7 +107,7 @@ Example 3: @JSRS + @Blastcore-A3:
### 1.5 Explosive System *Part of: ace_explosive* -The "Explosive System" module lets you tweak the settings for the new explosive system that ACE introduces. +The "Explosive System" module lets you tweak the settings for the new explosive system that ACE3 introduces. **Settings:** @@ -236,7 +236,7 @@ This module enables Mission Makers to specificly enable units to move a rallypoi

It's important to mention that this doesn't work for player who join during a mission (JIP = Join in progress). That's something we can't change because that's the way Bohemia has implemented their module framework.

-To enable JIP players to move rally points have a look at [ACE Rallypoints](./mission-tools.html#1.-ace-rallypoints). +To enable JIP players to move rally points have a look at [ACE3 Rallypoints](./mission-tools.html#1.-ace-rallypoints). ### 1.15 Respawn System @@ -313,7 +313,7 @@ This module allows you to customize the weather settings.
Note:
-

ACE Weather overrides weather settings (editor, mission settings) and automatically calculates wind, temperature and pressure according to map location, date, time of day and cloud coverage and allows the weather to evolve realistically as the simulation progresses. Weather synchronization occurs between all clients.
Adjustment of the weather is possible by modifying the overcast value (for example: 0.7 may result in intermittent rain).

+

ACE3 Weather overrides weather settings (editor, mission settings) and automatically calculates wind, temperature and pressure according to map location, date, time of day and cloud coverage and allows the weather to evolve realistically as the simulation progresses. Weather synchronization occurs between all clients.
Adjustment of the weather is possible by modifying the overcast value (for example: 0.7 may result in intermittent rain).

@@ -322,8 +322,8 @@ This module allows you to customize the weather settings. 1. **Weather propagation (Boolean)**
Enables sever side weather propagation.
`Default value: Yes` -2. **ACE Weather (Boolean)**
-Overrides the default weather with ACE weather (map based).
+2. **ACE3 Weather (Boolean)**
+Overrides the default weather with ACE3 weather (map based).
`Default value: Yes` 3. **Sync Rain (Boolean)**
Synchronizes rain.
@@ -377,7 +377,7 @@ And then there's the "LSD Vehicles" module … it does 'something' to all v -## 2. ACE Medical +## 2. ACE3 Medical *Part of: ace_medical* ### 2.1 Medical Settings @@ -515,7 +515,7 @@ Whether or not the objects in the list will be a medical vehicle.
`Default value: Yes` -## 3. ACE Mission Modules +## 3. ACE3 Mission Modules *Part of: ace_missionmodules* ### 3.1 Ambiance Sounds From 725b1447e7d4a5308da276d8129e26c3da562dbd Mon Sep 17 00:00:00 2001 From: BullHorn Date: Mon, 18 May 2015 00:07:26 +0300 Subject: [PATCH 8/9] Doc: Weather explanation Add note for players explaining weather sync Add notes for mission makers explaining synergy between propagation and weather variables --- documentation/feature/weather.md | 2 +- documentation/missionmaker/modules.md | 8 ++++++++ 2 files changed, 9 insertions(+), 1 deletion(-) diff --git a/documentation/feature/weather.md b/documentation/feature/weather.md index d2330ed69b..284b5627fd 100644 --- a/documentation/feature/weather.md +++ b/documentation/feature/weather.md @@ -8,7 +8,7 @@ parent: wiki ## 1. Overview -ACE3 Weather is enabled by default. This feature simulates realistic weather according to map location, time of day, date, etc. +ACE3 Weather is enabled by default. This feature simulates realistic weather according to map location, time of day, date, etc and makes sure every player experiences the same weather effects. ## 2. Usage diff --git a/documentation/missionmaker/modules.md b/documentation/missionmaker/modules.md index 473fd04a9f..37ae31e4cf 100644 --- a/documentation/missionmaker/modules.md +++ b/documentation/missionmaker/modules.md @@ -322,8 +322,16 @@ This module allows you to customize the weather settings. 1. **Weather propagation (Boolean)**
Enables sever side weather propagation.
`Default value: Yes` +
+
Note:
+

This feature is responsible for synchronizing weather between all clients. Disabling it is not recommended.

+
2. **ACE3 Weather (Boolean)**
Overrides the default weather with ACE3 weather (map based).
+
+
Note:
+

This feature can be disabled without affecting the weather propagation above. Useful if you prefer changing weather settings manually.

+
`Default value: Yes` 3. **Sync Rain (Boolean)**
Synchronizes rain.
From 08afd3e4e546015aaf7fe6d953f694f7bf730c42 Mon Sep 17 00:00:00 2001 From: BullHorn Date: Mon, 18 May 2015 00:18:13 +0300 Subject: [PATCH 9/9] Docs: modules.md remove redundant word --- documentation/missionmaker/modules.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/documentation/missionmaker/modules.md b/documentation/missionmaker/modules.md index 37ae31e4cf..93af598761 100644 --- a/documentation/missionmaker/modules.md +++ b/documentation/missionmaker/modules.md @@ -324,13 +324,13 @@ Enables sever side weather propagation.
`Default value: Yes`
Note:
-

This feature is responsible for synchronizing weather between all clients. Disabling it is not recommended.

+

This is responsible for synchronizing weather between all clients. Disabling it is not recommended.

2. **ACE3 Weather (Boolean)**
Overrides the default weather with ACE3 weather (map based).
Note:
-

This feature can be disabled without affecting the weather propagation above. Useful if you prefer changing weather settings manually.

+

This can be disabled without affecting the weather propagation above. Useful if you prefer changing weather settings manually.

`Default value: Yes` 3. **Sync Rain (Boolean)**