Objects/doc

Revision as of 06:24, 3 January 2021

Documentation

Use this doc for pages about objects, consult List of Objects for references

Usage

Item

{{Objects
|name      =
|image     = 
|tier      = 
|group     = 
|type      =
|recipe    =
|crafting  =
|crafting2 =
|unlock    = 
}}

Resource

{{Objects
|name      =
|image     = 
|tier      = 
|group     = 
|type      =
|value     =
}}

Example (Unlockable Item)

{{Objects
|name      = Small Wind Turbine
|image     = Small Wind Turbine.png
|tier      = 1
|group     = Item
|type      = Power Generation
|recipe    = 1x {{ItemLink|Glass}}
|crafting  = Backpack
|unlock    = 500
}}

Small Wind Turbine

Details
Tier	Small
Group	Item
Type	Power Generation
Crafted at	Backpack
Recipe	1x Glass
Unlock Cost	500 Bytes

Parameters

name = The name of the object

image = The chosen icon for the object

tier = The tier of the object, either Small, Medium, Large, or Extra Large

group = The group of the object, ex. Item, Module

type = The subgroup of the object, ex. Creative, Base Building

recipe = (do not include if uncraftable) The recipe used to craft the item

crafting = (do not include if uncraftable) The module used to craft the item

crafting2 = (do not include if uncraftable or craftable only by one module) The second module used to craft the item

unlock = An item's cost to unlock the blueprint in the Research Catalog

Example (Default Unlocked Item)

{{Objects
|name      = Beacon
|image     = beacon.png
|tier      = 
|group     = Item
|type      = Exploration
|recipe    = 1x {{ItemLink|Quartz}}
|crafting  = Backpack
|unlock    = Unlocked
}}

Beacon

Details
Tier	Unknown
Group	Item
Type	Exploration
Crafted at	Backpack
Recipe	1x Quartz
Unlock Cost	Unlocked

Parameters

name = The name of the object

image = The chosen icon for the object

tier = The tier of the object, either Small, Medium, Large, or Extra Large

group = The group of the object, ex. Item, Module

type = The subgroup of the object, ex. Creative, Base Building

recipe = (do not include if uncraftable) The recipe used to craft the item

crafting = (do not include if uncraftable) The module used to craft the item

crafting2 = (do not include if uncraftable or craftable only by one module) The second module used to craft the item

unlock = An item's cost to unlock the blueprint in the Research Catalog. Use Unlocked if it's a default item at the start of a game

Example (Resource)

{{Objects
|name      = Titanium
|image     = Nugget Titanium.png
|tier      = 1
|group     = Resource
|type      = Refined
|recipe    = {{ItemLink|Titanite}}
|crafting  = Smelting Furnace
|value     = 210
}}

Titanium

Details
Tier	Small
Group	Resource
Type	Refined
Crafted at	Smelting Furnace
Recipe	Titanite
Byte Value	210 Bytes

Parameters

name = The name of the object

image = The chosen icon for the object

tier = The tier of the object, either Small, Medium, Large, or Extra Large.

group = The group of the object, ex. Item, Module.

type = The subgroup of the object, ex. Creative, Base Building.

recipe = The items used to create the item

crafting = The crafting module the item is created at

value = how much value for said resource if it were to be researched with the Research Chamber

This is the documentation page, it should be transcluded into the main template page. See Template:Doc for more information.

@@ Line 3: / Line 3: @@
 == Usage ==
+=== Item ===
 <pre>
 {{Objects
@@ Line 12: / Line 13: @@
 |recipe    =
 |crafting  =
-|research  =
+|crafting2 =
-|value     =
+|unlock    =
 }}
 </pre>
-== Parameters ==
+=== Resource ===
+<pre>
+{{Objects
+|name      =
+|image     =
+|tier      =
+|group     =
+|type      =
+|value     =
+}}
+</pre>
+== Example (Unlockable Item) ==
-* '''name'''      = The name of the objects
-* '''image'''     = The chosen icon for the object
-* '''tier'''          = The tier of the object (Only use 1,2,and 3)
-* '''group'''      = The group of the object
-* '''type'''        = The subgroup of the object
-* '''recipe'''     = (do not include if uncraftable) The recipe used craft it
-* '''crafting'''  = (do not include if uncraftable) The fabricator used to craft it
-* '''research'''   = whether or not an item is re-searchable or not
-* '''value'''      = (for resources only) how much compound can be brought from one of this item
-== Example ==
+<pre>
 {{Objects
-|name      = Small Solar Panel
+|name      = Small Wind Turbine
-|image     = Solar.png
+|image     = Small Wind Turbine.png
 |tier      = 1
-|group     = Power
+|group     = Item
-|type      = Module
+|type      = Power Generation
-|recipe    = 1x [[Compound]]
+|recipe    = 1x {{ItemLink|Glass}}
-|crafting  = [[Backpack]]
+|crafting  = Backpack
+|unlock    = 500
 }}
+</pre>
 {{Objects
-|name      = Titanium
+|name      = Small Wind Turbine
-|image     = Icon_Titanium.png
+|image     = Small Wind Turbine.png
 |tier      = 1
-|group     = Resource
+|group     = Item
-|type      = Rare
+|type      = Power Generation
+|recipe    = 1x {{ItemLink|Glass}}
-|value   = 4
+|crafting  = Backpack
+|unlock    = 500
 }}
+=== Parameters ===
+* '''name'''      = The name of the object
+* '''image'''     = The chosen icon for the object
+* '''tier'''      = The tier of the object, either Small, Medium, Large, or Extra Large
+* '''group'''      = The group of the object, ex. Item, Module
+* '''type'''        = The subgroup of the object, ex. Creative, Base Building
+* '''recipe'''     = (do not include if uncraftable) The recipe used to craft the item
+* '''crafting'''  = (do not include if uncraftable) The module used to craft the item
+* '''crafting2'''  = (do not include if uncraftable or craftable only by one module) The second module used to craft the item
+* '''unlock'''   = An item's cost to unlock the blueprint in the [[Research Catalog]]
+{{Clear}}
+== Example (Default Unlocked Item) ==
+<pre>
+{{Objects
+|name      = Beacon
+|image     = beacon.png
+|tier      =
+|group     = Item
+|type      = Exploration
+|recipe    = 1x {{ItemLink|Quartz}}
+|crafting  = Backpack
+|unlock    = Unlocked
+}}
+</pre>
+{{Objects
+|name      = Beacon
+|image     = beacon.png
+|tier      =
+|group     = Item
+|type      = Exploration
+|recipe    = 1x {{ItemLink|Quartz}}
+|crafting  = Backpack
+|unlock    = Unlocked
+}}
+=== Parameters ===
+* '''name'''      = The name of the object
+* '''image'''     = The chosen icon for the object
+* '''tier'''      = The tier of the object, either Small, Medium, Large, or Extra Large
+* '''group'''      = The group of the object, ex. Item, Module
+* '''type'''        = The subgroup of the object, ex. Creative, Base Building
+* '''recipe'''     = (do not include if uncraftable) The recipe used to craft the item
+* '''crafting'''  = (do not include if uncraftable) The module used to craft the item
+* '''crafting2'''  = (do not include if uncraftable or craftable only by one module) The second module used to craft the item
+* '''unlock'''   = An item's cost to unlock the blueprint in the [[Research Catalog]]. Use Unlocked if it's a default item at the start of a game
+{{Clear}}
+== Example (Resource) ==
+<pre>
+{{Objects
+|name      = Titanium
+|image     = Nugget Titanium.png
+|tier      = 1
+|group     = Resource
+|type      = Refined
+|recipe    = {{ItemLink|Titanite}}
+|crafting  = Smelting Furnace
+|value     = 210
+}}
+</pre>
+{{Objects
+|name      = Titanium
+|image     = Nugget Titanium.png
+|tier      = 1
+|group     = Resource
+|type      = Refined
+|recipe    = {{ItemLink|Titanite}}
+|crafting  = Smelting Furnace
+|value     = 210
+}}
+== Parameters ==
+* '''name'''      = The name of the object
+* '''image'''     = The chosen icon for the object
+* '''tier'''      = The tier of the object, either Small, Medium, Large, or Extra Large.
+* '''group'''      = The group of the object, ex. Item, Module.
+* '''type'''        = The subgroup of the object, ex. Creative, Base Building.
+* '''recipe'''     = The items used to create the item
+* '''crafting'''   = The crafting module the item is created at
+* '''value'''      = how much value for said resource if it were to be researched with the [[Research Chamber]]
+{{Clear}}
 {{doc/end}}