GameData:Example: Difference between revisions
Jump to navigation
Jump to search
added engine |
added multiple modules |
||
Line 79: | Line 79: | ||
*** '''flags''': Any flags noted for the engine as text. | *** '''flags''': Any flags noted for the engine as text. | ||
*** '''alt_mode''': Only include for multi-mode engines. This element contains a second collection of the engine elements defined above. | *** '''alt_mode''': Only include for multi-mode engines. This element contains a second collection of the engine elements defined above. | ||
** '''engine_gimbal''' | |||
*** '''pitch''': The value of the pitch the gimbal can generate, in <code>kN</code>. | |||
*** '''yaw''': The value of the yaw the gimbal can generate, in <code>kN</code>. | |||
** '''generator''' | |||
*** '''outputs''' | |||
**** '''electric_charge''': The value of the electric charge the generator produces as a number. | |||
**** '''units''': The units of the electric charge the generator produces, e.g. <code>U/s</code>. | |||
*** '''always_active''': If the generator is always active, set to <code>true</code> otherwise set to <code>false</code>. | |||
*** '''engine_alternator''': If the generator is an engine alternator, set to <code>true</code> otherwise set to <code>false</code>. | |||
*** '''output_decays''': If the generator has a decay, include this element. | |||
**** ''lifetime'': Use sub-elements <code>y</code>, <code>d</code>, <code>h</code>, <code>m</code>, & <code>s</code> to define how long the decay occurs over. | |||
** '''resource_intake''' | |||
*** '''resource''': The resource which is taken in as text, e.g. <code>intake_air</code>. | |||
*** '''area''': The area over which the resource is taken in, in <code>m<sup>2</sup></code>. | |||
*** '''efficicency''': Use sub-elements <code>mach0</code>, <code>mach1</code>, and <code>mach5</code> to define the efficiency of the resource collection, in <code>%</code>. | |||
=== Celestial bodies === | === Celestial bodies === |
Revision as of 22:58, 12 January 2025
Pages in the Data: namespace are reserved for storing JSON-formatted information on game entities such as parts and celestial bodies. They are accessed and implemented in articles via Template:Data. Subpages of this page provide populated examples of various parts as well as a blank example that lists every usable data set for an entity type.
Example subpages
Parts
Celestial Bodies
Data sets
A Data: page contains a wide variety of information relevant to its subject. These elements should follow the order presented below for consistency.
All Data: pages start with the entity element which can be "part", "body", "node", et cetera. The following lists the data sets per entity type defined.
Parts
- name: The name of the part as it appears in-game.
- subtitle: The subtitle of the part as it appears in-game.
- file: The file name, including the extension, of the wiki thumbnail image for the part. Should not include apostrophe, spaces, or periods.
- category: The part’s category, e.g.
fuel tank
,engine
, orutility
. - family: The part’s family, or subcategory, e.g.
methalox
,stabilizer
, orbattery
. - mass: The mass of the part, in
t
. - size: The size of the part, using the two-character tag per Size labels e.g.
SM
orLG
. - max_temp: The highest temperature the part can withstand, in
K
. - imp_tol: The highest impact velocity the part can withstand, in
m/s
. - stores_research: If the part stores the results of science experiments, either
true
orfalse
. - resources: What resource(s) can be contained by the part. Units are in
t
, orU
for Electric Charge. Do not include any blank elements.- units: The units, per resource, to use for display.
- manufacturer: The in-game manufacturer of the part, e.g.
Kerbodyne
. - modules: Each part may have zero or more of the following part modules:
- command_module
- crew_required: Minimum number of Kerbals the part needs to function.
- command_module
- reaction_wheel
- torque: How much pitch, roll, and yaw the part can induce, in
kN
. - resources_required: How much electric charge the part needs to use this module, in
/s
.
- torque: How much pitch, roll, and yaw the part can induce, in
- reaction_wheel
- data_transmitter
- range
- units: The units that specify the data transmitter range, e.g., Mm.
- max: The value of the maximum transmission distance in the units of paired units element.
- rate: The rate of data transmission, in
KiB/s
.
- range
- data_transmitter
- science_experiment
- experiment: The name of the experiment type, e.g., "Crew Observation".
- reports_create: Data and/or sample reports created,
true
orfalse
each. - report_size: Size of the report, in
KiB
. - requirements: Environment conditions necessary to run the experiment.
- duration: How long the experiment takes to run, in
seconds
. The {{ExpandTime}} template is typically used to display this in a more readable format. - crew_required: If any crew is required to run the experiment,
true
orfalse
.
- science_experiment
- rcs_thruster
- max_thrust
- atm: The maximum thrust at 1atm, in
kN
. - vac: The maximum thrust in vacuum, in
kN
.
- atm: The maximum thrust at 1atm, in
- isp
- atm: The Isp at 1atm, in
kN
. - vac: The Isp in vacuum, in
kN
.
- atm: The Isp at 1atm, in
- propellants
- resources: Individual elements per the resource consumed to generate thrust. Do not include blank elements.
- units: The units defining the consumption rate of the specified resources. Do not include blank elements.
- max_thrust
- rcs_thruster
- engine
- mode_name: Name of the engine mode if more than one mode exists. Leave as
""
if single-mode. - max_thrust
- atm: The maximum thrust at 1atm, in
kN
. - vac: The maximum thrust in vacuum, in
kN
.
- atm: The maximum thrust at 1atm, in
- isp
- atm: The Isp at 1atm, in
kN
. - vac: The Isp in vacuum, in
kN
.
- atm: The Isp at 1atm, in
- propellants
- resources: Individual elements per the resource consumed to generate thrust. Do not include blank elements.
- units: The units defining the consumption rate of the specified resources. Do not include blank elements.
- flags: Any flags noted for the engine as text.
- alt_mode: Only include for multi-mode engines. This element contains a second collection of the engine elements defined above.
- mode_name: Name of the engine mode if more than one mode exists. Leave as
- engine
- engine_gimbal
- pitch: The value of the pitch the gimbal can generate, in
kN
. - yaw: The value of the yaw the gimbal can generate, in
kN
.
- pitch: The value of the pitch the gimbal can generate, in
- engine_gimbal
- generator
- outputs
- electric_charge: The value of the electric charge the generator produces as a number.
- units: The units of the electric charge the generator produces, e.g.
U/s
.
- always_active: If the generator is always active, set to
true
otherwise set tofalse
. - engine_alternator: If the generator is an engine alternator, set to
true
otherwise set tofalse
. - output_decays: If the generator has a decay, include this element.
- lifetime: Use sub-elements
y
,d
,h
,m
, &s
to define how long the decay occurs over.
- lifetime: Use sub-elements
- outputs
- generator
- resource_intake
- resource: The resource which is taken in as text, e.g.
intake_air
. - area: The area over which the resource is taken in, in
m2
. - efficicency: Use sub-elements
mach0
,mach1
, andmach5
to define the efficiency of the resource collection, in%
.
- resource: The resource which is taken in as text, e.g.
- resource_intake