Template:Damage table/doc: Difference between revisions

From Official Barotrauma Wiki
Jump to: navigation, search
(Created page with "{{doc/start}} Used paramaters will be displayed in that order, from left to right. XML data details may vary, there are exceptions etc. {| !Parameter!!Description!!Relevant t...")
 
No edit summary
Line 3: Line 3:


XML data details may vary, there are exceptions etc.
XML data details may vary, there are exceptions etc.
Deprecated parameters are kept functional to not break any pages that still use them, but they shouldn't be used anymore.
{|
{|
!Parameter!!Description!!Relevant tag in xml
!Parameter!!Description!!Relevant tag in xml
Line 18: Line 20:
|attackdamage||Deprecated, do not use|| -
|attackdamage||Deprecated, do not use|| -
|-
|-
|afflictions||Direct Hit Afflictions, as opposed to explosion afflictions.<br>Use the hyperlink template (or hl for short), followed by the value (followed by "sec" in the case of stun)<br>Use <nowiki><br></nowiki> between each affliction (which makes for a shorter newline than a double newline).<br>Example: <code><nowiki>{{hl|Bite Wounds||Affliction Bite Wounds|Internal Damage}} 50<br>{{hl|Stun}} 3 sec</nowiki></code>||TODO
|afflictions||Direct Hit Afflictions, as opposed to explosion afflictions.<br>Use the [[Template:Affliction|Affliction]] template.<br>Use <nowiki><br></nowiki> between each affliction (which makes for a shorter newline than a double newline).<br>Example: <code><nowiki>{{Affliction|Burn|||40}}<br>{{Affliction|Stun|||0.4 sec}}</nowiki></code>||TODO
|-
|-
|Penetration||Armor penetration in %||TODO
|penetration||Armor penetration in %||TODO
|-
|-
|aoe||Area of effect afflictions, same format as afflictions||TODO
|aoe||Area of effect afflictions, same format as afflictions||TODO
Line 59: Line 61:
|-
|-
|cooldown||Attack cooldown in seconds (for creature attacks only)||<small><limb><attack></small><big>'''cooldown'''</big><small></attack></limb></small>
|cooldown||Attack cooldown in seconds (for creature attacks only)||<small><limb><attack></small><big>'''cooldown'''</big><small></attack></limb></small>
|-
|notes||Additional notes for exceptions or things that aren't covered by other fields||
|}
|}
{{doc/end}}
{{doc/end}}

Revision as of 11:37, 26 July 2021

Documentation

Used paramaters will be displayed in that order, from left to right.

XML data details may vary, there are exceptions etc.

Deprecated parameters are kept functional to not break any pages that still use them, but they shouldn't be used anymore.

Parameter Description Relevant tag in xml
item Name of the attack (usually limb name for creatures, ammo type for weapons) Creatures: <limb>name</limb>
Weapons: name of ammo type
targettype Structure or Character (for creature attacks only) <limb><attack>targettype</attack></limb>
context Water, Ground, or Any (for creature attacks only) <limb><attack>context</attack></limb>
range Range in meters (for creature attacks only). In xml files, the value is given in centimeters, so "300" in the xml = "3" in here. <limb><attack>range</attack></limb>
ammocount Ammunition count that the weapon can store at a time. TODO
attackdamage Deprecated, do not use -
afflictions Direct Hit Afflictions, as opposed to explosion afflictions.
Use the Affliction template.
Use <br> between each affliction (which makes for a shorter newline than a double newline).
Example: {{Affliction|Burn|||40}}<br>{{Affliction|Stun|||0.4 sec}}
TODO
penetration Armor penetration in % TODO
aoe Area of effect afflictions, same format as afflictions TODO
aoeinside Area of effect afflictions that only affects targets inside the submarine, such as molochs ram ("Core") attack which stuns only inside.
Identified by onlyinside="true", in <explosion>, in <attack>.
TODO
aoerange Area of Effect in meters. In xml files, the value is given in centimeters, so "300" in the xml = "3" in here. TODO
bleedingdamage Deprecated, use "afflictions" instead -
structuredamage Structure Damage. In the case of explosions, add the explosion damage after a newline, e.g. "30 (direct hit) <br> 50 (explosion)" Creatures: <limb><attack>structuredamage</attack></limb>
Weapons: TODO
itemdamage Item Damage Creatures: <limb><attack>itemdamage</attack></limb>
Weapons: TODO
stundamage Deprecated, use "afflictions" instead -
force Direct hit kinematic force (not explosion force) Creatures: <limb><attack>force</attack></limb>
Hand weapons ammo: <Item><Projectile><Attack>targetforce</Attack></Projectile></Item>
explosionrange Explosion Radius (m) Creatures: <limb><attack><Explosion>range</Explosion></attack></limb>
Explosives: <Item><Throwable><StatusEffect><Explosion>range</Explosion></StatusEffect></Throwable></Item>
Hand weapons ammo: <Item><Projectile><Explosion>range</Explosion></Projectile></Item>
Sub weapons ammo: <Item><StatusEffect><Explosion>range</Explosion></StatusEffect></Item>
explosionforce Explosion kinematic force (not direct hit force) Creatures: <limb><attack><Explosion>force</Explosion></attack></limb>
Explosives: <Item><Throwable><StatusEffect><Explosion>force</Explosion></StatusEffect></Throwable></Item>
Hand weapons ammo: <Item><Projectile><Explosion>force</Explosion></Projectile></Item>
Sub weapons ammo: <Item><StatusEffect><Explosion>force</Explosion></StatusEffect></Item>
severlimbs Probability to sever limbs (cut off creatures' limbs that can be cut off)
float: "0.1" = 10%
<Item><Projectile><Attack>severlimbsprobability</Attack></Projectile></Item> (0 if absent)
damagetype Deprecated, use "afflictions" instead -
stick Does the ammo stick to entities. At the time of writing, only applies to spineling projectiles and harpoons (afaik) <Item><Projectile>sticktocharacters</Projectile></Item> (false if absent)
duration Attack Duration. Mostly useful when some entries have long durations, such as the watcher's acid mist
Can probably be omitted if all entries are below 1 second
<limb><attack>duration</attack></limb>
cost Ammo/magazine/ammo box store price. Use min-max base prices from outpost types that sell the item
Can probably be omitted when all ammo has their own page
<Item><Price>baseprice</Price></Item>
multiplied by lowest and highest price multipliers, excluding locations that don't sell it
crafting Crafting Materials
Can probably be omitted when all ammo has their own page
<Item><Fabricate><RequiredItem/></Fabricate></Item> (can't be crafted if absent)
deconstruction Deconstruction Yield
Can probably be omitted when all ammo has their own page
<Item><Deconstruct><Item/></Deconstruct></Item> (can't be deconstructed if absent)
raw Deprecated, do not use -
cooldown Attack cooldown in seconds (for creature attacks only) <limb><attack>cooldown</attack></limb>
notes Additional notes for exceptions or things that aren't covered by other fields

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