Shipdata.plist

shipdata.plist will provide Oolite with all the definitions necessary to include it as an entity in the game, be it ship, station, freak object or sub-entity (extra). The following (property) entries are, for order's sake, listed alphabetically:

accuracy

Used with missiles it has influence on tracking of target. Allowed values with missiles are between 0.0 and 10.0. When not defined, the system assings to the missile the accuracy value of 0.0, which corresponds to the standard missile tracking behaviour.

Used with NPC ships it enlarges the chance of shooting at greater distances. Value with NPC ships is between -5 and 10.

Example:

<key>accuracy</key>
<integer>8</integer>

aft_eject_position

Determines the XYZ point on the model from which cargo is ejected.

Example:

<key>aft_eject_position</key>
<string>0.0 -4.5 -23.0</string>

aft_weapon_type

Assigns the ship's laser. Any weapon type from the equipment.plist can be used (and WEAPON_NONE).

Example:

<key>aft_weapon_type</key>
<string>WEAPON_BEAM_LASER</string>

ai_type

Assigns an AI to the entity. This may be a previously existing AI, or one custom made for the occasion.

Example:

<key>ai_type</key>
<string>pirateAI.plist</string>

auto_ai

Introduced in version 1.69 to autoswitch ai to the appropriate one if a ship was added by a script in one of its standard roles like trader or pirate. See also the comment inside the autoAIMap.plist inside Oolite 1.69 or newer. Example:

<key>auto_ai</key>
<true/>

beacon

A special feature for beacons and navigation aids. The string can be anything - the first letter is what's displayed in the advanced space compass.

Example:

<key>beacon</key>
<string>X-code</string> 

bounty

Sets a Cr. reward on the NPC's head, and is bound to give it trouble with the law .

Example:

<key>bounty</key>
<integer>50</integer>

cargo_carried

Determines the type of cargo carried as described in commodities and commodities.plist. Only one type can be specified.

Example:

<key>cargo_carried</key>
<string>Gold</string>

cargo_type

Determines if object is indeed cargo (CARGO_RANDOM, CARGO_SLAVES, CARGO_THARGOID, CARGO_ALLOY, CARGO_MINERALS) or a ship, as below, which is not cargo. Only works for randomly generated cargopods. Works since Oolite 1.71 also for pods spawn by a script. Another notable type of cargo is the scripted item (CARGO_SCRIPTED_ITEM), as examplified by the cloacking device. Other cargo_types than the above mentioned won't work unless you use CARGO_CARRIED.

Example:

<key>cargo_type</key>
<string>CARGO_NOT_CARGO</string>

In v1.63, more controll will be available through the CARGO_CARRIED string. (see also discussion)

Example:

<key>cargo_type</key> 
<string>CARGO_CARRIED</string> 
<key>cargo_carried</key> 
<string>4 Gold</string>

conditions

Whit this option you can include an array of extra conditions when to add a ship. When the conditions are not met, the ship does not appear in a selection list by role. Useful when you have a standard ship like a trader that should only be added in certain systems.

Example:

<key>conditions</key>
     <array>
              <string>systemGovernment_number equal 3</string>
              <string>systemEconomy_number lessthan 4</string>
     </array>

custom_views

Will add the ability to display custom POVs of the player ship, in game toggled by pressing v.

This is an array with any number of entries, one for each view, each with:

• a view_description - giving a textual description of the view.
• a view_position - relative to the origin of the ship model.
• a view_orientation - this is a quaternion expressing a rotation from directly forwards.
• a weapon_facing - FORWARD, AFT, PORT or STARBOARD. The weapon that will fire when that view is selected.

The view_position is best chosen by selecting a facet, line or point in Wings and copying down the coordinates.

For the view_orientation you will probably need a calculator but the basic method is to choose a unit vector (x y z) as the axis for a rotation then calculate the four values W X Y and Z for the quaternion as follows:

W = the cosine of half the angle rotated about the axis xyz
X = the sine of half the angle rotated about xyz, multiplied by x
Y = the sine of half the angle rotated about xyz, multiplied by y
Z = the sine of half the angle rotated about xyz, multiplied by z

Four decimal places are probably enough accuracy for these values.

Example:

     <key>custom_views</key> 
     <array> 
        <dict> 
           <key>view_description</key> 
           <string>External View - Aft</string> 
           <key>view_position</key> 
           <string>0.0 100.0 -173.21</string> 
           <key>view_orientation</key> 
           <string>0.966 -0.259 0.0 0.0</string> 
           <key>weapon_facing</key> 
           <string>FORWARD</string> 
        </dict> 
        <dict> 
           <key>view_description</key> 
           <string>Scoop camera</string> 
           <key>view_position</key> 
           <string>0.0 -38.3333 1.6666</string> 
           <key>view_orientation</key> 
           <string>1.0 0.0 0.0 0.0</string> 
           <key>weapon_facing</key> 
           <string>FORWARD</string> 
        </dict> 
     </array>

death_actions

Gives an opportunity to have a ship's death trigger one or a set of script_actions.

Example:

<key>death_actions</key>
<array>
   <string>spawn: explosive_shrapnel 1</string>
</array>

defense_ship

Gives an oportunity to designate a particular ship by name that will defend a station/carrier. When launched from a carrier the scanclass becomes that of the carrier.

Example:

<key>defense_ship</key>
<string>my_defender</string>

defense_ship_role

Gives an oportunity to designate a particular (group of) ships that will defend a station/carrier. This has to be specified in the roles of the ship(s) that are assigned to defend. When launched from a carrier the scanclass becomes that of the carrier.

Example:

<key>defense_ship_role</key>
<string>carrier_defenders</string>

density

This real value is used to calculate a ships total mass. Default is 1.0 (Introduced in version 1.69?)

Example:

<key>density</key>
<real>1.5</real>

energy_recharge_rate

The rate at which energy is replenished. Stations are at 100, Adders at 2..

Example:

<key>energy_recharge_rate</key>
<real>3.5</real>

escape_pod_model

With this entry ships can have custom escape pods. (starting from version 1.65) You have to specify the role of your custom escape pod (not its entry-name).

Example:

<key>escape_pod_model</key>
<string>custom_pod</string>

escorts

Determines how many escorts an NPC shall have. Maximum is 16. In save systems Oolite may randomly decide to subtract escorts from the defined value.

Example:

<key>escorts</key>
<integer>4</integer>

escort-role

Assigns the specific ship type to be the escort, by the ship's role

Example:

<key>escort-role</key> 
<string>my_custom_escort_role</string>

escort-ship

Assigns the specific ship type to be the escort, by the ship's name.

Example:

<key>escort-ship</key>
<string>cobramk1</string>

equipment_price_factor

Equipment price mask for dockables.

Example:

<key>equipment_price_factor</key>
<real>4.5</real>

equivalent_tech_level

Sets shipyard tech level for dockables, different to the local system techlevel.

Example:

<key>equivalent_tech_level</key>
<integer>1</integer>

exhaust

The XYZ position(s) of exhaust plume(s), and the XYZ of the plume shape, ergo

x y z width height length

x y z is the position relative to the origin of the main model.

width in metres, how wide a plume is on x axis.

height in metres, how tall a plume is on y axis.

length in metres, how long a plume is on z axis.

Below are 2 assigned plumes at coords 5, 0, -25 and -5, 0, -25, and each plume is 6 m wide, 4 m tall and m 10 long

Example:

<key>exhaust</key>
<array>
    <string>5 0.0 -25 6.0 4.0 10.0</string>
    <string>-5 0.0 -25 6.0 4.0 10.0</string>
</array>

extra_cargo

New in version 1.62rc3 Cargobay extension size can now be customised. This is the amount the cargo capacity increases when an extra cargobay is installed. Defauld value is 15. It is only used with player ships.

Example:

<key>extra_cargo</key>
<integer>value</integer>

forward_weapon_type

Assigns the ship's laser. Any weapon type from the equipment.plist can be used (and WEAPON_NONE).

Example:

<key>forward_weapon_type</key>
<string>WEAPON_BEAM_LASER</string>

frangible

Determines if eventual sub-entities are "loose". By default any given object is already frangible, so the use of this line must be to negate that. If set to false, the object plus subentities will be regarded as a single object. If set to true, sub entities can be destroyed seperately from the main object.

Example:

<key>frangible</key>
<false/>

fragment_chance

Determines if a ship breaks apart into fragments. Default is set to YES.

Example:

<key>fragment_chance</key>
<false/>

fuel

Determines an NPC ship's fuel storage, which will affect how it uses its Fuel Injectors.

Example:

<key>fuel</key>
<integer>70</integer>

has_cloacking_device

Determines if a ship has a cloacking device installed. By chance factor, or true/false.

Example:

<key> has_cloacking_device </key>
<real>0.5</real>

has_ecm

Determines if a ship has the E.C.M system installed. By chance factor, or true/false.

Example:

<key>has_ecm</key>
<real>0.5</real>

or

<key>has_ecm</key>
<false/>

has_energy_bomb

Determines if a ship has an energy bomb. If it has it might launch a mine with role "energy_bomb" as part of his fleeing behavior. currently the only build-in mine with this role is the q-bomb.

Example:

<key> has_energy_bomb </key>
<false/>

has_escape_pod

Determines if a ship has an escape pod. Starting with version 1.65 ships can have multiple escape pods. has_escape_pod must than be a numeric value of 2 or higher.

Example:

<key>has_escape_pod</key>
<false/>

has_fuel_injection

Determines if a ship has the witchdrive fuel injector.

Example:

<key>has_fuel_injection</key>
<real>0.99</real>

has_military_jammer

Determines if a ship has a military jammer. Ships equipped with this item become invisible on the radar. Example:

<key>has_military_jammer</key>
<real>0.75</real>

has_military_scanner_filter

Determines if a ship has a military jammer filter. Ships equipped with this item can see ships equipped with a military jammer on the radar. Example:

<key>has_military_scanner_filter</key>
<real>0.50</real>

has_npc_traffic

Determines if a carrier has trader trafic. Default is no, but when set to YES traders will launch now and then just like stations do. Introduced in version 1.70

Example:

<key> has_npc_traffic </key>
<true/>

has_scoop

Determines if a ship has a fuel/cargo scoop.

Example:

<key>has_scoop</key>
<false/>

has_shield_booster

Determines if a ship has the shield booster. (enlarges max energy with 256)

Example:

<key>has_shield_booster</key>
<real>0.80</real>

has_shield_enhancer

Determines if a ship has the coveted shield enhancer. (enlarges max energy with 256 and raises energy recharge rate with 1.5)

Example:

<key>has_shield_enhancer</key>
<real>0.45</real>

hasShipyard

Determines if a station or carrier has a shipyard. By chance factor, or true/false, but value can also be an array of conditions.

Example:

<key>hasShipyard</key>
<true/>

heat_insulation

This real number gives the amount of heat insulation of a ship. Default is 1.0 Only for NPC ships. Playes ships can have the equipment EQ_HEAT_SHIELDING with gives the player than a heat_insulation of 2.0

Example:

<key> heat_insulation </key>
<real>2.0</real>

hud

Used for a playership, to assign another HUD than the default one.

Example:

<key>hud</key>
<string>specialhud.plist</string>

isCarrier

Added as a tag for making the model be considered a carrier. An alternative to including carrier among the roles.

Example:

<key>isCarrier</key>
<true/>

laser_color

Determines a ship's laser colour.

In Oolite 1.69 and later, this is any colour specifier. In earlier versions, it must be a named colour. Also as of 1.69, the game requires laser colours to be reasonably bright; if the brightest colour component is less than 0.5, the colour will be brightened.

Example:

<key>laser_color</key>
<string>cyanColor</string>

launch_actions

Triggers a script on the entity just after setup, also when called by spawn and addShip methods. Can be used to change to a custom AI, when a ship is generated by standard role. script_actions

Example:
"role = trader"
<key>launch_actions</key>
 <array>
  <string>setAITo: pirateAI.plist</string>
 </array>

like_ship

Allows a shipdata entry (of a ship with many matching characteristics to another) to be short and sweet. Then a "like_ship" key exist, the whole entry of a ship with this name is used as base for this ship. Only differences with the original ship have to be specified. (It is best not to refer to other references as it always uses its data from the original ship and neglect changes in an altered ship.)

Example:

<key>like_ship</key>
<string>adder</string>
<key>max_flight_speed</key>
<real>700</real>
<key>name</key>
<string>Freak Turbo Adder</string>

likely_cargo

This is only used for ships with role asteroid and pirate. With asteroids it gives the likely number of boulders it breaks into. With pirates added by the System Populator: when lower than 16 it is the cargo, when higher than 15, it is changed in a random value between 0 and 15. This value is overridden by the actual scooped cargo if the pirate had scooped something.

Example:

<key>likely_cargo</key>
<integer>2</integer>

materials

See Materials in Oolite.

max_cargo

Sets the ship's cargo limit. On explosion of trader ships added by the System Populator, 10% of this value is used as likely cargo. When the result is lower than 16 it is the cargo, when higher than 15, it is changed in a random value between 0 and 15.

Example:

<key>max_cargo</key>
<integer>5</integer>

max_defense_ships

Designates how many ships a dockable entity (station, carrier) can launch in defense. See also Station Ships

Example:

<key>max_defense_ships </key>
<integer>10</integer>

max_energy

Sets the ship's energy value.

Example:

<key>max_energy</key>
<real>300</real>

max_flight_pitch

Sets pitch factor. Will usually range from a sluggish 0.6 to a very sensitive 3.0

Example:

<key>max_flight_pitch</key>
<real>2.2</real>

max_flight_roll

Sets roll factor. Will usually range from 0.8 to 4.6.

Example:

<key>max_flight_roll</key>
<real>4.2000000000000002</real>

max_flight_speed

Sets the model's top speed. Interceptors fly at 520 (0.52 LM), Shuttles at 80.

Example:

<key>max_flight_speed</key>
<real>320</real>

max_flight_yaw

Sets yaw factor. Will usually range from a sluggish 0.6 to a very sensitive 3.0 When no value is defined it will use the same value as max_flight_pitch

Example:

<key>max_flight_yaw</key>
<real>2.2</real>

max_missiles

Sets a ship's missile limit.

Example:

<key>max_missiles</key>
<integer>1</integer>

max_police

Designates how many police or patrol ships a dockable entity (station, carrier) can launch. See also Station Ships

Example:

<key>max_police </key>
<integer>10</integer>

max_scavengers

Designates how many scavengers or miners a dockable entity (station, carrier) can launch. See also Station Ships

Example:

<key>max_scavengers</key>
<integer>10</integer>

missile_launch_position

Determines the XYZ point on the model from which a missile is launched.

Example:

<key>missile_launch_position</key>
<string>0.0 -2.25 10.0</string>

missiles

Sets a ship's probable number of missiles.

Example:

<key>missiles</key>
<integer>0</integer>

missile_role

Defines the entity that is launched as missile. Can specify a certain missile-type or any other ship-entity by role. Only applies to NPC's, player-ship dependacies must be defined in the shipyard.plist. If no missile_role is defined and a NPC ship launches a missile he most often chooses the default missile but sometimes chooses one at random from all ships with role missile inside one of the installed OXP's.

Example:

<key>missile_role</key>
<string>thargon</string>

model

Assigns the entity's corresponding .dat file that will be found with the exact same name in the Models folder.

Example:

<key>model</key>
<string>example_ship.dat</string>

name

States the model's name as it will be known to the ID computer.

Example:

<key>name</key>
<string>ExampleShip Mark IX</string>

no_boulders

With older versions, scripted asteroids had no boulders by default. Starting with 1.70 all asteroids produce boulders when hit by a mining laser. no_boulders can overwrite this to emulate the old situation. By chance factor, or true/false.

Example:

<key>no_boulders</key>
<true/>

pilot

Gives the ship a predefined pilot, defined in characters.plist. Can eject in pod, if available, and be captured.

Example:

<key>pilot</key>
<string>constrictor-mission-thief</string>

roles

Assigns which role(s) the entity should have, that can correspond to one specific, exclusive use, or several.

The game engine constantly calls for generic roles to populate the universe. In the example below the ship in question will be considered twice as often (2.0) when a trader is called for, only one quarter as often (0.25) when looking for a hunter, and as often as any other pirate ships when looking for a pirate.

Example:

<key>roles</key>
<string>hunter(0.25) trader(2.0) pirate</string>

or an exclusive role, simply:

<key>roles</key>
<string>uniquely_named_role</string>

This has the benefit of being the only ship to be selected when a script calls for the uniquely_named_role ship.

An item from the commodities can also be named as a role, for when that commodity is floating in space and called upon, to be represented by a particular model.

Example:

<key>roles</key> 
<string>Gold</string>

Some roles are used by the game engine to populate systems, detect and define properties. (see also the System Populator) Such roles include 'thargoid', 'missile' and 'energybomb'. Externally used equipment also needs specific mention of role, for example EQ_*_MINE and EQ_*_MISSILE.

rotating

Given to a station when rotation is desired.

Example:

<key>rotating</key>
<true/>

rotational_velocity

May be applied to a sub-entity, like the following entry to the subentity spines of the Weeviloid Hunter. Takes the form of quaternions. The following example enables rotation around the Z-axis.

Example:

<key>rotational_velocity</key>
<string>0.707 0.0 0.0 0.707</string>

scanClass

Will alter the model's appearance on the IFF system. If this line is omitted, it will become by default a standard ship entity, appearing as yellow flag on the radar. There are other options.

• CLASS_BUOY
• CLASS_CARGO
• CLASS_MILITARY
• CLASS_MISSILE
• CLASS_POLICE
• CLASS_ROCK
• CLASS_STATION
• CLASS_THARGOID

Developer Note

Oolite uses scanClass internally to determine the behaviour of some ships (particularly with regard to who may shoot whom without incurring legal penatlties). Bear this in mind and don't allocate CLASS_POLICE or CLASS_THARGOID to ships lightly!

Example:

<key>scanClass</key>
<string>CLASS_ROCK</string>

scanner_range

Sets a custom scanner range. Standard is 30km, thargoids have 50km. Only applies to NPCs.

script

Specifies a JavaScript script to attach to the ship. Ship scripts were introduced with Oolite test release 1.70, and are the preferred approach to scripting ships in new versions of Oolite.

script_info

A property list whose contents are available to JavaScript scripts, for whatever use they desire. It is exposed to JavaScript as the scriptInfo property of Ship objects.

script_actions

Gives an oportunity to insert events such as in script.plist, to involve a specific shipdata entity. As seen in the following example, this particular object checks if Player has a cloaking device, and if not, will award it. Should Player already have it, the gift will be in gold. See also scripts within shipdata for more detailled info.

Example:

<key>script_actions</key>
<array>
    <string>debugOn</string>
    <string>testForEquipment: EQ_CLOAKING_DEVICE</string>
    <dict>
       <key>conditions</key>
       <array>
          <string>foundEquipment_bool equal NO</string>
       </array>
       <key>do</key>
       <array>
          <string>awardEquipment: EQ_CLOAKING_DEVICE</string>
       </array>
       <key>else</key>
       <array>
          <string>awardCargo: 100 Gold</string>
       </array>
    </dict>
    <string>debugOff</string>
</array>

setup_actions

Arranges a process that may be necessary for some objects, like ball turrets.

Example:

<key>setup_actions</key>
<array>
   <string>initialiseTurret</string>
</array>

shaders

The shaders dictionary has the same structure as the materials dictionary. When shaders are available, the contents of the shaders dictionary are used in preference to those in materials. If shaders are not available, the shaders dictionary is ignored.

smooth

Determines if the model will use glLightModel(GL_FLAT) or glLightModel(GL_SMOOTH).

If true, then lighting effects will be interpolated across the polygons of the model, giving a more 'rounded' effect.

Asteroids, Boulders and Splinters use this effect as do some other models.

Example:

<key>smooth</key>
<true/>

spawn

The spawn directory is only used when a ship is added with the command: "spawnShip: shipname". This command only allows to add one ship by name (not role!). The position and orientation are taken from a spawn directory that describes the position it is placed and the position it is looking at.

Example

<key>spawn</key>
<dict>
      <key>facing_position</key>
      <string>spu 0 0 0</string>
      <key>position</key>
      <string>wpu 0 0 0.2</string>
</dict>

subentities

Can assign other objects, lights and turrets, to be associated with the model, fixed to a relative position. The first three numbers are XYZ positions, however, controlling positioning of enslaved objects is done by means of quaternions.

Lights follow their own recipe.

*FLASHER* x y z hue speed offset size

x y z is the position relative to the origin of the main model.

hue describes the colour of the light as an angle on a colour wheel.(0DEG = red =360DEG)

speed describes how fast the light pulses (on a sine wave) in Hertz (at 0 the light is constantly lit)

offset is the offset to the sine wave (0..1) to time-shift each light

size is the size of the light's corona in metres

Example:

<key>subentities</key>
<array>
   <string>mySubEntity 0 -5 10 1 0 0 0</string>
   <string>*FLASHER* 0 5.5 10 30.0 1 0.0 12</string>
</array>

note: armed subentities always fire along their Z-axis. When rotating along the Z(t=0)-axis.

thrust

Gives the entity an 'inertia' value, translating size and speed into a form of velocity. 0 for rocks and cargo, 50 for a very fast ship, 100 for a station..

Example:

<key>thrust</key>
<real>25</real>

unpiloted

Used to designate items that will never have a pilot, thus never turn aggressive and never eject a pod.

Example:

<key>unpiloted</key>
<true/>

view_position_..

Sets the ship's 4 point-of-view positions in XYZ relative to the model.

Example:

<key>view_position_aft</key>
<string>0.0 5.0 -20.0</string>
<key>view_position_forward</key>
<string>0.0 1.9375 5.0</string>
<key>view_position_port</key>
<string>-11.85 2.825 -3.5</string>
<key>view_position_starboard</key>
<string>11.85 2.825 -3.5</string>

weapon_energy

Gives a weapon energy value to the ship's laser that is different than the default.

Default values are: WEAPON_PLASMA_CANNON = 6.0; WEAPON_PULSE_LASER = 15.0; WEAPON_BEAM_LASER = 15.0; WEAPON_MINING_LASER = 50.0; WEAPON_THARGOID_LASER = 12.5; WEAPON_MILITARY_LASER = 23.0

Example:

<key>weapon_energy</key>
<real>15</real>

weapon_offset

Used to change the offsetpoint of a plasma cannon. Removed after version 1.65

Example:

<key>weapon_offset_x</key>
<real>10</real>

weapon_position_..

Plots the 'gunmouth' points of the model's 4 potential lasers.

Example:

<key>weapon_position_aft</key>
<string>0.0 -5.0 -20.0</string>
<key>weapon_position_forward</key>
<string>0.0 0.0417 16.6667</string>
<key>weapon_position_port</key>
<string>-13.75 -2.0625 -1.875</string>
<key>weapon_position_starboard</key>
<string>13.75 -2.0625 -1.875</string>

---