View source for Template:TorpedoTravelTime/Documentation

{{docpage}}
<div style="float:left;margin-right:20px;">__TOC__</div>
== Description ==
Calculate torpedo travel time for a given speed and distance. Outputted value is a raw number of seconds, without any formatting or units. It can be used as a direct input for other templates or parser functions.<br/>
For realistic battles it's calculated using the real torpedo speed, for arcade battles it's using speed multiplier introduced in [[Update "Red Skies"]]:
{{Quote|Torpedo speed multiplier in AB:<br/>
Up to 4 km the multiplier is 3;<br/>
From 4 to 8 km multiplier drops linearly from 3 to 1;<br/>
Over 8 km the multiplier is 1.}}

== Parameters ==
* '''distance''' - Distance travelled by the torpedo '''in kilometers.''' Default: <kbd>10</kbd> 
* '''speed''' - Torpedo speed as indicated in the game interface '''in kilometers per hour (km/h).''' Default: <kbd>91</kbd>
* '''mode''' - One of: <kbd>AB</kbd> or <kbd>Arcade</kbd>, alternatively <kbd>RB</kbd> or <kbd>Realistic</kbd>, '''case-sensitive'''. Default: <kbd>RB</kbd>
* '''round''' - To how many decimal places should output be rounded. Default: <kbd>0</kbd> means that 332.67326733 will be rounded to 333. Non-default shouldn't be used for any times that go in minutes.

== Examples of use ==
{|
|-
|style="vertical-align: top;"| [[S.I. 250/533,4X7,5 Tipo A (533 mm)]] time to reach maximum range in Realistic battles:

{{TorpedoTravelTime|distance=4|speed=76}} s
<pre>{{TorpedoTravelTime|distance=4|speed=76}} s</pre>

| [[Type 93 Model 1, Mod 2 (610 mm)]] travel time for a typical spawn-to-spawn range (12 km) in Arcade battles:

{{TorpedoTravelTime|mode=AB|distance=12|speed=91}} s (≈{{#expr:{{TorpedoTravelTime|mode=AB|distance=12|speed=91}}/60 round 0}} minutes)
<pre>{{TorpedoTravelTime|mode=AB|distance=12|speed=91}} s (≈{{#expr:{{TorpedoTravelTime|mode=AB|distance=12|speed=91}}/60 round 0}} minutes)</pre>
|-
|style="vertical-align: top;"| [[G7a (533 mm)]] travel time with and without torpedo mode compared at 4 kilometers:

Without torpedo mode: {{TorpedoTravelTime|mode=AB|distance=4|speed=81}} s; With torpedo mode: {{TorpedoTravelTime|mode=AB|distance=4|speed=56}} s
<pre>Without torpedo mode: {{TorpedoTravelTime|mode=AB|distance=4|speed=81}} s; With torpedo mode: {{TorpedoTravelTime|mode=AB|distance=4|speed=56}} s</pre>
| [[Model 1923DT (550 mm)]] comparison between RB and AB:

{| class="wikitable" style="text-align:center" width="auto"
! rowspan="2" | Torpedo Mode !! colspan="2" | Travel time to 8 km (s)
|-
! Arcade Battles !! Realistic Battles
|-
| {{Annotation|No|'Torpedo Mode' modification uninstalled}} || {{TorpedoTravelTime|mode=AB|distance=8|speed=72}} || {{TorpedoTravelTime|mode=RB|distance=8|speed=72}}
|-
| {{Annotation|Yes|'Torpedo Mode' modification installed}} || {{TorpedoTravelTime|mode=AB|distance=8|speed=64.8}} || {{TorpedoTravelTime|mode=RB|distance=8|speed=64.8}}
|}

<pre>{| class="wikitable" style="text-align:center" width="auto"
! rowspan="2" | Torpedo Mode !! colspan="2" | Travel time to 8 km (s)
|-
! Arcade Battles !! Realistic Battles
|-
| {{Annotation|No|'Torpedo Mode' modification uninstalled}} || {{TorpedoTravelTime|mode=AB|distance=8|speed=72}} || {{TorpedoTravelTime|mode=RB|distance=8|speed=72}}
|-
| {{Annotation|Yes|'Torpedo Mode' modification installed}} || {{TorpedoTravelTime|mode=AB|distance=8|speed=64.8}} || {{TorpedoTravelTime|mode=RB|distance=8|speed=64.8}}
|}</pre>
|-
|}
{{Sp-begin|TemplateData}}
<div style="text-align:left">
<templatedata>
{
    "description": "Calculate torpedo travel time",
    "params": {
        "distance": {
            "label": "Distance travelled",
            "type": "number",
            "required": false,
            "description": "Distance travelled by the torpedo in kilometers",
            "example": "10"
        },
        "speed": {
            "label": "Speed",
            "type": "number",
            "required": false,
            "description": "Torpedo speed as indicated in the game interface in km/h",
            "example": "91"
        },
        "mode": {
            "label": "Game mode",
            "type": "string",
            "required": false,
            "description": "RB or AB",
            "example": "RB"
        },
        "round": {
            "label": "Rounding",
            "type": "number",
            "required": false,
            "description": "Round to decimal places",
            "example": "0"
        }
    },
    "sets": [
    ]
}
</templatedata>
</div>
{{Sp-end}}