Template:Damage/doc: Difference between revisions

From Space Station 14 Wiki
Aliser (talk | contribs)
Aliser (talk | contribs)
docs for the distribution param
 
(11 intermediate revisions by the same user not shown)
Line 1: Line 1:
== Usage ==
{{tji|Damage|<type or group>|[amount]|[dealt or healed]}}
{{Callout|Tip|If possible, use the alias templates found in the table below instead of this one, as they are a bit easier to use.}}
Specify a damage {{kbd|type}} or {{kbd|group}} from the table below and any optional params. Any casing is allowed.
Depending on whether it's a damage type or group, the following will be generated:
* If it's a damage '''type''', a potentially colored label with an amount (if specified) will be produced. If specified type is an alias, the real definition will be used for displaying a label (hence the same labels for some damage types in the damage types table).
* If it's a damage '''group''', a label will be produced for that group, similar to the damage type. The damage types composing that group will be listed in parenthesis, with amount if it's specified for all of them (including the group label).
For amount a simple number will do. If it's a damage group, specify the amount for the entire group - each subtype will get its amount properly calculated.
The {{kbd|[dealt or healed]}} optional allows to specify whether damage was dealed or healed. Simply put {{kbd|+}} for healing or {{kbd|-}} for dealt damage. Using this parameter requires specifying the amount.
If any of the above is confusing, check out the examples below.
== How to make changes ==
See {{m|Damage}} for details.
== Examples ==
=== Damage type ===
{{tji|Damage|Blunt}}
{{gda}}
{{Damage|Blunt}}
=== Damage type with an amount ===
{{tji|Damage|Poison|5}}
{{gda}}
{{Damage|Poison|5}}
=== Damage group ===
{{tji|Damage|Burn}}
{{gda}}
{{Damage|Burn}}
=== Damage group with an amount ===
* {{tji|Damage|Toxin|10}}
* {{tji|Damage|Brute|25}}
{{gda}}
* {{Damage|Toxin|10}}
* {{Damage|Brute|25}}
=== Specifying dealt/healed damage ===
{{Callout|Tip|Requires specifying the amount.}}
* {{tji|Damage|Caustic|10|+}}
* {{tji|Damage|Caustic|10|-}}
{{gda}}
* {{Damage|Caustic|10|+}}
* {{Damage|Caustic|10|-}}
=== Configuring distribution between damage types in a group ===
Damage group can distribute its damage between damage types in different ways:
* By default, the damage gets evenly distributed between damage types: {{Damage|Toxin|10}}. Each damage type can only heal/deal its part of damage, no more.
* With {{kbd|shared}} value on the {{kbd|distribution}} param, the damage is shared among all damage types: {{Damage|Toxin|10|distribution=shared}}. Each damage type can heal the entire damage of the damage group.
Above example: {{tji|Damage|Toxin|10|distribution:shared}}. A few aliases are available also: {{kbd|distrib}} and {{kbd|split}}.
{| class="wikitable"
|+ All three rendered
|-
! Example !! Result
|-
| {{tji|Damage|Toxin|10|distribution:shared}} || {{Damage|Toxin|10|distribution=shared}}
|-
| {{tji|Damage|Toxin|10|distrib:shared}} || {{Damage|Toxin|10|distrib=shared}}
|-
| {{tji|Damage|Toxin|10|split:shared}} || {{Damage|Toxin|10|split=shared}}
|}
== List of damage groups ==
{| class="wikitable"
|-
! Damage group !! How it looks !! Alias template
|-
|
* Brute
||
* {{Damage|Brute}}
||
* {{t|Brute}}
|-
|
* Burn
||
* {{Damage|Burn}}
||
* {{t|Burn}}
|-
|
* Airloss
||
* {{Damage|Airloss}}
||
* {{t|Airloss}}
|-
|
* Toxin 
||
* {{Damage|Toxin}}
||
* {{t|Toxin}}
|-
|
* Genetic 
||
* {{Damage|Genetic}}
||
* {{t|Genetic}}
|-
|
* Metaphysical 
||
* {{Damage|Metaphysical}}
||
* {{t|Metaphysical}}
|}
== List of damage types ==
== List of damage types ==
{| class="wikitable"
{| class="wikitable"
|-
|-
! Damage type !! How it looks
! Damage type !! How it looks !! Alias template
|-
|-
|
|
* Asphyxiation
* Asphyxiation
* Airloss
||  
||  
* {{Damage|Asphyxiation}}
* {{Damage|Asphyxiation}}
* {{Damage|Airloss}}
||
* {{t|Asphyxiation}}


|-
|-
Line 15: Line 150:
* Bloodloss  
* Bloodloss  
* Bleeding  
* Bleeding  
* Bleed
||  
||  
* {{Damage|Bloodloss}}
* {{Damage|Bloodloss}}
* {{Damage|Bleeding}}
* {{Damage|Bleeding}}
* {{Damage|Bleed}}
||
* {{t|Bloodloss}}
* {{t|Bleeding}}
* {{t|Bleed}}


|-
|-
|  
|  
* Blunt  
* Blunt  
* Brute
||  
||  
* {{Damage|Blunt}}
* {{Damage|Blunt}}
* {{Damage|Brute}}
||
* {{t|Blunt}}


|-
|-
Line 32: Line 173:
||  
||  
* {{Damage|Cellular}}
* {{Damage|Cellular}}
||
* {{t|Cellular}}


|-
|-
Line 38: Line 181:
||  
||  
* {{Damage|Caustic}}
* {{Damage|Caustic}}
||
* {{t|Caustic}}


|-
|-
Line 44: Line 189:
||  
||  
* {{Damage|Cold}}
* {{Damage|Cold}}
||
* {{t|Cold}}


|-
|-
|  
|  
* Burn
* Heat   
* Heat   
||  
||  
* {{Damage|Burn}}
* {{Damage|Heat}}
* {{Damage|Heat}}
||
* {{t|Heat}}


|-
|-
|  
|  
* Piercing   
* Piercing   
* Puncture
||  
||  
* {{Damage|Piercing}}
* {{Damage|Piercing}}
* {{Damage|Puncture}}
||
* {{t|Piercing}}
* {{t|Puncture}}


|-
|-
Line 64: Line 216:
||  
||  
* {{Damage|Poison}}
* {{Damage|Poison}}
||
* {{t|Poison}}


|-
|-
|  
|  
* Radiation
* Radiation
* Rad
||  
||  
* {{Damage|Radiation}}
* {{Damage|Radiation}}
* {{Damage|Rad}}
||
* {{t|Radiation}}
* {{t|Rad}}


|-
|-
Line 76: Line 235:
||  
||  
* {{Damage|Shock}}
* {{Damage|Shock}}
||
* {{t|Shock}}


|-
|-
Line 82: Line 243:
||  
||  
* {{Damage|Slash}}
* {{Damage|Slash}}
||
* {{t|Slash}}


|-
|-
Line 88: Line 251:
||  
||  
* {{Damage|Structural}}
* {{Damage|Structural}}
||
* {{t|Structural}}


|-
|-
Line 94: Line 259:
||  
||  
* {{Damage|Holy}}
* {{Damage|Holy}}
||
* {{t|Holy damage}}


|}
|}
[[Category:Template documentation]]

Latest revision as of 14:13, 26 May 2025

Usage

{{Damage|<type or group>|[amount]|[dealt or healed]}}

Tip
If possible, use the alias templates found in the table below instead of this one, as they are a bit easier to use.

Specify a damage type or group from the table below and any optional params. Any casing is allowed.

Depending on whether it's a damage type or group, the following will be generated:

  • If it's a damage type, a potentially colored label with an amount (if specified) will be produced. If specified type is an alias, the real definition will be used for displaying a label (hence the same labels for some damage types in the damage types table).
  • If it's a damage group, a label will be produced for that group, similar to the damage type. The damage types composing that group will be listed in parenthesis, with amount if it's specified for all of them (including the group label).

For amount a simple number will do. If it's a damage group, specify the amount for the entire group - each subtype will get its amount properly calculated.

The [dealt or healed] optional allows to specify whether damage was dealed or healed. Simply put + for healing or - for dealt damage. Using this parameter requires specifying the amount.

If any of the above is confusing, check out the examples below.

How to make changes

See Module:Damage for details.

Examples

Damage type

{{Damage|Blunt}}

blunt

Damage type with an amount

{{Damage|Poison|5}}

5 poison

Damage group

{{Damage|Burn}}

burn (heat, shock, cold and caustic)

Damage group with an amount

  • 10 toxin (5 poison and 5 radiation)
  • 25 brute (≈8.3 blunt, ≈8.3 slash and ≈8.3 piercing)

Specifying dealt/healed damage

Tip
Requires specifying the amount.

  • 10 caustic
  • 10 caustic

Configuring distribution between damage types in a group

Damage group can distribute its damage between damage types in different ways:

  • By default, the damage gets evenly distributed between damage types: 10 toxin (5 poison and 5 radiation). Each damage type can only heal/deal its part of damage, no more.
  • With shared value on the distribution param, the damage is shared among all damage types: 10 toxin (10 damage between poison and radiation). Each damage type can heal the entire damage of the damage group.

Above example: {{Damage|Toxin|10|distribution=shared}}. A few aliases are available also: distrib and split.

All three rendered
Example Result
{{Damage|Toxin|10|distribution=shared}} 10 toxin (10 damage between poison and radiation)
{{Damage|Toxin|10|distrib=shared}} 10 toxin (10 damage between poison and radiation)
{{Damage|Toxin|10|split=shared}} 10 toxin (10 damage between poison and radiation)

List of damage groups

Damage group How it looks Alias template
  • Brute
  • brute (blunt, slash and piercing)
  • Burn
  • burn (heat, shock, cold and caustic)
  • Airloss
  • airloss (asphyxiation and bloodloss)
  • Toxin
  • toxin (poison and radiation)
  • Genetic
  • genetic (cellular)
  • Metaphysical
  • metaphysical (holy)


List of damage types

Damage type How it looks Alias template
  • Asphyxiation
  • asphyxiation
  • Bloodloss
  • Bleeding
  • Bleed
  • bloodloss
  • bloodloss
  • bloodloss
  • Blunt
  • blunt
  • Cellular
  • cellular
  • Caustic
  • caustic
  • Cold
  • cold
  • Heat
  • heat
  • Piercing
  • Puncture
  • piercing
  • piercing
  • Poison
  • poison
  • Radiation
  • Rad
  • radiation
  • radiation
  • Shock
  • shock
  • Slash
  • slash
  • Structural
  • structural
  • Holy
  • holy