Template:Reward/doc

This is the documentation page for Template:Reward.

When it is viewed directly, links using variables may appear broken; do not replace these with hardcoded page names or URLs.

The template can be used in cases where resource rewards are being given using namespace parameters (as in events and similar cases) - these parameters (and their associated values) stay consistent across the files.

Parameters

Note: Make sure to use the right parameter 2 (multiplier/amount) on File:Unity.png Unity and File:Influence.png Influence special cases.
Parameter 1 also accepts the full term for each resource (e.g. "influence" or "inf")
Parameter 1 and parameter 2 are not inherently linked, so it is possible to mix and match them.

Resource	Parameter 1	Parameter 2	Multi	Amount
File:Energy Credits.png Energy	enc / energy	mat1 mat2 mat3 mat4 mat5	06x 12x 18x 24x 48x	100 ~ 1000 150 ~ 2000 250 ~ 5000 350 ~ 10 000 700 ~ 30 000
File:Minerals.png Minerals	min / minerals
Food	food
File:Unity.png Unity	uni / unity
File:Alloys.png Alloys	aly / alloys
File:Consumer goods.png Consumer goods	cgd / consumer goods
File:Exotic gases.png Exotic gases	gas / exotic gases
File:Rare crystals.png Rare crystals	crs / rare crystals
File:Volatile motes.png Volatile motes	mote / volatile motes
File:Nanites.png Nanites	nan / nanites
File:Engineering research.png Engineering File:Physics research.png Physics File:Society research.png Society Research	eng / engineering phy / physics soc / society rsh / research	rsh1 rsh2 rsh3 rsh4 rsh5	12x 18x 24x 48x 96x	0250 ~ 100 000 0350 ~ 100 000 0500 ~ 100 0000 1000 ~ 1 000 000 2000 ~ 2 000 000
File:Influence.png Influence	inf	inf1 inf2 inf3 inf4 inf5 inf6	06x 12x 18x 24x 36x 48x	040 ~ 100 080 ~ 175 125 ~ 250 150 ~ 300 250 ~ 500 300 ~ 600
File:Influence.png Influence (First contact cases)	inf	con11 con12 (proactive) con21 con22 (proactive)	06x 09x 10x 15x	20 ~ 80 30 ~ 120 40 ~ 100 60 ~ 150
File:Unity.png Unity (special cases)	uni	uni1 uni2 uni3 uni4 uni5	06x 12x 18x 24x 48x	100 ~ 100 000 150 ~ 100 000 250 ~ 1 000 000 350 ~ 1 000 000 700 ~ 2 000 000
File:Minor artifacts.png Minor artifacts	art	art1 art2 art3 art4	small medium large great	10, 30, or 50 60, 80, or 100 100, 200, or 300 500, 750, or 1000
File:Astral threads.png Astral threads	ast	ast1 ast2 ast3	small medium large	40, 50, or 60 90, 100, or 110 140, 150, or 160

Usage

Format: {{reward|Resource_Type|Resource_Amount|Custom_Prefix|Custom_Yield_Prefix}}
The Custom_Prefix and Custom_Yield_Prefix variables can use the string "empty" to not display anything at all for shorter formatting.

Examples

The following will produce the below results (in the listed order):

* {{reward|enc|mat3}}
* {{reward|cgd|mat2}}
* {{reward|uni|mat1}}
* {{reward|uni|uni1}}
* {{reward|phy|rsh2}}
* {{reward|rsh|rsh4}}
* {{reward|uni|uni9}}
* {{reward|inf|inf1}}
* {{reward|inf|con12}}
* {{reward|art|art1|Receive|one of}}
* {{reward|art|art2|empty|empty}}
* {{reward|ast|ast2|empty|empty}}

• File:Energy Credits.png 18x energy output (250~5000)
• File:Consumer goods.png 12x consumer goods output (150~2000)
• File:Unity.png 6x unity output (100~1000)
• File:Unity.png 6x unity output (100~100 000)
• File:Physics research.png 18x physics output (350~100 000)
• 48x research output (1000~1 000 000 of each)
• File:Unity.png 120x unity output (240~9999)
• File:Influence.png 6x influence output (40~100)
• File:Influence.png 9x influence output (30~120)
• Receive File:Minor artifacts.png small minor artifacts reward (one of 10, 30, or 50)
• File:Minor artifacts.png medium minor artifacts reward (60, 80, or 100)
• File:Astral threads.png medium astral threads reward (90, 100, or 110)

References

To update template values see reference files in folder Stellaris/common:

1. For event rewards see reference file Stellaris/common/scripted_variables/00_scripted_variables.txt (appears under ### EVENT REWARDS).
2. Minor artifact rewards are in Stellaris/common/scripted_effects/archaeology_event_effects.txt (under # REWARDS).
3. Astral thread rewards are defined in Stellaris/common/scripted_effects/astral_rift_effects.txt (under # REWARDS) with a multiplier effect defined in Stellaris/common/scripted_effects/astral_planes_effects.txt.