Template:Sandbox/User:Bonbaun/Rggtable/doc

This is a documentation subpage for Template:Sandbox/User:Bonbaun/Rggtable. It contains usage information, categories, and other content that is not part of the original template page.

Template:Sandbox/User:Bonbaun/Rggtable invokes function rggtable in Module:Sandbox/User:Bonbaun/Rggtable using Lua.

Template:Sandbox/User:Bonbaun/Rggtable invokes Module:Rggtable using Lua.

This template displays a table for resource gathering guides.

Usage

This template can be used by entering the following onto a relevant page. This is all still placeholder.

{{Rggtable
|Activity =
|Image =
|Skill =
|Item =
|Quest =
|Other =
|Other Benefits =
|Input# =
|Input#num =
|Input#value =
|Input#note =
|Output# =
|Output#num =
|Output#value =
|Output#note =
|Location =
|Category =
|Members =
|Intensity =
|Details =
|kph = 
|kph name = 
|isperkill = 
}}

Activity

This parameter states the activity to make money.

Version

Only required when utilising a Tabber to have multiple mmgtables on one page.
This should be set to the same as the tabber title to ensure it can auto-switch to the correct table. This also appears in the main table on money making guide in brackets.

Image

This parameter displays an image.

Skill

This parameter states the skill requirements for the activity.

Item

This parameter states the items needed for the activity.

Quest

This parameter states the quests that need to be done for the activity.

Other

This parameter lists other requirements not covered by the Skill, Item and Quest parameters.

Other Benefits

This parameter lists any experience rewards or other non-monetary benefits of this method.

Input#, Input#num, Input#value, Input#note, Input#isph

These parameters state the inputs needed to start the activity. The # is replaced with a whole, positive number, in sequence, starting from 1.

• Input# specifies the item.
• Input#num specifies how many of the item will be used per hour.
• Input#value specifies the per-item value of the item (if it's different from the Grand Exchange price).
• Input#note can be used to specify other information about an input, such as stating that a coin cost represents expenses related to repairing equipment.
• Input#isph can be used to specify that the input is required per hour. Default is true. If set to false, the input number will be multiplied by kph.

Output#, Output#num, Output#value, and Output#note

These parameters state the outputs received from the activity. The # is replaced with a whole, positive number, in sequence, starting from 1.

• Output# specifies the item.
• Output#num specifies how many of the item will be obtained per hour.
• Output#value specifies the per-item value of the item (if it's different from the Grand Exchange price).
• Output#note can specify other information about an output, such as stating that a coin output is the result of using High level alchemy.

Location

This parameter states the location of the activity. Currently, this is not actually displayed anywhere.

Category

This parameter states whether the activity is: "Combat", "Collecting", "Skilling", or "Processing". "Combat/Low", "Combat/Mid", and "Combat/High" also work for "Combat", if more specific categorization is desired.

Members

This parameter states whether the activity is Free-to-play ("Members=No"). If this parameter is not set, the page will be added to Category:Money making guides without a membership status.

Intensity

This parameter states whether the activity is:"High", "Moderate" or "Low" intensity.
Should no argument be given or if the argument is invalid, it will default to "Unknown".

Details

This parameter lists details for the activity.

kph

This parameter allows you to specify a number of kills or actions per hour. This is to be used with Input#isph and isperkill to allow the user to customize their actions per hour.

kph name

This parameter specifies the name of the "kills per hour" (default) label, for money making guides that are not based on kills.

isperkill

This parameter specifies whether the outputs are given per-kill rather than per-hour.

Exclude

Set to yes to prevent the template from setting SMW properties, which will prevent it showing up in the MMG lists. It also adds Category:Obsolete money making guides.

Deprecated parameters

The following parameters are still usable, but should not be used.

Inputs

A formatted list of all inputs. Should be replaced with the Input# parameters.

Outputs

A formatted list of all outputs. Should be replaced with the Output# parameters.

Profit

The expected hourly profit. If Inputs and Outputs have been properly replaced, this will be automatically calculated, and this parameter should be removed.