Definition object

This describes a Ship Hull's attributes.

Content definition root context

Available instructions: state, add, template, remove, remove-all, update, update-all

Add / Update Template

ShipHull:
  - add: # or - update:
      $ShipHullId: MyNewShipHull
      RaceId: 3
      Role: Escort # Escort, Frigate, Destroyer, Cruiser, CapitalShip, Carrier, TroopTransport, 
#FuelTanker, ExplorationShip, ConstructionShip, FreighterSmall, FreighterMedium, FreighterLarge, 
#PassengerShip, MiningShip, ColonyShip, DefensiveBase, MiningStation, ResearchStation, 
#MonitoringStation, ResortBase, SpaceportSmall, SpaceportMedium, SpaceportLarge, FighterInterceptor, 
#FighterBomber, PlanetDestroyer :3
      Level: 0 # Used to define the subrole, ex- 0 is Escort, 1 is Patrol Escort, 2 is Heavy Escort.
      DesignTemplateId: -1 # can define a specific DesignTemplate to be used
      Size: 125 # Hit Points of the Hull
      MaximumSize: 375 # Size useable for components = MaxSize-Size
      DisplaySize: 200
      ModelName: Ships/Haakonish/escort
      CockpitImageFilename: ''
      BaseCost: 1400 # Money
      ArmorReactiveRating: 3
      IonDefense: 1
      EngineLimit: 3 
      CountermeasuresBonus: 0.1
      TargetingBonus: 0
      TurnRollRate: 0.25 
      MaximumTurnRollAngle: 0.35
      Bonuses:
        - Type: ShipSpeed
          Amount: 0.25
          AppliesTo: Item
          FilterId: 0
          DiscoveryLevel: 0
          Description: 
          Sources: []
          SourceAmounts: []
        - Type: ShipManeuvering
          Amount: 0.25
          AppliesTo: Item
          FilterId: 0
          DiscoveryLevel: 0
          Description: 
          Sources: []
          SourceAmounts: []
      ModelSize: 
        X: 0
        Y: 0
        Z: 0
      ComponentBays:
        - ComponentBayId: 0
          Type: Weapon # Weapon, Engine, Sensor, Defense, General
          MaximumComponentSize: 120
          MeshName: '#weapon0' # name of the mesh (External hardpoint displayed on the hull of the ship.  
#Several components may occupy the same hardpoint.  These meshes and their names are created/ described 
#in the actual 3D data of the ship, found in a Bundle, elsewhere.)
          RotationHalfArcRange: 2.356 # 90 deg: 0.79, 135 deg: 1.18, 180 deg: 1.57, 225 deg: 1.96, 
#270 deg: 2.36, 360 deg: 3.14 (thanks to: KeCzajkowski)

          DisplayEffectRescaleFactor: 
            X: 0
            Y: 0
            Z: 0
          DisplayEffectOffset: 
            X: 0
            Y: 0
            Z: 0
          Meshes: []
        - ComponentBayId: 1
          Type: Engine
          MaximumComponentSize: 50
          MeshName: '#engine0'
          RotationHalfArcRange: 0
          DisplayEffectRescaleFactor: 
            X: 0.75
            Y: 0.75
            Z: 1
          DisplayEffectOffset: 
            X: 0
            Y: 0
            Z: 0
          Meshes: []
        - ComponentBayId: 2
          Type: Engine
          MaximumComponentSize: 50
          MeshName: '#engine1'
          RotationHalfArcRange: 0
          DisplayEffectRescaleFactor: 
            X: 0
            Y: 0
            Z: 0
          DisplayEffectOffset: 
            X: 0
            Y: 0
            Z: 0
          Meshes: []
        - ComponentBayId: 3
          Type: Engine
          MaximumComponentSize: 50
          MeshName: '#engine2'
          RotationHalfArcRange: 0
          DisplayEffectRescaleFactor: 
            X: 0
            Y: 0
            Z: 0
          DisplayEffectOffset: 
            X: 0
            Y: 0
            Z: 0
          Meshes: []
        - ComponentBayId: 4
          Type: Sensor
          MaximumComponentSize: 19
          MeshName: '#sensor0'
          RotationHalfArcRange: 0
          DisplayEffectRescaleFactor: 
            X: 0
            Y: 0
            Z: 0
          DisplayEffectOffset: 
            X: 0
            Y: 0
            Z: 0
          Meshes: []
        - ComponentBayId: 5
          Type: Sensor
          MaximumComponentSize: 19
          MeshName: '#sensor1'
          RotationHalfArcRange: 0
          DisplayEffectRescaleFactor: 
            X: 0
            Y: 0
            Z: 0
          DisplayEffectOffset: 
            X: 0
            Y: 0
            Z: 0
          Meshes: []
        - ComponentBayId: 6
          Type: Defense
          MaximumComponentSize: 50
          MeshName: '#defense0'
          RotationHalfArcRange: 0
          DisplayEffectRescaleFactor: 
            X: 0
            Y: 0
            Z: 0
          DisplayEffectOffset: 
            X: 0
            Y: 0
            Z: 0
          Meshes: []
        - ComponentBayId: 7
          Type: Defense
          MaximumComponentSize: 50
          MeshName: 
          RotationHalfArcRange: 0
          DisplayEffectRescaleFactor: 
            X: 0
            Y: 0
            Z: 0
          DisplayEffectOffset: 
            X: 0
            Y: 0
            Z: 0
          Meshes: []
        - ComponentBayId: 8
          Type: General
          MaximumComponentSize: 50
          MeshName: 
          RotationHalfArcRange: 0
          DisplayEffectRescaleFactor: 
            X: 0
            Y: 0
            Z: 0
          DisplayEffectOffset: 
            X: 0
            Y: 0
            Z: 0
          Meshes: []
        - ComponentBayId: 9
          Type: General
          MaximumComponentSize: 50
          MeshName: 
          RotationHalfArcRange: 0
          DisplayEffectRescaleFactor: 
            X: 0
            Y: 0
            Z: 0
          DisplayEffectOffset: 
            X: 0
            Y: 0
            Z: 0
          Meshes: []
        - ComponentBayId: 10
          Type: General
          MaximumComponentSize: 50
          MeshName: 
          RotationHalfArcRange: 0
          DisplayEffectRescaleFactor: 
            X: 0
            Y: 0
            Z: 0
          DisplayEffectOffset: 
            X: 0
            Y: 0
            Z: 0
          Meshes: []
        - ComponentBayId: 11
          Type: General
          MaximumComponentSize: 50
          MeshName: 
          RotationHalfArcRange: 0
          DisplayEffectRescaleFactor: 
            X: 0
            Y: 0
            Z: 0
          DisplayEffectOffset: 
            X: 0
            Y: 0
            Z: 0
          Meshes: []
        - ComponentBayId: 12
          Type: General
          MaximumComponentSize: 50
          MeshName: 
          RotationHalfArcRange: 0
          DisplayEffectRescaleFactor: 
            X: 0
            Y: 0
            Z: 0
          DisplayEffectOffset: 
            X: 0
            Y: 0
            Z: 0
          Meshes: []
        - ComponentBayId: 13
          Type: General
          MaximumComponentSize: 50
          MeshName: 
          RotationHalfArcRange: 0
          DisplayEffectRescaleFactor: 
            X: 0
            Y: 0
            Z: 0
          DisplayEffectOffset: 
            X: 0
            Y: 0
            Z: 0
          Meshes: []
        - ComponentBayId: 14
          Type: General
          MaximumComponentSize: 50
          MeshName: 
          RotationHalfArcRange: 0
          DisplayEffectRescaleFactor: 
            X: 0
            Y: 0
            Z: 0
          DisplayEffectOffset: 
            X: 0
            Y: 0
            Z: 0
          Meshes: []
        - ComponentBayId: 15
          Type: General
          MaximumComponentSize: 50
          MeshName: 
          RotationHalfArcRange: 0
          DisplayEffectRescaleFactor: 
            X: 0
            Y: 0
            Z: 0
          DisplayEffectOffset: 
            X: 0
            Y: 0
            Z: 0
          Meshes: []
        - ComponentBayId: 16
          Type: General
          MaximumComponentSize: 50
          MeshName: 
          RotationHalfArcRange: 0
          DisplayEffectRescaleFactor: 
            X: 0
            Y: 0
            Z: 0
          DisplayEffectOffset: 
            X: 0
            Y: 0
            Z: 0
          Meshes: []
        - ComponentBayId: 17
          Type: General
          MaximumComponentSize: 50
          MeshName: 
          RotationHalfArcRange: 0
          DisplayEffectRescaleFactor: 
            X: 0
            Y: 0
            Z: 0
          DisplayEffectOffset: 
            X: 0
            Y: 0
            Z: 0
          Meshes: []
      ResourcesRequired:
      - ResourceId: 8
        Amount: 62
      - ResourceId: 10
        Amount: 90
      Name: Escort
      Description: >- # https://yaml-multiline.info/
        Lorem ipsum dolor sit amet, consectetur adipiscing elit.
        Proin vehicula porta justo, eu lacinia erat condimentum et.
        Suspendisse semper ut lectus in efficitur.

        Ut interdum lacus sed est ornare elementum vehicula maximus sapien.
        Donec sed ipsum tortor.
      ImageFilename: Ships/Haakonish/Images/escort
      RunningLights: # Leave blank unless the Hull has this mesh, will crash game on galaxy gen.  
#This example Mesh was taken from another ship, it must be removed for Haakonish/escort to be used.
        - MeshName: '#Runninglight0'
          Position:
            X: 0
            Y: 0
            Z: 0
          Color:
            R: 0
            G: 255
            B: 0
            A: 255
          TimingOffset: 0.25
          LightTimeOn: 0.5
          LightTimeOff: 0.5
      Emitters: [] # unknown effect, meshes?
      Modules: [] # unknown effect, meshes?
      UnusedModelNodeIds: [] # unknown effect
      MaterialName: # unknown effect
      DeadMaterialName: # unknown effect
      BuildSpeedFactor: 1
      BoundingBox: # unknown effect
        Minimum:
          X: 3.4028234663852886E+38
          Y: 3.4028234663852886E+38
          Z: 3.4028234663852886E+38
        Maximum:
          X: -3.4028234663852886E+38
          Y: -3.4028234663852886E+38
          Z: -3.4028234663852886E+38