Template:Creatures infobox/doc: Difference between revisions

From Official Barotrauma Wiki
Jump to: navigation, search
mNo edit summary
(updated)
Line 1: Line 1:
{{doc/start}}
{{doc/start}}
<pre>
This infobox goes on every creature page.
{{Creatures infobox
 
| name = Name override
==Main==
| image = Image.png
Displayed in the infobox itself
| hp = HP number
{|
| swimspeed = Swimming speed
!Parameter!!Description!!width=15%|Expected value!!Notes
| walkspeed = Walking speed (if none, just use swim speed)
|-
| weakpoints = Weak points (not armored)
| identifier || ... || String ||
| armorval = The armor % for each armored limb versus each affliction (eg "damagemultiplier = 0.1" == 90% armor)
|-
| entersub = Can this creature enter the submarine?
| name || ... || String ||  Default: PAGENAME
| sight = Sight value
|-
| hearing = Hearing value
| image || PNG of the creature, obtained by using the wikiimage_character [[Console Command]] in the creature editor || File ||  Default: PAGENAME.png
| behavior = When is this creature aggressive? (eg Always, Only to Humans, Only to Submarine)
|-
| drops = Item 1 (or item set 1) this creature is able to drop upon death.
| imagewidth || ... || Integer ||  Default: 200px
| chance = The probability of the item(set)1 being dropped by the creature on death in percent.
|-
| add drops2/chance2, drops3/chance3 to add the following items or item sets. Add an asterisk '''*''' after the mutually exclusive items.
| hp || HP (vitality) || Integer || Found in Content/Characters/CreatureName/CreatureName.xml, in <health>
}}
|-
</pre>
| hpvariant || HP (vitality) of the variant if different || Integer ||
This infobox goes on every creature page. If you don't know what to put in any of the above values, you can find everything in Barotrauma's files.
|-
| variantname || name of the variant (e.g. "Boss" for the Moloch Boss) || String ||
|-
| combatstrength || Combat strength (used by AI) || Integer || In the future, this will be used by AI target priorities tables
|-
| swimspeed || ... || Float || Found in Content/Characters/CreatureName/Animations/CreatureNameSwimSlow, -SwimFast
|-
| walkspeed || ... || Float || Found in Content/Characters/CreatureName/Animations/CreatureNameWalk, -Run
|-
| weakpoints || Limb(s) that have lower resistances (higher damage multipliers) || String || Don't include the detailed values here. We used to do it, but now each limb and damage modifier has its own parameter, see the [[#Damage Modifiers]] section below
|-
| armorval || Limb(s) that have higher resistances (lower damage multipliers) || String ||  Don't include the detailed values here. We used to do it, but now each limb and damage modifier has its own parameter, see the [[#Damage Modifiers]] section below
|-
| entersub || Can the creature enter the submarine || Boolean (yes/no) ||
|-
| sight || ... || Float || Found in Content/Characters/CreatureName/CreatureName.xml, in <ai>
|-
| hearing || ... || Float || Found in Content/Characters/CreatureName/CreatureName.xml, in <ai>
|-
| sightvariant || Sight of the variant, if different || Float || note
|-
| hearingvariant || Hearing of the variant, if different || Float || note
|-
| behavior || Is the creature agressive vs subs, characters... || String || In the future, an AI target priorities table will cover this in detail<br>Found in Content/Characters/CreatureName/CreatureName.xml, in <ai>
|-
| drops<br>drops2<br>drops3 || Items found on the creature's corpse || <code><nowiki>{{hl|itemname}}</nowiki> x [number if > 1]</code> || Found in Content/Characters/CreatureName/CreatureName.xml, in <inventory>
|-
| chance<br>chance2<br>chance3 || probability for each drop || Integer || Don't include the <code>%</code> sign
|}
 
==Damage Modifiers==
Displayed in the ==Defense== section of the creature page, using the [[Template:Damage modifiers|Damage modifiers template]]
{|
!Parameter!!Description!!Expected value!!Notes
|-
| stunimmunity<br>bleedingimmunity<br>burnimmunity<br>poisonimmunity || Immunities || Boolean (set to 1 if true, don't specify if false) || Found in Content/Characters/CreatureName/CreatureName.xml, in <health>
|-                                                       
| limb1<br>limb2<br>limb3<br>limb4<br>limb5 || name of each limb (or group of limbs) that has its own specific damage modifiers || String || Found in Content/Characters/CreatureName/CreatureNameDefaultRagdoll.xml, look for <limb> and then <damagemodifiers> under each limb. If there is no damage modifier, don't include the limb. Group limbs that have the same damage modifiers when possible. Notify [[User_talk:31percent|31percent]] if somehow more than 5 different limb groups are needed.
|-
| limb1[affliction]<br><small>limb1burn, limb1bleeding, limb1alldamage, limb1internaldamage, limb1lacerations, limb1bluntforcetrauma, limb1deeptissueinjury, limb1bitewounds, limb1gunshotwound, limb1organdamage</small><br>limb2[affliction]<br>(...)<br>limb5[affliction] || Each individual limb damage multiplier || Float || For example, if limb3 = Tentacle, and if Tentacle has <code><damagemodifier (...) afflictiontypes="bleeding" damagemultiplier="0.5" (...) /></code>, then input <code>limb3bleeding = 0.5</code>
|}
 
==Attacks==
Displayed in the ==Attacks== section of the creature page, using the [[Template:Attacks|Attacks template]] (WIP)
{|
!Parameter!!Description!!Expected value!!Notes
|-
| attack1<br>attack2<br>attack3<br>attack4 || Name of each attack || String || Found in Content/Characters/CreatureName/CreatureNameDefaultRagdoll.xml, look for <limb> and then <attack>
|-
| colspan = 4 style="text-align:center;"| '''The following also applies to attack2, attack3, and attack4'''
|-
| attack1target || Target type of attack1 || String (allowed values: character, submarine, any) ||
|-
| attack1structuredamage || || Integer ||
|-
| attack1explosionrange || || Integer ||
|-
| attack1explosionrange2 || only used for the black moloch for now. Appears directly after attack1explosionrange || Wikitext || <!--molochs-->
|-
| attack1cooldown || || Float ||
|-
| attack1bitewounds || || Float ||
|-
| attack1bitewoundschance || probability to apply bite wounds || Integer || Don't include the <code>%</code> sign
|-
| attack1bleeding || || Float ||
|-
| attack1bleedingchance || probability to apply bleeding || Integer || Don't include the <code>%</code> sign
|-
| attack1stun || || Float ||
|-
| attack1stuninside || Stun applied only to character that are inside a submarine || Float || <!--molochs-->
|-
| attack1stunchance || probability to apply stun || Integer || Don't include the <code>%</code> sign
|-
| attack1huskinfection || || Float ||
|-
| attack1huskinfectionchance || probability to apply husk infection || Integer || Don't include the <code>%</code> sign
|-
| attack1burn || || Float ||
|-
| attack1burnchance || probability to apply burn || Integer || Don't include the <code>%</code> sign
|-
| attack1watchersgaze || || Float ||
|-
| attack1emp || only used for the black moloch for now. || Float || <!--black moloch-->
|}
{{doc/end}}
{{doc/end}}

Revision as of 15:11, 2 May 2022

Documentation
[purge]

This infobox goes on every creature page.

Main

Displayed in the infobox itself

Parameter Description Expected value Notes
identifier ... String
name ... String Default: PAGENAME
image PNG of the creature, obtained by using the wikiimage_character Console Command in the creature editor File Default: PAGENAME.png
imagewidth ... Integer Default: 200px
hp HP (vitality) Integer Found in Content/Characters/CreatureName/CreatureName.xml, in <health>
hpvariant HP (vitality) of the variant if different Integer
variantname name of the variant (e.g. "Boss" for the Moloch Boss) String
combatstrength Combat strength (used by AI) Integer In the future, this will be used by AI target priorities tables
swimspeed ... Float Found in Content/Characters/CreatureName/Animations/CreatureNameSwimSlow, -SwimFast
walkspeed ... Float Found in Content/Characters/CreatureName/Animations/CreatureNameWalk, -Run
weakpoints Limb(s) that have lower resistances (higher damage multipliers) String Don't include the detailed values here. We used to do it, but now each limb and damage modifier has its own parameter, see the #Damage Modifiers section below
armorval Limb(s) that have higher resistances (lower damage multipliers) String Don't include the detailed values here. We used to do it, but now each limb and damage modifier has its own parameter, see the #Damage Modifiers section below
entersub Can the creature enter the submarine Boolean (yes/no)
sight ... Float Found in Content/Characters/CreatureName/CreatureName.xml, in <ai>
hearing ... Float Found in Content/Characters/CreatureName/CreatureName.xml, in <ai>
sightvariant Sight of the variant, if different Float note
hearingvariant Hearing of the variant, if different Float note
behavior Is the creature agressive vs subs, characters... String In the future, an AI target priorities table will cover this in detail
Found in Content/Characters/CreatureName/CreatureName.xml, in <ai>
drops
drops2
drops3		 Items found on the creature's corpse {{hl|itemname}} x [number if > 1] Found in Content/Characters/CreatureName/CreatureName.xml, in <inventory>
chance
chance2
chance3		 probability for each drop Integer Don't include the % sign

Damage Modifiers

Displayed in the ==Defense== section of the creature page, using the Damage modifiers template

Parameter Description Expected value Notes
stunimmunity
bleedingimmunity
burnimmunity
poisonimmunity		 Immunities Boolean (set to 1 if true, don't specify if false) Found in Content/Characters/CreatureName/CreatureName.xml, in <health>
limb1
limb2
limb3
limb4
limb5		 name of each limb (or group of limbs) that has its own specific damage modifiers String Found in Content/Characters/CreatureName/CreatureNameDefaultRagdoll.xml, look for <limb> and then <damagemodifiers> under each limb. If there is no damage modifier, don't include the limb. Group limbs that have the same damage modifiers when possible. Notify 31percent if somehow more than 5 different limb groups are needed.
limb1[affliction]
limb1burn, limb1bleeding, limb1alldamage, limb1internaldamage, limb1lacerations, limb1bluntforcetrauma, limb1deeptissueinjury, limb1bitewounds, limb1gunshotwound, limb1organdamage
limb2[affliction]
(...)
limb5[affliction]		 Each individual limb damage multiplier Float For example, if limb3 = Tentacle, and if Tentacle has <damagemodifier (...) afflictiontypes="bleeding" damagemultiplier="0.5" (...) />, then input limb3bleeding = 0.5

Attacks

Displayed in the ==Attacks== section of the creature page, using the Attacks template (WIP)

Parameter Description Expected value Notes
attack1
attack2
attack3
attack4		 Name of each attack String Found in Content/Characters/CreatureName/CreatureNameDefaultRagdoll.xml, look for <limb> and then <attack>
The following also applies to attack2, attack3, and attack4
attack1target Target type of attack1 String (allowed values: character, submarine, any)
attack1structuredamage Integer
attack1explosionrange Integer
attack1explosionrange2 only used for the black moloch for now. Appears directly after attack1explosionrange Wikitext
attack1cooldown Float
attack1bitewounds Float
attack1bitewoundschance probability to apply bite wounds Integer Don't include the % sign
attack1bleeding Float
attack1bleedingchance probability to apply bleeding Integer Don't include the % sign
attack1stun Float
attack1stuninside Stun applied only to character that are inside a submarine Float
attack1stunchance probability to apply stun Integer Don't include the % sign
attack1huskinfection Float
attack1huskinfectionchance probability to apply husk infection Integer Don't include the % sign
attack1burn Float
attack1burnchance probability to apply burn Integer Don't include the % sign
attack1watchersgaze Float
attack1emp only used for the black moloch for now. Float

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

Retrieved from "https://barotraumagame.com/baro-wiki/index.php?title=Template:Creatures_infobox/doc&oldid=23538"