View source for Template:Effectiveness/doc

{{Documentation}}
==Description==
This template is designed for use in the [[Money making Guide]]s. With an input of the cost of items bought and items sold, and the amount processed in an hour, it outputs a star rating for this with a calculated profit value, rounded to the nearest 1,000. The star rating corresponds to the following table, agreeded up in [[Forum:Money Method Metric]]:
{| class="wikitable"
|-
!Profit range||Number of stars||
|-
|Profit ≥ 500,000||5||'''<span style="font-size:16pt; color:#0000ff">*****</span>
|-
|250,000 ≤ Profit < 500,000||4||'''<span style="font-size:16pt; color:#0000ff">****</span><span style="font-size:16pt; color:#bbbbbb">*</span>
|-
|150,000 ≤ Profit < 250,000||3||'''<span style="font-size:16pt; color:#0000ff">***</span><span style="font-size:16pt; color:#bbbbbb">**</span>
|-
|100,000 ≤ Profit < 150,000||2||'''<span style="font-size:16pt; color:#0000ff">**</span><span style="font-size:16pt; color:#bbbbbb">***</span>
|-
|50,000 ≤ Profit < 100,000||1||'''<span style="font-size:16pt; color:#0000ff">*</span><span style="font-size:16pt; color:#bbbbbb">****</span>
|-
|0 ≤ Profit < 50,000||0||'''<span style="font-size:16pt; color:#bbbbbb">*****</span>
|-
|0 > Profit||5, red||'''<span style="font-size:16pt; color:#ff0000">*****</span>
|}

==Usage==
<pre>{{Effectiveness
|buy    = value of items bought, no commas, brackets not required
|sell   = value of items sold, no commas, brackets not required
|amount = amount of items processed per hour, no commas
|output = optional - what is output; "value" results in the value only, "stars" reulsts in stars only. If both are wanted it can be left out.
}}</pre>

===Examples===
'''Note:''' not all examples are stricly realistic, could do with better ones.
{| class="wikitable"
|-
!Method||Code used||Output
|-
|style="width:200px"|Fishing for [[crayfish]].||<pre>{{Effectiveness
|buy=0
|sell={{GEPrice|Raw crayfish|n}}
|amount=594}}</pre>||{{Effectiveness |buy=0 |sell={{GEPrice|Raw crayfish|n}} |amount=594}}
|-
|style="width:200px"|Buying 64 battlestaves from [[Zaff]] and selling them.||<pre>{{Effectiveness
|buy=7000
|sell={{GEPrice|Battlestaff|n}}
|amount=64}}</pre>||{{Effectiveness|buy=7000|sell={{GEPrice|Battlestaff|n}}|amount=64}}
|-
|Fletching yew longbows from logs and bow strings, 5000 per hour.||<pre>{{Effectiveness
|buy={{GEPrice|Yew logs|n}}+{{GEPrice|Bow string|n}}
|sell={{GEPrice|Yew longbow|n}}
|amount=5000}}</pre>||{{Effectiveness|buy={{GEPrice|Yew logs|n}}+{{GEPrice|Bow string|n}}|sell={{GEPrice|Yew longbow|n}}|amount=5000}}
|-
|Collecting 2000 snape grass per hour and selling .||<pre>{{Effectiveness
|buy=0
|sell={{GEPrice|Snape grass|n}}
|amount=2000}}</pre>||{{Effectiveness|buy=0|sell={{GEPrice|Snape grass|n}}|amount=2000}}
|-
|Buying uncut diamonds and selling cut ones, 500 per hour.||<pre>{{Effectiveness
|buy={{GEPrice|Uncut diamond|n}}
|sell={{GEPrice|Diamond|n}}
|amount=500}}</pre>||{{Effectiveness|buy={{GEPrice|Uncut diamond|n}}|sell={{GEPrice|Diamond|n}}|amount=500}}
|-
|Mining 1,000 iron ore per hour, stars only.||<pre>{{Effectiveness
|buy=0
|sell={{GEPrice|Iron ore|n}}
|amount=1000
|output=stars}}</pre>||{{Effectiveness|buy=0|sell={{GEPrice|Iron ore|n}}|amount=1000|output=stars}}
|-
|Mining 1,000 iron ore per hour, value only.||<pre>{{Effectiveness
|buy=0
|sell={{GEPrice|Iron ore|n}}
|amount=1000
|output=value}}</pre>||{{Effectiveness|buy=0|sell={{GEPrice|Iron ore|n}}|amount=1000|output=value}}
|}

==Notes==
*If using [[Template:GEPrice]], the <code>|n</code> parameter must be used (i.e. {{t|GEPrice|item|n}}) for items worth 1,000 coins or more (as this removes the comma). If worth less than 1,000, <code>|n</code> should still be included incase the item ''does'' reach 1,000 coins or more in the future.
*The ''output'' parameter can be left out completely if both the stars and the value are wanted.
*This is designed for use in a table, but can be used alone.
*Please see [[RuneScape:WikiGuilds/Money Method Metric|here]] for discussing changes to the table.
<noinclude>[[Category:Template documentation|{{PAGENAME}}]]</noinclude>