Template:Guides/doc: Difference between revisions

From Roat Pkz
Jump to navigation Jump to search
No edit summary
Line 1: Line 1:
Working templates
Working templates
== Combat Styles ==
{{Documentation}}
==Usage==
<pre>
{{CombatStyles
|                  <!--  The first unnamed parameter determines the combat style of a weapon. -->
|speed          = <!--  The base attack speed of a weapon. This value is identical to the one used in {{Infobox Bonuses}}. -->
|attackrange    = <!--  The base attack range of a weapon. This value is identical to the one used in {{Infobox Bonuses}}. -->
}}
</pre>
==Quick copy==
<code><nowiki>{{CombatStyles||speed=|attackrange=}}</nowiki></code>
==Details==
Possible values for the first field are listed below. See [[Weapons/Types]] for a full overview.
{{div col|colwidth=10em}}
* 2h Sword
* Axe
* Banner
* Bladed Staff
* Blaster
* Bludgeon
* Blunt
* Bow
* Bulwark
* Chinchompas
* Claw
* Crossbow
* Gun
* Pickaxe
* Polearm
* Polestaff
* Powered Staff
* Salamander
* Scythe
* Slash Sword
* Spear
* Spiked
* Stab Sword
* Staff
* Thrown
* Unarmed
* Whip
{{div col end}}
==Examples==
<code><nowiki>{{CombatStyles|Bow|speed=4|attackrange=9}}</nowiki></code>
{{CombatStyles|Bow|speed=4|attackrange=9}}
<code><nowiki>{{CombatStyles|Gun|speed=varies|attackrange=varies}}</nowiki></code>
{{CombatStyles|Gun|speed=varies|attackrange=varies}}
<code><nowiki>{{CombatStyles|Unarmed|speed=No|attackrange=None ????}}</nowiki></code>
{{CombatStyles|Unarmed|speed=No|attackrange=None ????}}
<code><nowiki>{{CombatStyles|Polestaff}}</nowiki></code>
{{CombatStyles|Polestaff}}
{{TemplateData|<templatedata>
{
"params": {
"1": {
"label": "Combat style",
"description": "The combat style of the weapon, categorised by available combat options",
"type": "string",
"required": true
},
"speed": {
"label": "Attack speed",
"description": "Base attack speed of a weapon, in ticks",
"type": "number",
"suggested": true
},
"attackrange": {
"label": "Attack range",
"description": "Base attack range of a weapon, in game tiles",
"type": "number",
"suggested": true
}
},
"description": "Displays the available combat options of a weapon and formats its attack speed and range",
"paramOrder": [
"1",
"speed",
"attackrange"
],
"format": "inline"
}
</templatedata>}}





Revision as of 12:55, 1 April 2024

Working templates

Combat Styles

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

Usage

{{CombatStyles
|                  <!--  The first unnamed parameter determines the combat style of a weapon. -->
|speed           = <!--  The base attack speed of a weapon. This value is identical to the one used in {{Infobox Bonuses}}. -->
|attackrange     = <!--  The base attack range of a weapon. This value is identical to the one used in {{Infobox Bonuses}}. -->
}}

Quick copy

{{CombatStyles||speed=|attackrange=}}

Details

Possible values for the first field are listed below. See Weapons/Types for a full overview.

  • 2h Sword
  • Axe
  • Banner
  • Bladed Staff
  • Blaster
  • Bludgeon
  • Blunt
  • Bow
  • Bulwark
  • Chinchompas
  • Claw
  • Crossbow
  • Gun
  • Pickaxe
  • Polearm
  • Polestaff
  • Powered Staff
  • Salamander
  • Scythe
  • Slash Sword
  • Spear
  • Spiked
  • Stab Sword
  • Staff
  • Thrown
  • Unarmed
  • Whip

Examples

{{CombatStyles|Bow|speed=4|attackrange=9}}

Combat styleAttack typeWeapon styleAttack speedRangeExperienceLevel boost
AccurateRangedAccurate4 ticks (2.4s)9 tilesRanged Hitpoints+3 Ranged
RapidRangedRapid3 ticks (1.8s)9 tilesRanged HitpointsNone
LongrangeRangedLongrange4 ticks (2.4s)10 tilesRanged Defence Hitpoints+3 Defence

{{CombatStyles|Gun|speed=varies|attackrange=varies}}

Combat styleAttack typeWeapon styleAttack speedRangeExperienceLevel boost
Aim and FireNoneNoneVariableVariableNoneNone
KickCrushAggressiveStrength Hitpoints+3 Strength

{{CombatStyles|Unarmed|speed=No|attackrange=None ????}}

Combat styleAttack typeWeapon styleAttack speedRangeExperienceLevel boost
PunchCrushAccurateN/AN/AAttack Hitpoints+3 Attack
KickCrushAggressiveStrength Hitpoints+3 Strength
BlockCrushDefensiveDefence Hitpoints+3 Defence

{{CombatStyles|Polestaff}}

Combat styleAttack typeWeapon styleExperienceLevel boost
BashCrushAccurateAttack Hitpoints+3 Attack
PoundCrushAggressiveStrength Hitpoints+3 Strength
BlockCrushDefensiveDefence Hitpoints+3 Defence

Template data

Show/hide template's data

The following information is used by extensions and applications, such as VisualEditor, to help users implement this template onto pages. Please ensure that it is up-to-date.

Displays the available combat options of a weapon and formats its attack speed and range

Template parameters

This template prefers inline formatting of parameters.

ParameterDescriptionTypeStatus
Combat style1

The combat style of the weapon, categorised by available combat options

Stringrequired
Attack speedspeed

Base attack speed of a weapon, in ticks

Numbersuggested
Attack rangeattackrange

Base attack range of a weapon, in game tiles

Numbersuggested




Infobox Bonuses

 {{Infobox Bonuses
|astab = 
|aslash = 
|acrush = 
|amagic = 
|arange = 
|dstab = 
|dslash = 
|dcrush = 
|dmagic = 
|drange = 
|str = 
|rstr = 
|mdmg = 
|prayer = 
|slot = 
|speed = 
|attackrange = 
|combatstyle = 
|image = [[File:Armadyl godsword equipped.png|120px]]
|altimage = [[File:Armadyl godsword equipped female.png|120px]]
|caption = 
}}


 Attack bonuses
StabSlashCrushMagicRanged
? (edit)? (edit)? (edit)? (edit)? (edit)
 Defence bonuses
StabSlashCrushMagicRanged
? (edit)? (edit)? (edit)? (edit)? (edit)
 Other bonusesSlot
StrengthRangedMagic damagePrayer? (edit)
? (edit)? (edit)? (edit)? (edit)? (edit)

Infobox Item

Template:Guides/doc
? (edit)
Released? (edit)
Removal(Optional) (Update)
Also called(Optional)
Properties
Tradeable? (edit)
Bankable(Optional)
Stacks in bank(Optional)
Equipable? (edit)
Stackable? (edit)
Noteable(Optional)
Edible(Optional)
Options? (edit)
Worn options(Optional)
Examine? (edit)
Values
Value? (edit)
Weight? (edit)
Respawn time(Optional)
Advanced data
Item ID? (edit)
{{Infobox Item
|name = 
|image = 
|release = 
|update = 
|removal = (Optional)
|removalupdate = (Optional)
|aka = (Optional)
|members = 
|quest = 
|tradeable = 
|bankable = (Optional)
|stacksinbank = (Optional)
|placeholder = (Optional)
|equipable = 
|stackable = 
|noteable = (Optional)
|edible = (Optional)
|options = 
|wornoptions = (Optional)
|destroy = 
|examine = 
|value = 
|alchable = (Optional)
|weight = 
|respawn = (Optional)
|exchange = (Optional)
|gemwname = (Optional)
|id = 
}} 





Infobox Monster

Template:Guides/doc
? (edit)
Released? (edit)
Donator? (edit)
Combat level? (edit)
Examine? (edit)
Combat info
AttributeNone
Max hit? (edit)
Aggressive? (edit)
Poisonous? (edit)
Attack style? (edit)
Attack speed? (edit)
Respawn time(Optional)
Slayer info
Slayer level(Optional)
Slayer XP(Optional)
Category(Optional)
Assigned by? (edit)
Combat stats
? (edit)? (edit)? (edit)? (edit)? (edit)? (edit)
Aggressive stats
Monster attack bonusMonster strength bonusMonster magic strength bonusMonster ranged strength bonus
? (edit)? (edit)? (edit)? (edit)? (edit)? (edit)
Defensive stats
? (edit)? (edit)? (edit)? (edit)? (edit)
Advanced data
Monster ID? (edit)
{{Infobox Monster
|name = 
|image = 
|release = 
|update = 
|members = 
|combat = 
|size = 
|examine = 
|attributes = (Optional)
|max hit = 
|aggressive = 
|poisonous = 
|attack style = 
|attack speed = 
|respawn = (Optional)
|slaylvl = (Optional)
|slayxp = (Optional)
|cat = (Optional)
|assignedby = (Optional)
|hitpoints = 
|att = 
|str = 
|def = 
|mage = 
|range = 
|attbns = 
|strbns = 
|amagic = 
|mbns = 
|arange = 
|rngbns = 
|dstab = 
|dslash = 
|dcrush = 
|dmagic = 
|drange = 
|id = 
}}



Infobox Pure

Hemmi80
MembersYes
Also calledGod
Build type1-vs-1
Combat level126
Primary attack style
Example combat stats
999999999999999999999999999912748
 {{Infobox Pure
|name = <!-- name of the build -->
|aka = <!-- when applicable: other names of this build -->
|image = <!-- example image of what the build looks like with its gear on -->
|members = <!-- either Yes or No -->
|ironman = <!-- if this build is made for playing as an ironman, e.g. to prevent gaining hitpoints experience -->
|type = <!-- comma seperated list; choose: 1v1, tank, scout, multi, no-honour, ragger, skiller.
|combat = <!-- combat level for this pure; can also be a range of combat level, separated by a comma. -->
|uses melee = <!-- yes / no: account uses melee attack style -->
|uses ranged = <!-- yes / no: account uses ranged attack style -->
|uses magic = <!-- yes / no: account uses magic attack style -->
|attack style = <!-- optional: which combat style is the primary attacking style of this build; either melee, magic, ranged, hybrid or no (only 'no' if this build is not meant for attacking) -->
|weapons = <!-- list of weapons for which the max hit will be given; must specify the same amount of weapons and max hits -->
|max hit = <!-- list of maximum possible hits corresponding to the weapons defined in the previous parameter -->
|hitpoints = <!-- ideal hitpoints level for this build -->
|att = <!-- ideal attack level for this build -->
|str = <!-- ideal strength level for this build -->
|def = <!-- ideal defence level for this build -->
|mage = <!-- ideal magic level for this build -->
|range = <!-- ideal ranged level for this build -->
|pray = <!-- ideal prayer level for this build -->
}}


SCP

The SCP template displays a clickable skill icon picture that links to the skill page. This can be also be used in other templates that display skill icons.

Usage

{{SCP|<skill>|<number>|link = (optional) yes}}

Examples Just skill:

{{SCP|Magic}}

Skill and level:

{{SCP|Magic|50}}

50

Skill, level, and link:

{{SCP|Magic|50|link=yes}}

50 [[]]

Non-skill clickpics This template can produce a number of clickpics which are not skill icons.

Name Image Link
overall Skills
diary Achievement Diary
combatachievement Combat Achievements
combat Combat level
combatstyle Combat styles
dd Distractions and Diversions
favour Kourend Favour
minigame Minigames
music Music Music
raid Raids
quest Quest points
time Time
total Total level


PLINKT

Been edited so it doesnt link

The picture link table template is a variant of {{plink}} used to created image-and-text links within tables.

Usage {{plinkt|item|txt=text|pic=file name}}

Examples

Code Produces Standard syntax
{{plinkt|Abyssal whip}} Abyssal whip [[File:Abyssal whip.png|link=Abyssal whip]]||[[Abyssal whip]]
{{plinkt|Granite maul|pic=Abyssal whip}} Granite maul [[File:Abyssal whip.png|link=Granite maul]]||[[Granite maul]]

PLINK

Been edited so it doesnt link

The picture link template creates an image and links it to the page as well as including text. For a textless version, use {{plinkp}}.

This template is not intended to be commonly used in mainspace articles. It is primarily used in navboxes and tables to add images to help with navigation. In most other cases, pages should be linked with normal markup and without an image.

Usage

{{plink|item|pic=file name|txt=text}}

Examples

Examples
Code Produces Standard syntax
{{plink|Abyssal whip}} Abyssal whip Abyssal whip [[File:Abyssal whip.png|link=Abyssal whip]] [[Abyssal whip]]
{{plink|Granite maul|pic=Abyssal whip}} Granite maul Granite maul [[File:Abyssal whip.png|link=Granite maul]] [[Granite maul]]
{{plink|Abyssal whip|txt=Whip}} Abyssal whip Whip [[File:Abyssal whip.png|link=Abyssal whip]] [[Abyssal whip|Whip]]
{{plink|Granite maul|pic=Abyssal whip|txt=Whip}} Granite maul Whip [[File:Abyssal whip.png|link=Granite maul]] [[Granite maul|Whip]]


Skill outfit

{{Skill outfit|Lumberjack hat|Lumberjack top|Lumberjack legs|Lumberjack boots}}
Item XP Bonus
Lumberjack hat 0%
Lumberjack top 0%
Lumberjack legs 0%
Lumberjack boots 0%
Sub-total 0%
Set bonus 0%
Full set 10%