Template:StatSource/doc

Documentation

[purge]

This template is used to define a source for the StatSources template.

Usage

{{StatSource
    sourceType = One of: Item, Skill, Effect, Enchantment, Other
    stat = name of the stat this is a source of. See "stat names" below.
    valueType = One of: flat, restore, regenModifier. See "value types" below.
    value = the value which this source affects the stat by. Use % and ranges as needed.
    duration = Leave blank if invalid. Duration in seconds, minutes, or "permanent"
    notes = custom displayed text if extra information is needed
    dlc = required DLC. Either leave blank, or use The Soroboreans or The Three Brothers
}}

Blank Template

{{StatSource|sourceType= |stat= |valueType= |value= |duration= |notes= |dlc= }}

Stat Names

The following values are accepted for the stat field:

• health
• burntHealth
• mana
• burntMana
• manaCost
• stamina
• burntStamina
• staminaCost
• hunger
• drink
• rest
• temperature
• hotWeatherDef
• coldWeatherDef
• weight
• corruption
• corruptionResistance
• moveSpeed
• pouchBonus
• stealth
• cooldownReduction
• impactResist
• impactBonus
• stability
• protection
• barrier
• statusResist
• attackSpeed

Value Types

The following values are accepted for the type field:

• flat for sources which increase the value of the stat by a flat amount, for example Fitness, temporary effect buffs, etc
• restore for sources which restore or regenerate the stat, for example Life Potion or Health Recovery
• regenModifier for sources which modify the regen rate of the stat, for example Slow Metabolism

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