Template:SetBonus/doc: Difference between revisions

Latest revision as of 11:34, 27 April 2025

This template is used to display set bonuses granted by equipping multiple pieces of a named item set (e.g., armor or accessories).

It supports up to 3 tiers of bonuses, each with up to 3 effects, and automatically categorizes the item by each affected stat.

Usage

Place this inside another template such as Armor or Accessory:

{{SetBonus
 | set_name = 

 | set_bonus_1_required = 
 | set_bonus_1_effect1_stat = 
 | set_bonus_1_effect1_value = 
 | set_bonus_1_effect2_stat = 
 | set_bonus_1_effect2_value = 
 | set_bonus_1_effect3_stat = 
 | set_bonus_1_effect3_value = 

 | set_bonus_2_required = 
 | set_bonus_2_effect1_stat = 
 | set_bonus_2_effect1_value = 
 | set_bonus_2_effect2_stat = 
 | set_bonus_2_effect2_value = 
 | set_bonus_2_effect3_stat = 
 | set_bonus_2_effect3_value = 

 | set_bonus_3_required = 
 | set_bonus_3_effect1_stat = 
 | set_bonus_3_effect1_value = 
 | set_bonus_3_effect2_stat = 
 | set_bonus_3_effect2_value = 
 | set_bonus_3_effect3_stat = 
 | set_bonus_3_effect3_value = 
}}

Parameters

Set Metadata

set_name: The name of the armor or accessory set being referenced.
set_bonus_N_required: Number of pieces required to activate tier N of the bonus.

Bonus Tiers

Each tier accepts up to 3 bonus effects using a stat and value pair.

set_bonus_N_effectX_stat: The stat affected (e.g., Hit, Positional, Healing).
set_bonus_N_effectX_value: The value applied to the stat.

Stats are automatically bolded and linked to their respective categories

Auto-Categorization

Each unique stat used will automatically add the item to a corresponding category

Example Output

2 pieces: +1 Healing, +1 Resilience
3 pieces: +3 Healing, +3 Resilience
5 pieces: +7 Healing, +7 Resilience

@@ Line 4: / Line 4: @@
 == Usage ==
-Place this inside another template such as Armor or CraftedWeapon:
+Place this inside another template such as Armor or Accessory:
 <pre>
@@ Line 49: / Line 49: @@
 ;set_bonus_N_effectX_stat
-:The stat affected (e.g., Strength, Vitality).
+:The stat affected (e.g., Hit, Positional, Healing).
 ;set_bonus_N_effectX_value
-:The value applied to the stat (e.g., +5, +2%).
+:The value applied to the stat.
-Stats are automatically bolded and linked to their respective categories using:
+Stats are automatically bolded and linked to their respective categories
-:<code>[[:Category:Strength|'''Strength''']]</code>
 == Auto-Categorization ==
-Each unique stat used will automatically add the item to a corresponding category:
+Each unique stat used will automatically add the item to a corresponding category
-:For example, an effect on <code>Strength</code> will add:
-:<code>[[Category:Strength]]</code>
 == Example Output ==
-pieces: +5 '''Strength''', +3 '''Vitality'''
+pieces: +1 '''Healing''', +1 '''Resilience'''<br>
-pieces: +3% '''Critical Hit Chance'''
+pieces: +3 '''Healing''', +3 '''Resilience'''<br>
-pieces: +10 '''Max Health''', +2% '''Ember Affinity'''
+pieces: +7 '''Healing''', +7 '''Resilience'''