Difference between revisions of "Template:Infobox/Part/doc"

From Kerbal Space Program Wiki
Jump to: navigation, search
(Create doc)
 
m (cirrected "volume" and "stacked" info)
Line 10: Line 10:
 
|costs=800
 
|costs=800
 
|mass=0.2
 
|mass=0.2
|volume=25
 
|stacking capacity=4
 
 
|drag=0.3
 
|drag=0.3
 
|temp=3400
 
|temp=3400
Line 22: Line 20:
 
|more={{Infobox/Part/adapter
 
|more={{Infobox/Part/adapter
 
   |out=4
 
   |out=4
 +
  }}
 +
  {{Infobox/Part/cargo
 +
  |volume=425
 +
  |stack=3
 
   }}
 
   }}
 
}}
 
}}
Line 38: Line 40:
 
=== More parameter ===
 
=== More parameter ===
 
To add additional fields the {{{more}}} parameter should be used with {{Tl|Infobox/Part/Line}} or {{Tl|Infobox/Line}}. It is preferred to use one of the [[:Category:Infobox/Part modules|modules]].
 
To add additional fields the {{{more}}} parameter should be used with {{Tl|Infobox/Part/Line}} or {{Tl|Infobox/Line}}. It is preferred to use one of the [[:Category:Infobox/Part modules|modules]].
 +
 +
'''Attention!''' To describe the required cargo parameters of any part, such as "value" and "stacking", there is a separate {{Tl|Infobox/Part/cargo|cargo}} module, which must be included in the infobox of each part
  
 
=== Manufacturer ===
 
=== Manufacturer ===
Line 67: Line 71:
 
|costs=
 
|costs=
 
|mass=
 
|mass=
|volume=
 
|stacking capacity=
 
 
|lf=
 
|lf=
 
|ox=
 
|ox=
Line 90: Line 92:
 
|notes=
 
|notes=
 
|nref=
 
|nref=
|more=
+
|more={{Infobox/Part/cargo
 +
  |volume=
 +
  |stack=
 +
  }}
 
}}</pre>
 
}}</pre>
  
Line 105: Line 110:
 
|costs=800
 
|costs=800
 
|mass=0.2
 
|mass=0.2
|volume=25
 
|stacking capacity=4
 
 
|drag=0.3
 
|drag=0.3
 
|temp=3400
 
|temp=3400
Line 118: Line 121:
 
   |out=4
 
   |out=4
 
   }}
 
   }}
 +
  {{Infobox/Part/cargo
 +
  |volume=425
 +
  |stack=3
 +
  }}
 
}}</pre>
 
}}</pre>
  

Revision as of 15:34, 2 September 2024

Infobox/Part
Part image
Adapter by
O.M.B. Demolition Enterprises

Radial size Large, Small, Tiny
Cost (total) 800.00 Funds
Mass (total) 0.200 t
Drag 0.3
Max. Temp. 3400 K
Impact Tolerance 12 m/s
Research Meta-materials.png Meta-Materials
Unlock cost 1 200 Funds
Since version 0.21
Part configuration part.cfg
Outgoing connectors 4
Packed volume 425 l
Stacking capacity 3 units

Usage

To avoid adding the information for each language this templates should be reused and with the suggested subpage name /Box. The Templates help page contains additional information how to implement reusing. All page which use template directly should add the {{Data template used}} note.

Parameters

Name Optional Description Default
Parameters of {{Infobox/Part}}
name Yes Name of the part, which can be found in the localization file. Uses {{Dict/part name}} to translate names. {{BASEPAGENAME}}
file Yes Filename to image of the part. File:Image needed.svg
size Yes Radial size of the part (uses {{Radial size}}). Not set/Hidden
size2 Yes Second radial size of the part (uses {{Radial size}}). Not set/Hidden
size3 Yes Third radial size of the part (uses {{Radial size}}). Not set/Hidden
size4 Yes Fourth radial size of the part (uses {{Radial size}}). Not set/Hidden
manufacturer Yes Manufacturer of the part. If set, linked to the category of this name (see also Category:Manufacturers). Automatically uses {{Infobox/Part/Manufacturer}} and {{Infobox/Part/Manufacturer entry}} on it. ?
manufacturer2 Yes Second manufacturer of the part. Not set/Hidden
costs No Cost of the part, which is usually given in the part configuration.
mass No Mass of the part, which is usually given in the part configuration.
drag No Drag of the part. By different values, add minimum_drag first and then maximum_drag
temp No Temperature resistance of the part, which is usually given in the part configuration.
tolerance No Impact tolerance of the part, which is usually given in the part configuration.
research Yes Research node required for this part. Uses {{Dict/sci node}} to translate names. Unknown
unlock cost No Cost to unlock the part, which is usually given in the part configuration.
since Yes Version the part first appeared in. It will be used in {{version}}. Unknown
dlc Yes Name of the dlc. Used for linking to the cfg-entry on the wiki. Can be:
  • mh (Making History)
  • bg (Breaking Ground)
Not Set
filename No The filename (with extension) of the part configuration.
part Yes Name of the part folder. Used for linking to the cfg-entry on the wiki. It will create a link to Parts/{{{parent}}}/{{{part}}}/{{{filename}}}. Unknown cfg
parent Yes Parent directory of the part folder. Used for linking to the cfg-entry on the wiki. Not set/Hidden

If a mandatory parameter is missing Category:Infobox/Part with missing parameters will be added.

Configuration file

With the new folder structure since version 0.20 the part config file must be placed at Parts/{{{parent}}}/{{{part}}}/{{{filename}}}. The {{Part config}} template should be used in the part configuration pages. For some parts the actual parent differs from the type. For those cases parent overrides the type-based parent definition. One example is the Vernor Engine, because it's a RCS engine but it's definition is in Engine although the other two RCS engines are in Utility.

More parameter

To add additional fields the {{{more}}} parameter should be used with {{Infobox/Part/Line}} or {{Infobox/Line}}. It is preferred to use one of the modules.

Attention! To describe the required cargo parameters of any part, such as "value" and "stacking", there is a separate {{Infobox/Part/cargo}} module, which must be included in the infobox of each part

Manufacturer

To add a manufacturer, it has to be added to the template {{Infobox/Part/Manufacturer}} and to {{Infobox/Part/ManufacturerUntranslated}}.

Types

For different types of parts this template allows to set the type parameter. The type will automatically set {{{role}}} and {{{parent}}} though they can be manually overwritten. The following values are supported:

Type Role Parent Subtemplate
cs Control surface Aero {{Infobox/Part/control surface}}
fan Fan shroud (n/a)
fr Fairing {{Infobox/Part/fairing}}
hs Heat shield {{Infobox/Part/heat shield}}
int Air intake {{Infobox/Part/air intake}}
let Winglet {{Infobox/Part/winglet}}
nc Nose cone (n/a)
win Wing {{Infobox/Part/lifting surface}}
car Cargo module Cargo {{Infobox/Part/inventory}}
cit Cargo item {{Infobox/Part/cargo}}
ga Ground anchor (n/a)
cm Command module Command {{Infobox/Part/command module}}
cp Cockpit
pod Command pod
rw Reaction wheel {{Infobox/Part/torque}}
sas Stability Augmentation System {{Infobox/Part/SAS}}
ft Fuel transfer CompoundParts (n/a)
str Strut (n/a)
air Airlock Coupling (n/a)
dec Decoupler {{Infobox/Part/separator}}
sep Separator
epl Engine plate
bat Battery Electrical {{Infobox/Part/energy storage}}
gen Generator {{Infobox/Part/generator}}
pan Solar panel {{Infobox/Part/solar panel}}
lfe Liquid fuel engine Engine {{Infobox/Part/reaction engine}}
mpe Monopropellant engine
srb Solid rocket booster {{Infobox/Part/solid fuel engine}}
je Jet engine {{Infobox/Part/jet engine}}
ie Ion engine {{Infobox/Part/ion engine}}
he Hybrid engine {{Infobox/Part/reaction engine}}, {{Infobox/Part/jet engine}}
dra Drain valve FuelTank (n/a)
lft Liquid fuel tank {{Infobox/Part/tank}}
mpt Monopropellant tank
xgt Xenon gas tank
tel Telescope Misc (n/a)
pro Propeller Propellers {{Infobox/Part/control surface}}
con Converter Resources {{Infobox/Part/converter}}
dri Resource harvester (n/a)
fc Fuel cell {{Infobox/Part/converter}}
ot Ore tank {{Infobox/Part/tank}}
sca Scanner (n/a)
cyl Cylinder Robotics {{Infobox/Part/servo}}
eng Engine
hin Hinge
pco Robotic controller (n/a)
rot Rotor {{Infobox/Part/servo}}
ser Servo
arm Scanning arm Science {{Infobox/Part/scanner arm}}, {{Infobox/Part/sensor}}
lab Laboratory {{Infobox/Part/laboratory}}
sen Environmental sensor {{Infobox/Part/sensor}}
sto Experiment Storage (n/a)
ada Adapter Structural {{Infobox/Part/adapter}}
grp Grip pad (n/a)
ste Structural element (n/a)
rad Radiator Thermal {{Infobox/Part/radiator}}
ant Antenna Utility {{Infobox/Part/antenna}}
cb Cargo bay (n/a)
chu Parachute {{Infobox/Part/parachute}}
claw Advanced Grabbing Unit (n/a)
dp Docking port {{Infobox/Part/docking port}}
fla Flag (n/a)
hab Habitation module {{Infobox/Part/crew}}
lad Ladder {{Infobox/Part/ladder}}
leg Landing leg (n/a)
les Launch Escape System (n/a)
lig Electric light {{Infobox/Part/electric usage}}
rcs Reaction Control System {{Infobox/Part/reaction engine}}, {{Infobox/Part/thrust vectors}}
sb Service bay (n/a)
gea Landing gear Wheel (n/a)
rov Rover wheel {{Infobox/Part/rover wheel}}


If a part uses more than one type, for example the R.A.P.I.E.R. Engine, the type parameter is usually omitted and each subtemplate should use a header from {{Infobox/Part/title}}.

Additionally test subjects can use {{Infobox/Part/test subject}}.

Roles

Prior to the module system "roles" where used, but have been abandoned because they are not flexible enough. Currently only {{Infobox/Part/Strut}} is the only role template still used.

Template

{{Infobox/Part
|name=
|file=
|type=
|role=
|size=
|size2=
|size3=
|manufacturer=
|manufacturer2=
|costs=
|mass=
|lf=
|ox=
|mp=
|sf=
|xg=
|ia=
|or=
|ab=
|drag=
|temp=
|tolerance=
|research=
|unlock cost=
|since=
|dlc=
|filename=
|part=
|parent=
|physics insignificant=
|notes=
|nref=
|more={{Infobox/Part/cargo
   |volume=
   |stack=
   }}
}}

Example

Example used on this page:

{{Infobox/Part
|file=TVR-400L Stack Quad-Adapter.png
|type=ada
|size=large
|size2=small
|size3=tiny
|manufacturer=OMB
|costs=800
|mass=0.2
|drag=0.3
|temp=3400
|tolerance=12
|research=Meta-Materials
|unlock cost=1200
|since=0.21
|filename=part.cfg
|part=adapterLargeSmallQuad
|more={{Infobox/Part/adapter
  |out=4
  }}
  {{Infobox/Part/cargo
   |volume=425
   |stack=3
   }}
}}

Translation

When using this template, most of it is translated automatically. To translate this template or one of the subtemplates, go to the {{Infobox/Part/Dict}} template.

Manufacturer

To add a translation for a manufacturer's name, add it to {{Infobox/Part/Manufacturer}} (use the {{lang}} template). Do not translate manufacturer names in the template {{Infobox/Part/ManufacturerUntranslated}}.