Template:Upgrade/doc: Difference between revisions

From Official Barotrauma Wiki
Jump to: navigation, search
(Created page with "{{doc/start}} {| style="width:100%; text-align:center" ! Parameter ! Required ! Description ! Expected Value |- | effect1 || 32px || The first effe...")
 
No edit summary
 
(3 intermediate revisions by 2 users not shown)
Line 10: Line 10:
| effect2 || [[File:Checkmark False.png|32px]] || The second effect of the upgrade. || String.
| effect2 || [[File:Checkmark False.png|32px]] || The second effect of the upgrade. || String.
|-
|-
| maxlevel || [[File:Checkmark False.png|32px]] || The maximum level of the upgrade. || Natural numbers between 1 and 10.
| maxlevel || [[File:Checkmark True.png|32px]] || The maximum level of the upgrade. || Natural number.
|-
|-
| tier1max || [[File:Checkmark True.png|32px]] || The highest upgrade level that can be reached by a tier 1 submarine. || Natural number between 1 and 10.
| tier1max || [[File:Checkmark True.png|32px]] || The highest upgrade level that can be reached by a tier 1 submarine. || Natural number.
|-
|-
| tier2max || [[File:Checkmark True.png|32px]] || The highest upgrade level that can be reached by a tier 2 submarine. || Natural number between 1 and 10.
| tier2max || [[File:Checkmark True.png|32px]] || The highest upgrade level that can be reached by a tier 2 submarine. || Natural number.
|-
|-
| effect1increase || [[File:Checkmark True.png|32px]] || The % change of the first effect per upgrade level. || Signed rational number.
| effect1increase || [[File:Checkmark True.png|32px]] || The % change of the first effect per upgrade level. || Signed rational number.
|-
|-
| effect2increase || [[File:Checkmark False.png|32px]] || The % change of the second effect per upgrade level. || Signed rational number.
| effect1value || [[File:Checkmark False.png|32px]] || Base value of the upgraded stat (Before first upgrade) || Signed rational number.
|-
| effect1unit || [[File:Checkmark False.png|32px]] || Unit of the base value. || Signed rational number.
|-
| effect2increase || [[File:Checkmark False.png|32px]] || The % change of the first effect per upgrade level. || Signed rational number.
|-
| effect2value || [[File:Checkmark False.png|32px]] || Base value of the upgraded stat (Before first upgrade) || Signed rational number.
|-
| effect2unit || [[File:Checkmark False.png|32px]] || Unit of the base value. || Signed rational number.
|-
|-
| baseprice || [[File:Checkmark True.png|32px]] || The base price of the upgrade. || Integer.
| baseprice || [[File:Checkmark True.png|32px]] || The base price of the upgrade. || Integer.
Line 26: Line 34:
| increasehigh || [[File:Checkmark True.png|32px]] || The % change in price for the last upgrade level. || Signed rational number.
| increasehigh || [[File:Checkmark True.png|32px]] || The % change in price for the last upgrade level. || Signed rational number.
|}
|}
= Example =
<pre style="width:fit-content">
{{Upgrade
| effect1 = Max Wall Health
| effect2 = Crush Depth
| maxlevel = 6
| tier1max = 2
| tier2max = 4
| effect1increase = 20
| effect2increase = 14
| effect2value = 3500
| effect2unit = m
| baseprice    = 2000
| increaselow  = 0
| increasehigh = 400
}}
</pre>
{{Upgrade
| effect1 = Max Wall Health
| effect2 = Crush Depth
| maxlevel = 6
| tier1max = 2
| tier2max = 4
| effect1increase = 20
| effect2increase = 14
| effect2value = 3500
| effect2unit = m
| baseprice    = 2000
| increaselow  = 0
| increasehigh = 400
}}
{{doc/end}}
{{doc/end}}

Latest revision as of 16:55, 31 December 2023

Documentation
Parameter Required Description Expected Value
effect1 The first effect of the upgrade. String.
effect2 The second effect of the upgrade. String.
maxlevel The maximum level of the upgrade. Natural number.
tier1max The highest upgrade level that can be reached by a tier 1 submarine. Natural number.
tier2max The highest upgrade level that can be reached by a tier 2 submarine. Natural number.
effect1increase The % change of the first effect per upgrade level. Signed rational number.
effect1value Base value of the upgraded stat (Before first upgrade) Signed rational number.
effect1unit Unit of the base value. Signed rational number.
effect2increase The % change of the first effect per upgrade level. Signed rational number.
effect2value Base value of the upgraded stat (Before first upgrade) Signed rational number.
effect2unit Unit of the base value. Signed rational number.
baseprice The base price of the upgrade. Integer.
increaselow The % change in price for the first upgrade level. Signed rational number.
increasehigh The % change in price for the last upgrade level. Signed rational number.

Example

{{Upgrade
| effect1 = Max Wall Health
| effect2 = Crush Depth

| maxlevel = 6
| tier1max = 2
| tier2max = 4

| effect1increase = 20
| effect2increase = 14
| effect2value = 3500
| effect2unit = m

| baseprice    = 2000
| increaselow  = 0
| increasehigh = 400
}}


Level Tier Max Wall Health Crush Depth Price
1 1 +20%  +14% (3990m) 2,000 mk
2 1 +40%  +28% (4480m) 3,333 mk
3 2 +60%  +42% (4970m) 4,666 mk
4 2 +80%  +56% (5460m) 6,000 mk
5 3 +100%  +70% (5950m) 7,333 mk
6 3 +120%  +84% (6440m) 8,666 mk

This is the documentation page, it should be transcluded into the main template page. See Template:Doc for more information.