Template:Modbox/doc: Difference between revisions

From [N8]
Jump to navigation Jump to search
Created page with "This template creates a tile that has two halves - either both containing text (coming soon), or the bottom half linking to a page. ==Usage== * <code>Name</code> – Name of..."
 
m updated docs to include Ship Class
 
(3 intermediate revisions by one other user not shown)
Line 1: Line 1:
This template creates a tile that has two halves - either both containing text (coming soon), or the bottom half linking to a page.
{{documentation}}
{{Confuse|Template:Infobox Mod}}
This template creates a Mod Infobox for usage only for the '''Mod Stores'''.


==Usage==
==Usage==
Line 10: Line 12:
* <code>ID</code> – Mod ID
* <code>ID</code> – Mod ID
* <code>Multi Install?</code> – Yes or No
* <code>Multi Install?</code> – Yes or No
* <code>Ship</code> - Ship Class: Any? Freighter? Fighter? Scout?
* <code>Condition</code>  
* <code>Condition</code>  
** 1 = Craftable
** 1 = Craftable
Line 30: Line 33:
|ID= 283
|ID= 283
|Multi= Yes
|Multi= Yes
|Ship=Any
|Condition= 1
|Condition= 1
|Attr= +1% Damage Reflection
|Attr= +1% Damage Reflection
Line 51: Line 55:
|ID= 283
|ID= 283
|Multi= Yes
|Multi= Yes
|Ship=Any
|Condition= 1
|Condition= 1
|Attr= +1% Damage Reflection
|Attr= +1% Damage Reflection
Line 67: Line 72:
{
{
"params": {
"params": {
"style": {},
"ReqLevel": {
"title": {
"description": "The main heading for the tile",
"type": "string",
"type": "string",
"description": "Required Level of the Mod",
"example": "ReqLevel= 35",
"required": true
"required": true
},
},
"text": {
"ItemLevel": {
"type": "string",
"description": "Item Rating/Tier of Mod",
"example": "ItemLevel= 515",
"required": true
},
"ID": {
"type": "string",
"description": "Mod ID",
"example": "ID= 19204",
"required": true
},
"Multi": {
"type": "string",
"description": "Is it Multi Install? Yes or No.",
"example": "Multi= Yes",
"required": true
},
"Image": {
"type": "string",
"description": "Mod Image.",
"example": "Image= Armor.png",
"required": true
},
"Name": {
"type": "string",
"required": true,
"description": "Name of the Mod",
"example": "Name= Hammered Garbage"
},
"Location": {
"type": "string",
"description": "Location of the Mod (Armor, Weapons, Sensors, etc.)",
"example": "Location= Utility",
"required": true
},
"Attr": {
"type": "string",
"description": "The Mod Attribute(s)",
"example": "Attr= +25 Damage",
"required": true
},
"Desc": {
"type": "string",
"description": "Mod Description/Summary",
"example": "Desc= Info: This Martian damage reflector sends 1% of all damage back to the attacker's shields",
"required": true
},
"Condition": {
"type": "string",
"description": "Is Mod Craftable, Purchasable or Both?",
"example": "1 = Craftable | 2 = Purchasable | 3 = Both Purchasable & Craftable",
"required": true
},
"MatsReq": {
"type": "string",
"description": "Materials Required to Craft a Craftable Mod",
"required": true,
"example": "See Example Above"
},
"Cost": {
"type": "string",
"description": "Mod Cost",
"example": "Cost= $75,000",
"required": true
},
"Rep": {
"type": "string",
"description": "Reputation Required to use Mod",
"example": "Rep= 1,000",
"required": true
"required": true
},
},
"link": {},
"Ship": {
"linktext": {}
"label": "Ship",
"description": "Ship Class?",
"example": "Any, Freighter, Fighter, Scout",
"type": "string"
}
},
},
"format": "block"
"format": "block",
"paramOrder": [
"Name",
"Image",
"Location",
"ReqLevel",
"ItemLevel",
"ID",
"Multi",
"Condition",
"Attr",
"Desc",
"Cost",
"Rep",
"MatsReq",
"Ship"
],
"description": "Detailed Guidelines for Parameter Usage"
}
}
</templatedata>
</templatedata>

Latest revision as of 03:31, 3 February 2021

This is a documentation subpage for Template:Modbox.
It contains usage information, categories, and other content that is not part of the original template page.
Not to be confused with Template:Infobox Mod.

This template creates a Mod Infobox for usage only for the Mod Stores.

Usage

  • Name – Name of the Mod
  • Image – Mod Image. Example: Armor.png
  • Location – Location of the Mod (Armor, Weapons, Sensors, etc.)
  • ReqLevel – Required Level of the Mod
  • ItemLevel – Item Rating/Tier of Mod
  • ID – Mod ID
  • Multi Install? – Yes or No
  • Ship - Ship Class: Any? Freighter? Fighter? Scout?
  • Condition
    • 1 = Craftable
    • 2 = Purchasable
    • 3 = Both Purchasable & Craftable
  • Attr – The Mod Attribute(s)
  • Desc – Mod Description/Summary
  • Cost – Mod Cost
  • Rep – Reputation Required to use Mod
  • MatsReq – Materials Required to Craft a Craftable Mod

Example

{{Modbox
|Name= Martian Mirror Panel
|Image= Armor.png
|Location= Armor
|ReqLevel= 2
|ItemLevel= 515
|ID= 283
|Multi= Yes
|Ship=Any
|Condition= 1
|Attr= +1% Damage Reflection
|Desc= Info: This Martian damage reflector sends 1% of all damage back to the attacker's shields
|Cost= $5,000
|Rep= 0
|MatsReq=
* Energy Cell: 0/1000
* Disrupter Cartridges: 0/150
* Tier III Mod Component: 0/100
* Military Grade Mod Frame: 0/1
}}

Result

Requires Level 2
Item Level 515
ID: 283
Install Multiple: Yes
Ship Class: Any
Martian Mirror Panel
Location: Armor
+1% Damage Reflection
Info: This Martian damage reflector sends 1% of all damage back to the attacker's shields

Materials Required:
  • Energy Cell: 0/1000
  • Disrupter Cartridges: 0/150
  • Tier III Mod Component: 0/100
  • Military Grade Mod Frame: 0/1

TemplateData

Detailed Guidelines for Parameter Usage

Template parameters

This template prefers block formatting of parameters.

ParameterDescriptionTypeStatus
NameName

Name of the Mod

Example
Name= Hammered Garbage
Stringrequired
ImageImage

Mod Image.

Example
Image= Armor.png
Stringrequired
LocationLocation

Location of the Mod (Armor, Weapons, Sensors, etc.)

Example
Location= Utility
Stringrequired
ReqLevelReqLevel

Required Level of the Mod

Example
ReqLevel= 35
Stringrequired
ItemLevelItemLevel

Item Rating/Tier of Mod

Example
ItemLevel= 515
Stringrequired
IDID

Mod ID

Example
ID= 19204
Stringrequired
MultiMulti

Is it Multi Install? Yes or No.

Example
Multi= Yes
Stringrequired
ConditionCondition

Is Mod Craftable, Purchasable or Both?

Example
1 = Craftable | 2 = Purchasable | 3 = Both Purchasable & Craftable
Stringrequired
AttrAttr

The Mod Attribute(s)

Example
Attr= +25 Damage
Stringrequired
DescDesc

Mod Description/Summary

Example
Desc= Info: This Martian damage reflector sends 1% of all damage back to the attacker's shields
Stringrequired
CostCost

Mod Cost

Example
Cost= $75,000
Stringrequired
RepRep

Reputation Required to use Mod

Example
Rep= 1,000
Stringrequired
MatsReqMatsReq

Materials Required to Craft a Craftable Mod

Example
See Example Above
Stringrequired
ShipShip

Ship Class?

Example
Any, Freighter, Fighter, Scout
Stringoptional