api-docs/models/ShipFrame.json

{
  "type": "object",
  "description": "The frame of the ship. The frame determines the number of modules and mounting points of the ship, as well as base fuel capacity. As the condition of the frame takes more wear, the ship will become more sluggish and less maneuverable.",
  "properties": {
    "symbol": {
      "type": "string",
      "enum": [
        "FRAME_PROBE",
        "FRAME_DRONE",
        "FRAME_INTERCEPTOR",
        "FRAME_RACER",
        "FRAME_FIGHTER",
        "FRAME_FRIGATE",
        "FRAME_SHUTTLE",
        "FRAME_EXPLORER",
        "FRAME_MINER",
        "FRAME_LIGHT_FREIGHTER",
        "FRAME_HEAVY_FREIGHTER",
        "FRAME_TRANSPORT",
        "FRAME_DESTROYER",
        "FRAME_CRUISER",
        "FRAME_CARRIER"
      ],
      "description": "Symbol of the frame."
    },
    "name": {
      "type": "string",
      "description": "Name of the frame."
    },
    "description": {
      "type": "string",
      "description": "Description of the frame."
    },
    "condition": {
      "$ref": "./ShipComponentCondition.json"
    },
    "integrity": {
      "$ref": "./ShipComponentIntegrity.json"
    },
    "moduleSlots": {
      "type": "integer",
      "minimum": 0,
      "description": "The amount of slots that can be dedicated to modules installed in the ship. Each installed module take up a number of slots, and once there are no more slots, no new modules can be installed."
    },
    "mountingPoints": {
      "type": "integer",
      "minimum": 0,
      "description": "The amount of slots that can be dedicated to mounts installed in the ship. Each installed mount takes up a number of points, and once there are no more points remaining, no new mounts can be installed."
    },
    "fuelCapacity": {
      "type": "integer",
      "minimum": 0,
      "description": "The maximum amount of fuel that can be stored in this ship. When refueling, the ship will be refueled to this amount."
    },
    "requirements": {
      "$ref": "./ShipRequirements.json"
    }
  },
  "required": [
    "symbol",
    "name",
    "condition",
    "performance",
    "description",
    "moduleSlots",
    "mountingPoints",
    "fuelCapacity",
    "requirements"
  ]
}