Jump to content

Template:SetBonus/doc: Difference between revisions

From Drifters Almanac
mNo edit summary
No edit summary
Line 1: Line 1:
This template displays set bonus effects that are triggered when multiple pieces of a named armor or accessory set are equipped.
This template is used to display set bonuses granted by equipping multiple pieces of a named item set (e.g., armor or accessories).


It is used inside other item templates like Armor, CraftedArmor, Accessories, or CraftedAccessories.
It supports up to 3 tiers of bonuses, each with up to 3 effects, and automatically categorizes the item by each affected stat.


== Usage ==
== Usage ==
 
Place this inside another template such as Armor or CraftedWeapon:
Add this inside your item template like so:


<pre>
<pre>
{{SetBonus
{{SetBonus
  | set_name =  
  | set_name =  
  | set_bonus_1_required =  
  | set_bonus_1_required =  
  | set_bonus_1_effect1 =  
  | set_bonus_1_effect1_stat =  
  | set_bonus_1_effect2 =  
  | set_bonus_1_effect1_value =  
  | set_bonus_1_effect3 =  
  | 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_required =  
  | set_bonus_2_effect1 =  
  | set_bonus_2_effect1_stat =  
  | set_bonus_2_effect2 =  
  | set_bonus_2_effect1_value =  
  | set_bonus_2_effect3 =  
  | 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_required =  
  | set_bonus_3_effect1 =  
  | set_bonus_3_effect1_stat =  
  | set_bonus_3_effect2 =  
  | set_bonus_3_effect1_value =  
  | set_bonus_3_effect3 =  
  | set_bonus_3_effect2_stat =
| set_bonus_3_effect2_value =
| set_bonus_3_effect3_stat =
| set_bonus_3_effect3_value =  
}}
}}
</pre>
</pre>


== Parameters ==
== Parameters ==


=== Set Metadata ===
;set_name
;set_name
:The name of the armor or accessory set.
: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., Strength, Vitality).
;set_bonus_N_effectX_value
:The value applied to the stat (e.g., +5, +2%).


;set_bonus_N_required
Stats are automatically bolded and linked to their respective categories using:
:Number of pieces required to activate this bonus tier. (Optional, but recommended.)
:<code>[[:Category:Strength|'''Strength''']]</code>


;set_bonus_N_effect1 / effect2 / effect3
== Auto-Categorization ==
:Up to 3 bonus effects per tier. These will be combined into a single line.
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>


== Notes ==
== Example Output ==
* Up to 3 bonus tiers are supported.
2 pieces: +5 '''Strength''', +3 '''Vitality''' 
* The set bonus section will not display unless at least one `effect1` is filled in.
3 pieces: +3% '''Critical Hit Chance''' 
* Category links should be handled by the item templates, not this one.
5 pieces: +10 '''Max Health''', +2% '''Ember Affinity'''

Revision as of 21:28, 23 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 CraftedWeapon:

{{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., Strength, Vitality).
set_bonus_N_effectX_value
The value applied to the stat (e.g., +5, +2%).

Stats are automatically bolded and linked to their respective categories using:

Strength

Auto-Categorization

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

For example, an effect on Strength will add:

Example Output

2 pieces: +5 Strength, +3 Vitality 3 pieces: +3% Critical Hit Chance 5 pieces: +10 Max Health, +2% Ember Affinity