api-docs/models/ShipModule.json
2024-12-15 15:28:31 +01:00

60 lines
1.8 KiB
JSON

{
"type": "object",
"description": "A module can be installed in a ship and provides a set of capabilities such as storage space or quarters for crew. Module installations are permanent.",
"properties": {
"symbol": {
"type": "string",
"enum": [
"MODULE_MINERAL_PROCESSOR_I",
"MODULE_GAS_PROCESSOR_I",
"MODULE_CARGO_HOLD_I",
"MODULE_CARGO_HOLD_II",
"MODULE_CARGO_HOLD_III",
"MODULE_CREW_QUARTERS_I",
"MODULE_ENVOY_QUARTERS_I",
"MODULE_PASSENGER_CABIN_I",
"MODULE_MICRO_REFINERY_I",
"MODULE_ORE_REFINERY_I",
"MODULE_FUEL_REFINERY_I",
"MODULE_SCIENCE_LAB_I",
"MODULE_JUMP_DRIVE_I",
"MODULE_JUMP_DRIVE_II",
"MODULE_JUMP_DRIVE_III",
"MODULE_WARP_DRIVE_I",
"MODULE_WARP_DRIVE_II",
"MODULE_WARP_DRIVE_III",
"MODULE_SHIELD_GENERATOR_I",
"MODULE_SHIELD_GENERATOR_II"
],
"description": "The symbol of the module."
},
"capacity": {
"type": "integer",
"minimum": 0,
"description": "Modules that provide capacity, such as cargo hold or crew quarters will show this value to denote how much of a bonus the module grants."
},
"range": {
"type": "integer",
"minimum": 0,
"description": "Modules that have a range will such as a sensor array show this value to denote how far the module can reach with its capabilities."
},
"name": {
"type": "string",
"description": "Name of this module."
},
"description": {
"type": "string",
"description": "Description of this module."
},
"requirements": {
"$ref": "./ShipRequirements.json"
}
},
"required": [
"symbol",
"name",
"description",
"requirements"
]
}