Template:Weapon

From Sons of the Forest Wiki
Jump to navigation Jump to search
Template-info.png Documentation

This template aims to provide comprehensible and complete way of adding an infobox to Weapon and Tool. Based on JPKMn user wikitable

Usage[edit source]

• Use this template to add an Portable Infobox to most items.
• If you don't have info or don't feel the need to add it just leave the parameter empty, don't cut it out.
• If anything needs to be added, feel free to do so (:


Template ready to use[edit source]

{{Weapon
|title      = 
|image      = 
|caption    = 
|alias      = 
|obtained   = 
|type       = 
|id         = 
|stack      = 
|added      = 
|block      = 
|capacity   = 
|ammo       = 
|attachment = 
|atype      = 
|distance   = 
|speed      = 
|standard   = 
|charge     = 
|downward   = 
|ing        = 
|equippable = 
|upgradable = 
|location   = 
|map        = 
|get        = 
|storage    = 
|uses       = 
|used       = 
}}

Template with Explanation[edit source]

{{Weapon
|title      = Title, by default it's page name
|image      = Filename representing the item
|caption    = Image description if needed
|alias      = Other names for the item
|obtained   = Check the lower page part for more info
|type       = Check the lower page part for more info
|id         = Item ID number
|stack      = Max. inventory stack size
|added      = Version of the game when the item was added
|block      = Check the lower page part for more info
|capacity   = Max. ammo loaded into the weapon
|ammo       = All ammo types that can be loaded
|attachment = All attachments that can be added
|atype      = Check the lower page part for more info
|distance   = Check the lower page part for more info
|speed      = Check the lower page part for more info
|standard   = Default left mouse button click attack
|charge     = Other name used "powerful attack"
|downward   = Self explanatory
|ing        = Crafting ingredients for the item
|equippable = Specifies if the item is equippable (Yes/No)
|upgradable = Specifies if the item is upgradable (Yes/No)
|location   = Where the item can be found
|map        = Linked Icon to map node
|get        = What is needed in order to obtain the item
|storage    = Where the item can be stored
|uses       = For what the item can be used
|used       = Who or what uses/needs the item
}}

Example[edit source]

{{Weapon
|title      = Crossbow
|image      = Crossbow Icon.png
|caption    = 
|alias      = 
|obtained   = Collecting
|type       = [[Items#Weapon|Weapon]]
|id         = 365
|stack      = 1
|added      = [[Updates|Early Access release]]
|block      = 
|capacity   = 1
|ammo       = [[Crossbow Bolt]]
|attachment = • [[Flashlight Attachment]] <br> • [[Laser Sight]]
|atype      = Ranged
|distance   = Long
|speed      = Slow
|standard   = 50
|charge     = 
|downward   = 
|ing        = 
|equippable = Yes
|upgradable = No
|location   = [[Bunkers#Food and Dining Bunker|Food and Dining Bunker]]
|map        = {{linked icon|Icon-Map-4|https://sotf.th.gl/locations/20|size=19px}}
|get        = [[Maintenance Keycard]]
|storage    = [[Inventory]]
|uses       = 
|used       = 
}}



Currently usable Parameters[edit source]

Please only use these parameters to keep all Infoboxes consistent.

|obtained

• Collecting - just picking up
• Cooking    - mixing food in Cooking Pot
• Crafting   - self explanatory
• Farming    - growing plants
• Hunting    - killing animals
• Looting    - opening stuff / killing enemies
• Cheating   - using console commands

|type

• [[Items#Weapon|Weapon]]
• [[Items#Tool|Tool]]

|block

• Weak
• Medium
• Strong

|atype

• Melee
• Stun
• Ranged
• Explosive

|distance

• Short
• Medium
• Long

|speed

• Slow
• Medium
• Fast

Template data[edit source]

Template for: Weapons and Tools.

Template parameters

ParameterDescriptionTypeStatus
Title|title

Title of the item.

Default
Page name
Stringrequired
Image|image

Filename representing the item.

Stringrequired
Caption|caption

Image description if needed.

Stringoptional
Alias|alias

Other names for the item.

Stringoptional
Obtained|obtained

How the item is obtained. Check this for [https://sonsoftheforest.wiki.gg/wiki/Template:Basic_item/doc#Currently_usable_Parameters Currently usable Parameters].

Stringrequired
Type|type

Type of the item. Check this for [https://sonsoftheforest.wiki.gg/wiki/Template:Basic_item/doc#Currently_usable_Parameters Currently usable Parameters].

Stringrequired
Item ID|id

Item ID number.

Numberrequired
Stack size|stack

Maximum inventory stack size.

Numberrequired
Game Version|added

Version of the game when the item was added.

Stringrequired
Blocking|block

Check the lower page part for more info.

Stringoptional
Capacity|capacity

Max. ammo loaded into the weapon.

Stringoptional
Ammunition|ammo

All ammo types that can be loaded.

Stringoptional
Attachments|attachment

All attachments that can be added.

Stringoptional
Attack type|atype

For item attacks check this [https://sonsoftheforest.wiki.gg/wiki/Template:Basic_item/doc#Currently_usable_Parameters Currently usable Parameters].

Stringoptional
Attack distance|distance

For item attack distances check this [https://sonsoftheforest.wiki.gg/wiki/Template:Basic_item/doc#Currently_usable_Parameters Currently usable Parameters].

Stringoptional
Attack speed|speed

For item attack speed check this [https://sonsoftheforest.wiki.gg/wiki/Template:Basic_item/doc#Currently_usable_Parameters Currently usable Parameters].

Stringoptional
Standard attack|standard

Default left mouse button click attack.

Stringoptional
Charged attack|charge

Other name is "powerful attack".

Stringoptional
Downward attack|downward

Self explanatory.

Stringoptional
Crafting|ing

Crafting ingredients for the item.

Stringrequired
Equippable|equippable

Specifies if the item is equippable (Yes/No).

Stringoptional
Upgradable|upgradable

Specifies if the item is upgradable (Yes/No).

Stringrequired
Location|location

Where the item can be found.

Stringoptional
Map|map

Linked Icon to map node.

Stringoptional
Get|get

What is needed in order to obtain the item.

Stringoptional
Storage|storage

Where the item can be stored.

Stringrequired
Uses|uses

For what the item can be used.

Stringoptional
Used|used

Who or what uses/needs the item.

Stringoptional