Difference between revisions of "Template:NavalMobility/Documentation"
(Removed blank parameters from example (blank parameters currently break the template if passed)) |
|||
(5 intermediate revisions by 2 users not shown) | |||
Line 2: | Line 2: | ||
<div style="float:left;margin-right:20px;">__TOC__</div> | <div style="float:left;margin-right:20px;">__TOC__</div> | ||
== Description == | == Description == | ||
− | This template inserts a standardised naval vessel mobility table using values from [[:Template:Specs]]. Additional values have to be measured, | + | This template inserts a standardised naval vessel mobility table using values from [[:Template:Specs]]. Additional values have to be measured, it's recommended to always use the [[#Recommended|fully-featured table]]. Note that all measured values should be done in Test Sail, with ''Secondary weapons'' set to ''No offensive armament''. |
+ | |||
== Parameters == | == Parameters == | ||
− | * '''SpeedForwardStockAB''' - Measured sustained speed flanking ahead (FLK AHEAD) in Arcade mode. If the speed flickers between two values in game - pick one that shows the | + | * '''SpeedForwardStockAB''' - Measured sustained speed flanking ahead (FLK AHEAD) in Arcade mode. If the speed flickers between two values in-game - pick the one that shows most of the time, if both show about as often - the higher one. |
− | * '''SpeedBackStockAB''' - Same as above, only at full reverse. | + | * '''SpeedBackStockAB''' - Same as above, only at full reverse. Do not add minus before the value (eg. instead of <kbd>-20</kbd> just write <kbd>20</kbd>). |
− | * '''TurnTimeStockAB''' - Measured average time in seconds after at least | + | * '''TurnTimeStockAB''' - Measured average time in seconds after at least 2 full 360° turns at constant speed (recommended average of 3 turns after the speed stabilizes). Table template will automatically round the displayed value if needed, but the template will still use a number in a provided precision for the calculations (eg. providing <kbd>18.433</kbd> over <kbd>18.43</kbd> is fine). Step-by-step guide: |
− | : | + | :# Open the game, select the vessel, edit modifications to uncheck all of them for stock (or select all for {{Annotation|Upgraded|All modifications installed}} - if you don't have all modifications researched yet, you cannot measure the Upgraded value) |
− | : | + | :# Right-click on the boat, choose Test Sail. |
− | : | + | :# Remove all additional weaponry (torpedoes, depth charges, etc. - ''Secondary weapons'' selected to ''No offensive armament'') |
− | : | + | :# Select Difficulty to appropriate mode - either Arcade Battles or Realistic Battles - select Vehicle Modification to Current, Time of Day 12:00, Weather: Clear. |
− | : | + | :# Enter a full rudder deflection turn (either starboard or port, shouldn't matter) at flank speed (FLK AHEAD) |
− | : | + | :# Wait for the speed to stabilize (turns should be completed at constant speeds), note the speed here - it's inputted in the TurnSpeed (eg. TurnSpeedStockAB) parameter. |
− | : | + | :# Complete several turns (>2; the more, the better), stop-watch the times to complete each turn |
− | : | + | :# Take the average of the times |
− | + | : Alternatively you can use a video recorder, then measure time in a video-editing tool. 60 FPS video is recommended | |
− | * '''TurnSpeedStockAB''' - Measured average sustained speed. If the speed flickers between two values in game - pick one that shows the | + | * '''TurnSpeedStockAB''' - Measured average sustained speed when turning. If the speed flickers between two values in-game - pick the one that shows most of the time, if both show about as often - the higher one. |
− | * '''TurnTimeSpadedAB''' - As above, only with all modifications | + | * '''TurnTimeSpadedAB''' - As above, only with all modifications installed. |
− | * '''TurnSpeedSpadedAB''' - As above, only with all modifications | + | * '''TurnSpeedSpadedAB''' - As above, only with all modifications installed. |
− | * '''SpeedForwardStockRB''' - As above, only in Realistic Battles | + | * '''SpeedForwardStockRB''' - As above, only in Realistic Battles. |
− | * '''SpeedBackStockRB''' - As above | + | * '''SpeedBackStockRB''' - As above. |
− | * '''TurnTimeStockRB''' - As above | + | * '''TurnTimeStockRB''' - As above. |
− | * '''TurnSpeedStockRB''' - As above | + | * '''TurnSpeedStockRB''' - As above. |
− | * '''TurnTimeSpadedRB''' - As above | + | * '''TurnTimeSpadedRB''' - As above. |
− | * '''TurnSpeedSpadedRB''' - As above | + | * '''TurnSpeedSpadedRB''' - As above. |
+ | * ''(automatic)'' '''SpeedForwardSpadedAB''' - Measured sustained speed flanking ahead (FLK AHEAD) in Arcade mode, with all modifications installed. Do not use unless the default value is incorrect. | ||
+ | * ''(automatic)'' '''SpeedBackSpadedAB''' - As above, but when reversing. | ||
+ | * ''(automatic)'' '''SpeedForwardSpadedRB''' - As above, in Realistic mode. | ||
+ | * ''(automatic)'' '''SpeedBackSpadedRB''' - As above. | ||
== Examples of use == | == Examples of use == | ||
{{#vardefine:me|jp_t14_class}} | {{#vardefine:me|jp_t14_class}} | ||
− | + | {| | |
− | The default table filled automatically from data of the {{Specs-Link|{{#var:me}}}} | + | |- |
+ | | The default table filled automatically from data of the {{Specs-Link|{{#var:me}}}} | ||
{{NavalMobility}} | {{NavalMobility}} | ||
<pre>{{NavalMobility}}</pre> | <pre>{{NavalMobility}}</pre> | ||
− | + | | Version with only the stock speed measured | |
− | Version with only the stock speed measured | ||
{{NavalMobility | {{NavalMobility | ||
|SpeedForwardStockAB = 83 | |SpeedForwardStockAB = 83 | ||
Line 46: | Line 51: | ||
|SpeedBackStockRB = 17 | |SpeedBackStockRB = 17 | ||
}}</pre> | }}</pre> | ||
− | + | |- | |
− | < | + | | <span id="Recommended">'''Recommended, fully-featured example.'''</span> Note that turn time of <kbd>18.433</kbd> was rounded to <kbd>18.43</kbd>. |
− | '''Recommended, fully-featured example.''' Note that turn time of <kbd>18.433</kbd> was rounded to <kbd>18.43</kbd>. | ||
{{NavalMobility | {{NavalMobility | ||
|SpeedForwardStockAB = 83 | |SpeedForwardStockAB = 83 | ||
Line 78: | Line 82: | ||
|TurnSpeedSpadedRB = 35 | |TurnSpeedSpadedRB = 35 | ||
}}</pre> | }}</pre> | ||
− | + | | Version with only partial measurements. Note that the table can accept just speed, or just turn speed, or just turn speed and time, without maximum speed. However, it is still highly recommended to provide all missing values. | |
− | Version with only partial measurements. Note that the table | ||
{{NavalMobility | {{NavalMobility | ||
|SpeedForwardStockAB = 83 | |SpeedForwardStockAB = 83 | ||
Line 101: | Line 104: | ||
|TurnSpeedSpadedRB = 35 | |TurnSpeedSpadedRB = 35 | ||
}}</pre> | }}</pre> | ||
− | + | |- | |
+ | |} | ||
{{Sp-begin|TemplateData}} | {{Sp-begin|TemplateData}} | ||
<div style="text-align:left"> | <div style="text-align:left"> | ||
<templatedata> | <templatedata> | ||
{ | { | ||
− | "description": "Mobility | + | "description": "Mobility characteristics table for naval units. All measured values should be done in Test Sail, with Secondary weapons set to 'No offensive armament'.", |
"params": { | "params": { | ||
"SpeedForwardStockAB": { | "SpeedForwardStockAB": { | ||
Line 112: | Line 116: | ||
"type": "number", | "type": "number", | ||
"required": false, | "required": false, | ||
− | "description": "Measured sustained speed flanking | + | "description": "Measured sustained speed flanking forwards. If the speed flickers between two values in-game - pick the one that shows most of the time, if both show about as often - the higher one.", |
"example": "83" | "example": "83" | ||
}, | }, | ||
Line 119: | Line 123: | ||
"type": "number", | "type": "number", | ||
"required": false, | "required": false, | ||
− | "description": "Measured sustained speed full reverse. If the speed flickers between two values in game - pick one that shows the | + | "description": "Measured sustained speed full reverse. If the speed flickers between two values in-game - pick the one that shows most of the time, if both show about as often - the higher one.", |
"example": "20" | "example": "20" | ||
}, | }, | ||
Line 126: | Line 130: | ||
"type": "string", | "type": "string", | ||
"required": false, | "required": false, | ||
− | "description": "Measured average time in seconds after at least | + | "description": "Measured average time in seconds after at least 2 full 360° turns (recommended average of 3 turns). Table will round the displayed value if needed, but use the number in the provided precision for calculations.", |
"example": "16.43" | "example": "16.43" | ||
}, | }, | ||
Line 133: | Line 137: | ||
"type": "number", | "type": "number", | ||
"required": false, | "required": false, | ||
− | "description": "Measured average sustained speed. If the speed flickers between two values in game - pick one that shows the | + | "description": "Measured average sustained speed while turning. If the speed flickers between two values in-game - pick the one that shows most of the time, if both show about as often - the higher one.", |
"example": "35" | "example": "35" | ||
}, | }, | ||
"TurnTimeSpadedAB": { | "TurnTimeSpadedAB": { | ||
− | "label": "Turn time - | + | "label": "Turn time - fully upgraded in AB", |
"type": "string", | "type": "string", | ||
"required": false, | "required": false, | ||
− | "description": "Measured average time in seconds after at least | + | "description": "Measured average time in seconds after at least 2 full 360° turns (recommended average of 3 turns). Table will round the displayed value if needed, but use the number in the provided precision for calculations.", |
"example": "11.1" | "example": "11.1" | ||
}, | }, | ||
"TurnSpeedSpadedAB": { | "TurnSpeedSpadedAB": { | ||
− | "label": "Turn speed - | + | "label": "Turn speed - fully upgraded in AB", |
"type": "number", | "type": "number", | ||
"required": false, | "required": false, | ||
− | "description": "Measured average sustained speed. If the speed flickers between two values in game - pick one that shows the | + | "description": "Measured average sustained speed while turning. If the speed flickers between two values in-game - pick the one that shows most of the time, if both show about as often - the higher one.", |
"example": "33" | "example": "33" | ||
}, | }, | ||
Line 154: | Line 158: | ||
"type": "number", | "type": "number", | ||
"required": false, | "required": false, | ||
− | "description": "Measured sustained speed flanking forward. If the speed flickers between two values in game - pick one that shows the | + | "description": "Measured sustained speed flanking forward. If the speed flickers between two values in-game - pick the one that shows most of the time, if both show about as often - the higher one.", |
"example": "53" | "example": "53" | ||
}, | }, | ||
Line 161: | Line 165: | ||
"type": "number", | "type": "number", | ||
"required": false, | "required": false, | ||
− | "description": "Measured sustained speed full reverse. If the speed flickers between two values in game - pick one that shows the | + | "description": "Measured sustained speed full reverse. If the speed flickers between two values in-game - pick the one that shows most of the time, if both show about as often - the higher one.", |
"example": "17" | "example": "17" | ||
}, | }, | ||
Line 168: | Line 172: | ||
"type": "string", | "type": "string", | ||
"required": false, | "required": false, | ||
− | "description": "Measured average time in seconds after at least | + | "description": "Measured average time in seconds after at least 2 full 360° turns (recommended average of 3 turns). Table will round the displayed value if needed, but use the number in the provided precision for calculations.", |
"example": "18.433" | "example": "18.433" | ||
}, | }, | ||
Line 175: | Line 179: | ||
"type": "number", | "type": "number", | ||
"required": false, | "required": false, | ||
− | "description": "Measured average sustained speed. If the speed flickers between two values in game - pick one that shows the | + | "description": "Measured average sustained speed while turning. If the speed flickers between two values in-game - pick the one that shows most of the time, if both show about as often - the higher one.", |
"example": "35" | "example": "35" | ||
}, | }, | ||
"TurnTimeSpadedRB": { | "TurnTimeSpadedRB": { | ||
− | "label": "Turn time - | + | "label": "Turn time - fully upgraded in RB", |
"type": "string", | "type": "string", | ||
"required": false, | "required": false, | ||
− | "description": "Measured average time in seconds after at least | + | "description": "Measured average time in seconds after at least 2 full 360° turns (recommended average of 3 turns). Table will round the displayed value if needed, but use the number in the provided precision for calculations.", |
"example": "16.6" | "example": "16.6" | ||
}, | }, | ||
"TurnSpeedSpadedRB": { | "TurnSpeedSpadedRB": { | ||
− | "label": "Turn speed - | + | "label": "Turn speed - fully upgraded in RB", |
"type": "number", | "type": "number", | ||
"required": false, | "required": false, | ||
− | "description": "Measured average sustained speed. If the speed flickers between two values in game - pick one that shows the | + | "description": "Measured average sustained speed while turning. If the speed flickers between two values in-game - pick the one that shows most of the time, if both show about as often - the higher one.", |
"example": "35" | "example": "35" | ||
} | } |
Latest revision as of 17:42, 25 December 2021
Contents
Description
This template inserts a standardised naval vessel mobility table using values from Template:Specs. Additional values have to be measured, it's recommended to always use the fully-featured table. Note that all measured values should be done in Test Sail, with Secondary weapons set to No offensive armament.
Parameters
- SpeedForwardStockAB - Measured sustained speed flanking ahead (FLK AHEAD) in Arcade mode. If the speed flickers between two values in-game - pick the one that shows most of the time, if both show about as often - the higher one.
- SpeedBackStockAB - Same as above, only at full reverse. Do not add minus before the value (eg. instead of -20 just write 20).
- TurnTimeStockAB - Measured average time in seconds after at least 2 full 360° turns at constant speed (recommended average of 3 turns after the speed stabilizes). Table template will automatically round the displayed value if needed, but the template will still use a number in a provided precision for the calculations (eg. providing 18.433 over 18.43 is fine). Step-by-step guide:
- Open the game, select the vessel, edit modifications to uncheck all of them for stock (or select all for Upgraded - if you don't have all modifications researched yet, you cannot measure the Upgraded value)
- Right-click on the boat, choose Test Sail.
- Remove all additional weaponry (torpedoes, depth charges, etc. - Secondary weapons selected to No offensive armament)
- Select Difficulty to appropriate mode - either Arcade Battles or Realistic Battles - select Vehicle Modification to Current, Time of Day 12:00, Weather: Clear.
- Enter a full rudder deflection turn (either starboard or port, shouldn't matter) at flank speed (FLK AHEAD)
- Wait for the speed to stabilize (turns should be completed at constant speeds), note the speed here - it's inputted in the TurnSpeed (eg. TurnSpeedStockAB) parameter.
- Complete several turns (>2; the more, the better), stop-watch the times to complete each turn
- Take the average of the times
- Alternatively you can use a video recorder, then measure time in a video-editing tool. 60 FPS video is recommended
- TurnSpeedStockAB - Measured average sustained speed when turning. If the speed flickers between two values in-game - pick the one that shows most of the time, if both show about as often - the higher one.
- TurnTimeSpadedAB - As above, only with all modifications installed.
- TurnSpeedSpadedAB - As above, only with all modifications installed.
- SpeedForwardStockRB - As above, only in Realistic Battles.
- SpeedBackStockRB - As above.
- TurnTimeStockRB - As above.
- TurnSpeedStockRB - As above.
- TurnTimeSpadedRB - As above.
- TurnSpeedSpadedRB - As above.
- (automatic) SpeedForwardSpadedAB - Measured sustained speed flanking ahead (FLK AHEAD) in Arcade mode, with all modifications installed. Do not use unless the default value is incorrect.
- (automatic) SpeedBackSpadedAB - As above, but when reversing.
- (automatic) SpeedForwardSpadedRB - As above, in Realistic mode.
- (automatic) SpeedBackSpadedRB - As above.
Examples of use
The default table filled automatically from data of the Type T-14
{{NavalMobility}} |
Version with only the stock speed measured
{{NavalMobility |SpeedForwardStockAB = 83 |SpeedBackStockAB = 20 |SpeedForwardStockRB = 53 |SpeedBackStockRB = 17 }} | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Recommended, fully-featured example. Note that turn time of 18.433 was rounded to 18.43.
{{NavalMobility |SpeedForwardStockAB = 83 |SpeedBackStockAB = 20 |TurnTimeStockAB = 16.43 |TurnSpeedStockAB = 35 |TurnTimeSpadedAB = 11.1 |TurnSpeedSpadedAB = 33 |SpeedForwardStockRB = 53 |SpeedBackStockRB = 17 |TurnTimeStockRB = 18.433 |TurnSpeedStockRB = 35 |TurnTimeSpadedRB = 16.6 |TurnSpeedSpadedRB = 35 }} |
Version with only partial measurements. Note that the table can accept just speed, or just turn speed, or just turn speed and time, without maximum speed. However, it is still highly recommended to provide all missing values.
{{NavalMobility |SpeedForwardStockAB = 83 |SpeedBackStockAB = 20 |TurnSpeedStockAB = 35 |TurnTimeSpadedAB = 11.1 |TurnTimeStockRB = 18.433 |TurnSpeedStockRB = 35 |TurnTimeSpadedRB = 16.6 |TurnSpeedSpadedRB = 35 }} |
Mobility characteristics table for naval units. All measured values should be done in Test Sail, with Secondary weapons set to 'No offensive armament'.
Parameter | Description | Type | Status | |
---|---|---|---|---|
Speed forward - stock in AB | SpeedForwardStockAB | Measured sustained speed flanking forwards. If the speed flickers between two values in-game - pick the one that shows most of the time, if both show about as often - the higher one.
| Number | optional |
Speed back - stock in AB | SpeedBackStockAB | Measured sustained speed full reverse. If the speed flickers between two values in-game - pick the one that shows most of the time, if both show about as often - the higher one.
| Number | optional |
Turn time - stock in AB | TurnTimeStockAB | Measured average time in seconds after at least 2 full 360° turns (recommended average of 3 turns). Table will round the displayed value if needed, but use the number in the provided precision for calculations.
| String | optional |
Turn speed - stock in AB | TurnSpeedStockAB | Measured average sustained speed while turning. If the speed flickers between two values in-game - pick the one that shows most of the time, if both show about as often - the higher one.
| Number | optional |
Turn time - fully upgraded in AB | TurnTimeSpadedAB | Measured average time in seconds after at least 2 full 360° turns (recommended average of 3 turns). Table will round the displayed value if needed, but use the number in the provided precision for calculations.
| String | optional |
Turn speed - fully upgraded in AB | TurnSpeedSpadedAB | Measured average sustained speed while turning. If the speed flickers between two values in-game - pick the one that shows most of the time, if both show about as often - the higher one.
| Number | optional |
Speed forward - stock in RB | SpeedForwardStockRB | Measured sustained speed flanking forward. If the speed flickers between two values in-game - pick the one that shows most of the time, if both show about as often - the higher one.
| Number | optional |
Speed back - stock in RB | SpeedBackStockRB | Measured sustained speed full reverse. If the speed flickers between two values in-game - pick the one that shows most of the time, if both show about as often - the higher one.
| Number | optional |
Turn time - stock in RB | TurnTimeStockRB | Measured average time in seconds after at least 2 full 360° turns (recommended average of 3 turns). Table will round the displayed value if needed, but use the number in the provided precision for calculations.
| String | optional |
Turn speed - stock in RB | TurnSpeedStockRB | Measured average sustained speed while turning. If the speed flickers between two values in-game - pick the one that shows most of the time, if both show about as often - the higher one.
| Number | optional |
Turn time - fully upgraded in RB | TurnTimeSpadedRB | Measured average time in seconds after at least 2 full 360° turns (recommended average of 3 turns). Table will round the displayed value if needed, but use the number in the provided precision for calculations.
| String | optional |
Turn speed - fully upgraded in RB | TurnSpeedSpadedRB | Measured average sustained speed while turning. If the speed flickers between two values in-game - pick the one that shows most of the time, if both show about as often - the higher one.
| Number | optional |