GameData:Example: Difference between revisions
Jump to navigation
Jump to search
added data transmitter info |
updated capitalization of elements to match the JSON |
||
| Line 17: | Line 17: | ||
A Data: page contains a wide variety of information relevant to its subject. | A Data: page contains a wide variety of information relevant to its subject. | ||
All Data: pages start with the ''' | 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 === | === 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. <code>fuel tank</code>, <code>engine</code>, or <code>utility</code>. | ||
* ''' | * '''family''': The part’s family, or subcategory, e.g. <code>methalox</code>, <code>stabilizer</code>, or <code>battery</code>. | ||
* ''' | * '''mass''': The mass of the part, in <code>kg</code>. | ||
* ''' | * '''size''': The size of the part, using the two-character tag per [[Size]] labels e.g. <code>SM</code> or <code>LG</code>. | ||
* ''' | * '''max_temp:''' The highest temperature the part can withstand, in <code>K</code>. | ||
* ''' | * '''imp_tol''': The highest impact velocity the part can withstand, in <code>m/s</code>. | ||
* ''' | * '''stores_research''': If the part stores the results of science experiments, either <code>true</code> or <code>false</code>. | ||
* ''' | * '''resources''': What resource(s) can be contained by the part. Units are in <code>t</code>, or <code>U</code> for Electric Charge. Do not include any blank elements. | ||
* ''' | * '''manufacturer''': The in-game manufacturer of the part, e.g. <code>Kerbodyne</code>. | ||
* ''' | * '''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. | ||
** ''' | ** '''reaction_wheel''' | ||
*** ''' | *** '''torque''': How much pitch, roll, and yaw the part can induce, in <code>kN</code>. | ||
*** ''' | *** '''resources_required''': How much electric charge the part needs to use this module, in <code>/s</code>. | ||
** ''' | ** '''data_transmitter''' | ||
*** '''range''' | *** '''range''' | ||
**** ''units'': The units that specify the data transmitter range, e.g., Mm. | **** ''units'': The units that specify the data transmitter range, e.g., Mm. | ||
| Line 45: | Line 45: | ||
*** '''rate''': The rate of data transmission, in <code>KiB/s</code>. | *** '''rate''': The rate of data transmission, in <code>KiB/s</code>. | ||
** ''' | ** '''science_experiment''' | ||
*** '''experiment''': The name of the experiment type, e.g., "Crew Observation". | *** '''experiment''': The name of the experiment type, e.g., "Crew Observation". | ||
*** '''reports_create''': Data and/or sample reports created, <code>true</code> or <code>false</code> each. | *** '''reports_create''': Data and/or sample reports created, <code>true</code> or <code>false</code> each. | ||
Revision as of 22:30, 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.
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
kg. - size: The size of the part, using the two-character tag per Size labels e.g.
SMorLG. - 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
trueorfalse. - resources: What resource(s) can be contained by the part. Units are in
t, orUfor Electric Charge. Do not include any blank elements. - 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.
- 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
- command_module
- 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,
trueorfalseeach. - 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
HH:MM:SS. - crew_required: If any crew is required to run the experiment,
trueorfalse.
- science_experiment