GameData:Example
Jump to navigation
Jump to search
Pages in the GameData: 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 GameData: page contains a wide variety of information relevant to its subject. These elements should follow the order presented below for consistency.
All GameData: 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.
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. This element must exist even if blank. If sub-elements of this element exist, do not include any blanks.- 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 part modules below. This element must exist even if blank.
- 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,
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
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,
trueorfalse.
- 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
trueotherwise set tofalse. - engine_alternator: If the generator is an engine alternator, set to
trueotherwise set tofalse. - output_decays: If the generator has a decay, include this element.
- lifetime: Use sub-elements
y,d,h,m, &sto 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. - efficiency: Use sub-elements
mach0,mach1, andmach5to define the efficiency of the resource collection, in%.
- resource: The resource which is taken in as text, e.g.
- resource_intake
- decouple
- force: The force the decoupler exerts to separate, in
kN. - all_nodes: Set to
trueif the decoupler separates on both sides (such as with stack separators) or tofalseif the decoupler remains attached to one side after use (such as with typical decouplers).
- force: The force the decoupler exerts to separate, in
- decouple
- docking_port
- type: The size of the actual docking node of the part, using the two-character tag per Size labels e.g.
SMorLG. - range: The distance from another docking node at which the magnetic effect activates, in
m. - force: The force the docking port exerts to separate, in
kN.
- type: The size of the actual docking node of the part, using the two-character tag per Size labels e.g.
- docking_port
- wheel
- steering_range: The angle span the wheel is capable of actuating along, in
°. - max_speed: The maximum speed the wheel can reach, in
m/s. - resources_required
- 'electric_charge': The amount of EC needed for the wheel to perform, in
U/s.
- 'electric_charge': The amount of EC needed for the wheel to perform, in
- brake_torque: The strength of the brakes on the wheel, in
kN.
- steering_range: The angle span the wheel is capable of actuating along, in
- wheel
- heat_shield
- resources Individual elements per the resource consumed to deflect heat. Typically only ablator. Do not include blank elements.
- heat_shield
- solar_panel
- deployable: Set to
trueif the panel can deploy orfalseif the panel is static. - outputs: The amount of EC the panel outputs, in
U/s.
- deployable: Set to
- solar_panel
- converter
- mode_name: Name of the converter mode if more than one mode exists. Leave as
""if single-mode. - inputs
- resources: Individual elements per the resource consumed by the converter. Do not include blank elements.
- units: The units defining the consumption rate of the specified resources. Do not include blank elements.
- outputs
- resources: Individual elements per the resource produced by the converter. Do not include blank elements.
- units: The units defining the production rate of the specified resources. Do not include blank elements.
- mode_name: Name of the converter mode if more than one mode exists. Leave as
- converter
- parachute
- drag
- semi_deployed: The amount of drag generated by the parachute while it is released but not yet expanded, in
kN. - deployed: The amount of drag generated by the parachute while it is fully expanded, in
kN.
- semi_deployed: The amount of drag generated by the parachute while it is released but not yet expanded, in
- drag
- parachute
- light
- resources_required
- electric_charge: The amount of EC consumed by the light while turned on, in
U/s.
- electric_charge: The amount of EC consumed by the light while turned on, in
- resources_required
- light
Celestial bodies
- name: The name 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.
- type: The type of body, e.g.,
Planet,Moon, orStar. - subtype: The surface type of the body, e.g.,
TerrestrialorGas. - system: The name of the system this body is part of, e.g.,
Kerbol. - parent: The name of whichever body the body orbits, e.g.,
JoolorKerbol. - mass: The mass of the body, in
t. - radius: The radius of the body, in
m. - sma: The semi-major axis of the body's orbit, in
m. - soi: The radius of the body's sphere of influence, in
m. - eccentricity: The eccentricity of the body's orbit.
Unitless - inclination: The inclination of the body's orbit, in
degrees. - arg_pe: The argument of periapsis of the body's orbit, in
degrees. - long_an: The longitude of the ascending node of the body's orbit, in
degrees. - anomaly: The mean anomaly of the body's orbit, in
degrees. - axial_tilt: The axial tilt of the body, in
degrees. - surface_gravity: The ratio of the acceleration due to gravity at sea level on the body relative to 9.81 m/s.
Unitless - sidereal_rotation_period: The sidereal rotation period of the body, in
s. The {{ExpandTime}} template is typically used to display this in a more readable format. - satellites: The number of bodies that orbit the body.
- atmo_pressure: The atmosphere pressure at sea level on the body, in
Pa. - atmo_height: The height of the atmosphere from sea level on the body, in
m. - atmo_oxygen: The presence of oxygen in the body's atmosphere,
trueorfalse.