User:MxFox/Sandbox/Degrades/doc

From Old School RuneScape Wiki
Jump to: navigation, search
Information icon-grey.svg
This is a documentation subpage for User:MxFox/Sandbox/Degrades.
It contains usage information, categories, and other content that is not part of the original template page.

Parameters

{{User:MxFox/Sandbox/Degrades|preset|...}}

1

This parameter selects a preset method of degradation, options for which can be overridden or tweaked. The generic and specific presets are detailed below.

Named

The following named parameters are broken down into groups by their purpose.

Behaviour

expenditure

Details the start of the blurb for how the item expends charges. By default, this is "Once depleted", unless the item's type is "break", in which case it changes to "Once completely degraded"

type

Valid inputs are break, revert, dust, bonus, corresponding to the four main types of degradation behavior, with the addition of bonusCharges detailed below.

  • break: The equipment breaks and requires repair.
  • revert: The equipment reverts to a component when it loses all charge.
  • dust: The equipment turns to dust or vanishes when all charges are expended.
  • charges: The equipment requires charges to be used.
  • bonus: The equipment acts as a charged item but some functionality remains in its depleted state, such as the Amulet of glory and Craw's bow

tradeability

Input options are empty, full, fullEmpty, notCombined, none, corresponding to the four main types of degradation behavior.

  • empty: The equipment can only be traded when completely depleted.
  • full: The equipment can only be traded when fully repaired/charged.
  • fullEmpty: The equipment can only be traded when either fully repaired/charged or completely depleted.
  • notCombined: The equipment cannot be traded whilst it is combined.
  • none: Doesn't display anything about tradeability, and overrides any preset attempting to.

Tradeability descriptions aren't given for items where degradation doesn't affect their charge such as Rings of Recoil (is tradeable regardless of charge), and items such as Arclight (isn't tradeable in any capacity), as these behaviours fall within the normal game mechanics.

Revert-specific

component

Only relevant if type is revert, describes the component that the item reverts into, and links to that item.

componentText

When using a component, componentText can be used to override the text displayed for the component link.

Display

text

Completely overrides the text for the details.

textAppend

Appends a new line containing the given text at the end of the details.

pic

Overrides the picture to the left, will still link to the Degradation page regardless.

plural

When value is yes, changes text in the text box to be applicable to be plural, allowing you to place it on a page discussing a group of items that behave identically.

Demonstrations

Presets

Generic presets cover the four primary outlines of degradation.

break, dust, revert, charges







Degradation.png
This item degrades with use.
Once depleted, it will break and require repairing.







Degradation.png
This item degrades with use.
Once depleted, it will disappear.







Degradation.png
This item degrades with use.
Once depleted, it will revert to a component.







Degradation.png
This item requires charges to use.
Once depleted, it will become drained and require recharging.

Specific Presets

Generally, specific instances are added for items which share a common source or item type and method of degradation.

Crystal

crystalWeapon, crystalArmour, crystalTool, crystalWeapon|expenditure=Once attacks against you deplete its charges







Degradation.png
This item degrades with use.
Once attack charges are depleted, it will revert to a crystal weapon seed.
This item is only tradeable when reverted.







Degradation.png
This item degrades with use.
Once attacks against you deplete its charges, it will revert to a crystal armour seed.
This item is only tradeable when reverted.







Degradation.png
This item requires charges to use some benefits.
Once depleted, it will become drained and lose some benefits until recharged.
This item becomes untradeable when its components are combined.

A special case must be made for the crystal shield.







Degradation.png
This item degrades with use.
Once attacks against you deplete its charges, it will revert to a crystal weapon seed.
This item is only tradeable when reverted.

Barrows, Wilderness, Toxic, ToxicHelm

barrows, wilderness, toxic, toxicHelm







Degradation.png
This item degrades with use.
After 15 hours of combat, it will break and require repairing.
This item is only tradeable when completely charged or degraded.







Degradation.png
This item requires charges to use some benefits.
Once attack charges are depleted, it will become drained and lose some benefits until recharged.
This item is only tradeable when completely depleted.







Degradation.png
This item requires charges to use.
Once attack charges are depleted, it will become drained and require recharging.
This item is only tradeable when completely depleted.







Degradation.png
This item requires charges to use.
Once depleted through combat, it will become drained and require recharging.
This item is only tradeable when completely depleted.

Jewellery

jewelleryDust, jewelleryCharges







Degradation.png
This item degrades with use.
Once depleted, it will disappear.







Degradation.png
This item requires charges to use some benefits.
Once depleted, it will become drained and lose some benefits until recharged.

Powered Weapon

poweredWeapon







Degradation.png
This item requires charges to use.
Once attack charges are depleted, it will become drained and require recharging.
This item is only tradeable when completely charged or depleted.

Manual Examples

Tentacle Whip

Use "revert" as a base and describe the item's behavior in more detail.

{{User:MxFox/Sandbox/Degrades|revert|expenditure=After 10,000 attacks|tradeability=notCombined|component=Kraken tentacle|pic=Kraken tentacle}}







Degradation.png
This item degrades with use.
After 10,000 attacks, it will revert to a kraken tentacle.
This item becomes untradeable when its components are combined.